Class Subscriptions

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
```
Subscriptions.As().List() // lists Subscriptions using the impersonated users' token
```
- Defined in api/Subscriptions.ts:168

Create

Create<TSubscription extends Subscription<any>>(
subscription: Subscription,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSubscription>>
Create a subscription Check out the docs for more info
Type Parameters
- TSubscription extends Subscription<any>
Parameters
- subscription: Subscription
  Required fields: Frequency, Interval, NextOrderDate
- 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<TSubscription>>
- Defined in api/Subscriptions.ts:63

Delete

Delete(subscriptionID: string, requestOptions?: RequestOptions): Promise<void>
Delete a subscription Check out the docs for more info
Parameters
- subscriptionID: string
  ID of the subscription.
- 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/Subscriptions.ts:127

Get

Get<TSubscription extends Subscription<any>>(
subscriptionID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSubscription>>
Retrieve a subscription Check out the docs for more info
Type Parameters
- TSubscription extends Subscription<any>
Parameters
- subscriptionID: string
  ID of the subscription.
- 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<TSubscription>>
- Defined in api/Subscriptions.ts:84

List

List<TSubscription extends Subscription<any>>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval")[];
        sortBy?: (
            | "ID"
            | "FromCompanyID"
            | "ToCompanyID"
            | "Interval"
            | "DateCreated"
            | "!ID"
            | "!DateCreated"
            | "FromUserID"
            | "!FromCompanyID"
            | "!ToCompanyID"
            | "!FromUserID"
            | "NextOrderDate"
            | "LastOrderDate"
            | "EndDate"
            | "!Interval"
            | "!NextOrderDate"
            | "!LastOrderDate"
            | "!EndDate"
        )[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TSubscription>>>
List subscriptions Check out the docs for more info
Type Parameters
- TSubscription extends Subscription<any>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval")[];
      sortBy?: (
          | "ID"
          | "FromCompanyID"
          | "ToCompanyID"
          | "Interval"
          | "DateCreated"
          | "!ID"
          | "!DateCreated"
          | "FromUserID"
          | "!FromCompanyID"
          | "!ToCompanyID"
          | "!FromUserID"
          | "NextOrderDate"
          | "LastOrderDate"
          | "EndDate"
          | "!Interval"
          | "!NextOrderDate"
          | "!LastOrderDate"
          | "!EndDate"
      )[];
  } = {}
  - 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" | "FromCompanyID" | "ToCompanyID" | "Interval")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: (
        | "ID"
        | "FromCompanyID"
        | "ToCompanyID"
        | "Interval"
        | "DateCreated"
        | "!ID"
        | "!DateCreated"
        | "FromUserID"
        | "!FromCompanyID"
        | "!ToCompanyID"
        | "!FromUserID"
        | "NextOrderDate"
        | "LastOrderDate"
        | "EndDate"
        | "!Interval"
        | "!NextOrderDate"
        | "!LastOrderDate"
        | "!EndDate"
    )[]
    
    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<TSubscription>>>
- Defined in api/Subscriptions.ts:42

Patch

Patch<TSubscription extends Subscription<any>>(
    subscriptionID: string,
    subscription: PartialDeep<Subscription>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSubscription>>
Partially update a subscription Check out the docs for more info
Type Parameters
- TSubscription extends Subscription<any>
Parameters
- subscriptionID: string
  ID of the subscription.
- subscription: PartialDeep<Subscription>
- 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<TSubscription>>
- Defined in api/Subscriptions.ts:149

Save

Save<TSubscription extends Subscription<any>>(
    subscriptionID: string,
    subscription: Subscription,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TSubscription>>
Create or update a subscription If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TSubscription extends Subscription<any>
Parameters
- subscriptionID: string
  ID of the subscription.
- subscription: Subscription
  Required fields: Frequency, Interval, NextOrderDate
- 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<TSubscription>>
- Defined in api/Subscriptions.ts:106

Class Subscriptions

Index

Methods

Methods

As

Returns this

Description

Example

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSubscription>>

Delete

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSubscription>>

List

Type Parameters

Parameters

Optionalfilters?: Filters

Optionalpage?: number

OptionalpageSize?: number

Optionalsearch?: string

OptionalsearchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval")[]

OptionalsortBy?: ( | "ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!Interval" | "!NextOrderDate" | "!LastOrderDate" | "!EndDate")[]

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredObjectDeep<ListPage<TSubscription>>>

Patch

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSubscription>>

Save

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TSubscription>>

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" | "FromCompanyID" | "ToCompanyID" | "Interval")[]

`Optional`sortBy?: (
| "ID"
| "FromCompanyID"
| "ToCompanyID"
| "Interval"
| "DateCreated"
| "!ID"
| "!DateCreated"
| "FromUserID"
| "!FromCompanyID"
| "!ToCompanyID"
| "!FromUserID"
| "NextOrderDate"
| "LastOrderDate"
| "EndDate"
| "!Interval"
| "!NextOrderDate"
| "!LastOrderDate"
| "!EndDate"
)[]

`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