Class OrderStatusesApi

Hierarchy

OrderStatusesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OrderStatusesApi(basePath?: string): OrderStatusesApi

- Defined in api/api.ts:63374
Parameters
- Optional basePath: string
Returns OrderStatusesApi

Properties

Protected basePath

basePath: string = "https://api-na.myconnectwise.net/v4_6_release/apis/3.0"

defaultHeaders

defaultHeaders: any

Methods

salesOrdersStatusesCountGet

salesOrdersStatusesCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

- Defined in api/api.ts:63387
Get Order Statuses Count

Parameters
- params: object
  - Optional conditions?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Count>

salesOrdersStatusesGet

salesOrdersStatusesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<OrderStatus>>

- Defined in api/api.ts:63428
Get Order Statuses

Parameters
- params: object
  - Optional childconditions?: string
  - Optional conditions?: string
  - Optional customfieldconditions?: string
  - Optional orderBy?: string
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<OrderStatus>>

salesOrdersStatusesIdDelete

salesOrdersStatusesIdDelete(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:63484
Delete Order Status By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

salesOrdersStatusesIdGet

salesOrdersStatusesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OrderStatus>

- Defined in api/api.ts:63521
Get Order Status By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<OrderStatus>

salesOrdersStatusesIdPatch

salesOrdersStatusesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OrderStatus>

- Defined in api/api.ts:63559
Update Order Status

Parameters
- params: object
  - id: number
  - operations: Array<PatchOperation>
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<OrderStatus>

salesOrdersStatusesIdPut

salesOrdersStatusesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OrderStatus>

- Defined in api/api.ts:63604
Replace Order Status

Parameters
- params: object
  - id: number
  - status: OrderStatus
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<OrderStatus>

salesOrdersStatusesPost

salesOrdersStatusesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<OrderStatus>>

- Defined in api/api.ts:63648
Create Order Status

Parameters
- params: object
  - status: OrderStatus
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<OrderStatus>>

Generated using TypeDoc