Class Addresses

Hierarchy

Addresses

Index

Properties

impersonating

Methods

As Create Delete DeleteAssignment Get List ListAssignments Patch Save SaveAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): Addresses
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
Addresses.As().List() // lists Addresses using the impersonated users' token
```
Returns Addresses
- Defined in api/Addresses.ts:254

Create

Create<TAddress>(buyerID: string, address: Address<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TAddress>>
Create a new address. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. Check out the docs for more info
Type Parameters
- TAddress extends Address<any, TAddress>
Parameters
- buyerID: string
  
  ID of the buyer.
- address: Address<any>
  
  Required fields: Street1, City, State, Zip, Country
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TAddress>>
- Defined in api/Addresses.ts:70

Delete

Delete(buyerID: string, addressID: string, requestOptions?: RequestOptions): Promise<void>
Delete an address. Check out the docs for more info
Parameters
- buyerID: string
  
  ID of the buyer.
- addressID: string
  
  ID of the address.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Addresses.ts:137

DeleteAssignment

DeleteAssignment(buyerID: string, addressID: string, listOptions?: {
userGroupID?: string;
userID?: string;
}, requestOptions?: RequestOptions): Promise<void>
Delete an address assignment. Check out the docs for more info
Parameters
- buyerID: string
  
  ID of the buyer.
- addressID: string
  
  ID of the address.
- listOptions: {
  userGroupID?: string;
  userID?: string;
  } = {}
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Addresses.ts:184

Get

Get<TAddress>(buyerID: string, addressID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TAddress>>
Get a single address. Check out the docs for more info
Type Parameters
- TAddress extends Address<any, TAddress>
Parameters
- buyerID: string
  
  ID of the buyer.
- addressID: string
  
  ID of the address.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TAddress>>
- Defined in api/Addresses.ts:92

List

List<TAddress>(buyerID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip")[];
    sortBy?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip" | "DateCreated" | "Country" | "Phone" | "!AddressName" | "!ID" | "!DateCreated" | "!CompanyName" | "!FirstName" | "!LastName" | "!Street1" | "!Street2" | "!City" | "!State" | "!Zip" | "!Country" | "!Phone")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TAddress>>>
Get a list of addresses. Check out the docs for more info
Type Parameters
- TAddress extends Address<any, TAddress>
Parameters
- buyerID: string
  
  ID of the buyer.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip")[];
      sortBy?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip" | "DateCreated" | "Country" | "Phone" | "!AddressName" | "!ID" | "!DateCreated" | "!CompanyName" | "!FirstName" | "!LastName" | "!Street1" | "!Street2" | "!City" | "!State" | "!Zip" | "!Country" | "!Phone")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip" | "DateCreated" | "Country" | "Phone" | "!AddressName" | "!ID" | "!DateCreated" | "!CompanyName" | "!FirstName" | "!LastName" | "!Street1" | "!Street2" | "!City" | "!State" | "!Zip" | "!Country" | "!Phone")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TAddress>>>
- Defined in api/Addresses.ts:48

ListAssignments

ListAssignments<TAddressAssignment>(buyerID: string, listOptions?: {
    addressID?: string;
    isBilling?: boolean;
    isShipping?: boolean;
    level?: PartyType;
    page?: number;
    pageSize?: number;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TAddressAssignment>>>
Get a list of address assignments. Check out the docs for more info
Type Parameters
- TAddressAssignment extends AddressAssignment
Parameters
- buyerID: string
  
  ID of the buyer.
- listOptions: {
      addressID?: string;
      isBilling?: boolean;
      isShipping?: boolean;
      level?: PartyType;
      page?: number;
      pageSize?: number;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional addressID?: string
    
    ID of the address.
  - Optional isBilling?: boolean
    
    Is billing of the address assignment.
  - Optional isShipping?: boolean
    
    Is shipping of the address assignment.
  - Optional level?: PartyType
    
    Level of the address assignment. Possible values: User, Group, Company.
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TAddressAssignment>>>
- Defined in api/Addresses.ts:213

Patch

Patch<TAddress>(buyerID: string, addressID: string, address: PartialObjectDeep<Address<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TAddress>>
Partially update an address. Check out the docs for more info
Type Parameters
- TAddress extends Address<any, TAddress>
Parameters
- buyerID: string
  
  ID of the buyer.
- addressID: string
  
  ID of the address.
- address: PartialObjectDeep<Address<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TAddress>>
- Defined in api/Addresses.ts:160

Save

Save<TAddress>(buyerID: string, addressID: string, address: Address<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TAddress>>
Create or update an address. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TAddress extends Address<any, TAddress>
Parameters
- buyerID: string
  
  ID of the buyer.
- addressID: string
  
  ID of the address.
- address: Address<any>
  
  Required fields: Street1, City, State, Zip, Country
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TAddress>>
- Defined in api/Addresses.ts:115

SaveAssignment

SaveAssignment(buyerID: string, addressAssignment: AddressAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update an address assignment. Check out the docs for more info
Parameters
- buyerID: string
  
  ID of the buyer.
- addressAssignment: AddressAssignment
  
  Required fields: AddressID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Addresses.ts:235

Class Addresses

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns Addresses

Create

Type Parameters

TAddress extends Address<any, TAddress>

Parameters

buyerID: string

address: Address<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TAddress>>

Delete

Parameters

buyerID: string

addressID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteAssignment

Parameters

buyerID: string

addressID: string

listOptions: { userGroupID?: string; userID?: string; } = {}

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TAddress extends Address<any, TAddress>

Parameters

buyerID: string

addressID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TAddress>>

List

Type Parameters

TAddress extends Address<any, TAddress>

Parameters

buyerID: string

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TAddress>>>

ListAssignments

Type Parameters

TAddressAssignment extends AddressAssignment

Parameters

buyerID: string

listOptions: { addressID?: string; isBilling?: boolean; isShipping?: boolean; level?: PartyType; page?: number; pageSize?: number; userGroupID?: string; userID?: string; } = {}

Optional addressID?: string

Optional isBilling?: boolean

Optional isShipping?: boolean

Optional level?: PartyType

Optional page?: number

Optional pageSize?: number

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TAddressAssignment>>>

Patch

Type Parameters

TAddress extends Address<any, TAddress>

Parameters

buyerID: string

addressID: string

address: PartialObjectDeep<Address<any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TAddress>>

`Private` impersonating

listOptions: {
userGroupID?: string;
userID?: string;
} = {}

`Optional` userGroupID?: string

`Optional` userID?: string

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "AddressName" | "CompanyName" | "City" | "Street1" | "Street2" | "LastName" | "FirstName" | "State" | "Zip")[]

listOptions: {
addressID?: string;
isBilling?: boolean;
isShipping?: boolean;
level?: PartyType;
page?: number;
pageSize?: number;
userGroupID?: string;
userID?: string;
} = {}

`Optional` addressID?: string

`Optional` isBilling?: boolean

`Optional` isShipping?: boolean

`Optional` level?: PartyType

`Optional` page?: number

`Optional` pageSize?: number

`Optional` userGroupID?: string

`Optional` userID?: string