Class Suppliers

Hierarchy

Suppliers

Index

Properties

impersonating

Methods

As Create Delete DeleteBuyer Get List ListBuyers Patch Save SaveBuyer

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TSupplier>(supplier: Supplier<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TSupplier>>
Create a new supplier. 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
- TSupplier extends Supplier<any, TSupplier>
Parameters
- supplier: Supplier<any>
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSupplier>>
- Defined in api/Suppliers.ts:67

Delete

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

DeleteBuyer

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

Get

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

List

List<TSupplier>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name")[];
    sortBy?: ("ID" | "Name" | "DateCreated" | "!ID" | "!DateCreated" | "!Name")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TSupplier>>>
Get a list of suppliers. Check out the docs for more info
Type Parameters
- TSupplier extends Supplier<any, TSupplier>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "DateCreated" | "!ID" | "!DateCreated" | "!Name")[];
  } = {}
  - 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" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "DateCreated" | "!ID" | "!DateCreated" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TSupplier>>>
- Defined in api/Suppliers.ts:46

ListBuyers

ListBuyers<TSupplierBuyer>(supplierID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name")[];
    sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TSupplierBuyer>>>
Get a list of supplier buyers. Check out the docs for more info
Type Parameters
- TSupplierBuyer extends SupplierBuyer
Parameters
- supplierID: string
  
  ID of the supplier.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - 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" | "Name")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TSupplierBuyer>>>
- Defined in api/Suppliers.ts:180

Patch

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

Save

Save<TSupplier>(supplierID: string, supplier: Supplier<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TSupplier>>
Create or update a supplier. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TSupplier extends Supplier<any, TSupplier>
Parameters
- supplierID: string
  
  ID of the supplier.
- supplier: Supplier<any>
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TSupplier>>
- Defined in api/Suppliers.ts:110

SaveBuyer

SaveBuyer(supplierID: string, buyerID: string, requestOptions?: RequestOptions): Promise<void>
Create or update a supplier buyer. Check out the docs for more info
Parameters
- supplierID: string
  
  ID of the supplier.
- buyerID: string
  
  ID of the buyer.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Suppliers.ts:202

Class Suppliers

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns Suppliers

Create

Type Parameters

TSupplier extends Supplier<any, TSupplier>

Parameters

supplier: Supplier<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSupplier>>

Delete

Parameters

supplierID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteBuyer

Parameters

supplierID: string

buyerID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TSupplier extends Supplier<any, TSupplier>

Parameters

supplierID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSupplier>>

List

Type Parameters

TSupplier extends Supplier<any, TSupplier>

Parameters

listOptions: { filters?: Filters; page?: number; pageSize?: number; search?: string; searchOn?: ("ID" | "Name")[]; sortBy?: ("ID" | "Name" | "DateCreated" | "!ID" | "!DateCreated" | "!Name")[]; } = {}

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "Name")[]

Optional sortBy?: ("ID" | "Name" | "DateCreated" | "!ID" | "!DateCreated" | "!Name")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TSupplier>>>

ListBuyers

Type Parameters

TSupplierBuyer extends SupplierBuyer

Parameters

supplierID: string

listOptions: { filters?: Filters; page?: number; pageSize?: number; search?: string; searchOn?: ("ID" | "Name")[]; sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]; } = {}

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "Name")[]

Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TSupplierBuyer>>>

Patch

Type Parameters

TSupplier extends Supplier<any, TSupplier>

Parameters

supplierID: string

supplier: PartialObjectDeep<Supplier<any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSupplier>>

Save

Type Parameters

TSupplier extends Supplier<any, TSupplier>

Parameters

supplierID: string

supplier: Supplier<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TSupplier>>

`Private` impersonating

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "Name")[];
sortBy?: ("ID" | "Name" | "DateCreated" | "!ID" | "!DateCreated" | "!Name")[];
} = {}

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "Name")[]

`Optional` sortBy?: ("ID" | "Name" | "DateCreated" | "!ID" | "!DateCreated" | "!Name")[]

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "Name")[];
sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
} = {}

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "Name")[]

`Optional` sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]