Class ApiClients

Hierarchy

ApiClients

Index

Properties

Methods

As Create CreateSecret Delete DeleteBuyerAssignment DeleteSecret DeleteSupplierAssignment Get GetSecret List ListAssignments ListSecrets Patch PatchSecret Save SaveAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TApiClient>(apiClient: ApiClient<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TApiClient>>
Create a new API client. 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
- TApiClient extends ApiClient<any, TApiClient>
Parameters
- apiClient: ApiClient<any>
  
  Required fields: AccessTokenDuration, AppName
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TApiClient>>
- Defined in api/ApiClients.ts:75

CreateSecret

CreateSecret<TApiClientSecretCreateResponse>(apiClientID: string, apiClientSecret: ApiClientSecret, requestOptions?: RequestOptions): Promise<RequiredDeep<TApiClientSecretCreateResponse>>
Create a new API client secret. Check out the docs for more info
Type Parameters
- TApiClientSecretCreateResponse extends ApiClientSecretCreateResponse
Parameters
- apiClientID: string
  
  ID of the api client.
- apiClientSecret: ApiClientSecret
  
  Required fields: Name
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TApiClientSecretCreateResponse>>
- Defined in api/ApiClients.ts:210

Delete

Delete(apiClientID: string, requestOptions?: RequestOptions): Promise<void>
Delete a API client. Check out the docs for more info
Parameters
- apiClientID: string
  
  ID of the api client.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/ApiClients.ts:139

DeleteBuyerAssignment

DeleteBuyerAssignment(apiClientID: string, buyerID: string, requestOptions?: RequestOptions): Promise<void>
Delete a API client buyer assignment. Check out the docs for more info
Parameters
- apiClientID: string
  
  ID of the api client.
- buyerID: string
  
  ID of the buyer.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/ApiClients.ts:345

DeleteSecret

DeleteSecret(apiClientID: string, apiClientSecretID: string, requestOptions?: RequestOptions): Promise<void>
Delete a API client secret. Check out the docs for more info
Parameters
- apiClientID: string
  
  ID of the api client.
- apiClientSecretID: string
  
  ID of the api client secret.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/ApiClients.ts:254

DeleteSupplierAssignment

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

Get

Get<TApiClient>(apiClientID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TApiClient>>
Get a single API client. Check out the docs for more info
Type Parameters
- TApiClient extends ApiClient<any, TApiClient>
Parameters
- apiClientID: string
  
  ID of the api client.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TApiClient>>
- Defined in api/ApiClients.ts:96

GetSecret

GetSecret<TApiClientSecret>(apiClientID: string, apiClientSecretID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TApiClientSecret>>
Get a single API client secret. Check out the docs for more info
Type Parameters
- TApiClientSecret extends ApiClientSecret
Parameters
- apiClientID: string
  
  ID of the api client.
- apiClientSecretID: string
  
  ID of the api client secret.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TApiClientSecret>>
- Defined in api/ApiClients.ts:232

List

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

ListAssignments

ListAssignments<TApiClientAssignment>(listOptions?: {
    apiClientID?: string;
    buyerID?: string;
    page?: number;
    pageSize?: number;
    supplierID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TApiClientAssignment>>>
Get a list of API client assignments. Check out the docs for more info
Type Parameters
- TApiClientAssignment extends ApiClientAssignment
Parameters
- listOptions: {
      apiClientID?: string;
      buyerID?: string;
      page?: number;
      pageSize?: number;
      supplierID?: string;
  } = {}
  - Optional apiClientID?: string
    
    ID of the api client.
  - Optional buyerID?: string
    
    ID of the buyer.
  - 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 supplierID?: string
    
    ID of the supplier.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TApiClientAssignment>>>
- Defined in api/ApiClients.ts:302

ListSecrets

ListSecrets<TApiClientSecret>(apiClientID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: "ID"[];
    sortBy?: ("ID" | "!ID")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TApiClientSecret>>>
Get a list of API client secrets. Check out the docs for more info
Type Parameters
- TApiClientSecret extends ApiClientSecret
Parameters
- apiClientID: string
  
  ID of the api client.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: "ID"[];
      sortBy?: ("ID" | "!ID")[];
  } = {}
  - 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"[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "!ID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TApiClientSecret>>>
- Defined in api/ApiClients.ts:188

Patch

Patch<TApiClient>(apiClientID: string, apiClient: PartialObjectDeep<ApiClient<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TApiClient>>
Partially update a API client. Check out the docs for more info
Type Parameters
- TApiClient extends ApiClient<any, TApiClient>
Parameters
- apiClientID: string
  
  ID of the api client.
- apiClient: PartialObjectDeep<ApiClient<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TApiClient>>
- Defined in api/ApiClients.ts:161

PatchSecret

PatchSecret<TApiClientSecret>(apiClientID: string, apiClientSecretID: string, apiClientSecret: PartialObjectDeep<ApiClientSecret>, requestOptions?: RequestOptions): Promise<RequiredDeep<TApiClientSecret>>
Partially update a API client secret. Check out the docs for more info
Type Parameters
- TApiClientSecret extends ApiClientSecret
Parameters
- apiClientID: string
  
  ID of the api client.
- apiClientSecretID: string
  
  ID of the api client secret.
- apiClientSecret: PartialObjectDeep<ApiClientSecret>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TApiClientSecret>>
- Defined in api/ApiClients.ts:277

Save

Save<TApiClient>(apiClientID: string, apiClient: ApiClient<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TApiClient>>
Update an API client. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TApiClient extends ApiClient<any, TApiClient>
Parameters
- apiClientID: string
  
  ID of the api client.
- apiClient: ApiClient<any>
  
  Required fields: AccessTokenDuration, AppName
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TApiClient>>
- Defined in api/ApiClients.ts:118

SaveAssignment

SaveAssignment(apiClientAssignment: ApiClientAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a API client assignment. Check out the docs for more info
Parameters
- apiClientAssignment: ApiClientAssignment
  
  Required fields: ApiClientID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/ApiClients.ts:323

Class ApiClients

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns ApiClients

Create

Type Parameters

TApiClient extends ApiClient<any, TApiClient>

Parameters

apiClient: ApiClient<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TApiClient>>

CreateSecret

Type Parameters

TApiClientSecretCreateResponse extends ApiClientSecretCreateResponse

Parameters

apiClientID: string

apiClientSecret: ApiClientSecret

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TApiClientSecretCreateResponse>>

Delete

Parameters

apiClientID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteBuyerAssignment

Parameters

apiClientID: string

buyerID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteSecret

Parameters

apiClientID: string

apiClientSecretID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteSupplierAssignment

Parameters

apiClientID: string

supplierID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TApiClient extends ApiClient<any, TApiClient>

Parameters

apiClientID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TApiClient>>

GetSecret

Type Parameters

TApiClientSecret extends ApiClientSecret

Parameters

apiClientID: string

apiClientSecretID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TApiClientSecret>>

List

Type Parameters

TApiClient extends ApiClient<any, TApiClient>

Parameters

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

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "AppName" | "DefaultContextUserName")[]

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

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TApiClient>>>

ListAssignments

Type Parameters

`Private` impersonating

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

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

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

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

listOptions: {
apiClientID?: string;
buyerID?: string;
page?: number;
pageSize?: number;
supplierID?: string;
} = {}

`Optional` apiClientID?: string

`Optional` buyerID?: string

`Optional` page?: number

`Optional` pageSize?: number

`Optional` supplierID?: string

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

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: "ID"[]

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