Whether the error was from the request being cancelled.
Response object that represents some error state from the API.
Property | Type | Description |
---|---|---|
|
|
Whether the error was from the request being cancelled. |
|
|
Optional exception class name. |
|
|
Optionally gives additional information to the client about what was wrong with their request. |
|
|
The HTTP status type such as |
|
|
The HTTP status code such as 404. |
|
|
When the error occurred as an ISO formatted date string. |
|
|
A human-readable representation of the type of error being returned. |
|
|
A machine-readable representation of the type of error being returned. |
extends ApiError
Type of ApiError for entity validation failures.
Property | Type | Description |
---|---|---|
|
|
Map of FieldValidationErrors where the key is the |
Options passed to the HTTP request call to customize the request configuration.
Property | Type | Description |
---|---|---|
|
|
Application token to be used for this specific operation.
This will take precedence over the client’s |
|
|
Bearer token to be used to authorize this request for a particular user.
This will include an |
|
|
Axios CancelToken to be used for request cancellation. This will be included on the request configuration passed to the request agent. |
|
|
Overrides of the HTTP request configuration for an operation. These overrides will be merged into the default request configuration for the operation.
|
|
|
Function used to customize the HTTP request configuration for an operation. This function can be async and return a Promise.
|
|
|
Overrides for the HTTP request headers for an operation. These headers will be merged into the default request headers for the operation. |
|
|
The current locale for the operation. This value will be added as an
|
|
|
Overrides for the HTTP request parameters for an operation. These parameters will be merged into the default request parameters for the operation. |
|
|
Options that allow for the access of sandboxed preview data |
Property | Type | Description |
---|---|---|
|
|
|
|
|
Application token to be used for this specific operation. |
|
|
Base URL for the axios client. |
|
|
Concatenated with the |
|
|
Concatenated with the |
|
|
The current locale for the operation. This value will be added as an
|
|
|
Options passed to the HTTP request call to customize the request for previews. These will be treated as the default values when constructing the relevant request headers. |
|
|
Default request configuration. |
Property | Type | Description |
---|---|---|
|
|
The unique currency code, the effective code depends on the currency. |
|
|
The numeric currency code. within the ISO-4217 name space. |
Defines the names of frequently used request headers.
Name | Value | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Represents a digital asset related to some entity like a product.
Property | Type | Description |
---|---|---|
|
|
The application id that this asset is associated with, used for asset resolving |
|
|
The tenant id that this asset is associated with, used for asset resolving |
|
|
Describes the general type of the asset. |
|
|
The name of the provider that is hosting the asset. |
|
|
The location used to resolve this asset. |
|
|
Fully quailified URL for the asset. Includes all tenant and context information. |
|
|
If and only if the type is 'EMBED', this field holds the HTML to embed. |
|
|
Text that corresponds to the HTML alt attribute that should be used when this asset is rendered in a browser. |
|
|
Text that corresponds to the HTML title attribute that should be used when this asset is rendered in a browser. |
|
|
Descriptive or identifying labels. |
|
|
extends GlobalApiError
Type of GlobalApiError for information about a field that failed validation.
Property | Type | Description |
---|---|---|
|
|
Path on the validated entity to the field that failed validation: |
|
|
Value that was rejected if applicable. |
Represents an individual global error that came back from the API.
Property | Type | Description |
---|---|---|
|
|
Can be either machine-readable or human-readable representation of the error. |
|
|
Human-readable representation of the error |
Property | Type | Description |
---|---|---|
|
|
The monetary amount. |
|
|
The currency. |
extends UnnumberedPageable
Pageable that is suitable for denoting page boundaries for a narrowed fetch. Narrowed
fetch results generally go through a NarrowExecutor
and as a result, can provide a
narrowed result set from what is physically represented in the database. For this reason, it is
important to keep track of a silent underlyingPageSize
when determining next page
offset values. For example, next page offset is generally calculated as the current offset
plus
the underlyingPageSize
.
Property | Type | Description |
---|---|---|
|
|
Whether the pagination results represent a forward progression or backwards progression. |
|
|
The number of physical database records processed. This can be different than the narrowed records returned in a page. |
Params to include in API requests to indicate pagination options for denoting page boundaries for a narrowed fetch.
Property | Type | Description |
---|---|---|
|
|
Whether to request a forward progression of results or a backward one. |
|
|
The offset to start the progression of the results, e.g., start at the 10th element. |
|
|
How the results should be sorted. |
Represents a "page" of data.
Property | Type | Description |
---|---|---|
|
|
The content in this page. |
|
|
Whether the page had no results. |
|
|
Whether the page is the first. |
|
|
Whether the page is the last. |
|
|
The page number. |
|
|
The number of elements in this page. |
|
|
The pagination info. |
|
|
The size of the page. |
|
|
The sort details for the page. |
|
|
The total of all elements including those that extend beyond this page. |
|
|
The total number of pages that can be returned based on the size and total elements. |
Defines the pagination for a result set.
Property | Type | Description |
---|---|---|
|
|
Whether it contains paged information. |
|
|
The offset to be taken according to the underlying page and page size. |
|
|
The page number. |
|
|
The number of items to be returned. |
|
|
The sort params for the pageable |
|
|
Whether it does NOT contain paged information. |
Params to include in API requests to indicate pagination options for default paging.
Property | Type | Description |
---|---|---|
|
|
The number of the page desired. |
|
|
The size of the page desired. |
|
|
How the results should be sorted. |
Options passed to the HTTP request call to customize the request for previews. This if the token is valid and and the sandbox is with in the same context as the token with a valid date
Property | Type | Description |
---|---|---|
|
|
Preview token to authorize that a request has access to preview data for a given sandbox |
|
|
The Sandbox ID. |
|
|
The date in which to preview data. |
Defines the sort details for a result set.
Property | Type | Description |
---|---|---|
|
|
Whether it is empty. |
|
|
Ordering to apply. |
|
|
Whether it is sorted. |
|
|
Whether it is NOT sorted. |
Describes the sort details for a specific property.
Property | Type | Description |
---|---|---|
|
|
The sort direction. |
|
|
Whether to ignore case when sorting on the |
|
|
The property to sort by. |
|
|
How to handle null values when sorting. |