Class AdminClient

Index

Constructors

Methods

addAllowedOrigins deactivateProfile getProfile listAllowedOrigins listProfiles removeAllowedOrigins setAllowedOrigins updateProfile

Constructors

constructor

new AdminClient(config: AdminConfig): AdminClient
Parameters
- config: AdminConfig
Returns AdminClient
- Defined in admin.ts:27

Methods

addAllowedOrigins

addAllowedOrigins(
orgId: string,
origins: string[],
): Promise<AllowedOriginsResponse>
Add origin(s) to the allowed list for an organization.
Parameters
- orgId: string
  Organization ID
- origins: string[]
  Origins to add
Returns Promise<AllowedOriginsResponse>
- Defined in admin.ts:218

deactivateProfile

deactivateProfile(
profileId: string,
brandOrgId?: string,
): Promise<{ message: string; profile: UserProfile }>
Deactivate (soft-delete) a user profile.
Parameters
- profileId: string
  Profile ID
- OptionalbrandOrgId: string
  Organization ID. If omitted, defaults to the org associated with the API key.
Returns Promise<{ message: string; profile: UserProfile }>
- Defined in admin.ts:170

getProfile

getProfile(profileId: string, brandOrgId?: string): Promise<UserProfile>
Get a single user profile by ID.
Parameters
- profileId: string
  Profile ID
- OptionalbrandOrgId: string
  Organization ID. If omitted, defaults to the org associated with the API key.
Returns Promise<UserProfile>
- Defined in admin.ts:132

listAllowedOrigins

listAllowedOrigins(orgId: string): Promise<AllowedOriginsResponse>
List allowed origins for an organization.
Parameters
- orgId: string
  Organization ID
Returns Promise<AllowedOriginsResponse>
- Defined in admin.ts:191

listProfiles

listProfiles(
brandOrgId?: string,
options?: ListProfilesOptions,
): Promise<PaginatedResponse<UserProfile>>
List user profiles for an organization.
Parameters
- OptionalbrandOrgId: string
  Organization ID. If omitted, defaults to the org associated with the API key.
- options: ListProfilesOptions = {}
Returns Promise<PaginatedResponse<UserProfile>>
- Defined in admin.ts:109

removeAllowedOrigins

removeAllowedOrigins(
orgId: string,
origins: string[],
): Promise<AllowedOriginsResponse>
Remove origin(s) from the allowed list for an organization.
Parameters
- orgId: string
  Organization ID
- origins: string[]
  Origins to remove
Returns Promise<AllowedOriginsResponse>
- Defined in admin.ts:232

setAllowedOrigins

setAllowedOrigins(
orgId: string,
origins: string[],
): Promise<AllowedOriginsResponse>
Replace all allowed origins for an organization.
Parameters
- orgId: string
  Organization ID
- origins: string[]
  Complete list of allowed origins (replaces existing)
Returns Promise<AllowedOriginsResponse>
- Defined in admin.ts:204

updateProfile

updateProfile(
    profileId: string,
    updates: UpdateProfileData,
    brandOrgId?: string,
): Promise<UserProfile>
Update a user profile's core fields.
Parameters
- profileId: string
  Profile ID
- updates: UpdateProfileData
  Fields to update
- OptionalbrandOrgId: string
  Organization ID. If omitted, defaults to the org associated with the API key.
Returns Promise<UserProfile>
- Defined in admin.ts:149