Class DeliveryConfigurations

Hierarchy

DeliveryConfigurations

Index

Properties

impersonating

Methods

As Create Delete Get List Patch Save

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TDeliveryConfig>(deliveryConfig: DeliveryConfig, requestOptions?: RequestOptions): Promise<RequiredDeep<TDeliveryConfig>>
Create a new delivery configuration. 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
- TDeliveryConfig extends DeliveryConfig
Parameters
- deliveryConfig: DeliveryConfig
  
  Required fields: Name, DeliveryTargets
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TDeliveryConfig>>
- Defined in api/DeliveryConfigurations.ts:63

Delete

Delete(deliveryConfigID: string, requestOptions?: RequestOptions): Promise<void>
Delete a delivery configuration. Check out the docs for more info
Parameters
- deliveryConfigID: string
  
  ID of the delivery config.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/DeliveryConfigurations.ts:127

Get

Get<TDeliveryConfig>(deliveryConfigID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TDeliveryConfig>>
Get a single delivery configuration. Check out the docs for more info
Type Parameters
- TDeliveryConfig extends DeliveryConfig
Parameters
- deliveryConfigID: string
  
  ID of the delivery config.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TDeliveryConfig>>
- Defined in api/DeliveryConfigurations.ts:84

List

List<TDeliveryConfig>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name")[];
    sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TDeliveryConfig>>>
Get a list of delivery configurations. Check out the docs for more info
Type Parameters
- TDeliveryConfig extends DeliveryConfig
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      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")[]
    
    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<TDeliveryConfig>>>
- Defined in api/DeliveryConfigurations.ts:42

Patch

Patch<TDeliveryConfig>(deliveryConfigID: string, deliveryConfig: PartialObjectDeep<DeliveryConfig>, requestOptions?: RequestOptions): Promise<RequiredDeep<TDeliveryConfig>>
Partially update a delivery configuration. Check out the docs for more info
Type Parameters
- TDeliveryConfig extends DeliveryConfig
Parameters
- deliveryConfigID: string
  
  ID of the delivery config. Required.
- deliveryConfig: PartialObjectDeep<DeliveryConfig>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TDeliveryConfig>>
- Defined in api/DeliveryConfigurations.ts:149

Save

Save<TDeliveryConfig>(deliveryConfigID: string, deliveryConfig: DeliveryConfig, requestOptions?: RequestOptions): Promise<RequiredDeep<TDeliveryConfig>>
Create or update a delivery configuration. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TDeliveryConfig extends DeliveryConfig
Parameters
- deliveryConfigID: string
  
  ID of the delivery config.
- deliveryConfig: DeliveryConfig
  
  Required fields: Name, DeliveryTargets
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TDeliveryConfig>>
- Defined in api/DeliveryConfigurations.ts:106

Class DeliveryConfigurations

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns DeliveryConfigurations

Create

Type Parameters

TDeliveryConfig extends DeliveryConfig

Parameters

deliveryConfig: DeliveryConfig

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TDeliveryConfig>>

Delete

Parameters

deliveryConfigID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TDeliveryConfig extends DeliveryConfig

Parameters

deliveryConfigID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TDeliveryConfig>>

List

Type Parameters

TDeliveryConfig extends DeliveryConfig

Parameters

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

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

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

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

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TDeliveryConfig>>>

Patch

Type Parameters

TDeliveryConfig extends DeliveryConfig

Parameters

deliveryConfigID: string

deliveryConfig: PartialObjectDeep<DeliveryConfig>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TDeliveryConfig>>

Save

Type Parameters

TDeliveryConfig extends DeliveryConfig

Parameters

deliveryConfigID: string

deliveryConfig: DeliveryConfig

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TDeliveryConfig>>

Settings

Member Visibility

Theme

`Private` impersonating

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

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

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

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