@epcc-sdk/sdks-shopper 0.0.14 → 0.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -0
- package/dist/client/@tanstack/react-query.gen.d.ts +408 -1
- package/dist/client/@tanstack/react-query.gen.js +229 -1
- package/dist/client/sdk.gen.d.ts +160 -1
- package/dist/client/sdk.gen.js +195 -0
- package/dist/client/transformers.gen.d.ts +2 -1
- package/dist/client/transformers.gen.js +16 -0
- package/dist/client/types.gen.d.ts +1477 -427
- package/dist/utils/extract-media.d.ts +15 -0
- package/dist/utils/extract-media.js +54 -0
- package/dist/utils/index.d.ts +1 -0
- package/dist/utils/index.js +1 -0
- package/package.json +2 -2
|
@@ -1881,6 +1881,22 @@ export type CartResponse = {
|
|
|
1881
1881
|
};
|
|
1882
1882
|
};
|
|
1883
1883
|
export type CartItemsObjectRequest = CartItemObject | SubscriptionItemObject | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject;
|
|
1884
|
+
export type CartItemsObjectResponse = CartItemResponseObject | SubscriptionItemResponseObject | CustomItemResponseObject | PromotionItemResponseObject;
|
|
1885
|
+
export type CartItemResponseObject = CartItemObjectData & CartItemResponse;
|
|
1886
|
+
export type SubscriptionItemResponseObject = SubscriptionItemObjectData & CartItemResponse;
|
|
1887
|
+
export type CustomItemResponseObject = CustomItemObjectData & {
|
|
1888
|
+
/**
|
|
1889
|
+
* Specifies the ID of the custom cart item
|
|
1890
|
+
*/
|
|
1891
|
+
id: string;
|
|
1892
|
+
description?: unknown;
|
|
1893
|
+
};
|
|
1894
|
+
export type PromotionItemResponseObject = PromotionItemObjectData & {
|
|
1895
|
+
/**
|
|
1896
|
+
* Specifies the ID of the promotion cart item
|
|
1897
|
+
*/
|
|
1898
|
+
id: string;
|
|
1899
|
+
};
|
|
1884
1900
|
export type CartItemObject = {
|
|
1885
1901
|
data?: CartItemObjectData & CartItemResponse;
|
|
1886
1902
|
};
|
|
@@ -3180,7 +3196,6 @@ export type CartInclude = {
|
|
|
3180
3196
|
*/
|
|
3181
3197
|
items?: Array<CartItemsObjectResponse>;
|
|
3182
3198
|
};
|
|
3183
|
-
export type CartItemsObjectResponse = CartItemObject | SubscriptionItemObject | CustomItemObject | PromotionItemObject;
|
|
3184
3199
|
/**
|
|
3185
3200
|
* Whether a plan is active on a subscription using that offering. The `active_plan` attribute is null if a plan is not active in a subscription.
|
|
3186
3201
|
*/
|
|
@@ -5013,215 +5028,758 @@ export type Error2 = {
|
|
|
5013
5028
|
*/
|
|
5014
5029
|
detail?: string;
|
|
5015
5030
|
};
|
|
5016
|
-
|
|
5017
|
-
* The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).
|
|
5018
|
-
*/
|
|
5019
|
-
export type AcceptLanguage = string;
|
|
5020
|
-
/**
|
|
5021
|
-
* The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.
|
|
5022
|
-
*/
|
|
5023
|
-
export type Channel = string;
|
|
5024
|
-
/**
|
|
5025
|
-
* This endpoints supports filtering. See [Filtering](#filtering).
|
|
5026
|
-
*
|
|
5027
|
-
*/
|
|
5028
|
-
export type FilterHierarchy = string;
|
|
5029
|
-
/**
|
|
5030
|
-
* This endpoint supports filtering, see [Filtering](#filtering).
|
|
5031
|
-
*
|
|
5032
|
-
*/
|
|
5033
|
-
export type FilterNode = string;
|
|
5034
|
-
/**
|
|
5035
|
-
* This endpoints support filtering. See [Filtering](#filtering).
|
|
5036
|
-
*
|
|
5037
|
-
*/
|
|
5038
|
-
export type FilterProduct = string;
|
|
5039
|
-
/**
|
|
5040
|
-
* This endpoint supports filtering. See [Filtering](#filtering).
|
|
5041
|
-
*
|
|
5042
|
-
*/
|
|
5043
|
-
export type FilterRule = string;
|
|
5044
|
-
/**
|
|
5045
|
-
* Using the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products.
|
|
5046
|
-
*
|
|
5047
|
-
*/
|
|
5048
|
-
export type Include = Array<"main_images" | "files" | "component_products">;
|
|
5049
|
-
/**
|
|
5050
|
-
* Using the `include=component_products` parameter, you can retrieve key attribute data for the bundle component products in the product bundle, such as SKU or slug .
|
|
5051
|
-
*
|
|
5052
|
-
*/
|
|
5053
|
-
export type IncludeComponentProducts = string;
|
|
5054
|
-
/**
|
|
5055
|
-
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.
|
|
5056
|
-
*/
|
|
5057
|
-
export type Limit = BigInt;
|
|
5058
|
-
/**
|
|
5059
|
-
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.
|
|
5060
|
-
*/
|
|
5061
|
-
export type Offset = BigInt;
|
|
5062
|
-
/**
|
|
5063
|
-
* Product tags are used to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. You can enhance your product list using tags, enabling you to refine your product list and run targeted promotions. Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.
|
|
5064
|
-
*/
|
|
5065
|
-
export type Tag = string;
|
|
5066
|
-
export type CartInclude2 = Array<"items">;
|
|
5067
|
-
/**
|
|
5068
|
-
* A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
|
|
5069
|
-
*/
|
|
5070
|
-
export type Include2 = string;
|
|
5071
|
-
/**
|
|
5072
|
-
* Some Subscriptions API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.
|
|
5073
|
-
*
|
|
5074
|
-
*/
|
|
5075
|
-
export type SubscriptionsFilter = string;
|
|
5076
|
-
/**
|
|
5077
|
-
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
5078
|
-
*/
|
|
5079
|
-
export type SubscriptionsPageLimit = BigInt;
|
|
5080
|
-
/**
|
|
5081
|
-
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
5082
|
-
*/
|
|
5083
|
-
export type SubscriptionsPageOffset = BigInt;
|
|
5084
|
-
/**
|
|
5085
|
-
* Some Inventories API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.
|
|
5086
|
-
*
|
|
5087
|
-
*/
|
|
5088
|
-
export type InventoriesFilter = string;
|
|
5089
|
-
/**
|
|
5090
|
-
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
5091
|
-
*/
|
|
5092
|
-
export type InventoriesPageLimit = number;
|
|
5093
|
-
/**
|
|
5094
|
-
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
5095
|
-
*/
|
|
5096
|
-
export type InventoriesPageOffset = number;
|
|
5097
|
-
/**
|
|
5098
|
-
* The bundle configuration.
|
|
5099
|
-
*/
|
|
5100
|
-
export type BundleConfigurationData2 = BundleConfigurationData;
|
|
5101
|
-
/**
|
|
5102
|
-
* A list of product id or sku and bundle configuration for cart.
|
|
5103
|
-
*/
|
|
5104
|
-
export type ProductsForCartConfiguration2 = ProductsForCartConfiguration;
|
|
5105
|
-
export type GetByContextReleaseData = {
|
|
5106
|
-
body?: never;
|
|
5107
|
-
headers?: {
|
|
5108
|
-
/**
|
|
5109
|
-
* The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).
|
|
5110
|
-
*/
|
|
5111
|
-
"accept-language"?: string;
|
|
5112
|
-
/**
|
|
5113
|
-
* The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.
|
|
5114
|
-
*/
|
|
5115
|
-
"EP-Channel"?: string;
|
|
5116
|
-
/**
|
|
5117
|
-
* Product tags are used to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. You can enhance your product list using tags, enabling you to refine your product list and run targeted promotions. Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.
|
|
5118
|
-
*/
|
|
5119
|
-
"EP-Context-Tag"?: string;
|
|
5120
|
-
};
|
|
5121
|
-
path?: never;
|
|
5122
|
-
query?: never;
|
|
5123
|
-
url: "/catalog";
|
|
5124
|
-
};
|
|
5125
|
-
export type GetByContextReleaseErrors = {
|
|
5031
|
+
export type Address = {
|
|
5126
5032
|
/**
|
|
5127
|
-
*
|
|
5033
|
+
* Specifies the the type of object. Set this value to `address`.
|
|
5128
5034
|
*/
|
|
5129
|
-
|
|
5130
|
-
};
|
|
5131
|
-
export type GetByContextReleaseError = GetByContextReleaseErrors[keyof GetByContextReleaseErrors];
|
|
5132
|
-
export type GetByContextReleaseResponses = {
|
|
5035
|
+
type?: string;
|
|
5133
5036
|
/**
|
|
5134
|
-
* The
|
|
5037
|
+
* The first name of the recipient on this address.
|
|
5135
5038
|
*/
|
|
5136
|
-
|
|
5039
|
+
first_name?: string;
|
|
5040
|
+
/**
|
|
5041
|
+
* The last name of the recipient on this address.
|
|
5042
|
+
*/
|
|
5043
|
+
last_name?: string;
|
|
5044
|
+
/**
|
|
5045
|
+
* The name for the address saved, such as `home`, `work` or `wife’s office`.
|
|
5046
|
+
*/
|
|
5047
|
+
name?: string;
|
|
5048
|
+
/**
|
|
5049
|
+
* A phone number for this address.
|
|
5050
|
+
*/
|
|
5051
|
+
phone_number?: string;
|
|
5052
|
+
/**
|
|
5053
|
+
* Any delivery instructions for this address.
|
|
5054
|
+
*/
|
|
5055
|
+
instructions?: string;
|
|
5056
|
+
/**
|
|
5057
|
+
* The company name at this address.
|
|
5058
|
+
*/
|
|
5059
|
+
company_name?: string;
|
|
5060
|
+
/**
|
|
5061
|
+
* The first portion of the address, usually the street address.
|
|
5062
|
+
*/
|
|
5063
|
+
line_1?: string;
|
|
5064
|
+
/**
|
|
5065
|
+
* The second portion of the address, usually an apartment or unit number.
|
|
5066
|
+
*/
|
|
5067
|
+
line_2?: string;
|
|
5068
|
+
/**
|
|
5069
|
+
* The city for this address.
|
|
5070
|
+
*/
|
|
5071
|
+
city?: string;
|
|
5072
|
+
/**
|
|
5073
|
+
* The county for this address.
|
|
5074
|
+
*/
|
|
5075
|
+
county?: string;
|
|
5076
|
+
/**
|
|
5077
|
+
* The state, province, territory, etc. for this address.
|
|
5078
|
+
*/
|
|
5079
|
+
region?: string;
|
|
5080
|
+
/**
|
|
5081
|
+
* The ZIP Code, Postcode, or other postal reference string for this delivery address.
|
|
5082
|
+
*/
|
|
5083
|
+
postcode?: string;
|
|
5084
|
+
/**
|
|
5085
|
+
* A two digit code for the country this address is in, expressed as per the ISO 3166-2 standard.
|
|
5086
|
+
*/
|
|
5087
|
+
country?: string;
|
|
5137
5088
|
};
|
|
5138
|
-
export type
|
|
5139
|
-
|
|
5140
|
-
|
|
5141
|
-
|
|
5142
|
-
|
|
5143
|
-
|
|
5144
|
-
|
|
5145
|
-
"accept-language"?: string;
|
|
5146
|
-
/**
|
|
5147
|
-
* The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.
|
|
5148
|
-
*/
|
|
5149
|
-
"EP-Channel"?: string;
|
|
5089
|
+
export type AddressResponse = Address & {
|
|
5090
|
+
/**
|
|
5091
|
+
* The unique identifier for an Address.
|
|
5092
|
+
*/
|
|
5093
|
+
id?: string;
|
|
5094
|
+
meta?: AccountAddressesMetaTimestamps;
|
|
5095
|
+
links?: {
|
|
5150
5096
|
/**
|
|
5151
|
-
*
|
|
5097
|
+
* A URL to the specific resource.
|
|
5152
5098
|
*/
|
|
5153
|
-
|
|
5099
|
+
self?: string;
|
|
5154
5100
|
};
|
|
5155
|
-
|
|
5156
|
-
|
|
5157
|
-
|
|
5158
|
-
|
|
5159
|
-
|
|
5160
|
-
|
|
5161
|
-
|
|
5101
|
+
};
|
|
5102
|
+
export type AccountAddressResponse = AddressResponse & {
|
|
5103
|
+
relationships?: {
|
|
5104
|
+
account?: {
|
|
5105
|
+
/**
|
|
5106
|
+
* The ID of the account.
|
|
5107
|
+
*/
|
|
5108
|
+
id?: string;
|
|
5109
|
+
/**
|
|
5110
|
+
* The type of object being returned.
|
|
5111
|
+
*/
|
|
5112
|
+
type?: string;
|
|
5113
|
+
};
|
|
5114
|
+
};
|
|
5115
|
+
};
|
|
5116
|
+
/**
|
|
5117
|
+
* Bad Request
|
|
5118
|
+
*/
|
|
5119
|
+
export type ErrorBadRequest = unknown;
|
|
5120
|
+
/**
|
|
5121
|
+
* Not Found
|
|
5122
|
+
*/
|
|
5123
|
+
export type ErrorNotFound = unknown;
|
|
5124
|
+
export type AccountAddressesMetaTimestamps = {
|
|
5125
|
+
timestamps?: {
|
|
5162
5126
|
/**
|
|
5163
|
-
* The
|
|
5127
|
+
* The date the address is created.
|
|
5164
5128
|
*/
|
|
5165
|
-
|
|
5129
|
+
created_at?: string;
|
|
5166
5130
|
/**
|
|
5167
|
-
* The
|
|
5131
|
+
* The date the address is updated.
|
|
5168
5132
|
*/
|
|
5169
|
-
|
|
5133
|
+
updated_at?: string;
|
|
5170
5134
|
};
|
|
5171
|
-
url: "/catalog/hierarchies";
|
|
5172
5135
|
};
|
|
5173
|
-
export type
|
|
5136
|
+
export type AccountAddressesError = {
|
|
5174
5137
|
/**
|
|
5175
|
-
*
|
|
5138
|
+
* The HTTP response code of the error.
|
|
5176
5139
|
*/
|
|
5177
|
-
|
|
5178
|
-
};
|
|
5179
|
-
export type GetByContextAllHierarchiesError = GetByContextAllHierarchiesErrors[keyof GetByContextAllHierarchiesErrors];
|
|
5180
|
-
export type GetByContextAllHierarchiesResponses = {
|
|
5140
|
+
status?: string;
|
|
5181
5141
|
/**
|
|
5182
|
-
*
|
|
5142
|
+
* A brief summary of the error.
|
|
5183
5143
|
*/
|
|
5184
|
-
|
|
5144
|
+
title?: string;
|
|
5145
|
+
/**
|
|
5146
|
+
* Optional additional detail about the error.
|
|
5147
|
+
*/
|
|
5148
|
+
detail?: string;
|
|
5185
5149
|
};
|
|
5186
|
-
export type
|
|
5187
|
-
|
|
5188
|
-
body?: never;
|
|
5189
|
-
headers?: {
|
|
5190
|
-
/**
|
|
5191
|
-
* The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).
|
|
5192
|
-
*/
|
|
5193
|
-
"accept-language"?: string;
|
|
5194
|
-
/**
|
|
5195
|
-
* The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.
|
|
5196
|
-
*/
|
|
5197
|
-
"EP-Channel"?: string;
|
|
5198
|
-
/**
|
|
5199
|
-
* Product tags are used to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. You can enhance your product list using tags, enabling you to refine your product list and run targeted promotions. Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.
|
|
5200
|
-
*/
|
|
5201
|
-
"EP-Context-Tag"?: string;
|
|
5202
|
-
};
|
|
5203
|
-
path: {
|
|
5204
|
-
/**
|
|
5205
|
-
* The catalog hierarchy ID.
|
|
5206
|
-
*/
|
|
5207
|
-
hierarchy_id: string;
|
|
5208
|
-
};
|
|
5209
|
-
query?: never;
|
|
5210
|
-
url: "/catalog/hierarchies/{hierarchy_id}";
|
|
5150
|
+
export type AccountAddressesErrorResponse = {
|
|
5151
|
+
errors: Array<AccountAddressesError>;
|
|
5211
5152
|
};
|
|
5212
|
-
|
|
5153
|
+
/**
|
|
5154
|
+
* The unique identifier.
|
|
5155
|
+
*/
|
|
5156
|
+
export type Uuid = string;
|
|
5157
|
+
export type MetaListPage = {
|
|
5213
5158
|
/**
|
|
5214
|
-
* The
|
|
5159
|
+
* The maximum number of records per page for this response. You can set this value up to 100.
|
|
5215
5160
|
*/
|
|
5216
|
-
|
|
5217
|
-
};
|
|
5218
|
-
export type GetByContextHierarchyError = GetByContextHierarchyErrors[keyof GetByContextHierarchyErrors];
|
|
5219
|
-
export type GetByContextHierarchyResponses = {
|
|
5161
|
+
limit?: number;
|
|
5220
5162
|
/**
|
|
5221
|
-
* The
|
|
5163
|
+
* The current page.
|
|
5222
5164
|
*/
|
|
5223
|
-
|
|
5224
|
-
|
|
5165
|
+
current?: number;
|
|
5166
|
+
/**
|
|
5167
|
+
* The current offset by number of records, not pages. Offset is zero-based.
|
|
5168
|
+
*/
|
|
5169
|
+
offset?: number;
|
|
5170
|
+
/**
|
|
5171
|
+
* The total page count.
|
|
5172
|
+
*/
|
|
5173
|
+
total?: number;
|
|
5174
|
+
};
|
|
5175
|
+
export type MetaListResults = {
|
|
5176
|
+
/**
|
|
5177
|
+
* The total number of results after applying filters, if any, or all results.
|
|
5178
|
+
*/
|
|
5179
|
+
total?: number;
|
|
5180
|
+
};
|
|
5181
|
+
export type MetaList = {
|
|
5182
|
+
page?: MetaListPage;
|
|
5183
|
+
results?: MetaListResults;
|
|
5184
|
+
};
|
|
5185
|
+
export type Account = {
|
|
5186
|
+
/**
|
|
5187
|
+
* Specifies the the type of object. Set this value to `account`.
|
|
5188
|
+
*/
|
|
5189
|
+
type: string;
|
|
5190
|
+
/**
|
|
5191
|
+
* Specifies the name of the account.
|
|
5192
|
+
*/
|
|
5193
|
+
name: string;
|
|
5194
|
+
/**
|
|
5195
|
+
* Specifies the legal name of the account.
|
|
5196
|
+
*/
|
|
5197
|
+
legal_name?: string | null;
|
|
5198
|
+
/**
|
|
5199
|
+
* Specifies the registration ID. If specified, this field is checked for uniqueness.
|
|
5200
|
+
*/
|
|
5201
|
+
registration_id?: string | null;
|
|
5202
|
+
/**
|
|
5203
|
+
* The unique attribute associated with the account. For example, this could be an external reference from a separate company system. The maximum length is 2048 characters. Default is `null`.
|
|
5204
|
+
*/
|
|
5205
|
+
external_ref?: string;
|
|
5206
|
+
};
|
|
5207
|
+
export type ReadOnlyParentId = {
|
|
5208
|
+
/**
|
|
5209
|
+
* Specifies the ID of the parent account.
|
|
5210
|
+
*/
|
|
5211
|
+
readonly parent_id?: string | null;
|
|
5212
|
+
};
|
|
5213
|
+
export type WritableParentId = {
|
|
5214
|
+
/**
|
|
5215
|
+
* Specifies the ID of the parent account, this field cannot be changed after creation.
|
|
5216
|
+
*/
|
|
5217
|
+
parent_id?: string | null;
|
|
5218
|
+
};
|
|
5219
|
+
export type AccountResponse = Account & ReadOnlyParentId & {
|
|
5220
|
+
/**
|
|
5221
|
+
* The unique identifier for an Account.
|
|
5222
|
+
*/
|
|
5223
|
+
id?: Uuid;
|
|
5224
|
+
/**
|
|
5225
|
+
* Additional information for this realm. For more information, see [The meta object](https://elasticpath.dev/docs/commerce-cloud/accounts/using-account-management-api/account-management-api-overview#the-meta-object) section.
|
|
5226
|
+
*/
|
|
5227
|
+
meta?: AccountManagementMetaTimestamps;
|
|
5228
|
+
links?: {
|
|
5229
|
+
/**
|
|
5230
|
+
* A URL to the specific resource.
|
|
5231
|
+
*/
|
|
5232
|
+
self?: string;
|
|
5233
|
+
};
|
|
5234
|
+
};
|
|
5235
|
+
/**
|
|
5236
|
+
* Whether a user with [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) can update their own account member details. By default, this is disabled. Set to `update_only` if you want the user to update their own account member details. The user can update their own account member details by updating [User Authentication Info](/docs/authentication/single-sign-on/user-authentication-info-api/overview) and [User Authentication Password Profile Info](/docs/authentication/single-sign-on/user-authentication-password-profiles-api/password-profile-overview).
|
|
5237
|
+
*/
|
|
5238
|
+
export type AccountMemberSelfManagement = "disabled" | "update_only";
|
|
5239
|
+
export type AccountAuthenticationSettings = {
|
|
5240
|
+
/**
|
|
5241
|
+
* Specifies the the type of object. Set this value to `account_authentication_settings`.
|
|
5242
|
+
*/
|
|
5243
|
+
type?: string;
|
|
5244
|
+
/**
|
|
5245
|
+
* Set to `true` to enable self signup.
|
|
5246
|
+
*/
|
|
5247
|
+
enable_self_signup?: boolean;
|
|
5248
|
+
/**
|
|
5249
|
+
* This will automatically create an account for each new account member, using the account member’s name as the account name.
|
|
5250
|
+
*/
|
|
5251
|
+
auto_create_account_for_account_members?: boolean;
|
|
5252
|
+
/**
|
|
5253
|
+
* Whether a user with [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) can update their own account member details. By default, this is disabled. Set to `update_only` if you want the user to update their own account member details. The user can update their own account member details by updating [User Authentication Info](/docs/authentication/single-sign-on/user-authentication-info-api/overview) and [User Authentication Password Profile Info](/docs/authentication/single-sign-on/user-authentication-password-profiles-api/password-profile-overview).
|
|
5254
|
+
*/
|
|
5255
|
+
account_member_self_management?: "disabled" | "update_only";
|
|
5256
|
+
/**
|
|
5257
|
+
* The expiry time for Account Management Authentication Token in seconds. If you want to implement idle timout for you application, see [Implementing Idle Timeout](/guides/How-To/Accounts/implement-idle-timeout)
|
|
5258
|
+
*/
|
|
5259
|
+
account_management_authentication_token_timeout_secs?: number;
|
|
5260
|
+
};
|
|
5261
|
+
export type AccountAuthenticationSettingsResponse = AccountAuthenticationSettings & {
|
|
5262
|
+
id?: Uuid;
|
|
5263
|
+
relationships?: {
|
|
5264
|
+
authentication_realm?: {
|
|
5265
|
+
data?: {
|
|
5266
|
+
/**
|
|
5267
|
+
* The ID of the authentication realm entity.
|
|
5268
|
+
*/
|
|
5269
|
+
id?: string;
|
|
5270
|
+
/**
|
|
5271
|
+
* The type of the authentication realm entity.
|
|
5272
|
+
*/
|
|
5273
|
+
type?: string;
|
|
5274
|
+
links?: {
|
|
5275
|
+
/**
|
|
5276
|
+
* A URL to the specific resource.
|
|
5277
|
+
*/
|
|
5278
|
+
self?: string;
|
|
5279
|
+
};
|
|
5280
|
+
};
|
|
5281
|
+
};
|
|
5282
|
+
};
|
|
5283
|
+
meta?: {
|
|
5284
|
+
/**
|
|
5285
|
+
* The client ID to be used in Single Sign On authentication flows for accounts.
|
|
5286
|
+
*/
|
|
5287
|
+
client_id?: string;
|
|
5288
|
+
};
|
|
5289
|
+
links?: {
|
|
5290
|
+
/**
|
|
5291
|
+
* A URL to the specific resource.
|
|
5292
|
+
*/
|
|
5293
|
+
self?: string;
|
|
5294
|
+
};
|
|
5295
|
+
};
|
|
5296
|
+
export type AccountMembershipSettings = {
|
|
5297
|
+
data?: {
|
|
5298
|
+
/**
|
|
5299
|
+
* Specifies the the type of object. Set this value to `account_membership_setting`.
|
|
5300
|
+
*/
|
|
5301
|
+
type?: "account_membership_setting";
|
|
5302
|
+
/**
|
|
5303
|
+
* The number of accounts an account member can be associated with. You can set this value to any number up to 10,000.
|
|
5304
|
+
*/
|
|
5305
|
+
membership_limit?: number;
|
|
5306
|
+
};
|
|
5307
|
+
};
|
|
5308
|
+
export type AccountMember = {
|
|
5309
|
+
/**
|
|
5310
|
+
* The unique identifier for the account member.
|
|
5311
|
+
*/
|
|
5312
|
+
id?: string;
|
|
5313
|
+
/**
|
|
5314
|
+
* The type of the object that is returned.
|
|
5315
|
+
*/
|
|
5316
|
+
type?: string;
|
|
5317
|
+
/**
|
|
5318
|
+
* The name of the account member.
|
|
5319
|
+
*/
|
|
5320
|
+
name?: string;
|
|
5321
|
+
/**
|
|
5322
|
+
* The email address of the account member.
|
|
5323
|
+
*/
|
|
5324
|
+
email?: string;
|
|
5325
|
+
};
|
|
5326
|
+
export type AccountMemberResponse = AccountMember & {
|
|
5327
|
+
meta?: AccountManagementMetaTimestamps;
|
|
5328
|
+
links?: {
|
|
5329
|
+
/**
|
|
5330
|
+
* A URL to the specific resource.
|
|
5331
|
+
*/
|
|
5332
|
+
self?: string;
|
|
5333
|
+
};
|
|
5334
|
+
};
|
|
5335
|
+
export type AccountMembership = {
|
|
5336
|
+
/**
|
|
5337
|
+
* Specifies the unique identifier of the account member that the membership is associated with.
|
|
5338
|
+
*/
|
|
5339
|
+
account_member_id?: string;
|
|
5340
|
+
/**
|
|
5341
|
+
* Specifies the type of the object. Set this value to `account_membership`.
|
|
5342
|
+
*/
|
|
5343
|
+
type?: string;
|
|
5344
|
+
};
|
|
5345
|
+
export type AccountMembershipResponse = {
|
|
5346
|
+
/**
|
|
5347
|
+
* Represents the unique identifier for the account membership.
|
|
5348
|
+
*/
|
|
5349
|
+
id?: string;
|
|
5350
|
+
/**
|
|
5351
|
+
* Represents the type of the object returned.
|
|
5352
|
+
*/
|
|
5353
|
+
type?: string;
|
|
5354
|
+
meta?: AccountManagementMetaTimestamps;
|
|
5355
|
+
relationships?: {
|
|
5356
|
+
account_member?: {
|
|
5357
|
+
data?: {
|
|
5358
|
+
/**
|
|
5359
|
+
* Specifies the ID of the account member.
|
|
5360
|
+
*/
|
|
5361
|
+
id?: string;
|
|
5362
|
+
/**
|
|
5363
|
+
* Specifies the type of the account member.
|
|
5364
|
+
*/
|
|
5365
|
+
type?: string;
|
|
5366
|
+
};
|
|
5367
|
+
};
|
|
5368
|
+
};
|
|
5369
|
+
links?: {
|
|
5370
|
+
/**
|
|
5371
|
+
* A URL to the specific resource.
|
|
5372
|
+
*/
|
|
5373
|
+
self?: string;
|
|
5374
|
+
};
|
|
5375
|
+
};
|
|
5376
|
+
export type AccountMembershipResponseUsingAccountMemberId = {
|
|
5377
|
+
/**
|
|
5378
|
+
* Represents the unique identifier for the account membership.
|
|
5379
|
+
*/
|
|
5380
|
+
id?: string;
|
|
5381
|
+
/**
|
|
5382
|
+
* Represents the type of the object returned.
|
|
5383
|
+
*/
|
|
5384
|
+
type?: string;
|
|
5385
|
+
meta?: AccountManagementMetaTimestamps;
|
|
5386
|
+
relationships?: {
|
|
5387
|
+
account?: {
|
|
5388
|
+
data?: {
|
|
5389
|
+
/**
|
|
5390
|
+
* Specifies the ID of the account.
|
|
5391
|
+
*/
|
|
5392
|
+
id?: string;
|
|
5393
|
+
/**
|
|
5394
|
+
* Specifies the type of the Account.
|
|
5395
|
+
*/
|
|
5396
|
+
type?: string;
|
|
5397
|
+
};
|
|
5398
|
+
};
|
|
5399
|
+
};
|
|
5400
|
+
links?: {
|
|
5401
|
+
/**
|
|
5402
|
+
* A URL to the specific resource.
|
|
5403
|
+
*/
|
|
5404
|
+
self?: string;
|
|
5405
|
+
};
|
|
5406
|
+
};
|
|
5407
|
+
export type AccountManagementAuthenticationToken = {
|
|
5408
|
+
/**
|
|
5409
|
+
* Specifies the type of the object. You must use `account_management_authentication_token`.
|
|
5410
|
+
*/
|
|
5411
|
+
type?: string;
|
|
5412
|
+
};
|
|
5413
|
+
export type OpenIdConnectRequest = AccountManagementAuthenticationToken & {
|
|
5414
|
+
/**
|
|
5415
|
+
* Species the authentication mechanism. You must use `oidc`.
|
|
5416
|
+
*/
|
|
5417
|
+
authentication_mechanism: string;
|
|
5418
|
+
/**
|
|
5419
|
+
* Specifies the code returned from the OpenID Connect Provider authentication.
|
|
5420
|
+
*/
|
|
5421
|
+
oauth_authorization_code: string;
|
|
5422
|
+
/**
|
|
5423
|
+
* Specifies the URL of the front-end that handles the callback of the token.
|
|
5424
|
+
*/
|
|
5425
|
+
oauth_redirect_uri: string;
|
|
5426
|
+
/**
|
|
5427
|
+
* Specifies the Proof Key for Code Exchange (PKCE) code verifier corresponding to the code challenge supplied to the authorization endpoint. For more information about code verifier and challenge, see Generating a [Code Verifier and Challenge](https://elasticpath.dev/docs/commerce-cloud/authentication/single-sign-on/get-single-sign-on-customer-token#generate-proof-key-for-code-exchange-pkce-parameters).
|
|
5428
|
+
*/
|
|
5429
|
+
oauth_code_verifier: string;
|
|
5430
|
+
};
|
|
5431
|
+
export type PasswordRequest = AccountManagementAuthenticationToken & {
|
|
5432
|
+
/**
|
|
5433
|
+
* Species the authentication mechanism. You must use `password`.
|
|
5434
|
+
*/
|
|
5435
|
+
authentication_mechanism: string;
|
|
5436
|
+
/**
|
|
5437
|
+
* The password profile ID. For more information, see [password profiles page](https://elasticpath.dev/docs/commerce-cloud/authentication/single-sign-on/password-profiles-api/overview).
|
|
5438
|
+
*/
|
|
5439
|
+
password_profile_id: string;
|
|
5440
|
+
/**
|
|
5441
|
+
* The username.
|
|
5442
|
+
*/
|
|
5443
|
+
username: string;
|
|
5444
|
+
/**
|
|
5445
|
+
* The password.
|
|
5446
|
+
*/
|
|
5447
|
+
password: string;
|
|
5448
|
+
};
|
|
5449
|
+
export type SelfSignupRequest = AccountManagementAuthenticationToken & {
|
|
5450
|
+
/**
|
|
5451
|
+
* Species the authentication mechanism. You must use `self_signup`.
|
|
5452
|
+
*/
|
|
5453
|
+
authentication_mechanism: string;
|
|
5454
|
+
/**
|
|
5455
|
+
* The password profile ID. For more information, see [password profiles page](https://elasticpath.dev/docs/commerce-cloud/authentication/single-sign-on/password-profiles-api/overview).
|
|
5456
|
+
*/
|
|
5457
|
+
password_profile_id: string;
|
|
5458
|
+
/**
|
|
5459
|
+
* The username.
|
|
5460
|
+
*/
|
|
5461
|
+
username: string;
|
|
5462
|
+
/**
|
|
5463
|
+
* The password.
|
|
5464
|
+
*/
|
|
5465
|
+
password: string;
|
|
5466
|
+
/**
|
|
5467
|
+
* The name.
|
|
5468
|
+
*/
|
|
5469
|
+
name: string;
|
|
5470
|
+
/**
|
|
5471
|
+
* The email.
|
|
5472
|
+
*/
|
|
5473
|
+
email: string;
|
|
5474
|
+
};
|
|
5475
|
+
export type PasswordlessRequest = AccountManagementAuthenticationToken & {
|
|
5476
|
+
/**
|
|
5477
|
+
* Species the authentication mechanism. You must use `passwordless`.
|
|
5478
|
+
*/
|
|
5479
|
+
authentication_mechanism: string;
|
|
5480
|
+
/**
|
|
5481
|
+
* The password profile ID. For more information, see [password profiles page](https://elasticpath.dev/docs/commerce-cloud/authentication/single-sign-on/password-profiles-api/overview).
|
|
5482
|
+
*/
|
|
5483
|
+
password_profile_id: string;
|
|
5484
|
+
/**
|
|
5485
|
+
* The username.
|
|
5486
|
+
*/
|
|
5487
|
+
username: string;
|
|
5488
|
+
/**
|
|
5489
|
+
* The one-time password token.
|
|
5490
|
+
*/
|
|
5491
|
+
one_time_password_token: string;
|
|
5492
|
+
};
|
|
5493
|
+
export type SwitchingAccountRequest = AccountManagementAuthenticationToken & {
|
|
5494
|
+
/**
|
|
5495
|
+
* Species the authentication mechanism. You must use `account_management_authentication_token`.
|
|
5496
|
+
*/
|
|
5497
|
+
authentication_mechanism: string;
|
|
5498
|
+
};
|
|
5499
|
+
export type AccountManagementAuthenticationTokenResponse = {
|
|
5500
|
+
/**
|
|
5501
|
+
* Specifies the type of the object.
|
|
5502
|
+
*/
|
|
5503
|
+
type?: string;
|
|
5504
|
+
/**
|
|
5505
|
+
* The name of the account that this token grants access to.
|
|
5506
|
+
*/
|
|
5507
|
+
account_name?: string;
|
|
5508
|
+
/**
|
|
5509
|
+
* The ID of the account that this token grants access to.
|
|
5510
|
+
*/
|
|
5511
|
+
account_id?: string;
|
|
5512
|
+
/**
|
|
5513
|
+
* The JWT authentication token that the shopper uses as the `EP-Account-Management-Authentication-Token` header [in all other endpoints](https://elasticpath.dev/docs/commerce-cloud/authentication/tokens/account-management-authentication-token).
|
|
5514
|
+
*/
|
|
5515
|
+
token?: string;
|
|
5516
|
+
/**
|
|
5517
|
+
* The epoch time that this token expires at. The time is set to 24 hours after the token is generated.
|
|
5518
|
+
*/
|
|
5519
|
+
expires?: Date;
|
|
5520
|
+
};
|
|
5521
|
+
export type AccountManagementMetaTimestamps = {
|
|
5522
|
+
timestamps?: {
|
|
5523
|
+
/**
|
|
5524
|
+
* The date the account is created.
|
|
5525
|
+
*/
|
|
5526
|
+
created_at?: string;
|
|
5527
|
+
/**
|
|
5528
|
+
* The date the account is updated.
|
|
5529
|
+
*/
|
|
5530
|
+
updated_at?: string;
|
|
5531
|
+
};
|
|
5532
|
+
};
|
|
5533
|
+
export type AccountManagementError = {
|
|
5534
|
+
/**
|
|
5535
|
+
* A brief summary of the error.
|
|
5536
|
+
*/
|
|
5537
|
+
title: string;
|
|
5538
|
+
/**
|
|
5539
|
+
* The HTTP response code of the error.
|
|
5540
|
+
*/
|
|
5541
|
+
status: string;
|
|
5542
|
+
/**
|
|
5543
|
+
* Optional additional detail about the error.
|
|
5544
|
+
*/
|
|
5545
|
+
detail?: string;
|
|
5546
|
+
};
|
|
5547
|
+
export type AccountManagementErrorResponse = {
|
|
5548
|
+
errors: Array<AccountManagementError>;
|
|
5549
|
+
};
|
|
5550
|
+
/**
|
|
5551
|
+
* The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).
|
|
5552
|
+
*/
|
|
5553
|
+
export type AcceptLanguage = string;
|
|
5554
|
+
/**
|
|
5555
|
+
* The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.
|
|
5556
|
+
*/
|
|
5557
|
+
export type Channel = string;
|
|
5558
|
+
/**
|
|
5559
|
+
* This endpoints supports filtering. See [Filtering](#filtering).
|
|
5560
|
+
*
|
|
5561
|
+
*/
|
|
5562
|
+
export type FilterHierarchy = string;
|
|
5563
|
+
/**
|
|
5564
|
+
* This endpoint supports filtering, see [Filtering](#filtering).
|
|
5565
|
+
*
|
|
5566
|
+
*/
|
|
5567
|
+
export type FilterNode = string;
|
|
5568
|
+
/**
|
|
5569
|
+
* This endpoints support filtering. See [Filtering](#filtering).
|
|
5570
|
+
*
|
|
5571
|
+
*/
|
|
5572
|
+
export type FilterProduct = string;
|
|
5573
|
+
/**
|
|
5574
|
+
* This endpoint supports filtering. See [Filtering](#filtering).
|
|
5575
|
+
*
|
|
5576
|
+
*/
|
|
5577
|
+
export type FilterRule = string;
|
|
5578
|
+
/**
|
|
5579
|
+
* Using the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products.
|
|
5580
|
+
*
|
|
5581
|
+
*/
|
|
5582
|
+
export type Include = Array<"main_images" | "files" | "component_products">;
|
|
5583
|
+
/**
|
|
5584
|
+
* Using the `include=component_products` parameter, you can retrieve key attribute data for the bundle component products in the product bundle, such as SKU or slug .
|
|
5585
|
+
*
|
|
5586
|
+
*/
|
|
5587
|
+
export type IncludeComponentProducts = string;
|
|
5588
|
+
/**
|
|
5589
|
+
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.
|
|
5590
|
+
*/
|
|
5591
|
+
export type Limit = BigInt;
|
|
5592
|
+
/**
|
|
5593
|
+
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.
|
|
5594
|
+
*/
|
|
5595
|
+
export type Offset = BigInt;
|
|
5596
|
+
/**
|
|
5597
|
+
* Product tags are used to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. You can enhance your product list using tags, enabling you to refine your product list and run targeted promotions. Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.
|
|
5598
|
+
*/
|
|
5599
|
+
export type Tag = string;
|
|
5600
|
+
export type CartInclude2 = Array<"items">;
|
|
5601
|
+
/**
|
|
5602
|
+
* A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
|
|
5603
|
+
*/
|
|
5604
|
+
export type Include2 = string;
|
|
5605
|
+
/**
|
|
5606
|
+
* Some Subscriptions API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.
|
|
5607
|
+
*
|
|
5608
|
+
*/
|
|
5609
|
+
export type SubscriptionsFilter = string;
|
|
5610
|
+
/**
|
|
5611
|
+
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
5612
|
+
*/
|
|
5613
|
+
export type SubscriptionsPageLimit = BigInt;
|
|
5614
|
+
/**
|
|
5615
|
+
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
5616
|
+
*/
|
|
5617
|
+
export type SubscriptionsPageOffset = BigInt;
|
|
5618
|
+
/**
|
|
5619
|
+
* Some Inventories API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.
|
|
5620
|
+
*
|
|
5621
|
+
*/
|
|
5622
|
+
export type InventoriesFilter = string;
|
|
5623
|
+
/**
|
|
5624
|
+
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
5625
|
+
*/
|
|
5626
|
+
export type InventoriesPageLimit = number;
|
|
5627
|
+
/**
|
|
5628
|
+
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
5629
|
+
*/
|
|
5630
|
+
export type InventoriesPageOffset = number;
|
|
5631
|
+
/**
|
|
5632
|
+
* Specifies the filter attributes.
|
|
5633
|
+
*/
|
|
5634
|
+
export type Filter = string;
|
|
5635
|
+
/**
|
|
5636
|
+
* The number of records per page.
|
|
5637
|
+
*/
|
|
5638
|
+
export type PageLimit = BigInt;
|
|
5639
|
+
/**
|
|
5640
|
+
* The number of records to offset the results by.
|
|
5641
|
+
*/
|
|
5642
|
+
export type PageOffset = BigInt;
|
|
5643
|
+
/**
|
|
5644
|
+
* Parameter to retrieve more information about any related resources like account members.
|
|
5645
|
+
*/
|
|
5646
|
+
export type IncludeAccountMember = string;
|
|
5647
|
+
/**
|
|
5648
|
+
* Parameter to retrieve more information about any related resources like accounts.
|
|
5649
|
+
*/
|
|
5650
|
+
export type IncludeAccount = string;
|
|
5651
|
+
/**
|
|
5652
|
+
* Supported attributes are `created_at`, `email`, `id`, `name`, or `updated_at`. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with `-`, for example, `-updated_at`. The default sort order is `created_at` in descending order. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
5653
|
+
*/
|
|
5654
|
+
export type Sort = string;
|
|
5655
|
+
/**
|
|
5656
|
+
* The bundle configuration.
|
|
5657
|
+
*/
|
|
5658
|
+
export type BundleConfigurationData2 = BundleConfigurationData;
|
|
5659
|
+
/**
|
|
5660
|
+
* A list of product id or sku and bundle configuration for cart.
|
|
5661
|
+
*/
|
|
5662
|
+
export type ProductsForCartConfiguration2 = ProductsForCartConfiguration;
|
|
5663
|
+
export type GetByContextReleaseData = {
|
|
5664
|
+
body?: never;
|
|
5665
|
+
headers?: {
|
|
5666
|
+
/**
|
|
5667
|
+
* The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).
|
|
5668
|
+
*/
|
|
5669
|
+
"accept-language"?: string;
|
|
5670
|
+
/**
|
|
5671
|
+
* The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.
|
|
5672
|
+
*/
|
|
5673
|
+
"EP-Channel"?: string;
|
|
5674
|
+
/**
|
|
5675
|
+
* Product tags are used to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. You can enhance your product list using tags, enabling you to refine your product list and run targeted promotions. Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.
|
|
5676
|
+
*/
|
|
5677
|
+
"EP-Context-Tag"?: string;
|
|
5678
|
+
};
|
|
5679
|
+
path?: never;
|
|
5680
|
+
query?: never;
|
|
5681
|
+
url: "/catalog";
|
|
5682
|
+
};
|
|
5683
|
+
export type GetByContextReleaseErrors = {
|
|
5684
|
+
/**
|
|
5685
|
+
* The unexpected error.
|
|
5686
|
+
*/
|
|
5687
|
+
default: ErrorResponse;
|
|
5688
|
+
};
|
|
5689
|
+
export type GetByContextReleaseError = GetByContextReleaseErrors[keyof GetByContextReleaseErrors];
|
|
5690
|
+
export type GetByContextReleaseResponses = {
|
|
5691
|
+
/**
|
|
5692
|
+
* The catalog.
|
|
5693
|
+
*/
|
|
5694
|
+
200: ReleaseData;
|
|
5695
|
+
};
|
|
5696
|
+
export type GetByContextReleaseResponse = GetByContextReleaseResponses[keyof GetByContextReleaseResponses];
|
|
5697
|
+
export type GetByContextAllHierarchiesData = {
|
|
5698
|
+
body?: never;
|
|
5699
|
+
headers?: {
|
|
5700
|
+
/**
|
|
5701
|
+
* The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).
|
|
5702
|
+
*/
|
|
5703
|
+
"accept-language"?: string;
|
|
5704
|
+
/**
|
|
5705
|
+
* The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.
|
|
5706
|
+
*/
|
|
5707
|
+
"EP-Channel"?: string;
|
|
5708
|
+
/**
|
|
5709
|
+
* Product tags are used to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. You can enhance your product list using tags, enabling you to refine your product list and run targeted promotions. Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.
|
|
5710
|
+
*/
|
|
5711
|
+
"EP-Context-Tag"?: string;
|
|
5712
|
+
};
|
|
5713
|
+
path?: never;
|
|
5714
|
+
query?: {
|
|
5715
|
+
/**
|
|
5716
|
+
* This endpoints supports filtering. See [Filtering](#filtering).
|
|
5717
|
+
*
|
|
5718
|
+
*/
|
|
5719
|
+
filter?: string;
|
|
5720
|
+
/**
|
|
5721
|
+
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.
|
|
5722
|
+
*/
|
|
5723
|
+
"page[limit]"?: BigInt;
|
|
5724
|
+
/**
|
|
5725
|
+
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.
|
|
5726
|
+
*/
|
|
5727
|
+
"page[offset]"?: BigInt;
|
|
5728
|
+
};
|
|
5729
|
+
url: "/catalog/hierarchies";
|
|
5730
|
+
};
|
|
5731
|
+
export type GetByContextAllHierarchiesErrors = {
|
|
5732
|
+
/**
|
|
5733
|
+
* An unexpected error.
|
|
5734
|
+
*/
|
|
5735
|
+
default: ErrorResponse;
|
|
5736
|
+
};
|
|
5737
|
+
export type GetByContextAllHierarchiesError = GetByContextAllHierarchiesErrors[keyof GetByContextAllHierarchiesErrors];
|
|
5738
|
+
export type GetByContextAllHierarchiesResponses = {
|
|
5739
|
+
/**
|
|
5740
|
+
* The hierarchies of the catalog.
|
|
5741
|
+
*/
|
|
5742
|
+
200: HierarchyListData;
|
|
5743
|
+
};
|
|
5744
|
+
export type GetByContextAllHierarchiesResponse = GetByContextAllHierarchiesResponses[keyof GetByContextAllHierarchiesResponses];
|
|
5745
|
+
export type GetByContextHierarchyData = {
|
|
5746
|
+
body?: never;
|
|
5747
|
+
headers?: {
|
|
5748
|
+
/**
|
|
5749
|
+
* The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).
|
|
5750
|
+
*/
|
|
5751
|
+
"accept-language"?: string;
|
|
5752
|
+
/**
|
|
5753
|
+
* The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the `EP-Channel` header in your requests.
|
|
5754
|
+
*/
|
|
5755
|
+
"EP-Channel"?: string;
|
|
5756
|
+
/**
|
|
5757
|
+
* Product tags are used to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. You can enhance your product list using tags, enabling you to refine your product list and run targeted promotions. Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.
|
|
5758
|
+
*/
|
|
5759
|
+
"EP-Context-Tag"?: string;
|
|
5760
|
+
};
|
|
5761
|
+
path: {
|
|
5762
|
+
/**
|
|
5763
|
+
* The catalog hierarchy ID.
|
|
5764
|
+
*/
|
|
5765
|
+
hierarchy_id: string;
|
|
5766
|
+
};
|
|
5767
|
+
query?: never;
|
|
5768
|
+
url: "/catalog/hierarchies/{hierarchy_id}";
|
|
5769
|
+
};
|
|
5770
|
+
export type GetByContextHierarchyErrors = {
|
|
5771
|
+
/**
|
|
5772
|
+
* The unexpected error.
|
|
5773
|
+
*/
|
|
5774
|
+
default: ErrorResponse;
|
|
5775
|
+
};
|
|
5776
|
+
export type GetByContextHierarchyError = GetByContextHierarchyErrors[keyof GetByContextHierarchyErrors];
|
|
5777
|
+
export type GetByContextHierarchyResponses = {
|
|
5778
|
+
/**
|
|
5779
|
+
* The catalog hierarchy.
|
|
5780
|
+
*/
|
|
5781
|
+
200: HierarchyData;
|
|
5782
|
+
};
|
|
5225
5783
|
export type GetByContextHierarchyResponse = GetByContextHierarchyResponses[keyof GetByContextHierarchyResponses];
|
|
5226
5784
|
export type GetByContextHierarchyNodesData = {
|
|
5227
5785
|
body?: never;
|
|
@@ -5752,7 +6310,12 @@ export type GetByContextProductsForNodeData = {
|
|
|
5752
6310
|
/**
|
|
5753
6311
|
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.
|
|
5754
6312
|
*/
|
|
5755
|
-
"page[offset]"?: BigInt;
|
|
6313
|
+
"page[offset]"?: BigInt;
|
|
6314
|
+
/**
|
|
6315
|
+
* Using the `include` parameter, you can retrieve top-level resources, such as, files or main image, bundle component products.
|
|
6316
|
+
*
|
|
6317
|
+
*/
|
|
6318
|
+
include?: Array<"main_images" | "files" | "component_products">;
|
|
5756
6319
|
};
|
|
5757
6320
|
url: "/catalog/nodes/{node_id}/relationships/products";
|
|
5758
6321
|
};
|
|
@@ -7958,70 +8521,350 @@ export type GetATransactionData = {
|
|
|
7958
8521
|
body?: never;
|
|
7959
8522
|
path: {
|
|
7960
8523
|
/**
|
|
7961
|
-
* The unique identifier of the order that you require transactions for.
|
|
8524
|
+
* The unique identifier of the order that you require transactions for.
|
|
8525
|
+
*/
|
|
8526
|
+
orderID: string;
|
|
8527
|
+
/**
|
|
8528
|
+
* The unique identifier of the transaction.
|
|
8529
|
+
*/
|
|
8530
|
+
transactionID: string;
|
|
8531
|
+
};
|
|
8532
|
+
query?: never;
|
|
8533
|
+
url: "/v2/orders/{orderID}/transactions/{transactionID}";
|
|
8534
|
+
};
|
|
8535
|
+
export type GetATransactionErrors = {
|
|
8536
|
+
/**
|
|
8537
|
+
* Unauthorized
|
|
8538
|
+
*/
|
|
8539
|
+
401: ResponseError;
|
|
8540
|
+
};
|
|
8541
|
+
export type GetATransactionError = GetATransactionErrors[keyof GetATransactionErrors];
|
|
8542
|
+
export type GetATransactionResponses = {
|
|
8543
|
+
200: ResponseData & {
|
|
8544
|
+
data?: TransactionResponse;
|
|
8545
|
+
};
|
|
8546
|
+
};
|
|
8547
|
+
export type GetATransactionResponse = GetATransactionResponses[keyof GetATransactionResponses];
|
|
8548
|
+
export type CancelATransactionData = {
|
|
8549
|
+
body?: OrdersTransactionsCancelRequest;
|
|
8550
|
+
path: {
|
|
8551
|
+
/**
|
|
8552
|
+
* The unique identifier of the order.
|
|
8553
|
+
*/
|
|
8554
|
+
orderID: string;
|
|
8555
|
+
/**
|
|
8556
|
+
* The unique identifier of the transaction to be canceled or voided.
|
|
8557
|
+
*/
|
|
8558
|
+
transactionID: string;
|
|
8559
|
+
};
|
|
8560
|
+
query?: never;
|
|
8561
|
+
url: "/v2/orders/{orderID}/transactions/{transactionID}/cancel";
|
|
8562
|
+
};
|
|
8563
|
+
export type CancelATransactionErrors = {
|
|
8564
|
+
/**
|
|
8565
|
+
* Unauthorized
|
|
8566
|
+
*/
|
|
8567
|
+
401: ResponseError;
|
|
8568
|
+
};
|
|
8569
|
+
export type CancelATransactionError = CancelATransactionErrors[keyof CancelATransactionErrors];
|
|
8570
|
+
export type CancelATransactionResponses = {
|
|
8571
|
+
200: ResponseData & {
|
|
8572
|
+
data?: TransactionResponse;
|
|
8573
|
+
};
|
|
8574
|
+
};
|
|
8575
|
+
export type CancelATransactionResponse = CancelATransactionResponses[keyof CancelATransactionResponses];
|
|
8576
|
+
export type GetSubscriptionProductData = {
|
|
8577
|
+
body?: never;
|
|
8578
|
+
path: {
|
|
8579
|
+
/**
|
|
8580
|
+
* The unique identifier of a product.
|
|
8581
|
+
*/
|
|
8582
|
+
product_uuid: SubscriptionsUuid;
|
|
8583
|
+
};
|
|
8584
|
+
query?: never;
|
|
8585
|
+
url: "/v2/subscriptions/products/{product_uuid}";
|
|
8586
|
+
};
|
|
8587
|
+
export type GetSubscriptionProductErrors = {
|
|
8588
|
+
/**
|
|
8589
|
+
* Bad request. The request failed validation.
|
|
8590
|
+
*/
|
|
8591
|
+
400: SubscriptionsErrorResponse;
|
|
8592
|
+
/**
|
|
8593
|
+
* Not found. The requested entity does not exist.
|
|
8594
|
+
*/
|
|
8595
|
+
404: SubscriptionsErrorResponse;
|
|
8596
|
+
/**
|
|
8597
|
+
* Internal server error. There was a system failure in the platform.
|
|
8598
|
+
*/
|
|
8599
|
+
500: SubscriptionsErrorResponse;
|
|
8600
|
+
};
|
|
8601
|
+
export type GetSubscriptionProductError = GetSubscriptionProductErrors[keyof GetSubscriptionProductErrors];
|
|
8602
|
+
export type GetSubscriptionProductResponses = {
|
|
8603
|
+
/**
|
|
8604
|
+
* Success. The product details are returned.
|
|
8605
|
+
*/
|
|
8606
|
+
200: {
|
|
8607
|
+
data?: Product2;
|
|
8608
|
+
};
|
|
8609
|
+
};
|
|
8610
|
+
export type GetSubscriptionProductResponse = GetSubscriptionProductResponses[keyof GetSubscriptionProductResponses];
|
|
8611
|
+
export type GetPlanData = {
|
|
8612
|
+
body?: never;
|
|
8613
|
+
path: {
|
|
8614
|
+
/**
|
|
8615
|
+
* The unique identifier of the plan.
|
|
8616
|
+
*/
|
|
8617
|
+
plan_uuid: SubscriptionsUuid;
|
|
8618
|
+
};
|
|
8619
|
+
query?: never;
|
|
8620
|
+
url: "/v2/subscriptions/plans/{plan_uuid}";
|
|
8621
|
+
};
|
|
8622
|
+
export type GetPlanErrors = {
|
|
8623
|
+
/**
|
|
8624
|
+
* Bad request. The request failed validation.
|
|
8625
|
+
*/
|
|
8626
|
+
400: SubscriptionsErrorResponse;
|
|
8627
|
+
/**
|
|
8628
|
+
* Not found. The requested entity does not exist.
|
|
8629
|
+
*/
|
|
8630
|
+
404: SubscriptionsErrorResponse;
|
|
8631
|
+
/**
|
|
8632
|
+
* Internal server error. There was a system failure in the platform.
|
|
8633
|
+
*/
|
|
8634
|
+
500: SubscriptionsErrorResponse;
|
|
8635
|
+
};
|
|
8636
|
+
export type GetPlanError = GetPlanErrors[keyof GetPlanErrors];
|
|
8637
|
+
export type GetPlanResponses = {
|
|
8638
|
+
/**
|
|
8639
|
+
* Success. The details of the plan are returned.
|
|
8640
|
+
*/
|
|
8641
|
+
200: {
|
|
8642
|
+
data?: Plan;
|
|
8643
|
+
};
|
|
8644
|
+
};
|
|
8645
|
+
export type GetPlanResponse = GetPlanResponses[keyof GetPlanResponses];
|
|
8646
|
+
export type ListOfferingsData = {
|
|
8647
|
+
body?: never;
|
|
8648
|
+
path?: never;
|
|
8649
|
+
query?: {
|
|
8650
|
+
/**
|
|
8651
|
+
* Some Subscriptions API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.
|
|
8652
|
+
*
|
|
8653
|
+
*/
|
|
8654
|
+
filter?: string;
|
|
8655
|
+
/**
|
|
8656
|
+
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8657
|
+
*/
|
|
8658
|
+
"page[offset]"?: BigInt;
|
|
8659
|
+
/**
|
|
8660
|
+
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8661
|
+
*/
|
|
8662
|
+
"page[limit]"?: BigInt;
|
|
8663
|
+
/**
|
|
8664
|
+
* A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
|
|
8665
|
+
*/
|
|
8666
|
+
include?: string;
|
|
8667
|
+
};
|
|
8668
|
+
url: "/v2/subscriptions/offerings";
|
|
8669
|
+
};
|
|
8670
|
+
export type ListOfferingsErrors = {
|
|
8671
|
+
/**
|
|
8672
|
+
* Bad request. The request failed validation.
|
|
8673
|
+
*/
|
|
8674
|
+
400: SubscriptionsErrorResponse;
|
|
8675
|
+
/**
|
|
8676
|
+
* Internal server error. There was a system failure in the platform.
|
|
8677
|
+
*/
|
|
8678
|
+
500: SubscriptionsErrorResponse;
|
|
8679
|
+
};
|
|
8680
|
+
export type ListOfferingsError = ListOfferingsErrors[keyof ListOfferingsErrors];
|
|
8681
|
+
export type ListOfferingsResponses = {
|
|
8682
|
+
/**
|
|
8683
|
+
* Success. A list of offerings is returned.
|
|
8684
|
+
*/
|
|
8685
|
+
200: {
|
|
8686
|
+
data?: Array<Offering>;
|
|
8687
|
+
included?: OfferingIncludes;
|
|
8688
|
+
links?: Links2;
|
|
8689
|
+
};
|
|
8690
|
+
};
|
|
8691
|
+
export type ListOfferingsResponse = ListOfferingsResponses[keyof ListOfferingsResponses];
|
|
8692
|
+
export type GetOfferingData = {
|
|
8693
|
+
body?: never;
|
|
8694
|
+
path: {
|
|
8695
|
+
/**
|
|
8696
|
+
* The unique identifier of the offering.
|
|
8697
|
+
*/
|
|
8698
|
+
offering_uuid: SubscriptionsUuid;
|
|
8699
|
+
};
|
|
8700
|
+
query?: {
|
|
8701
|
+
/**
|
|
8702
|
+
* A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
|
|
8703
|
+
*/
|
|
8704
|
+
include?: string;
|
|
8705
|
+
};
|
|
8706
|
+
url: "/v2/subscriptions/offerings/{offering_uuid}";
|
|
8707
|
+
};
|
|
8708
|
+
export type GetOfferingErrors = {
|
|
8709
|
+
/**
|
|
8710
|
+
* Bad request. The request failed validation.
|
|
8711
|
+
*/
|
|
8712
|
+
400: SubscriptionsErrorResponse;
|
|
8713
|
+
/**
|
|
8714
|
+
* Not found. The requested entity does not exist.
|
|
8715
|
+
*/
|
|
8716
|
+
404: SubscriptionsErrorResponse;
|
|
8717
|
+
/**
|
|
8718
|
+
* Internal server error. There was a system failure in the platform.
|
|
8719
|
+
*/
|
|
8720
|
+
500: SubscriptionsErrorResponse;
|
|
8721
|
+
};
|
|
8722
|
+
export type GetOfferingError = GetOfferingErrors[keyof GetOfferingErrors];
|
|
8723
|
+
export type GetOfferingResponses = {
|
|
8724
|
+
/**
|
|
8725
|
+
* Success. The details of the subscription offering are returned.
|
|
8726
|
+
*/
|
|
8727
|
+
200: {
|
|
8728
|
+
data?: Offering;
|
|
8729
|
+
included?: OfferingIncludes;
|
|
8730
|
+
};
|
|
8731
|
+
};
|
|
8732
|
+
export type GetOfferingResponse = GetOfferingResponses[keyof GetOfferingResponses];
|
|
8733
|
+
export type ListOfferingPlansData = {
|
|
8734
|
+
body?: never;
|
|
8735
|
+
path: {
|
|
8736
|
+
/**
|
|
8737
|
+
* The unique identifier of the offering.
|
|
8738
|
+
*/
|
|
8739
|
+
offering_uuid: SubscriptionsUuid;
|
|
8740
|
+
};
|
|
8741
|
+
query?: {
|
|
8742
|
+
/**
|
|
8743
|
+
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8744
|
+
*/
|
|
8745
|
+
"page[offset]"?: BigInt;
|
|
8746
|
+
/**
|
|
8747
|
+
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8748
|
+
*/
|
|
8749
|
+
"page[limit]"?: BigInt;
|
|
8750
|
+
};
|
|
8751
|
+
url: "/v2/subscriptions/offerings/{offering_uuid}/plans";
|
|
8752
|
+
};
|
|
8753
|
+
export type ListOfferingPlansErrors = {
|
|
8754
|
+
/**
|
|
8755
|
+
* Not found. The requested entity does not exist.
|
|
8756
|
+
*/
|
|
8757
|
+
404: SubscriptionsErrorResponse;
|
|
8758
|
+
/**
|
|
8759
|
+
* Internal server error. There was a system failure in the platform.
|
|
8760
|
+
*/
|
|
8761
|
+
500: SubscriptionsErrorResponse;
|
|
8762
|
+
};
|
|
8763
|
+
export type ListOfferingPlansError = ListOfferingPlansErrors[keyof ListOfferingPlansErrors];
|
|
8764
|
+
export type ListOfferingPlansResponses = {
|
|
8765
|
+
/**
|
|
8766
|
+
* Success. A list of plans attached with the offering is returned.
|
|
8767
|
+
*/
|
|
8768
|
+
200: {
|
|
8769
|
+
data?: Array<OfferingPlan>;
|
|
8770
|
+
links?: Links2;
|
|
8771
|
+
};
|
|
8772
|
+
};
|
|
8773
|
+
export type ListOfferingPlansResponse = ListOfferingPlansResponses[keyof ListOfferingPlansResponses];
|
|
8774
|
+
export type ListOfferingFeaturesData = {
|
|
8775
|
+
body?: never;
|
|
8776
|
+
path: {
|
|
8777
|
+
/**
|
|
8778
|
+
* The unique identifier of the offering.
|
|
7962
8779
|
*/
|
|
7963
|
-
|
|
8780
|
+
offering_uuid: SubscriptionsUuid;
|
|
8781
|
+
};
|
|
8782
|
+
query?: {
|
|
7964
8783
|
/**
|
|
7965
|
-
* The
|
|
8784
|
+
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
7966
8785
|
*/
|
|
7967
|
-
|
|
8786
|
+
"page[offset]"?: BigInt;
|
|
8787
|
+
/**
|
|
8788
|
+
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8789
|
+
*/
|
|
8790
|
+
"page[limit]"?: BigInt;
|
|
7968
8791
|
};
|
|
7969
|
-
|
|
7970
|
-
url: "/v2/orders/{orderID}/transactions/{transactionID}";
|
|
8792
|
+
url: "/v2/subscriptions/offerings/{offering_uuid}/features";
|
|
7971
8793
|
};
|
|
7972
|
-
export type
|
|
8794
|
+
export type ListOfferingFeaturesErrors = {
|
|
7973
8795
|
/**
|
|
7974
|
-
*
|
|
8796
|
+
* Not found. The requested entity does not exist.
|
|
7975
8797
|
*/
|
|
7976
|
-
|
|
8798
|
+
404: SubscriptionsErrorResponse;
|
|
8799
|
+
/**
|
|
8800
|
+
* Internal server error. There was a system failure in the platform.
|
|
8801
|
+
*/
|
|
8802
|
+
500: SubscriptionsErrorResponse;
|
|
7977
8803
|
};
|
|
7978
|
-
export type
|
|
7979
|
-
export type
|
|
7980
|
-
|
|
7981
|
-
|
|
8804
|
+
export type ListOfferingFeaturesError = ListOfferingFeaturesErrors[keyof ListOfferingFeaturesErrors];
|
|
8805
|
+
export type ListOfferingFeaturesResponses = {
|
|
8806
|
+
/**
|
|
8807
|
+
* Success. A list of subscription features attached to the offering is returned.
|
|
8808
|
+
*/
|
|
8809
|
+
200: {
|
|
8810
|
+
data?: Array<OfferingFeature>;
|
|
8811
|
+
links?: Links2;
|
|
7982
8812
|
};
|
|
7983
8813
|
};
|
|
7984
|
-
export type
|
|
7985
|
-
export type
|
|
7986
|
-
body?:
|
|
8814
|
+
export type ListOfferingFeaturesResponse = ListOfferingFeaturesResponses[keyof ListOfferingFeaturesResponses];
|
|
8815
|
+
export type ListOfferingProductsData = {
|
|
8816
|
+
body?: never;
|
|
7987
8817
|
path: {
|
|
7988
8818
|
/**
|
|
7989
|
-
* The unique identifier of the
|
|
8819
|
+
* The unique identifier of the offering.
|
|
7990
8820
|
*/
|
|
7991
|
-
|
|
8821
|
+
offering_uuid: SubscriptionsUuid;
|
|
8822
|
+
};
|
|
8823
|
+
query?: {
|
|
7992
8824
|
/**
|
|
7993
|
-
* The
|
|
8825
|
+
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
7994
8826
|
*/
|
|
7995
|
-
|
|
8827
|
+
"page[offset]"?: BigInt;
|
|
8828
|
+
/**
|
|
8829
|
+
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8830
|
+
*/
|
|
8831
|
+
"page[limit]"?: BigInt;
|
|
7996
8832
|
};
|
|
7997
|
-
|
|
7998
|
-
url: "/v2/orders/{orderID}/transactions/{transactionID}/cancel";
|
|
8833
|
+
url: "/v2/subscriptions/offerings/{offering_uuid}/products";
|
|
7999
8834
|
};
|
|
8000
|
-
export type
|
|
8835
|
+
export type ListOfferingProductsErrors = {
|
|
8001
8836
|
/**
|
|
8002
|
-
*
|
|
8837
|
+
* Not found. The requested entity does not exist.
|
|
8003
8838
|
*/
|
|
8004
|
-
|
|
8839
|
+
404: SubscriptionsErrorResponse;
|
|
8840
|
+
/**
|
|
8841
|
+
* Internal server error. There was a system failure in the platform.
|
|
8842
|
+
*/
|
|
8843
|
+
500: SubscriptionsErrorResponse;
|
|
8005
8844
|
};
|
|
8006
|
-
export type
|
|
8007
|
-
export type
|
|
8008
|
-
|
|
8009
|
-
|
|
8845
|
+
export type ListOfferingProductsError = ListOfferingProductsErrors[keyof ListOfferingProductsErrors];
|
|
8846
|
+
export type ListOfferingProductsResponses = {
|
|
8847
|
+
/**
|
|
8848
|
+
* Success. A list of subscription products attached to the offering is returned.
|
|
8849
|
+
*/
|
|
8850
|
+
200: {
|
|
8851
|
+
data?: Array<OfferingProduct>;
|
|
8852
|
+
links?: Links2;
|
|
8010
8853
|
};
|
|
8011
8854
|
};
|
|
8012
|
-
export type
|
|
8013
|
-
export type
|
|
8855
|
+
export type ListOfferingProductsResponse = ListOfferingProductsResponses[keyof ListOfferingProductsResponses];
|
|
8856
|
+
export type GetFeatureData = {
|
|
8014
8857
|
body?: never;
|
|
8015
8858
|
path: {
|
|
8016
8859
|
/**
|
|
8017
|
-
* The unique identifier of a
|
|
8860
|
+
* The unique identifier of a feature.
|
|
8018
8861
|
*/
|
|
8019
|
-
|
|
8862
|
+
feature_uuid: SubscriptionsUuid;
|
|
8020
8863
|
};
|
|
8021
8864
|
query?: never;
|
|
8022
|
-
url: "/v2/subscriptions/
|
|
8865
|
+
url: "/v2/subscriptions/features/{feature_uuid}";
|
|
8023
8866
|
};
|
|
8024
|
-
export type
|
|
8867
|
+
export type GetFeatureErrors = {
|
|
8025
8868
|
/**
|
|
8026
8869
|
* Bad request. The request failed validation.
|
|
8027
8870
|
*/
|
|
@@ -8035,389 +8878,596 @@ export type GetSubscriptionProductErrors = {
|
|
|
8035
8878
|
*/
|
|
8036
8879
|
500: SubscriptionsErrorResponse;
|
|
8037
8880
|
};
|
|
8038
|
-
export type
|
|
8039
|
-
export type
|
|
8881
|
+
export type GetFeatureError = GetFeatureErrors[keyof GetFeatureErrors];
|
|
8882
|
+
export type GetFeatureResponses = {
|
|
8040
8883
|
/**
|
|
8041
|
-
* Success. The
|
|
8884
|
+
* Success. The feature details are returned.
|
|
8042
8885
|
*/
|
|
8043
8886
|
200: {
|
|
8044
|
-
data?:
|
|
8887
|
+
data?: Feature;
|
|
8045
8888
|
};
|
|
8046
8889
|
};
|
|
8047
|
-
export type
|
|
8048
|
-
export type
|
|
8890
|
+
export type GetFeatureResponse = GetFeatureResponses[keyof GetFeatureResponses];
|
|
8891
|
+
export type GetStockData = {
|
|
8049
8892
|
body?: never;
|
|
8050
8893
|
path: {
|
|
8051
8894
|
/**
|
|
8052
|
-
* The unique identifier of the
|
|
8895
|
+
* The unique identifier of the product.
|
|
8053
8896
|
*/
|
|
8054
|
-
|
|
8897
|
+
product_uuid: InventoriesUuid;
|
|
8055
8898
|
};
|
|
8056
8899
|
query?: never;
|
|
8057
|
-
url: "/v2/
|
|
8900
|
+
url: "/v2/inventories/{product_uuid}";
|
|
8058
8901
|
};
|
|
8059
|
-
export type
|
|
8060
|
-
/**
|
|
8061
|
-
* Bad request. The request failed validation.
|
|
8062
|
-
*/
|
|
8063
|
-
400: SubscriptionsErrorResponse;
|
|
8902
|
+
export type GetStockErrors = {
|
|
8064
8903
|
/**
|
|
8065
8904
|
* Not found. The requested entity does not exist.
|
|
8066
8905
|
*/
|
|
8067
|
-
404:
|
|
8906
|
+
404: InventoriesErrorResponse;
|
|
8068
8907
|
/**
|
|
8069
8908
|
* Internal server error. There was a system failure in the platform.
|
|
8070
8909
|
*/
|
|
8071
|
-
500:
|
|
8910
|
+
500: InventoriesErrorResponse;
|
|
8072
8911
|
};
|
|
8073
|
-
export type
|
|
8074
|
-
export type
|
|
8912
|
+
export type GetStockError = GetStockErrors[keyof GetStockErrors];
|
|
8913
|
+
export type GetStockResponses = {
|
|
8075
8914
|
/**
|
|
8076
|
-
* Success.
|
|
8915
|
+
* Success. Returns the stock for the given product UUID
|
|
8077
8916
|
*/
|
|
8078
8917
|
200: {
|
|
8079
|
-
data
|
|
8918
|
+
data: StockResponse;
|
|
8080
8919
|
};
|
|
8081
8920
|
};
|
|
8082
|
-
export type
|
|
8083
|
-
export type
|
|
8921
|
+
export type GetStockResponse = GetStockResponses[keyof GetStockResponses];
|
|
8922
|
+
export type ListLocationsData = {
|
|
8084
8923
|
body?: never;
|
|
8085
8924
|
path?: never;
|
|
8086
8925
|
query?: {
|
|
8087
8926
|
/**
|
|
8088
|
-
*
|
|
8089
|
-
*
|
|
8090
|
-
*/
|
|
8091
|
-
filter?: string;
|
|
8092
|
-
/**
|
|
8093
|
-
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8927
|
+
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8094
8928
|
*/
|
|
8095
|
-
"page[offset]"?:
|
|
8929
|
+
"page[offset]"?: number;
|
|
8096
8930
|
/**
|
|
8097
|
-
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8931
|
+
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8098
8932
|
*/
|
|
8099
|
-
"page[limit]"?:
|
|
8933
|
+
"page[limit]"?: number;
|
|
8100
8934
|
/**
|
|
8101
|
-
*
|
|
8935
|
+
* Some Inventories API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.
|
|
8936
|
+
*
|
|
8102
8937
|
*/
|
|
8103
|
-
|
|
8938
|
+
filter?: string;
|
|
8104
8939
|
};
|
|
8105
|
-
url: "/v2/
|
|
8940
|
+
url: "/v2/inventories/locations";
|
|
8106
8941
|
};
|
|
8107
|
-
export type
|
|
8942
|
+
export type ListLocationsErrors = {
|
|
8108
8943
|
/**
|
|
8109
8944
|
* Bad request. The request failed validation.
|
|
8110
8945
|
*/
|
|
8111
|
-
400:
|
|
8946
|
+
400: InventoriesErrorResponse;
|
|
8947
|
+
};
|
|
8948
|
+
export type ListLocationsError = ListLocationsErrors[keyof ListLocationsErrors];
|
|
8949
|
+
export type ListLocationsResponses = {
|
|
8950
|
+
/**
|
|
8951
|
+
* Success. A list of locations is returned
|
|
8952
|
+
*/
|
|
8953
|
+
200: {
|
|
8954
|
+
data?: Array<Location>;
|
|
8955
|
+
links?: Links2;
|
|
8956
|
+
};
|
|
8957
|
+
};
|
|
8958
|
+
export type ListLocationsResponse = ListLocationsResponses[keyof ListLocationsResponses];
|
|
8959
|
+
export type CreateAnAccessTokenData = {
|
|
8960
|
+
body?: AccessTokenRequest;
|
|
8961
|
+
path?: never;
|
|
8962
|
+
query?: never;
|
|
8963
|
+
url: "/oauth/access_token";
|
|
8964
|
+
};
|
|
8965
|
+
export type CreateAnAccessTokenErrors = {
|
|
8966
|
+
/**
|
|
8967
|
+
* Bad Request
|
|
8968
|
+
*/
|
|
8969
|
+
400: ErrorResponse2;
|
|
8970
|
+
/**
|
|
8971
|
+
* Unauthorized
|
|
8972
|
+
*/
|
|
8973
|
+
401: ErrorResponse2;
|
|
8112
8974
|
/**
|
|
8113
8975
|
* Internal server error. There was a system failure in the platform.
|
|
8114
8976
|
*/
|
|
8115
|
-
|
|
8977
|
+
default: ErrorResponse2;
|
|
8116
8978
|
};
|
|
8117
|
-
export type
|
|
8118
|
-
export type
|
|
8979
|
+
export type CreateAnAccessTokenError = CreateAnAccessTokenErrors[keyof CreateAnAccessTokenErrors];
|
|
8980
|
+
export type CreateAnAccessTokenResponses = {
|
|
8119
8981
|
/**
|
|
8120
|
-
*
|
|
8982
|
+
* OK
|
|
8983
|
+
*/
|
|
8984
|
+
200: AccessTokenResponse;
|
|
8985
|
+
};
|
|
8986
|
+
export type CreateAnAccessTokenResponse = CreateAnAccessTokenResponses[keyof CreateAnAccessTokenResponses];
|
|
8987
|
+
export type GetV2AccountAddressesData = {
|
|
8988
|
+
body?: never;
|
|
8989
|
+
path: {
|
|
8990
|
+
/**
|
|
8991
|
+
* The ID of the account you want to retrieve.
|
|
8992
|
+
*/
|
|
8993
|
+
accountID: string;
|
|
8994
|
+
};
|
|
8995
|
+
query?: never;
|
|
8996
|
+
url: "/v2/accounts/{accountID}/addresses";
|
|
8997
|
+
};
|
|
8998
|
+
export type GetV2AccountAddressesErrors = {
|
|
8999
|
+
/**
|
|
9000
|
+
* Not Found
|
|
9001
|
+
*/
|
|
9002
|
+
404: AccountAddressesErrorResponse;
|
|
9003
|
+
};
|
|
9004
|
+
export type GetV2AccountAddressesError = GetV2AccountAddressesErrors[keyof GetV2AccountAddressesErrors];
|
|
9005
|
+
export type GetV2AccountAddressesResponses = {
|
|
9006
|
+
/**
|
|
9007
|
+
* OK
|
|
8121
9008
|
*/
|
|
8122
9009
|
200: {
|
|
8123
|
-
data?: Array<
|
|
8124
|
-
included?: OfferingIncludes;
|
|
8125
|
-
links?: Links2;
|
|
9010
|
+
data?: Array<AccountAddressResponse>;
|
|
8126
9011
|
};
|
|
8127
9012
|
};
|
|
8128
|
-
export type
|
|
8129
|
-
export type
|
|
9013
|
+
export type GetV2AccountAddressesResponse = GetV2AccountAddressesResponses[keyof GetV2AccountAddressesResponses];
|
|
9014
|
+
export type DeleteV2AccountAddressData = {
|
|
8130
9015
|
body?: never;
|
|
8131
9016
|
path: {
|
|
8132
9017
|
/**
|
|
8133
|
-
* The
|
|
9018
|
+
* The ID of the account that contains the address to delete.
|
|
8134
9019
|
*/
|
|
8135
|
-
|
|
9020
|
+
accountID: string;
|
|
9021
|
+
/**
|
|
9022
|
+
* The ID of the address to delete.
|
|
9023
|
+
*/
|
|
9024
|
+
addressID: string;
|
|
8136
9025
|
};
|
|
8137
|
-
query?:
|
|
9026
|
+
query?: never;
|
|
9027
|
+
url: "/v2/accounts/{accountID}/addresses/{addressID}";
|
|
9028
|
+
};
|
|
9029
|
+
export type DeleteV2AccountAddressErrors = {
|
|
9030
|
+
/**
|
|
9031
|
+
* Not Found
|
|
9032
|
+
*/
|
|
9033
|
+
404: AccountAddressesErrorResponse;
|
|
9034
|
+
};
|
|
9035
|
+
export type DeleteV2AccountAddressError = DeleteV2AccountAddressErrors[keyof DeleteV2AccountAddressErrors];
|
|
9036
|
+
export type DeleteV2AccountAddressResponses = {
|
|
9037
|
+
/**
|
|
9038
|
+
* No Content
|
|
9039
|
+
*/
|
|
9040
|
+
204: void;
|
|
9041
|
+
};
|
|
9042
|
+
export type DeleteV2AccountAddressResponse = DeleteV2AccountAddressResponses[keyof DeleteV2AccountAddressResponses];
|
|
9043
|
+
export type GetV2AccountAddressData = {
|
|
9044
|
+
body?: never;
|
|
9045
|
+
path: {
|
|
9046
|
+
/**
|
|
9047
|
+
* The ID of the account you want to retrieve.
|
|
9048
|
+
*/
|
|
9049
|
+
accountID: string;
|
|
9050
|
+
/**
|
|
9051
|
+
* The ID of the address you want to retrieve.
|
|
9052
|
+
*/
|
|
9053
|
+
addressID: string;
|
|
9054
|
+
};
|
|
9055
|
+
query?: never;
|
|
9056
|
+
url: "/v2/accounts/{accountID}/addresses/{addressID}";
|
|
9057
|
+
};
|
|
9058
|
+
export type GetV2AccountAddressErrors = {
|
|
9059
|
+
/**
|
|
9060
|
+
* Not Found
|
|
9061
|
+
*/
|
|
9062
|
+
404: AccountAddressesErrorResponse;
|
|
9063
|
+
};
|
|
9064
|
+
export type GetV2AccountAddressError = GetV2AccountAddressErrors[keyof GetV2AccountAddressErrors];
|
|
9065
|
+
export type GetV2AccountAddressResponses = {
|
|
9066
|
+
/**
|
|
9067
|
+
* OK
|
|
9068
|
+
*/
|
|
9069
|
+
200: {
|
|
9070
|
+
data?: AccountAddressResponse;
|
|
9071
|
+
};
|
|
9072
|
+
};
|
|
9073
|
+
export type GetV2AccountAddressResponse = GetV2AccountAddressResponses[keyof GetV2AccountAddressResponses];
|
|
9074
|
+
export type PostV2AccountAddressData = {
|
|
9075
|
+
body?: {
|
|
9076
|
+
data: Address;
|
|
9077
|
+
};
|
|
9078
|
+
path: {
|
|
8138
9079
|
/**
|
|
8139
|
-
*
|
|
9080
|
+
* The ID of the account you want to create an address for.
|
|
8140
9081
|
*/
|
|
8141
|
-
|
|
9082
|
+
accountID: string;
|
|
8142
9083
|
};
|
|
8143
|
-
|
|
9084
|
+
query?: never;
|
|
9085
|
+
url: "/v2/accounts/{accountID}/addresses/{addressID}";
|
|
8144
9086
|
};
|
|
8145
|
-
export type
|
|
8146
|
-
/**
|
|
8147
|
-
* Bad request. The request failed validation.
|
|
8148
|
-
*/
|
|
8149
|
-
400: SubscriptionsErrorResponse;
|
|
9087
|
+
export type PostV2AccountAddressErrors = {
|
|
8150
9088
|
/**
|
|
8151
|
-
*
|
|
9089
|
+
* Bad Request
|
|
8152
9090
|
*/
|
|
8153
|
-
|
|
9091
|
+
400: AccountAddressesErrorResponse;
|
|
8154
9092
|
/**
|
|
8155
|
-
*
|
|
9093
|
+
* Not Found
|
|
8156
9094
|
*/
|
|
8157
|
-
|
|
9095
|
+
404: AccountAddressesErrorResponse;
|
|
8158
9096
|
};
|
|
8159
|
-
export type
|
|
8160
|
-
export type
|
|
9097
|
+
export type PostV2AccountAddressError = PostV2AccountAddressErrors[keyof PostV2AccountAddressErrors];
|
|
9098
|
+
export type PostV2AccountAddressResponses = {
|
|
8161
9099
|
/**
|
|
8162
|
-
*
|
|
9100
|
+
* OK
|
|
8163
9101
|
*/
|
|
8164
9102
|
200: {
|
|
8165
|
-
data?:
|
|
8166
|
-
included?: OfferingIncludes;
|
|
9103
|
+
data?: AccountAddressResponse;
|
|
8167
9104
|
};
|
|
8168
9105
|
};
|
|
8169
|
-
export type
|
|
8170
|
-
export type
|
|
8171
|
-
body?:
|
|
8172
|
-
|
|
8173
|
-
/**
|
|
8174
|
-
* The unique identifier of the offering.
|
|
8175
|
-
*/
|
|
8176
|
-
offering_uuid: SubscriptionsUuid;
|
|
9106
|
+
export type PostV2AccountAddressResponse = PostV2AccountAddressResponses[keyof PostV2AccountAddressResponses];
|
|
9107
|
+
export type PutV2AccountAddressData = {
|
|
9108
|
+
body?: {
|
|
9109
|
+
data: Address;
|
|
8177
9110
|
};
|
|
8178
|
-
|
|
9111
|
+
path: {
|
|
8179
9112
|
/**
|
|
8180
|
-
* The
|
|
9113
|
+
* The ID of the account you want to create an address for.
|
|
8181
9114
|
*/
|
|
8182
|
-
|
|
9115
|
+
accountID: string;
|
|
8183
9116
|
/**
|
|
8184
|
-
* The
|
|
9117
|
+
* The ID of the address you want to update.
|
|
8185
9118
|
*/
|
|
8186
|
-
|
|
9119
|
+
addressID: string;
|
|
8187
9120
|
};
|
|
8188
|
-
|
|
9121
|
+
query?: never;
|
|
9122
|
+
url: "/v2/accounts/{accountID}/addresses/{addressID}";
|
|
8189
9123
|
};
|
|
8190
|
-
export type
|
|
9124
|
+
export type PutV2AccountAddressErrors = {
|
|
8191
9125
|
/**
|
|
8192
|
-
*
|
|
9126
|
+
* Bad Request
|
|
8193
9127
|
*/
|
|
8194
|
-
|
|
9128
|
+
400: AccountAddressesErrorResponse;
|
|
8195
9129
|
/**
|
|
8196
|
-
*
|
|
9130
|
+
* Not Found
|
|
8197
9131
|
*/
|
|
8198
|
-
|
|
9132
|
+
404: AccountAddressesErrorResponse;
|
|
8199
9133
|
};
|
|
8200
|
-
export type
|
|
8201
|
-
export type
|
|
9134
|
+
export type PutV2AccountAddressError = PutV2AccountAddressErrors[keyof PutV2AccountAddressErrors];
|
|
9135
|
+
export type PutV2AccountAddressResponses = {
|
|
8202
9136
|
/**
|
|
8203
|
-
*
|
|
9137
|
+
* OK
|
|
8204
9138
|
*/
|
|
8205
9139
|
200: {
|
|
8206
|
-
data?:
|
|
8207
|
-
links?: Links2;
|
|
9140
|
+
data?: AccountAddressResponse;
|
|
8208
9141
|
};
|
|
8209
9142
|
};
|
|
8210
|
-
export type
|
|
8211
|
-
export type
|
|
9143
|
+
export type PutV2AccountAddressResponse = PutV2AccountAddressResponses[keyof PutV2AccountAddressResponses];
|
|
9144
|
+
export type GetV2AccountsData = {
|
|
8212
9145
|
body?: never;
|
|
8213
|
-
path
|
|
9146
|
+
path?: never;
|
|
9147
|
+
query?: {
|
|
8214
9148
|
/**
|
|
8215
|
-
*
|
|
9149
|
+
* Specifies the filter attributes.
|
|
8216
9150
|
*/
|
|
8217
|
-
|
|
8218
|
-
};
|
|
8219
|
-
query?: {
|
|
9151
|
+
filter?: string;
|
|
8220
9152
|
/**
|
|
8221
|
-
* The
|
|
9153
|
+
* The number of records per page.
|
|
9154
|
+
*/
|
|
9155
|
+
"page[limit]"?: BigInt;
|
|
9156
|
+
/**
|
|
9157
|
+
* The number of records to offset the results by.
|
|
8222
9158
|
*/
|
|
8223
9159
|
"page[offset]"?: BigInt;
|
|
8224
9160
|
/**
|
|
8225
|
-
*
|
|
9161
|
+
* Supported attributes are `created_at`, `email`, `id`, `name`, or `updated_at`. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with `-`, for example, `-updated_at`. The default sort order is `created_at` in descending order. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
8226
9162
|
*/
|
|
8227
|
-
|
|
9163
|
+
sort?: string;
|
|
8228
9164
|
};
|
|
8229
|
-
url: "/v2/
|
|
9165
|
+
url: "/v2/accounts";
|
|
8230
9166
|
};
|
|
8231
|
-
export type
|
|
9167
|
+
export type GetV2AccountsErrors = {
|
|
8232
9168
|
/**
|
|
8233
|
-
*
|
|
9169
|
+
* Unauthorized
|
|
8234
9170
|
*/
|
|
8235
|
-
|
|
9171
|
+
401: AccountManagementErrorResponse;
|
|
8236
9172
|
/**
|
|
8237
|
-
* Internal server error.
|
|
9173
|
+
* Internal server error.
|
|
8238
9174
|
*/
|
|
8239
|
-
|
|
9175
|
+
default: AccountManagementErrorResponse;
|
|
8240
9176
|
};
|
|
8241
|
-
export type
|
|
8242
|
-
export type
|
|
9177
|
+
export type GetV2AccountsError = GetV2AccountsErrors[keyof GetV2AccountsErrors];
|
|
9178
|
+
export type GetV2AccountsResponses = {
|
|
8243
9179
|
/**
|
|
8244
|
-
*
|
|
9180
|
+
* OK
|
|
8245
9181
|
*/
|
|
8246
9182
|
200: {
|
|
8247
|
-
data?: Array<
|
|
8248
|
-
|
|
9183
|
+
data?: Array<AccountResponse>;
|
|
9184
|
+
meta?: MetaList;
|
|
9185
|
+
links?: {
|
|
9186
|
+
/**
|
|
9187
|
+
* Always the current page.
|
|
9188
|
+
*/
|
|
9189
|
+
current?: string;
|
|
9190
|
+
/**
|
|
9191
|
+
* Always the first page.
|
|
9192
|
+
*/
|
|
9193
|
+
first?: string;
|
|
9194
|
+
/**
|
|
9195
|
+
* Always `null` if there is only one page.
|
|
9196
|
+
*/
|
|
9197
|
+
last?: string;
|
|
9198
|
+
/**
|
|
9199
|
+
* Always `null` if there is only one page.
|
|
9200
|
+
*/
|
|
9201
|
+
next?: string;
|
|
9202
|
+
/**
|
|
9203
|
+
* Always `null` if the user is on the first page.
|
|
9204
|
+
*/
|
|
9205
|
+
prev?: string;
|
|
9206
|
+
};
|
|
8249
9207
|
};
|
|
8250
9208
|
};
|
|
8251
|
-
export type
|
|
8252
|
-
export type
|
|
9209
|
+
export type GetV2AccountsResponse = GetV2AccountsResponses[keyof GetV2AccountsResponses];
|
|
9210
|
+
export type GetV2AccountsAccountIdData = {
|
|
8253
9211
|
body?: never;
|
|
8254
9212
|
path: {
|
|
8255
9213
|
/**
|
|
8256
|
-
* The
|
|
8257
|
-
*/
|
|
8258
|
-
offering_uuid: SubscriptionsUuid;
|
|
8259
|
-
};
|
|
8260
|
-
query?: {
|
|
8261
|
-
/**
|
|
8262
|
-
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8263
|
-
*/
|
|
8264
|
-
"page[offset]"?: BigInt;
|
|
8265
|
-
/**
|
|
8266
|
-
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
9214
|
+
* The ID of the account you want to retrieve.
|
|
8267
9215
|
*/
|
|
8268
|
-
|
|
9216
|
+
accountID: string;
|
|
8269
9217
|
};
|
|
8270
|
-
|
|
9218
|
+
query?: never;
|
|
9219
|
+
url: "/v2/accounts/{accountID}";
|
|
8271
9220
|
};
|
|
8272
|
-
export type
|
|
9221
|
+
export type GetV2AccountsAccountIdErrors = {
|
|
8273
9222
|
/**
|
|
8274
|
-
* Not
|
|
9223
|
+
* Not Found
|
|
8275
9224
|
*/
|
|
8276
|
-
404:
|
|
9225
|
+
404: AccountManagementErrorResponse;
|
|
8277
9226
|
/**
|
|
8278
|
-
* Internal server error.
|
|
9227
|
+
* Internal server error.
|
|
8279
9228
|
*/
|
|
8280
|
-
|
|
9229
|
+
default: AccountManagementErrorResponse;
|
|
8281
9230
|
};
|
|
8282
|
-
export type
|
|
8283
|
-
export type
|
|
9231
|
+
export type GetV2AccountsAccountIdError = GetV2AccountsAccountIdErrors[keyof GetV2AccountsAccountIdErrors];
|
|
9232
|
+
export type GetV2AccountsAccountIdResponses = {
|
|
8284
9233
|
/**
|
|
8285
|
-
*
|
|
9234
|
+
* OK
|
|
8286
9235
|
*/
|
|
8287
9236
|
200: {
|
|
8288
|
-
data?:
|
|
8289
|
-
links?: Links2;
|
|
9237
|
+
data?: AccountResponse;
|
|
8290
9238
|
};
|
|
8291
9239
|
};
|
|
8292
|
-
export type
|
|
8293
|
-
export type
|
|
9240
|
+
export type GetV2AccountsAccountIdResponse = GetV2AccountsAccountIdResponses[keyof GetV2AccountsAccountIdResponses];
|
|
9241
|
+
export type GetV2AccountMembersData = {
|
|
8294
9242
|
body?: never;
|
|
8295
|
-
path
|
|
9243
|
+
path?: never;
|
|
9244
|
+
query?: {
|
|
8296
9245
|
/**
|
|
8297
|
-
* The
|
|
9246
|
+
* The number of records per page.
|
|
8298
9247
|
*/
|
|
8299
|
-
|
|
9248
|
+
"page[limit]"?: BigInt;
|
|
9249
|
+
/**
|
|
9250
|
+
* The number of records to offset the results by.
|
|
9251
|
+
*/
|
|
9252
|
+
"page[offset]"?: BigInt;
|
|
9253
|
+
/**
|
|
9254
|
+
* Supported attributes are `created_at`, `email`, `id`, `name`, or `updated_at`. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with `-`, for example, `-updated_at`. The default sort order is `created_at` in descending order. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
9255
|
+
*/
|
|
9256
|
+
sort?: string;
|
|
9257
|
+
/**
|
|
9258
|
+
* Specifies the filter attributes.
|
|
9259
|
+
*/
|
|
9260
|
+
filter?: string;
|
|
8300
9261
|
};
|
|
8301
|
-
|
|
8302
|
-
url: "/v2/subscriptions/features/{feature_uuid}";
|
|
9262
|
+
url: "/v2/account-members";
|
|
8303
9263
|
};
|
|
8304
|
-
export type
|
|
8305
|
-
/**
|
|
8306
|
-
* Bad request. The request failed validation.
|
|
8307
|
-
*/
|
|
8308
|
-
400: SubscriptionsErrorResponse;
|
|
9264
|
+
export type GetV2AccountMembersErrors = {
|
|
8309
9265
|
/**
|
|
8310
|
-
*
|
|
9266
|
+
* Unauthorized
|
|
8311
9267
|
*/
|
|
8312
|
-
|
|
9268
|
+
401: AccountManagementErrorResponse;
|
|
8313
9269
|
/**
|
|
8314
|
-
* Internal server error.
|
|
9270
|
+
* Internal server error.
|
|
8315
9271
|
*/
|
|
8316
|
-
|
|
9272
|
+
default: AccountManagementErrorResponse;
|
|
8317
9273
|
};
|
|
8318
|
-
export type
|
|
8319
|
-
export type
|
|
9274
|
+
export type GetV2AccountMembersError = GetV2AccountMembersErrors[keyof GetV2AccountMembersErrors];
|
|
9275
|
+
export type GetV2AccountMembersResponses = {
|
|
8320
9276
|
/**
|
|
8321
|
-
*
|
|
9277
|
+
* OK
|
|
8322
9278
|
*/
|
|
8323
9279
|
200: {
|
|
8324
|
-
data?:
|
|
9280
|
+
data?: Array<AccountMemberResponse>;
|
|
9281
|
+
meta?: MetaList;
|
|
9282
|
+
links?: {
|
|
9283
|
+
/**
|
|
9284
|
+
* Always the current page.
|
|
9285
|
+
*/
|
|
9286
|
+
current?: string;
|
|
9287
|
+
/**
|
|
9288
|
+
* Always the first page.
|
|
9289
|
+
*/
|
|
9290
|
+
first?: string;
|
|
9291
|
+
/**
|
|
9292
|
+
* Always `null` if there is only one page.
|
|
9293
|
+
*/
|
|
9294
|
+
last?: string;
|
|
9295
|
+
/**
|
|
9296
|
+
* Always `null` if there is only one page.
|
|
9297
|
+
*/
|
|
9298
|
+
next?: string;
|
|
9299
|
+
/**
|
|
9300
|
+
* Always `null` if the user is on the first page.
|
|
9301
|
+
*/
|
|
9302
|
+
prev?: string;
|
|
9303
|
+
};
|
|
8325
9304
|
};
|
|
8326
9305
|
};
|
|
8327
|
-
export type
|
|
8328
|
-
export type
|
|
9306
|
+
export type GetV2AccountMembersResponse = GetV2AccountMembersResponses[keyof GetV2AccountMembersResponses];
|
|
9307
|
+
export type GetV2AccountMembersAccountMemberIdData = {
|
|
8329
9308
|
body?: never;
|
|
8330
9309
|
path: {
|
|
8331
9310
|
/**
|
|
8332
|
-
* The unique identifier of the
|
|
9311
|
+
* The unique identifier of the account member that you want to retrieve.
|
|
8333
9312
|
*/
|
|
8334
|
-
|
|
9313
|
+
accountMemberID: string;
|
|
8335
9314
|
};
|
|
8336
9315
|
query?: never;
|
|
8337
|
-
url: "/v2/
|
|
9316
|
+
url: "/v2/account-members/{accountMemberID}";
|
|
8338
9317
|
};
|
|
8339
|
-
export type
|
|
9318
|
+
export type GetV2AccountMembersAccountMemberIdErrors = {
|
|
8340
9319
|
/**
|
|
8341
|
-
* Not
|
|
9320
|
+
* Not Found
|
|
8342
9321
|
*/
|
|
8343
|
-
404:
|
|
9322
|
+
404: AccountManagementErrorResponse;
|
|
8344
9323
|
/**
|
|
8345
|
-
* Internal server error.
|
|
9324
|
+
* Internal server error.
|
|
8346
9325
|
*/
|
|
8347
|
-
|
|
9326
|
+
default: AccountManagementErrorResponse;
|
|
8348
9327
|
};
|
|
8349
|
-
export type
|
|
8350
|
-
export type
|
|
9328
|
+
export type GetV2AccountMembersAccountMemberIdError = GetV2AccountMembersAccountMemberIdErrors[keyof GetV2AccountMembersAccountMemberIdErrors];
|
|
9329
|
+
export type GetV2AccountMembersAccountMemberIdResponses = {
|
|
8351
9330
|
/**
|
|
8352
|
-
*
|
|
9331
|
+
* OK
|
|
8353
9332
|
*/
|
|
8354
9333
|
200: {
|
|
8355
|
-
data
|
|
9334
|
+
data?: AccountMemberResponse;
|
|
8356
9335
|
};
|
|
8357
9336
|
};
|
|
8358
|
-
export type
|
|
8359
|
-
export type
|
|
9337
|
+
export type GetV2AccountMembersAccountMemberIdResponse = GetV2AccountMembersAccountMemberIdResponses[keyof GetV2AccountMembersAccountMemberIdResponses];
|
|
9338
|
+
export type GetV2AccountsAccountIdAccountMembershipsData = {
|
|
8360
9339
|
body?: never;
|
|
8361
|
-
path
|
|
9340
|
+
path: {
|
|
9341
|
+
/**
|
|
9342
|
+
* The ID of the account for which you want to get the list of unassigned account members.
|
|
9343
|
+
*/
|
|
9344
|
+
accountID: string;
|
|
9345
|
+
};
|
|
8362
9346
|
query?: {
|
|
8363
9347
|
/**
|
|
8364
|
-
*
|
|
9348
|
+
* Specifies the filter attributes.
|
|
8365
9349
|
*/
|
|
8366
|
-
|
|
9350
|
+
filter?: string;
|
|
8367
9351
|
/**
|
|
8368
|
-
*
|
|
9352
|
+
* Supported attributes are `created_at`, `email`, `id`, `name`, or `updated_at`. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with `-`, for example, `-updated_at`. The default sort order is `created_at` in descending order. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
8369
9353
|
*/
|
|
8370
|
-
|
|
9354
|
+
sort?: string;
|
|
8371
9355
|
/**
|
|
8372
|
-
*
|
|
8373
|
-
*
|
|
9356
|
+
* The number of records per page.
|
|
8374
9357
|
*/
|
|
8375
|
-
|
|
9358
|
+
"page[limit]"?: BigInt;
|
|
9359
|
+
/**
|
|
9360
|
+
* The number of records to offset the results by.
|
|
9361
|
+
*/
|
|
9362
|
+
"page[offset]"?: BigInt;
|
|
9363
|
+
/**
|
|
9364
|
+
* Parameter to retrieve more information about any related resources like account members.
|
|
9365
|
+
*/
|
|
9366
|
+
include?: string;
|
|
8376
9367
|
};
|
|
8377
|
-
url: "/v2/
|
|
9368
|
+
url: "/v2/accounts/{accountID}/account-memberships";
|
|
8378
9369
|
};
|
|
8379
|
-
export type
|
|
9370
|
+
export type GetV2AccountsAccountIdAccountMembershipsErrors = {
|
|
8380
9371
|
/**
|
|
8381
|
-
*
|
|
9372
|
+
* Not Found
|
|
8382
9373
|
*/
|
|
8383
|
-
|
|
9374
|
+
404: AccountManagementErrorResponse;
|
|
9375
|
+
/**
|
|
9376
|
+
* Internal server error.
|
|
9377
|
+
*/
|
|
9378
|
+
default: AccountManagementErrorResponse;
|
|
8384
9379
|
};
|
|
8385
|
-
export type
|
|
8386
|
-
export type
|
|
9380
|
+
export type GetV2AccountsAccountIdAccountMembershipsError = GetV2AccountsAccountIdAccountMembershipsErrors[keyof GetV2AccountsAccountIdAccountMembershipsErrors];
|
|
9381
|
+
export type GetV2AccountsAccountIdAccountMembershipsResponses = {
|
|
8387
9382
|
/**
|
|
8388
|
-
*
|
|
9383
|
+
* OK
|
|
8389
9384
|
*/
|
|
8390
9385
|
200: {
|
|
8391
|
-
data?: Array<
|
|
8392
|
-
|
|
9386
|
+
data?: Array<AccountMembershipResponse>;
|
|
9387
|
+
meta?: MetaList;
|
|
9388
|
+
links?: {
|
|
9389
|
+
/**
|
|
9390
|
+
* Always the current page.
|
|
9391
|
+
*/
|
|
9392
|
+
current?: string;
|
|
9393
|
+
/**
|
|
9394
|
+
* Always the first page.
|
|
9395
|
+
*/
|
|
9396
|
+
first?: string;
|
|
9397
|
+
/**
|
|
9398
|
+
* Always `null` if there is only one page.
|
|
9399
|
+
*/
|
|
9400
|
+
last?: string;
|
|
9401
|
+
/**
|
|
9402
|
+
* Always `null` if there is only one page.
|
|
9403
|
+
*/
|
|
9404
|
+
next?: string;
|
|
9405
|
+
/**
|
|
9406
|
+
* Always `null` if the user is on the first page.
|
|
9407
|
+
*/
|
|
9408
|
+
prev?: string;
|
|
9409
|
+
};
|
|
8393
9410
|
};
|
|
8394
9411
|
};
|
|
8395
|
-
export type
|
|
8396
|
-
export type
|
|
8397
|
-
body?:
|
|
9412
|
+
export type GetV2AccountsAccountIdAccountMembershipsResponse = GetV2AccountsAccountIdAccountMembershipsResponses[keyof GetV2AccountsAccountIdAccountMembershipsResponses];
|
|
9413
|
+
export type PostV2AccountMembersTokensData = {
|
|
9414
|
+
body?: {
|
|
9415
|
+
data: ({
|
|
9416
|
+
authentication_mechanism?: "oidc";
|
|
9417
|
+
} & OpenIdConnectRequest) | ({
|
|
9418
|
+
authentication_mechanism?: "password";
|
|
9419
|
+
} & PasswordRequest) | ({
|
|
9420
|
+
authentication_mechanism?: "passwordless";
|
|
9421
|
+
} & PasswordlessRequest) | ({
|
|
9422
|
+
authentication_mechanism?: "self_signup";
|
|
9423
|
+
} & SelfSignupRequest) | ({
|
|
9424
|
+
authentication_mechanism?: "account_management_authentication_token";
|
|
9425
|
+
} & SwitchingAccountRequest);
|
|
9426
|
+
};
|
|
8398
9427
|
path?: never;
|
|
8399
9428
|
query?: never;
|
|
8400
|
-
url: "/
|
|
9429
|
+
url: "/v2/account-members/tokens";
|
|
8401
9430
|
};
|
|
8402
|
-
export type
|
|
8403
|
-
/**
|
|
8404
|
-
* Bad Request
|
|
8405
|
-
*/
|
|
8406
|
-
400: ErrorResponse2;
|
|
9431
|
+
export type PostV2AccountMembersTokensErrors = {
|
|
8407
9432
|
/**
|
|
8408
9433
|
* Unauthorized
|
|
8409
9434
|
*/
|
|
8410
|
-
401:
|
|
9435
|
+
401: AccountManagementErrorResponse;
|
|
8411
9436
|
/**
|
|
8412
|
-
* Internal server error.
|
|
9437
|
+
* Internal server error.
|
|
8413
9438
|
*/
|
|
8414
|
-
default:
|
|
9439
|
+
default: AccountManagementErrorResponse;
|
|
8415
9440
|
};
|
|
8416
|
-
export type
|
|
8417
|
-
export type
|
|
9441
|
+
export type PostV2AccountMembersTokensError = PostV2AccountMembersTokensErrors[keyof PostV2AccountMembersTokensErrors];
|
|
9442
|
+
export type PostV2AccountMembersTokensResponses = {
|
|
8418
9443
|
/**
|
|
8419
|
-
*
|
|
9444
|
+
* Created
|
|
8420
9445
|
*/
|
|
8421
|
-
|
|
9446
|
+
201: {
|
|
9447
|
+
data?: Array<AccountManagementAuthenticationTokenResponse>;
|
|
9448
|
+
meta?: MetaList;
|
|
9449
|
+
links?: {
|
|
9450
|
+
/**
|
|
9451
|
+
* Always the current page.
|
|
9452
|
+
*/
|
|
9453
|
+
current?: string;
|
|
9454
|
+
/**
|
|
9455
|
+
* Always the first page.
|
|
9456
|
+
*/
|
|
9457
|
+
first?: string;
|
|
9458
|
+
/**
|
|
9459
|
+
* Always `null` if there is only one page.
|
|
9460
|
+
*/
|
|
9461
|
+
last?: string;
|
|
9462
|
+
/**
|
|
9463
|
+
* Always `null` if there is only one page.
|
|
9464
|
+
*/
|
|
9465
|
+
next?: string;
|
|
9466
|
+
/**
|
|
9467
|
+
* Always `null` if the user is on the first page.
|
|
9468
|
+
*/
|
|
9469
|
+
prev?: string;
|
|
9470
|
+
};
|
|
9471
|
+
};
|
|
8422
9472
|
};
|
|
8423
|
-
export type
|
|
9473
|
+
export type PostV2AccountMembersTokensResponse = PostV2AccountMembersTokensResponses[keyof PostV2AccountMembersTokensResponses];
|