Class AddressesApi

Hierarchy

BaseAPI
- AddressesApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new AddressesApi(configuration?: Configuration): AddressesApi

Inherited from runtime.BaseAPI.constructor
- Defined in runtime.ts:25
Parameters
- configuration: Configuration = ...
Returns AddressesApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

createAddress

createAddress(requestParameters: CreateAddressOperationRequest): Promise<AddressResponse>

- Defined in apis/AddressesApi.ts:95
Creates a new address in the organization. Create an address

Parameters
- requestParameters: CreateAddressOperationRequest
Returns Promise<AddressResponse>

createAddressRaw

createAddressRaw(requestParameters: CreateAddressOperationRequest): Promise<ApiResponse<AddressResponse>>

- Defined in apis/AddressesApi.ts:69
Creates a new address in the organization. Create an address

Parameters
- requestParameters: CreateAddressOperationRequest
Returns Promise<ApiResponse<AddressResponse>>

deleteAddress

deleteAddress(requestParameters: DeleteAddressRequest): Promise<string>

- Defined in apis/AddressesApi.ts:127
Delete a specific address. Delete an address

Parameters
- requestParameters: DeleteAddressRequest
Returns Promise<string>

deleteAddressRaw

deleteAddressRaw(requestParameters: DeleteAddressRequest): Promise<ApiResponse<string>>

- Defined in apis/AddressesApi.ts:104
Delete a specific address. Delete an address

Parameters
- requestParameters: DeleteAddressRequest
Returns Promise<ApiResponse<string>>

getAddress

getAddress(requestParameters: GetAddressRequest): Promise<AddressResponse>

- Defined in apis/AddressesApi.ts:159
Returns a specific address. Retrieve an address

Parameters
- requestParameters: GetAddressRequest
Returns Promise<AddressResponse>

getAddressRaw

getAddressRaw(requestParameters: GetAddressRequest): Promise<ApiResponse<AddressResponse>>

- Defined in apis/AddressesApi.ts:136
Returns a specific address. Retrieve an address

Parameters
- requestParameters: GetAddressRequest
Returns Promise<ApiResponse<AddressResponse>>

listAddresses

listAddresses(requestParameters: ListAddressesRequest): Promise<ListAddressesResponse>

- Defined in apis/AddressesApi.ts:207
Returns a list of all addresses in an organization. List all addresses

Parameters
- requestParameters: ListAddressesRequest
Returns Promise<ListAddressesResponse>

listAddressesRaw

listAddressesRaw(requestParameters: ListAddressesRequest): Promise<ApiResponse<ListAddressesResponse>>

- Defined in apis/AddressesApi.ts:168
Returns a list of all addresses in an organization. List all addresses

Parameters
- requestParameters: ListAddressesRequest
Returns Promise<ApiResponse<ListAddressesResponse>>

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from runtime.BaseAPI.request
- Defined in runtime.ts:47
Parameters
- context: RequestOpts
Returns Promise<Response>

updateAddress

updateAddress(requestParameters: UpdateAddressOperationRequest): Promise<AddressResponse>

- Defined in apis/AddressesApi.ts:246
Update a specific address. Update an address

Parameters
- requestParameters: UpdateAddressOperationRequest
Returns Promise<AddressResponse>

updateAddressRaw

updateAddressRaw(requestParameters: UpdateAddressOperationRequest): Promise<ApiResponse<AddressResponse>>

- Defined in apis/AddressesApi.ts:216
Update a specific address. Update an address

Parameters
- requestParameters: UpdateAddressOperationRequest
Returns Promise<ApiResponse<AddressResponse>>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

Inherited from runtime.BaseAPI.withMiddleware
- Defined in runtime.ts:31
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T

Inherited from runtime.BaseAPI.withPostMiddleware
- Defined in runtime.ts:42
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T

Inherited from runtime.BaseAPI.withPreMiddleware
- Defined in runtime.ts:37
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Generated using TypeDoc