Class CountriesApi

Hierarchy

CountriesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CountriesApi(basePath?: string): CountriesApi

- Defined in api/api.ts:39980
Parameters
- Optional basePath: string
Returns CountriesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyCountriesCountGet

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

- Defined in api/api.ts:39993
Get Countries Count

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

companyCountriesGet

companyCountriesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Country>>

- Defined in api/api.ts:40034
Get Countries

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

companyCountriesIdDelete

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

- Defined in api/api.ts:40090
Delete Country By Id

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

companyCountriesIdGet

companyCountriesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Country>

- Defined in api/api.ts:40127
Get Country By Id

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

companyCountriesIdPatch

companyCountriesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Country>

- Defined in api/api.ts:40165
Update Country

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

companyCountriesIdPut

companyCountriesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Country>

- Defined in api/api.ts:40210
Replace Country

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

companyCountriesPost

companyCountriesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Country>

- Defined in api/api.ts:40254
Create Country

Parameters
- params: object
  - country: Country
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Country>

Generated using TypeDoc