Class OrderSynchronization

Index

Methods

As Delete Get Patch Save

Methods

As

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

Delete

Delete(requestOptions?: RequestOptions): Promise<void>
Delete an order sync Check out the docs for more info
Parameters
- 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/OrderSynchronization.ts:71

Get

Get<TOrderSyncConfig extends OrderSyncConfig>(
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TOrderSyncConfig>>
Retrieve an order sync Check out the docs for more info
Type Parameters
- TOrderSyncConfig extends OrderSyncConfig
Parameters
- 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<TOrderSyncConfig>>
- Defined in api/OrderSynchronization.ts:30

Patch

Patch<TOrderSyncConfig extends OrderSyncConfig>(
orderSyncConfig: PartialDeep<OrderSyncConfig>,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TOrderSyncConfig>>
Partially update an order sync Check out the docs for more info
Type Parameters
- TOrderSyncConfig extends OrderSyncConfig
Parameters
- orderSyncConfig: PartialDeep<OrderSyncConfig>
- 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<TOrderSyncConfig>>
- Defined in api/OrderSynchronization.ts:92

Save

Save<TOrderSyncConfig extends OrderSyncConfig>(
orderSyncConfig: OrderSyncConfig,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TOrderSyncConfig>>
Create or update an order sync If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TOrderSyncConfig extends OrderSyncConfig
Parameters
- orderSyncConfig: OrderSyncConfig
  Required fields: DeliveryConfigID
- 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<TOrderSyncConfig>>
- Defined in api/OrderSynchronization.ts:51