Class Registration

constructor

• new Registration(api: Api): Registration

  Parameters

  • api: Api

  Returns Registration

api

deleteProfilePicture

• deleteProfilePicture(): Promise<ApiResponse<void, void>>

  Deletes the current user's profile pictures

  Returns Promise<ApiResponse<void, void>>

  Promise resolving when profile pictures are successfully deleted

  Example

  await registration.deleteProfilePicture()
  console.log('Profile pictures deleted')
  Copy

getMyProfile

• getMyProfile(argOptions?: ProfileOptions): Promise<ProfileDataExtended>

  Parameters

  • OptionalargOptions: ProfileOptions

  Returns Promise<ProfileDataExtended>

getProfilePicture

• getProfilePicture(
      uid: string,
      size?: ProfilePictureSize,
  ): Promise<ApiResponse<ProfilePictureResponse, ProfilePictureResponse>>

  Retrieves a profile picture for a specific user and size

  Parameters

  • uid: string

    User ID whose profile picture to retrieve
  • size: ProfilePictureSize = 'medium'

    Image size variant (thumb, medium, large)

  Returns Promise<ApiResponse<ProfilePictureResponse, ProfilePictureResponse>>

  Promise resolving to profile picture response with signed URL

  Example

  // Get medium size profile picture for user
  const result = await registration.getProfilePicture('user123', 'medium')
  console.log('Image URL:', result.url)
  
  // Get thumbnail for current user
  const result = await registration.getProfilePicture('current', 'thumb')
  Copy

register

• register(
      data?: RegisterFormData,
  ): Promise<ApiResponse<{ message: string }, { message: string }>>

  Parameters

  • Optionaldata: RegisterFormData

  Returns Promise<ApiResponse<{ message: string }, { message: string }>>

requestRegisterWithConfiguration

• requestRegisterWithConfiguration(
      configurationHash: string,
      email: string,
  ): Promise<ApiResponse<{ message: string }, { message: string }>>

  Parameters

  • configurationHash: string
  • email: string

  Returns Promise<ApiResponse<{ message: string }, { message: string }>>

uploadProfilePicture

• uploadProfilePicture(
      file:
          | string
          | Blob
          | ArrayBuffer
          | Uint8Array<ArrayBufferLike>
          | Buffer<ArrayBufferLike>,
      contentType?: string,
  ): Promise<
      ApiResponse<ProfilePictureUploadResponse, ProfilePictureUploadResponse>,
  >

  Uploads a profile picture for the current user by sending RAW binary image data. API Gateway will base64-encode it and set isBase64Encoded for the Lambda handler.

  Accepts Blobs/Buffers/ArrayBuffers/Uint8Arrays or Data URLs/base64 strings.

  Size limit: <= 3.5MB (decoded/binary).

  Parameters

  • file:
        | string
        | Blob
        | ArrayBuffer
        | Uint8Array<ArrayBufferLike>
        | Buffer<ArrayBufferLike>
  • OptionalcontentType: string

  Returns Promise<ApiResponse<ProfilePictureUploadResponse, ProfilePictureUploadResponse>>

verify

• verify(
      hash: string,
      data?: SelfRegisterFormData,
  ): Promise<ApiResponse<{ message: string }, { message: string }>>

  Parameters

  • hash: string
  • Optionaldata: SelfRegisterFormData

  Returns Promise<ApiResponse<{ message: string }, { message: string }>>

verifyMail

• verifyMail(code: string): Promise<ApiResponse<void, void>>

  Parameters

  • code: string

  Returns Promise<ApiResponse<void, void>>