Class AddressFormatsApi

Hierarchy

AddressFormatsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AddressFormatsApi(basePath?: string): AddressFormatsApi

- Defined in api/api.ts:12901
Parameters
- Optional basePath: string
Returns AddressFormatsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

companyAddressFormatsCountGet

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

- Defined in api/api.ts:12914
Get Address Formats Count

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

companyAddressFormatsGet

companyAddressFormatsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<AddressFormat>>

- Defined in api/api.ts:12955
Get Address Formats

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

companyAddressFormatsIdDelete

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

- Defined in api/api.ts:13011
Delete Address Format By Id

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

companyAddressFormatsIdGet

companyAddressFormatsIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AddressFormat>

- Defined in api/api.ts:13048
Get Address Format By Id

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

companyAddressFormatsIdPatch

companyAddressFormatsIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AddressFormat>

- Defined in api/api.ts:13086
Update Address Format

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

companyAddressFormatsIdPut

companyAddressFormatsIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AddressFormat>

- Defined in api/api.ts:13131
Replace Address Format

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

companyAddressFormatsPost

companyAddressFormatsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AddressFormat>

- Defined in api/api.ts:13175
Create Address Format

Parameters
- params: object
  - addressFormat: AddressFormat
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<AddressFormat>

Generated using TypeDoc