Class Users

Hierarchy

Users

Index

Properties

impersonating

Methods

As Create Delete Get GetAccessToken List ListAcrossBuyers Move Patch RevokeUserTokens Save UnlockUserAccount

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): Users
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
Users.As().List() // lists Users using the impersonated users' token
```
Returns Users
- Defined in api/Users.ts:300

Create

Create<TUser>(buyerID: string, user: User<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TUser>>
Create a new user. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- buyerID: string
  
  ID of the buyer.
- user: User<any>
  
  Required fields: Username, FirstName, LastName, Email, Active
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUser>>
- Defined in api/Users.ts:74

Delete

Delete(buyerID: string, userID: string, requestOptions?: RequestOptions): Promise<void>
Delete a user. Check out the docs for more info
Parameters
- buyerID: string
  
  ID of the buyer.
- userID: string
  
  ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Users.ts:141

Get

Get<TUser>(buyerID: string, userID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TUser>>
Get a single user. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- buyerID: string
  
  ID of the buyer.
- userID: string
  
  ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUser>>
- Defined in api/Users.ts:96

GetAccessToken

GetAccessToken<TAccessToken>(buyerID: string, userID: string, impersonateTokenRequest: ImpersonateTokenRequest, requestOptions?: RequestOptions): Promise<RequiredDeep<TAccessToken>>
Get a single user access token. Check out the docs for more info
Type Parameters
- TAccessToken extends AccessToken
Parameters
- buyerID: string
  
  ID of the buyer.
- userID: string
  
  ID of the user.
- impersonateTokenRequest: ImpersonateTokenRequest
  
  Required fields: ClientID, Roles
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TAccessToken>>
- Defined in api/Users.ts:187

List

List<TUser>(buyerID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[];
    sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "LastActive" | "PasswordLastSetDate" | "!Username" | "!Email" | "!LastActive" | "!PasswordLastSetDate")[];
    userGroupID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TUser>>>
Get a list of users. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- buyerID: string
  
  ID of the buyer.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[];
      sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "LastActive" | "PasswordLastSetDate" | "!Username" | "!Email" | "!LastActive" | "!PasswordLastSetDate")[];
      userGroupID?: string;
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "LastActive" | "PasswordLastSetDate" | "!Username" | "!Email" | "!LastActive" | "!PasswordLastSetDate")[]
    
    Comma-delimited list of fields to sort by.
  - Optional userGroupID?: string
    
    ID of the user group.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TUser>>>
- Defined in api/Users.ts:52

ListAcrossBuyers

ListAcrossBuyers<TUser>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[];
    sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "LastActive" | "PasswordLastSetDate" | "!Username" | "!Email" | "!LastActive" | "!PasswordLastSetDate")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TUser>>>
Get a list of user across buyers. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[];
      sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "LastActive" | "PasswordLastSetDate" | "!Username" | "!Email" | "!LastActive" | "!PasswordLastSetDate")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "LastActive" | "PasswordLastSetDate" | "!Username" | "!Email" | "!LastActive" | "!PasswordLastSetDate")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TUser>>>
- Defined in api/Users.ts:281

Move

Move<TUser>(buyerID: string, userID: string, newBuyerID: string, listOptions?: {
orders?: UserOrderMoveOption;
}, requestOptions?: RequestOptions): Promise<RequiredDeep<TUser>>
Move a user to a different buyer. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- buyerID: string
  
  ID of the buyer.
- userID: string
  
  ID of the user.
- newBuyerID: string
  
  ID of the new buyer.
- listOptions: {
  orders?: UserOrderMoveOption;
  } = {}
  - Optional orders?: UserOrderMoveOption
    
    Orders of the user. Possible values: None, Unsubmitted, All.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUser>>
- Defined in api/Users.ts:211

Patch

Patch<TUser>(buyerID: string, userID: string, user: PartialObjectDeep<User<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TUser>>
Partially update a user. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- buyerID: string
  
  ID of the buyer.
- userID: string
  
  ID of the user.
- user: PartialObjectDeep<User<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUser>>
- Defined in api/Users.ts:164

RevokeUserTokens

RevokeUserTokens(buyerID: string, userID: string, requestOptions?: RequestOptions): Promise<void>
Revoke a user tokens. Revokes all security tokens of specified buyer user. Check out the docs for more info
Parameters
- buyerID: string
  
  ID of the buyer.
- userID: string
  
  ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Users.ts:233

Save

Save<TUser>(buyerID: string, userID: string, user: User<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TUser>>
Create or update a user. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- buyerID: string
  
  ID of the buyer.
- userID: string
  
  ID of the user.
- user: User<any>
  
  Required fields: Username, FirstName, LastName, Email, Active
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUser>>
- Defined in api/Users.ts:119

UnlockUserAccount

UnlockUserAccount(buyerID: string, userID: string, requestOptions?: RequestOptions): Promise<void>
Unlock a user account. Check out the docs for more info
Parameters
- buyerID: string
  
  ID of the buyer.
- userID: string
  
  ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Users.ts:255

Class Users

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns Users

Create

Type Parameters

TUser extends User<any, TUser>

Parameters

buyerID: string

user: User<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TUser>>

Delete

Parameters

buyerID: string

userID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TUser extends User<any, TUser>

Parameters

buyerID: string

userID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TUser>>

GetAccessToken

Type Parameters

TAccessToken extends AccessToken

Parameters

buyerID: string

userID: string

impersonateTokenRequest: ImpersonateTokenRequest

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TAccessToken>>

List

Type Parameters

TUser extends User<any, TUser>

Parameters

buyerID: string

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]

Optional sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "LastActive" | "PasswordLastSetDate" | "!Username" | "!Email" | "!LastActive" | "!PasswordLastSetDate")[]

Optional userGroupID?: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TUser>>>

ListAcrossBuyers

Type Parameters

TUser extends User<any, TUser>

Parameters

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]

Optional sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "LastActive" | "PasswordLastSetDate" | "!Username" | "!Email" | "!LastActive" | "!PasswordLastSetDate")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TUser>>>

Move

Type Parameters

TUser extends User<any, TUser>

Parameters

buyerID: string

userID: string

newBuyerID: string

listOptions: { orders?: UserOrderMoveOption; } = {}

Optional orders?: UserOrderMoveOption

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TUser>>

`Private` impersonating

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]

`Optional` sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "LastActive" | "PasswordLastSetDate" | "!Username" | "!Email" | "!LastActive" | "!PasswordLastSetDate")[]

`Optional` userGroupID?: string

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]

`Optional` sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "LastActive" | "PasswordLastSetDate" | "!Username" | "!Email" | "!LastActive" | "!PasswordLastSetDate")[]

listOptions: {
orders?: UserOrderMoveOption;
} = {}

`Optional` orders?: UserOrderMoveOption