Class BuyerGroups

Index

Methods

As Create Delete Get List Patch Save

Methods

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
BuyerGroups.As().List() // lists BuyerGroups using the impersonated users' token
```
- Defined in api/BuyerGroups.ts:168

Create

Create<TBuyerGroup extends BuyerGroup<any>>(
buyerGroup: BuyerGroup,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBuyerGroup>>
Create a buyer group Check out the docs for more info
Type Parameters
- TBuyerGroup extends BuyerGroup<any>
Parameters
- buyerGroup: BuyerGroup
  Required fields: Name
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBuyerGroup>>
- Defined in api/BuyerGroups.ts:63

Delete

Delete(buyerGroupID: string, requestOptions?: RequestOptions): Promise<void>
Delete a buyer group Check out the docs for more info
Parameters
- buyerGroupID: string
  ID of the buyer group.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/BuyerGroups.ts:127

Get

Get<TBuyerGroup extends BuyerGroup<any>>(
buyerGroupID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBuyerGroup>>
Retrieve a buyer group Check out the docs for more info
Type Parameters
- TBuyerGroup extends BuyerGroup<any>
Parameters
- buyerGroupID: string
  ID of the buyer group.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBuyerGroup>>
- Defined in api/BuyerGroups.ts:84

List

List<TBuyerGroup extends BuyerGroup<any>>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "Name" | "Description")[];
        sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TBuyerGroup>>>
List buyer groups Check out the docs for more info
Type Parameters
- TBuyerGroup extends BuyerGroup<any>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - Optionalfilters?: 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.???'
  - Optionalpage?: number
    
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "Name" | "Description")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TBuyerGroup>>>
- Defined in api/BuyerGroups.ts:42

Patch

Patch<TBuyerGroup extends BuyerGroup<any>>(
    buyerGroupID: string,
    buyerGroup: PartialDeep<BuyerGroup>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBuyerGroup>>
Partially update a buyer group Check out the docs for more info
Type Parameters
- TBuyerGroup extends BuyerGroup<any>
Parameters
- buyerGroupID: string
  ID of the buyer group.
- buyerGroup: PartialDeep<BuyerGroup>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBuyerGroup>>
- Defined in api/BuyerGroups.ts:149

Save

Save<TBuyerGroup extends BuyerGroup<any>>(
    buyerGroupID: string,
    buyerGroup: BuyerGroup,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TBuyerGroup>>
Create or update a buyer group If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TBuyerGroup extends BuyerGroup<any>
Parameters
- buyerGroupID: string
  ID of the buyer group.
- buyerGroup: BuyerGroup
  Required fields: Name
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TBuyerGroup>>
- Defined in api/BuyerGroups.ts:106

Class BuyerGroups

Index

Methods

Methods

As

Returns this

Description

Example

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TBuyerGroup>>

Delete

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TBuyerGroup>>

List

Type Parameters

Parameters

Optionalfilters?: Filters

Optionalpage?: number

OptionalpageSize?: number

Optionalsearch?: string

OptionalsearchOn?: ("ID" | "Name" | "Description")[]

OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredObjectDeep<ListPage<TBuyerGroup>>>

Patch

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TBuyerGroup>>

Save

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TBuyerGroup>>

Settings

On This Page

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`filters?: Filters

`Optional`page?: number

`Optional`pageSize?: number

`Optional`search?: string

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

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

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string