Class SupplierAddresses

Hierarchy

SupplierAddresses

Index

Properties

impersonating

Methods

As Create Delete Get List Patch Save

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TAddress>(supplierID: string, address: Address<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TAddress>>
Create a new supplier 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
- supplierID: string
  
  ID of the supplier.
- address: Address<any>
  
  Required fields: Street1, City, State, Zip, Country
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TAddress>>
- Defined in api/SupplierAddresses.ts:65

Delete

Delete(supplierID: string, addressID: string, requestOptions?: RequestOptions): Promise<void>
Delete a supplier address. Check out the docs for more info
Parameters
- supplierID: string
  
  ID of the supplier.
- addressID: string
  
  ID of the address.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/SupplierAddresses.ts:132

Get

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

List

List<TAddress>(supplierID: 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 supplier addresses. Check out the docs for more info
Type Parameters
- TAddress extends Address<any, TAddress>
Parameters
- supplierID: string
  
  ID of the supplier.
- 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/SupplierAddresses.ts:43

Patch

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

Save

Save<TAddress>(supplierID: string, addressID: string, address: Address<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TAddress>>
Create or update a supplier 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
- supplierID: string
  
  ID of the supplier.
- 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/SupplierAddresses.ts:110

Class SupplierAddresses

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns SupplierAddresses

Create

Type Parameters

TAddress extends Address<any, TAddress>

Parameters

supplierID: string

address: Address<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TAddress>>

Delete

Parameters

supplierID: string

addressID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TAddress extends Address<any, TAddress>

Parameters

supplierID: string

addressID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TAddress>>

List

Type Parameters

TAddress extends Address<any, TAddress>

Parameters

supplierID: 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>>>

Patch

Type Parameters

TAddress extends Address<any, TAddress>

Parameters

supplierID: string

addressID: string

address: PartialObjectDeep<Address<any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TAddress>>

Save

Type Parameters

TAddress extends Address<any, TAddress>

Parameters

supplierID: string

addressID: string

address: Address<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TAddress>>

Settings

Member Visibility

Theme

`Private` impersonating

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

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