Class OrderStatusNotificationsApi

Hierarchy

OrderStatusNotificationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OrderStatusNotificationsApi(basePath?: string): OrderStatusNotificationsApi

- Defined in api/api.ts:63017
Parameters
- Optional basePath: string
Returns OrderStatusNotificationsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

salesOrdersStatusesIdNotificationsCountGet

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

- Defined in api/api.ts:63031
Get Order Status Notifications Count

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

salesOrdersStatusesIdNotificationsGet

salesOrdersStatusesIdNotificationsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<OrderStatusNotification>>

- Defined in api/api.ts:63078
Get Order Status Notifications

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

salesOrdersStatusesIdNotificationsNotificationIdDelete

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

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

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

salesOrdersStatusesIdNotificationsNotificationIdGet

salesOrdersStatusesIdNotificationsNotificationIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OrderStatusNotification>

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

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

salesOrdersStatusesIdNotificationsNotificationIdPatch

salesOrdersStatusesIdNotificationsNotificationIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OrderStatusNotification>

- Defined in api/api.ts:63227
Update Order Status Notification

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

salesOrdersStatusesIdNotificationsNotificationIdPut

salesOrdersStatusesIdNotificationsNotificationIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OrderStatusNotification>

- Defined in api/api.ts:63278
Replace Order Status Notification

Parameters
- params: object
  - id: number
  - notificationId: number
  - orderStatusNotification: OrderStatusNotification
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<OrderStatusNotification>

salesOrdersStatusesIdNotificationsPost

salesOrdersStatusesIdNotificationsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<OrderStatusNotification>

- Defined in api/api.ts:63328
Create Order Status Notification

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

Generated using TypeDoc