Class UserGroups

Hierarchy

UserGroups

Index

Properties

impersonating

Methods

As Create Delete DeleteUserAssignment Get List ListUserAssignments Patch Save SaveUserAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TUserGroup>(buyerID: string, userGroup: UserGroup<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TUserGroup>>
Create a new user group. 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
- TUserGroup extends UserGroup<any, TUserGroup>
Parameters
- buyerID: string
  
  ID of the buyer.
- userGroup: UserGroup<any>
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUserGroup>>
- Defined in api/UserGroups.ts:69

Delete

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

DeleteUserAssignment

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

Get

Get<TUserGroup>(buyerID: string, userGroupID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TUserGroup>>
Get a single user group. Check out the docs for more info
Type Parameters
- TUserGroup extends UserGroup<any, TUserGroup>
Parameters
- buyerID: string
  
  ID of the buyer.
- userGroupID: string
  
  ID of the user group.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUserGroup>>
- Defined in api/UserGroups.ts:91

List

List<TUserGroup>(buyerID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name" | "Description")[];
    sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TUserGroup>>>
Get a list of user groups. Check out the docs for more info
Type Parameters
- TUserGroup extends UserGroup<any, TUserGroup>
Parameters
- buyerID: string
  
  ID of the buyer.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - 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" | "Name" | "Description")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TUserGroup>>>
- Defined in api/UserGroups.ts:47

ListUserAssignments

ListUserAssignments<TUserGroupAssignment>(buyerID: string, listOptions?: {
    page?: number;
    pageSize?: number;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TUserGroupAssignment>>>
Get a list of user group user assignments. Check out the docs for more info
Type Parameters
- TUserGroupAssignment extends UserGroupAssignment
Parameters
- buyerID: string
  
  ID of the buyer.
- listOptions: {
      page?: number;
      pageSize?: number;
      userGroupID?: string;
      userID?: string;
  } = {}
  - 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 userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TUserGroupAssignment>>>
- Defined in api/UserGroups.ts:207

Patch

Patch<TUserGroup>(buyerID: string, userGroupID: string, userGroup: PartialObjectDeep<UserGroup<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TUserGroup>>
Partially update a user group. Check out the docs for more info
Type Parameters
- TUserGroup extends UserGroup<any, TUserGroup>
Parameters
- buyerID: string
  
  ID of the buyer.
- userGroupID: string
  
  ID of the user group.
- userGroup: PartialObjectDeep<UserGroup<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUserGroup>>
- Defined in api/UserGroups.ts:159

Save

Save<TUserGroup>(buyerID: string, userGroupID: string, userGroup: UserGroup<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TUserGroup>>
Create or update a user group. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TUserGroup extends UserGroup<any, TUserGroup>
Parameters
- buyerID: string
  
  ID of the buyer.
- userGroupID: string
  
  ID of the user group.
- userGroup: UserGroup<any>
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TUserGroup>>
- Defined in api/UserGroups.ts:114

SaveUserAssignment

SaveUserAssignment(buyerID: string, userGroupAssignment: UserGroupAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a user group user assignment. Check out the docs for more info
Parameters
- buyerID: string
  
  ID of the buyer.
- userGroupAssignment: UserGroupAssignment
  
  Required fields: UserGroupID, UserID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/UserGroups.ts:229

Class UserGroups

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns UserGroups

Create

Type Parameters

TUserGroup extends UserGroup<any, TUserGroup>

Parameters

buyerID: string

userGroup: UserGroup<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TUserGroup>>

Delete

Parameters

buyerID: string

userGroupID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteUserAssignment

Parameters

buyerID: string

userGroupID: string

userID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TUserGroup extends UserGroup<any, TUserGroup>

Parameters

buyerID: string

userGroupID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TUserGroup>>

List

Type Parameters

TUserGroup extends UserGroup<any, TUserGroup>

Parameters

buyerID: string

listOptions: { filters?: Filters; page?: number; pageSize?: number; search?: string; searchOn?: ("ID" | "Name" | "Description")[]; sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]; } = {}

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "Name" | "Description")[]

Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TUserGroup>>>

ListUserAssignments

Type Parameters

TUserGroupAssignment extends UserGroupAssignment

Parameters

buyerID: string

listOptions: { page?: number; pageSize?: number; userGroupID?: string; userID?: string; } = {}

Optional page?: number

Optional pageSize?: number

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TUserGroupAssignment>>>

Patch

Type Parameters

TUserGroup extends UserGroup<any, TUserGroup>

Parameters

buyerID: string

userGroupID: string

userGroup: PartialObjectDeep<UserGroup<any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TUserGroup>>

Save

Type Parameters

TUserGroup extends UserGroup<any, TUserGroup>

Parameters

`Private` impersonating

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "Name" | "Description")[];
sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
} = {}

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "Name" | "Description")[]

`Optional` sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

listOptions: {
page?: number;
pageSize?: number;
userGroupID?: string;
userID?: string;
} = {}

`Optional` page?: number

`Optional` pageSize?: number

`Optional` userGroupID?: string

`Optional` userID?: string