Interface UserDefaultAdapterAPI

Interface for User's Default Adapter's API

Description

This interface is used to define the API for User's Default Adapter. Implement this interface to create a custom API for communicating with User functionality.

interface UserDefaultAdapterAPI {
    checkUserPassword(args, requestContext?): Promise<{
        id: string;
        valid: true;
    } | {
        valid: false;
    }>;
    createInvitation(invitation, requestContext?): Promise<undefined | InvitationResponse>;
    createUser(user, requestContext?): Promise<UserResponse>;
    createUserForAdmin(user, requestContext?): Promise<UserResponse>;
    getAttachmentByIds(idList, requestContext?): Promise<(null | AttachmentResponse)[]>;
    getUserById(userId, requestContext?): Promise<undefined | UserResponse>;
    getUsers(args, requestContext?): Promise<PaginatedQueryResult<UserResponse>>;
    isAdminUser(userId, requestContext?): Promise<boolean>;
    isUserEmailVerified(userId, requestContext?): Promise<boolean>;
    updateUserReviewStats(args, requestContext?): Promise<undefined | UserResponse>;
}

Implemented by

User

checkUserPassword createInvitation createUser createUserForAdmin getAttachmentByIds getUserById getUsers isAdminUser isUserEmailVerified updateUserReviewStats

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

  • createInvitation(invitation, requestContext?): Promise<undefined | InvitationResponse>

  • API for creating an invitation for a user

    Parameters

    Returns Promise<undefined | InvitationResponse>

    Invitation data that was updated.

    Description

    This API is used to create an invitation to a user.

createUser

  • createUser(user, requestContext?): Promise<UserResponse>

  • API for creating a single user

    Parameters

    Returns Promise<UserResponse>

    User data that was created.

    Description

    This API is used to create a single user in the User service.

createUserForAdmin

  • createUserForAdmin(user, requestContext?): Promise<UserResponse>

  • API for creating a user as an admin

    Parameters

    Returns Promise<UserResponse>

    User data that was created.

    Description

    This API is used to create a single user in the User service. This API skips the email verification process.

getAttachmentByIds

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

  • API for getting multiple user attachments

    Parameters

    • idList: string[]

      List of user attachment IDs to be fetched.

    • Optional requestContext: RequestContext

      request context (requestId, serviceHistory)

    Returns Promise<(null | AttachmentResponse)[]>

    User attachments array that fetched if the id is not exist return null.

    Description

    This API is used to get multiple user attachments from the User service. It will return array exactly the same length as the idList, if the id is not exist return null instead in for the specific attachment.

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.

      • queryOptions: PaginatedListQueryOptions

        Query options for getting multiple users.

    • 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;
        }

        Review statistics body.

        • Optional averageRate?: number
        • Optional averageSubRates?: Record<string, number>
        • Optional totalCount?: number
      • userId: string

        User ID of the user to be updated.

    • 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