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