AddressApiFactory
AddressApi - factory interface
Signature
AddressApiFactory: (
configuration?: Configuration,
basePath?: string,
axios?: AxiosInstance
) => {
createAddress(baseSiteId: string,
userId: string,
address: Address,
fields?: string,
options?: any): AxiosPromise<Address>;
getAddress(addressId: string,
baseSiteId: string,
userId: string,
fields?: string,
options?: any): AxiosPromise<Address>;
getAddresses(baseSiteId: string,
userId: string,
fields?: string,
options?: any): AxiosPromise<AddressList>;
removeAddress(addressId: string,
baseSiteId: string,
userId: string,
options?: any): AxiosPromise<void>;
replaceAddress(addressId: string,
baseSiteId: string,
userId: string,
address: Address,
options?: any): AxiosPromise<void>;
updateAddress(addressId: string,
baseSiteId: string,
userId: string,
address: Address,
options?: any): AxiosPromise<void>;
validateAddress(baseSiteId: string,
userId: string,
address: Address,
fields?: string,
options?: any): AxiosPromise<AddressValidation>;
}Parameters
| Name | Required | Type | Description |
|---|---|---|---|
configuration | Optional | Configuration | |
basePath | Optional | string | |
axios | Optional | AxiosInstance |
Referenced Types
AxiosInstance- Address
AxiosPromise- AddressList
- AddressValidation