Class UserDefaultAdapterRestSdk

Default Adapter for User

Description

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

Implements

Constructors

constructor

Properties

checkUserPasswordPath createInvitationPath createUserForAdminPath createUserPath getAttachmentByIds getAttachmentsPath getOneUserPath getUsersPath internalToken patchUserPath userServiceEndpoint DEFAULT_CHECK_USER_PASSWORD_PATH DEFAULT_CREATE_INVITATION_PATH DEFAULT_CREATE_USER_FOR_ADMIN_PATH DEFAULT_CREATE_USER_PATH DEFAULT_GET_ATTACHMENTS_PATH DEFAULT_GET_ONE_USER_PATH DEFAULT_GET_USERS_PATH DEFAULT_PATCH_USERS_PATH

User

checkUserPassword createInvitation createUser createUserForAdmin getUserById getUsers isAdminUser isUserEmailVerified updateUserReviewStats

Constructors

constructor

Properties

Private checkUserPasswordPath

checkUserPasswordPath: string

Private createInvitationPath

createInvitationPath: string

Private createUserForAdminPath

createUserForAdminPath: string

Private createUserPath

createUserPath: 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 getOneUserPath

getOneUserPath: string

Private getUsersPath

getUsersPath: string

Private internalToken

internalToken: string

Private patchUserPath

patchUserPath: string

Private userServiceEndpoint

userServiceEndpoint: string

Static Private Readonly DEFAULT_CHECK_USER_PASSWORD_PATH

DEFAULT_CHECK_USER_PASSWORD_PATH: "/users/check_password" = '/users/check_password'

Static Private Readonly DEFAULT_CREATE_INVITATION_PATH

DEFAULT_CREATE_INVITATION_PATH: "/invitations" = '/invitations'

Static Private Readonly DEFAULT_CREATE_USER_FOR_ADMIN_PATH

DEFAULT_CREATE_USER_FOR_ADMIN_PATH: "/admin/users" = '/admin/users'

Static Private Readonly DEFAULT_CREATE_USER_PATH

DEFAULT_CREATE_USER_PATH: "/users" = '/users'

Static Private Readonly DEFAULT_GET_ATTACHMENTS_PATH

DEFAULT_GET_ATTACHMENTS_PATH: "/attachments" = '/attachments'

Static Private Readonly DEFAULT_GET_ONE_USER_PATH

DEFAULT_GET_ONE_USER_PATH: "/users/:userId" = '/users/:userId'

Static Private Readonly DEFAULT_GET_USERS_PATH

DEFAULT_GET_USERS_PATH: "/users" = '/users'

Static Private Readonly DEFAULT_PATCH_USERS_PATH

DEFAULT_PATCH_USERS_PATH: "/users/:userId" = '/users/:userId'

User

checkUserPassword

  • checkUserPassword(args, requestContext?): Promise<{
        id: string;
        valid: true;
    } | {
        valid: false;
    }>

  • API for checking user's password

    Parameters

    Returns Promise<{
        id: string;
        valid: true;
    } | {
        valid: false;
    }>

    Promise<{ valid: true; id: string } | { valid: false }> if valid, return valid: true and userId, if not valid return false

    Description

    This API is used to check if user's password is valid.

createInvitation

createUser

createUserForAdmin

getUserById

  • getUserById(userId, requestContext?): Promise<undefined | UserResponse>

  • API for getting a single user

    Parameters

    • userId: string

      User ID of the user to be fetched.

    • Optional requestContext: RequestContext

      request context (requestId, serviceHistory)

    Returns Promise<undefined | UserResponse>

    User data that was fetched.

    Description

    This API is used to get a single user from the User service.

getUsers

  • getUsers(args, requestContext?): Promise<PaginatedQueryResult<UserResponse>>

  • API for getting multiple users

    Parameters

    • args: {
          queryOptions?: PaginatedListQueryOptions;
      }

      Input containing property for getting multiple users.

      • Optional queryOptions?: PaginatedListQueryOptions
    • Optional requestContext: RequestContext

      request context (requestId, serviceHistory)

    Returns Promise<PaginatedQueryResult<UserResponse>>

    User data that was fetched.

    Description

    This API is used to get multiple users from the User service.

isAdminUser

  • isAdminUser(userId, requestContext?): Promise<boolean>

  • API for checking if user is an admin user

    Parameters

    • userId: string

      User ID of the user to be checked.

    • Optional requestContext: RequestContext

      request context (requestId, serviceHistory)

    Returns Promise<boolean>

    Promise if user is admin user, return true, if not return false

    Description

    This API is used to check if user is an admin user

isUserEmailVerified

  • isUserEmailVerified(userId, requestContext?): Promise<boolean>

  • API for checking if user's email has been verified

    Parameters

    • userId: string

      User ID of the user to be checked.

    • Optional requestContext: RequestContext

      request context (requestId, serviceHistory)

    Returns Promise<boolean>

    Promise if user's email has been verified, return true, if not return false

    Description

    This API is used to check if user's email has been verified

updateUserReviewStats

  • updateUserReviewStats(args, requestContext?): Promise<undefined | UserResponse>

  • API for updating review statistics for a single user

    Parameters

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

      Input containing properties for updating statistics.

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

    Returns Promise<undefined | UserResponse>

    Order data that was updated.

    Description

    This API is used to update review statistics for a single user in the User service.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc