Class ShipmentMethodsApi

Hierarchy

ShipmentMethodsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ShipmentMethodsApi(basePath?: string): ShipmentMethodsApi

- Defined in api/api.ts:85393
Parameters
- Optional basePath: string
Returns ShipmentMethodsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

procurementShipmentmethodsCountGet

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

- Defined in api/api.ts:85406
Get Shipment Methods Count

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

procurementShipmentmethodsGet

procurementShipmentmethodsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<ShipmentMethod>>

- Defined in api/api.ts:85447
Get Shipment Methods

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<ShipmentMethod>>

procurementShipmentmethodsIdDelete

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

- Defined in api/api.ts:85503
Delete Shipment Method By Id

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

procurementShipmentmethodsIdGet

procurementShipmentmethodsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ShipmentMethod>

- Defined in api/api.ts:85540
Get Shipment Method By Id

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

procurementShipmentmethodsIdPatch

procurementShipmentmethodsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ShipmentMethod>

- Defined in api/api.ts:85578
Update Shipment Method

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

procurementShipmentmethodsIdPut

procurementShipmentmethodsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ShipmentMethod>

- Defined in api/api.ts:85623
Replace Shipment Method

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

procurementShipmentmethodsPost

procurementShipmentmethodsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ShipmentMethod>

- Defined in api/api.ts:85667
Create Shipment Method

Parameters
- params: object
  - shipmentMethod: ShipmentMethod
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ShipmentMethod>

Generated using TypeDoc