Class OrganizationDefaultAdapterRestSdk

Default Adapter for Organization

Description

This class is used to define the default adapter for Organization. This adapter uses the REST SDK to communicate with Organization functionality.

Implements

Constructors

constructor

Properties

addOrUpdateUsersPath createOrganizationPath getAttachmentByIds getAttachmentsPath getOneOrganizationAttachmentPath getOrganizationAttachmentsPath getOrganizationByIdPath getOrganizationUsersPath getOrganizationsPath getUserOrganizationRolePath getUserOrganizationsPath internalToken isUserInOrganizationPath organizationServiceEndpoint patchOrganizationPath DEFAULT_ADD_OR_UPDATE_USERS DEFAULT_CREATE_ORGANIZATION DEFAULT_GET_ATTACHMENTS DEFAULT_GET_ONE_ORGANIZATION_ATTACHMENT DEFAULT_GET_ORGANIZATIONS DEFAULT_GET_ORGANIZATION_ATTACHMENTS DEFAULT_GET_ORGANIZATION_BY_ID DEFAULT_GET_ORGANIZATION_USERS DEFAULT_GET_USER_ORGANIZATIONS DEFAULT_GET_USER_ORGANIZATION_ROLE DEFAULT_IS_USER_IN_ORGANIZATION DEFAULT_PATCH_ORGANIZATION

Organization

addOrUpdateUsers createOrganization getOrganizationById getOrganizationUsers getOrganizations getUserOrganizationRole getUserOrganizations isUserInOrganization updateOrganizationReviewStats

Constructors

constructor

Properties

Private addOrUpdateUsersPath

addOrUpdateUsersPath: string

Private createOrganizationPath

createOrganizationPath: string

getAttachmentByIds

getAttachmentByIds: ((idList, requestContext?) => Promise<(null | AttachmentResponse)[]>)

Type declaration

    • (idList, requestContext?): Promise<(null | AttachmentResponse)[]>

    • Parameters

      Returns Promise<(null | AttachmentResponse)[]>

Private getAttachmentsPath

getAttachmentsPath: string

Private getOneOrganizationAttachmentPath

getOneOrganizationAttachmentPath: string

Private getOrganizationAttachmentsPath

getOrganizationAttachmentsPath: string

Private getOrganizationByIdPath

getOrganizationByIdPath: string

Private getOrganizationUsersPath

getOrganizationUsersPath: string

Private getOrganizationsPath

getOrganizationsPath: string

Private getUserOrganizationRolePath

getUserOrganizationRolePath: string

Private getUserOrganizationsPath

getUserOrganizationsPath: string

Private internalToken

internalToken: string

Private isUserInOrganizationPath

isUserInOrganizationPath: string

Private organizationServiceEndpoint

organizationServiceEndpoint: string

Private patchOrganizationPath

patchOrganizationPath: string

Static Private Readonly DEFAULT_ADD_OR_UPDATE_USERS

DEFAULT_ADD_OR_UPDATE_USERS: "/organizations/:orgId/users" = '/organizations/:orgId/users'

Static Private Readonly DEFAULT_CREATE_ORGANIZATION

DEFAULT_CREATE_ORGANIZATION: "/organizations" = '/organizations'

Static Private Readonly DEFAULT_GET_ATTACHMENTS

DEFAULT_GET_ATTACHMENTS: "/attachments" = '/attachments'

Static Private Readonly DEFAULT_GET_ONE_ORGANIZATION_ATTACHMENT

DEFAULT_GET_ONE_ORGANIZATION_ATTACHMENT: "/organizations/:orgId/attachments/:attachmentId" = '/organizations/:orgId/attachments/:attachmentId'

Static Private Readonly DEFAULT_GET_ORGANIZATIONS

DEFAULT_GET_ORGANIZATIONS: "/organizations" = '/organizations'

Static Private Readonly DEFAULT_GET_ORGANIZATION_ATTACHMENTS

DEFAULT_GET_ORGANIZATION_ATTACHMENTS: "/organizations/:orgId/attachments" = '/organizations/:orgId/attachments'

Static Private Readonly DEFAULT_GET_ORGANIZATION_BY_ID

DEFAULT_GET_ORGANIZATION_BY_ID: "/organizations/:orgId" = '/organizations/:orgId'

Static Private Readonly DEFAULT_GET_ORGANIZATION_USERS

DEFAULT_GET_ORGANIZATION_USERS: "/organizations/:orgId/users" = '/organizations/:orgId/users'

Static Private Readonly DEFAULT_GET_USER_ORGANIZATIONS

DEFAULT_GET_USER_ORGANIZATIONS: "/users/:userId/organizations" = '/users/:userId/organizations'

Static Private Readonly DEFAULT_GET_USER_ORGANIZATION_ROLE

DEFAULT_GET_USER_ORGANIZATION_ROLE: "/organizations/:orgId/users/:userId/role" = '/organizations/:orgId/users/:userId/role'

Static Private Readonly DEFAULT_IS_USER_IN_ORGANIZATION

DEFAULT_IS_USER_IN_ORGANIZATION: "/organizations/:orgId/users:exists?userId=:userId" = '/organizations/:orgId/users:exists?userId=:userId'

Static Private Readonly DEFAULT_PATCH_ORGANIZATION

DEFAULT_PATCH_ORGANIZATION: "/organizations/:orgId" = '/organizations/:orgId'

Organization

addOrUpdateUsers

createOrganization

getOrganizationById

getOrganizationUsers

getOrganizations

getUserOrganizationRole

  • getUserOrganizationRole(args, requestContext?): Promise<{
        role: string;
    }>

  • API for getting role of a user in an organization.

    Parameters

    • args: {
          orgId: string;
          userId: string;
      }

      Input containing parameters for fetching organizations.

      • orgId: string
      • userId: string
    • Optional requestContext: RequestContext

      request context (requestId, serviceHistory)

    Returns Promise<{
        role: string;
    }>

    Object containing the role of the user in the organization.

    Description

    This API is used to get the role a user has in an organization.

getUserOrganizations

isUserInOrganization

  • isUserInOrganization(args, requestContext?): Promise<{
        isUserInOrg: boolean;
    }>

  • API for checking if a user belongs to an organization

    Parameters

    • args: {
          orgId: string;
          userId: string;
      }

      Input containing properties for checking if a user belongs to an organization.

      • orgId: string
      • userId: string
    • Optional requestContext: RequestContext

      request context (requestId, serviceHistory)

    Returns Promise<{
        isUserInOrg: boolean;
    }>

    Object containing the boolean result of the check.

    Description

    This API is used to check if a user belongs to an organization.

updateOrganizationReviewStats

  • updateOrganizationReviewStats(args, requestContext?): Promise<undefined | Organization>

  • API for updating review statistics for a single organization

    Parameters

    • args: {
          orgId: string;
          reviewStats: {
              averageRate?: number;
              averageSubRates?: Record<string, number>;
              totalCount?: number;
          };
      }

      Input containing properties for updating statistics.

      • orgId: string
      • reviewStats: {
            averageRate?: number;
            averageSubRates?: Record<string, number>;
            totalCount?: number;
        }
        • Optional averageRate?: number
        • Optional averageSubRates?: Record<string, number>
        • Optional totalCount?: number
    • Optional requestContext: RequestContext

    Returns Promise<undefined | Organization>

    Organization data that was updated.

    Description

    This API is used to update review statistics for a single org in the Organization service.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc