Skip to main content

Class: AddressService

Defined in: service/AddressService.ts:112

Backwards-compatible class form. New code should call addressService(client).

Constructors​

Constructor​

new AddressService(client): AddressService

Defined in: service/AddressService.ts:114

Parameters​

client​

GraphQLClient

Returns​

AddressService

Methods​

createCompanyAddress()​

createCompanyAddress(input): Promise<Address>

Defined in: service/AddressService.ts:134

Creates a new address for a company

Parameters​

input​

CompanyAddressCreateInput

Company address creation input data

Returns​

Promise<Address>

createCustomerAddress()​

createCustomerAddress(input): Promise<Address>

Defined in: service/AddressService.ts:149

Creates a new address for a customer

Parameters​

input​

CustomerAddressCreateInput

Customer address creation input data

Returns​

Promise<Address>

deleteCompanyAddress()​

deleteCompanyAddress(input): Promise<boolean>

Defined in: service/AddressService.ts:144

Deletes a company address

Parameters​

input​

CompanyAddressDeleteInput

Company address deletion input data

Returns​

Promise<boolean>

deleteCustomerAddress()​

deleteCustomerAddress(input): Promise<boolean>

Defined in: service/AddressService.ts:159

Deletes a customer address

Parameters​

input​

CustomerAddressDeleteInput

Customer address deletion input data

Returns​

Promise<boolean>

getAddressesByCompanyId()​

getAddressesByCompanyId(companyId): Promise<Address[]>

Defined in: service/AddressService.ts:119

Fetches addresses for a company

Parameters​

companyId​

number

Company ID

Returns​

Promise<Address[]>

getAddressesByCustomerId()​

getAddressesByCustomerId(customerId): Promise<Address[]>

Defined in: service/AddressService.ts:124

Fetches addresses for a customer

Parameters​

customerId​

number

Customer ID

Returns​

Promise<Address[]>

getAddressesByOrderId()​

getAddressesByOrderId(orderId): Promise<Address[]>

Defined in: service/AddressService.ts:129

Fetches addresses for an order

Parameters​

orderId​

number

Order ID

Returns​

Promise<Address[]>

updateCompanyAddress()​

updateCompanyAddress(input): Promise<Address>

Defined in: service/AddressService.ts:139

Updates an existing company address

Parameters​

input​

CompanyAddressUpdateInput

Company address update input data

Returns​

Promise<Address>

updateCustomerAddress()​

updateCustomerAddress(input): Promise<Address>

Defined in: service/AddressService.ts:154

Updates an existing customer address

Parameters​

input​

CustomerAddressUpdateInput

Customer address update input data

Returns​

Promise<Address>