@epcc-sdk/sdks-shopper 0.0.32 → 0.0.34

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.
@@ -1893,27 +1893,6 @@ type CatalogReleaseCreateData = {
1893
1893
  include_organization_resources?: boolean | null;
1894
1894
  };
1895
1895
  };
1896
- type CartsRequest = {
1897
- /**
1898
- * The cart description.
1899
- */
1900
- description?: string;
1901
- discount_settings?: DiscountSettings;
1902
- /**
1903
- * The cart name provided by the shopper. A cart name must contain 1 to 255 characters. You cannot use whitespace characters, but special characters are permitted. For more information, see the [Safe Characters](/guides/Getting-Started/safe-characters) section.
1904
- */
1905
- name?: string;
1906
- contact?: CartContact;
1907
- /**
1908
- * This optional parameter sets a reference date for the cart. If this parameter is set, it allows the cart to act as one that might occur on that specified date. For example, such future carts might acquire future-enabled discounts, allowing users to test and validate future interactions with carts. The snapshot_date must be in the format 2026-02-21T15:07:25Z. By default, this parameter is left empty.
1909
- */
1910
- snapshot_date?: string;
1911
- custom_attributes?: CustomAttributes;
1912
- /**
1913
- * To remove the Stripe payment intent from a cart, pass the empty value in the `payment_intent_id` field. You must use an empty value for this field. You cannot use this endpoint to directly update the cart to use an existing Payment Intent.
1914
- */
1915
- payment_intent_id?: string;
1916
- };
1917
1896
  type CartContact = {
1918
1897
  /**
1919
1898
  * The email address attached to a cart.
@@ -1930,25 +1909,68 @@ type DiscountSettings = {
1930
1909
  */
1931
1910
  use_rule_promotions?: boolean;
1932
1911
  };
1912
+ type InventorySettings = {
1913
+ /**
1914
+ * This parameter enables deferring inventory checks on the cart. This allows items to be added to or updating in the cart without checking stock levels. Inventory checks are still performed as normal on checkout
1915
+ */
1916
+ defer_inventory_check?: boolean;
1917
+ };
1918
+ /**
1919
+ * Specifies custom attributes for cart or order objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types.
1920
+ *
1921
+ * Example:
1922
+ * ```
1923
+ * "custom_attributes": {
1924
+ * "is_member": {
1925
+ * "type": "boolean",
1926
+ * "value": true
1927
+ * },
1928
+ * "membership_level": {
1929
+ * "type": "string",
1930
+ * "value": "premium"
1931
+ * }
1932
+ * }
1933
+ * ```
1934
+ *
1935
+ */
1933
1936
  type CustomAttributes = {
1937
+ [key: string]: unknown;
1938
+ };
1939
+ type FormattedPriceData = {
1934
1940
  /**
1935
- * Specifies the custom attributes for the cart object. The attribute can be any string, numerical, and underscore. A cart can have maximum of 20 custom attributes.
1941
+ * The raw total.
1936
1942
  */
1937
- custom_attributes?: {
1938
- /**
1939
- * Specifies the attribute `type` and `value`.
1940
- */
1941
- attribute?: {
1942
- /**
1943
- * Specifies the type of the attribute such as string, integer, boolean, and float.
1944
- */
1945
- type?: string;
1946
- /**
1947
- * Specifies the value of the attribute.
1948
- */
1949
- value?: string | number | boolean;
1950
- };
1951
- };
1943
+ amount?: number;
1944
+ /**
1945
+ * The currency set for this amount.
1946
+ */
1947
+ currency?: string;
1948
+ /**
1949
+ * The formatted total based on the amount and currency.
1950
+ */
1951
+ formatted?: string;
1952
+ };
1953
+ /**
1954
+ * Relationship data entry
1955
+ */
1956
+ type RelationshipItem = {
1957
+ /**
1958
+ * The type of related resource.
1959
+ */
1960
+ type?: string;
1961
+ /**
1962
+ * The ID of the related resource.
1963
+ */
1964
+ id?: string;
1965
+ };
1966
+ /**
1967
+ * Array of relationships
1968
+ */
1969
+ type RelationshipArray = {
1970
+ /**
1971
+ * Individual relationships
1972
+ */
1973
+ data?: Array<RelationshipItem>;
1952
1974
  };
1953
1975
  type CartResponse = {
1954
1976
  /**
@@ -1969,10 +1991,12 @@ type CartResponse = {
1969
1991
  description?: string;
1970
1992
  contact?: CartContact;
1971
1993
  discount_settings?: DiscountSettings;
1994
+ inventory_settings?: InventorySettings;
1972
1995
  /**
1973
1996
  * Stripe-assigned unique identifier for the linked Payment Intent
1974
1997
  */
1975
1998
  payment_intent_id?: string;
1999
+ custom_attributes?: CustomAttributes;
1976
2000
  links?: {
1977
2001
  /**
1978
2002
  * A link to that specific resource.
@@ -1992,64 +2016,170 @@ type CartResponse = {
1992
2016
  };
1993
2017
  relationships?: {
1994
2018
  customers?: RelationshipArray;
1995
- items?: RelationshipArray;
2019
+ items?: RelationshipArray | {
2020
+ data?: null;
2021
+ };
1996
2022
  accounts?: RelationshipArray;
1997
2023
  custom_discounts?: RelationshipArray;
1998
2024
  promotions?: RelationshipArray;
1999
2025
  };
2000
2026
  };
2001
- type CartItemsObjectRequest = CartItemObject | SubscriptionItemObject | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject;
2002
- type CartItemsObjectResponse = CartItemResponseObject | SubscriptionItemResponseObject | CustomItemResponseObject | PromotionItemResponseObject;
2003
- type CartItemResponseObject = CartItemObjectData & CartItemResponse;
2004
- type SubscriptionItemResponseObject = SubscriptionItemObjectData & CartItemResponse;
2005
- type CustomItemResponseObject = CustomItemObjectData & {
2027
+ type ResponsePageLinks = {
2006
2028
  /**
2007
- * Specifies the ID of the custom cart item
2029
+ * Always the current page.
2008
2030
  */
2009
- id: string;
2010
- readonly image?: {
2031
+ current?: string;
2032
+ /**
2033
+ * Always the first page.
2034
+ */
2035
+ first?: string;
2036
+ /**
2037
+ * If there is only one page, it is `null`.
2038
+ */
2039
+ last?: string;
2040
+ /**
2041
+ * If there is only one page, it is `null`.
2042
+ */
2043
+ next?: string;
2044
+ /**
2045
+ * if the user is on the first page, it is `null`.
2046
+ */
2047
+ prev?: string;
2048
+ };
2049
+ type ResponsePaginationPage = {
2050
+ /**
2051
+ * The current page.
2052
+ */
2053
+ current?: number;
2054
+ /**
2055
+ * The maximum number of records per page for this response. You can set this value up to 100.
2056
+ */
2057
+ limit?: number;
2058
+ /**
2059
+ * The current offset by number of records, not pages. Offset is zero-based.
2060
+ */
2061
+ offset?: number;
2062
+ /**
2063
+ * The total page count.
2064
+ */
2065
+ total?: number;
2066
+ };
2067
+ type ResponsePaginationResults = {
2068
+ /**
2069
+ * The total page count.
2070
+ */
2071
+ total?: number;
2072
+ };
2073
+ type ResponseMetaCarts = {
2074
+ page?: ResponsePaginationPage;
2075
+ results?: ResponsePaginationResults;
2076
+ };
2077
+ type CartCollectionResponse = {
2078
+ data: Array<CartResponse>;
2079
+ links?: ResponsePageLinks;
2080
+ meta?: ResponseMetaCarts;
2081
+ };
2082
+ type ResponseErrorItem = {
2083
+ /**
2084
+ * A brief summary of the error.
2085
+ */
2086
+ title: string;
2087
+ /**
2088
+ * The HTTP response code of the error.
2089
+ */
2090
+ status: number;
2091
+ /**
2092
+ * Optional additional detail about the error.
2093
+ */
2094
+ detail?: string;
2095
+ meta?: {
2011
2096
  /**
2012
- * The MIME type for the uploaded file.
2097
+ * The resource id associated with the error
2013
2098
  */
2014
- readonly mime_type?: string;
2099
+ id?: string;
2100
+ ids?: Array<string>;
2101
+ item_ids?: Array<string>;
2015
2102
  /**
2016
- * The name of the image file that was uploaded.
2103
+ * The shipping group id associated with the error
2017
2104
  */
2018
- readonly file_name?: string;
2105
+ shipping_group_id?: string;
2106
+ shipping_group_ids?: Array<string>;
2019
2107
  /**
2020
- * The link to the image.
2108
+ * The cart id associated with the error
2021
2109
  */
2022
- readonly href?: string;
2023
- };
2024
- readonly manage_stock?: boolean;
2025
- unit_price?: ItemPriceData;
2026
- value?: ItemPriceData;
2027
- readonly links?: {
2028
- [key: string]: unknown;
2029
- };
2030
- readonly meta?: {
2031
- display_price?: {
2032
- with_tax?: FormattedPriceData;
2033
- without_tax?: FormattedPriceData;
2034
- tax?: FormattedPriceData;
2035
- discount?: FormattedPriceData;
2036
- without_discount?: FormattedPriceData;
2037
- };
2038
- timestamps?: CartCheckoutTimestamps;
2110
+ cart_id?: string;
2111
+ /**
2112
+ * The code associated with the error.
2113
+ */
2114
+ code?: string;
2115
+ /**
2116
+ * The order id associated with the error.
2117
+ */
2118
+ order_id?: string;
2119
+ /**
2120
+ * The value associated with the error.
2121
+ */
2122
+ value?: Array<unknown> | Array<unknown> | Array<unknown> | Array<unknown> | Array<unknown>;
2039
2123
  };
2040
2124
  };
2041
- type PromotionItemResponseObject = PromotionItemObjectData & {
2042
- /**
2043
- * Specifies the ID of the promotion cart item
2044
- */
2045
- id: string;
2046
- /**
2047
- * The name of the promotion item.
2048
- */
2049
- name?: string;
2125
+ type ResponseErrorResponse = {
2126
+ errors: Array<ResponseErrorItem>;
2127
+ };
2128
+ type CartsRequest = {
2129
+ data?: {
2130
+ /**
2131
+ * The cart description.
2132
+ */
2133
+ description?: string;
2134
+ discount_settings?: DiscountSettings;
2135
+ inventory_settings?: InventorySettings;
2136
+ /**
2137
+ * The cart name provided by the shopper. A cart name must contain 1 to 255 characters. You cannot use whitespace characters, but special characters are permitted. For more information, see the [Safe Characters](/guides/Getting-Started/safe-characters) section.
2138
+ */
2139
+ name?: string;
2140
+ contact?: CartContact;
2141
+ /**
2142
+ * This optional parameter sets a reference date for the cart. If this parameter is set, it allows the cart to act as one that might occur on that specified date. For example, such future carts might acquire future-enabled discounts, allowing users to test and validate future interactions with carts. The snapshot_date must be in the format 2026-02-21T15:07:25Z. By default, this parameter is left empty.
2143
+ */
2144
+ snapshot_date?: string;
2145
+ /**
2146
+ * Specifies custom attributes for cart objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types.
2147
+ *
2148
+ * Attribute types include:
2149
+ * - string
2150
+ * - boolean
2151
+ * - integer
2152
+ * - float
2153
+ *
2154
+ * Multiple custom attributes may be submitted together. A cart can have a maximum of 20 custom attributes.
2155
+ *
2156
+ * Example:
2157
+ * ```
2158
+ * "custom_attributes": {
2159
+ * "is_member": {
2160
+ * "type": "boolean",
2161
+ * "value": true
2162
+ * },
2163
+ * "membership_level": {
2164
+ * "type": "string",
2165
+ * "value": "premium"
2166
+ * }
2167
+ * }
2168
+ * ```
2169
+ *
2170
+ * Updating an existing cart with new custom attributes clears previously-saved attributes. In order to maintain existing custom attributes on a cart, please include them in the update request along with any new attributes.
2171
+ *
2172
+ */
2173
+ custom_attributes?: CustomAttributes;
2174
+ /**
2175
+ * To remove the Stripe payment intent from a cart, pass the empty value in the `payment_intent_id` field. You must use an empty value for this field. You cannot use this endpoint to directly update the cart to use an existing Payment Intent.
2176
+ */
2177
+ payment_intent_id?: string;
2178
+ };
2050
2179
  };
2051
- type CartItemObject = {
2052
- data?: CartItemObjectData & CartItemResponse;
2180
+ type CartEntityResponse = {
2181
+ data: CartResponse;
2182
+ included?: CartIncluded;
2053
2183
  };
2054
2184
  /**
2055
2185
  * The type of object being returned.
@@ -2102,78 +2232,140 @@ type CartItemObjectData = {
2102
2232
  */
2103
2233
  location?: string;
2104
2234
  };
2105
- type SubscriptionItemObject = {
2106
- data?: SubscriptionItemObjectData & CartItemResponse;
2107
- };
2108
- type SubscriptionItemObjectData = {
2109
- /**
2110
- * The type of object being returned.
2111
- */
2112
- type: "subscription_item";
2235
+ type ItemPriceData = {
2113
2236
  /**
2114
- * The number of items added to the cart.
2237
+ * The amount for this item as an integer.
2115
2238
  */
2116
- quantity: number;
2239
+ readonly amount?: number;
2117
2240
  /**
2118
- * Specifies the ID of the subscription offering you want to add to cart.
2241
+ * The currency this item was added to the cart as.
2119
2242
  */
2120
- id: string;
2243
+ readonly currency?: string;
2121
2244
  /**
2122
- * Specifies how the subscription offering should be configured.
2245
+ * Whether or not this price is tax inclusive.
2123
2246
  */
2124
- subscription_configuration: {
2125
- /**
2126
- * The ID of the plan within the offering to use for the subscription.
2127
- */
2128
- plan: string;
2129
- };
2130
- };
2131
- type CartMergeObjectRequest = {
2132
- data?: Array<CartMergeObject>;
2133
- options?: AddAllOrNothingOptionsObject;
2247
+ readonly includes_tax?: boolean;
2134
2248
  };
2135
- type CartMergeObject = {
2249
+ type CartItemFormattedPriceData = {
2136
2250
  /**
2137
- * The type of object being returned. Must be `cart_items`.
2251
+ * The amount per each single unit.
2138
2252
  */
2139
- type: "cart_items";
2253
+ unit?: FormattedPriceData;
2140
2254
  /**
2141
- * The original cart to be merged from.
2255
+ * The total amount of the item (i.e., unit * quantity).
2142
2256
  */
2143
- cart_id: string;
2144
- };
2145
- type CustomItemObject = {
2146
- data?: CustomItemObjectData;
2257
+ value?: FormattedPriceData;
2147
2258
  };
2148
- type CustomItemObjectData = {
2259
+ type CartItemResponse = {
2149
2260
  /**
2150
- * The type of object being returned. Must be `custom_item`.
2261
+ * The unique ID of the product.
2151
2262
  */
2152
- type: "custom_item";
2263
+ readonly product_id?: string;
2153
2264
  /**
2154
- * The number of custom items to add to cart.
2265
+ * The unique ID of the subscription offering for subscription items.
2155
2266
  */
2156
- quantity: number;
2157
- price: {
2158
- /**
2159
- * The unit price of the custom item.
2160
- */
2161
- amount: number;
2162
- /**
2163
- * Set to`true` if relevant taxes have been included in the price, `false` if not. Defaults to `true`.
2164
- */
2165
- includes_tax?: boolean;
2166
- };
2267
+ readonly subscription_offering_id?: string;
2167
2268
  /**
2168
- * A description of the custom item.
2269
+ * The name of this item
2169
2270
  */
2170
- description?: string;
2271
+ readonly name?: string;
2171
2272
  /**
2172
- * The `SKU` code to use for the custom item. See [best practices](https://elasticpath.dev/docs/commerce-cloud/carts/cart-items/add-custom-item-to-cart#best-practices) to use the `SKU` code.
2273
+ * A description of the cart item.
2173
2274
  */
2174
- sku?: string;
2275
+ readonly description?: string;
2175
2276
  /**
2176
- * The name of the custom item.
2277
+ * The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.
2278
+ */
2279
+ readonly catalog_id?: string;
2280
+ /**
2281
+ * The catalog source. Always `pim` or `legacy`.
2282
+ */
2283
+ readonly catalog_source?: string;
2284
+ readonly image?: {
2285
+ /**
2286
+ * The MIME type for the uploaded file.
2287
+ */
2288
+ readonly mime_type?: string;
2289
+ /**
2290
+ * The name of the image file that was uploaded.
2291
+ */
2292
+ readonly file_name?: string;
2293
+ /**
2294
+ * The link to the image.
2295
+ */
2296
+ readonly href?: string;
2297
+ };
2298
+ /**
2299
+ * Whether or not the quantity of the item will be checked against inventory.
2300
+ */
2301
+ readonly manage_stock?: boolean;
2302
+ /**
2303
+ * The unit price of the item.
2304
+ */
2305
+ unit_price?: ItemPriceData;
2306
+ /**
2307
+ * The total price of the item (i.e., unit * quantity).
2308
+ */
2309
+ value?: ItemPriceData;
2310
+ readonly links?: {
2311
+ /**
2312
+ * A URL related to the resource.
2313
+ */
2314
+ product?: string;
2315
+ };
2316
+ readonly meta?: {
2317
+ display_price?: {
2318
+ /**
2319
+ * The amount of this item after discounts and taxes are applied.
2320
+ */
2321
+ with_tax?: CartItemFormattedPriceData;
2322
+ /**
2323
+ * The amount of this item after discounts are applied and before taxes.
2324
+ */
2325
+ without_tax?: CartItemFormattedPriceData;
2326
+ /**
2327
+ * The amount of taxes applied to this item.
2328
+ */
2329
+ tax?: CartItemFormattedPriceData;
2330
+ /**
2331
+ * The amount of the discount applied to this item.
2332
+ */
2333
+ discount?: CartItemFormattedPriceData;
2334
+ without_discount?: CartItemFormattedPriceData;
2335
+ };
2336
+ timestamps?: CartCheckoutTimestamps;
2337
+ };
2338
+ };
2339
+ type CartItemObject = CartItemObjectData & CartItemResponse;
2340
+ type CustomItemObjectData = {
2341
+ /**
2342
+ * The type of object being returned. Must be `custom_item`.
2343
+ */
2344
+ type: "custom_item";
2345
+ /**
2346
+ * The number of custom items to add to cart.
2347
+ */
2348
+ quantity: number;
2349
+ price: {
2350
+ /**
2351
+ * The unit price of the custom item.
2352
+ */
2353
+ amount: number;
2354
+ /**
2355
+ * Set to`true` if relevant taxes have been included in the price, `false` if not. Defaults to `true`.
2356
+ */
2357
+ includes_tax?: boolean;
2358
+ };
2359
+ /**
2360
+ * A description of the custom item.
2361
+ */
2362
+ description?: string;
2363
+ /**
2364
+ * The `SKU` code to use for the custom item. See [best practices](https://elasticpath.dev/docs/commerce-cloud/carts/cart-items/add-custom-item-to-cart#best-practices) to use the `SKU` code.
2365
+ */
2366
+ sku?: string;
2367
+ /**
2368
+ * The name of the custom item.
2177
2369
  */
2178
2370
  name: string;
2179
2371
  /**
@@ -2187,25 +2379,38 @@ type CustomItemObjectData = {
2187
2379
  */
2188
2380
  shipping_group_id?: string;
2189
2381
  };
2190
- type ReOrderObjectRequest = {
2191
- data?: ReOrderObject;
2192
- options?: AddAllOrNothingOptionsObject;
2382
+ type CustomItemObject = {
2383
+ data?: CustomItemObjectData;
2193
2384
  };
2194
- type ReOrderObject = {
2385
+ type SubscriptionItemObjectData = {
2195
2386
  /**
2196
- * The type of resource being returned. Use `order_items`.
2387
+ * The type of object being returned.
2197
2388
  */
2198
- type: "order_items";
2389
+ type: "subscription_item";
2199
2390
  /**
2200
- * The unique identifier of the order.
2391
+ * The number of items added to the cart.
2201
2392
  */
2202
- order_id: string;
2203
- };
2204
- type BulkAddItemsRequest = {
2205
- data?: CartItemsObjectRequest | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject;
2393
+ quantity: number;
2394
+ /**
2395
+ * Specifies the ID of the subscription offering you want to add to cart.
2396
+ */
2397
+ id: string;
2398
+ /**
2399
+ * Specifies how the subscription offering should be configured.
2400
+ */
2401
+ subscription_configuration: {
2402
+ /**
2403
+ * The ID of the pricing option within the offering to use for the subscription.
2404
+ */
2405
+ pricing_option: string;
2406
+ /**
2407
+ * The ID of the plan within the offering to use for the subscription.
2408
+ */
2409
+ plan: string;
2410
+ };
2206
2411
  };
2207
- type PromotionItemObject = {
2208
- data?: PromotionItemObjectData;
2412
+ type SubscriptionItemObject = {
2413
+ data?: SubscriptionItemObjectData & CartItemResponse;
2209
2414
  };
2210
2415
  type PromotionItemObjectData = {
2211
2416
  /**
@@ -2217,6 +2422,18 @@ type PromotionItemObjectData = {
2217
2422
  */
2218
2423
  code: string;
2219
2424
  };
2425
+ type PromotionItemObject = {
2426
+ data?: PromotionItemObjectData;
2427
+ };
2428
+ type CartItemsResponse = {
2429
+ data?: Array<CartItemObject | CustomItemObject | SubscriptionItemObject | PromotionItemObject>;
2430
+ };
2431
+ type UpdateAllOrNothingOptionsObject = {
2432
+ /**
2433
+ * When set to`true`, if an error occurs for any item, no items are updated in the cart. When set to `false`, valid items are updated in the cart and the items with errors are reported in the response. Default is `true`.
2434
+ */
2435
+ update_all_or_nothing?: boolean;
2436
+ };
2220
2437
  type BulkUpdateCartsItems = {
2221
2438
  data?: Array<{
2222
2439
  /**
@@ -2236,8 +2453,78 @@ type BulkUpdateCartsItems = {
2236
2453
  }>;
2237
2454
  options?: UpdateAllOrNothingOptionsObject;
2238
2455
  };
2456
+ type CartItemObjectRequest = {
2457
+ data?: CartItemObject;
2458
+ };
2459
+ type CartMergeObject = {
2460
+ /**
2461
+ * The type of object being returned. Must be `cart_items`.
2462
+ */
2463
+ type: "cart_items";
2464
+ /**
2465
+ * The original cart to be merged from.
2466
+ */
2467
+ cart_id: string;
2468
+ };
2469
+ type AddAllOrNothingOptionsObject = {
2470
+ /**
2471
+ * When `true`, if an error occurs for any item, no items are added to the cart. When `false`, valid items are added to the cart and the items with errors are reported in the response. Default is `false`.
2472
+ */
2473
+ add_all_or_nothing?: boolean;
2474
+ };
2475
+ type CartMergeObjectRequest = {
2476
+ data?: CartMergeObject;
2477
+ options?: AddAllOrNothingOptionsObject;
2478
+ };
2479
+ type ReOrderObject = {
2480
+ /**
2481
+ * The type of resource being returned. Use `order_items`.
2482
+ */
2483
+ type: "order_items";
2484
+ /**
2485
+ * The unique identifier of the order.
2486
+ */
2487
+ order_id: string;
2488
+ };
2489
+ type ReOrderObjectRequest = {
2490
+ data?: ReOrderObject;
2491
+ options?: AddAllOrNothingOptionsObject;
2492
+ };
2493
+ type BulkAddItemsRequest = {
2494
+ data?: Array<CartItemObjectData | CartMergeObject | CustomItemObjectData | ReOrderObject | PromotionItemObjectData>;
2495
+ options?: AddAllOrNothingOptionsObject;
2496
+ };
2497
+ type CartTimestamps = {
2498
+ created_at?: string;
2499
+ updated_at?: unknown;
2500
+ expires_at?: unknown;
2501
+ };
2502
+ type CartsResponse = {
2503
+ data?: Array<CartItemObject | CustomItemObject | SubscriptionItemObject | PromotionItemObject>;
2504
+ meta?: {
2505
+ display_price?: {
2506
+ with_tax?: FormattedPriceData;
2507
+ without_tax?: FormattedPriceData;
2508
+ tax?: FormattedPriceData;
2509
+ discount?: FormattedPriceData;
2510
+ without_discount?: FormattedPriceData;
2511
+ discounts?: {
2512
+ [key: string]: {
2513
+ amount?: number;
2514
+ currency?: string;
2515
+ formatted?: string;
2516
+ };
2517
+ };
2518
+ };
2519
+ timestamps?: CartTimestamps;
2520
+ };
2521
+ };
2239
2522
  type UpdateCartsItems = {
2240
2523
  data?: {
2524
+ /**
2525
+ * The type of the cart item.
2526
+ */
2527
+ type?: "cart_item";
2241
2528
  /**
2242
2529
  * The unique identifier of the cart item.
2243
2530
  */
@@ -2258,176 +2545,89 @@ type UpdateCartsItems = {
2258
2545
  shipping_group_id?: string;
2259
2546
  };
2260
2547
  };
2261
- type AddAllOrNothingOptionsObject = {
2262
- /**
2263
- * When `true`, if an error occurs for any item, no items are added to the cart. When `false`, valid items are added to the cart and the items with errors are reported in the response. Default is `false`.
2264
- */
2265
- add_all_or_nothing?: boolean;
2548
+ type CartsRelationshipsAccountsData = {
2549
+ data?: Array<{
2550
+ /**
2551
+ * The ID of the account.
2552
+ */
2553
+ id?: string;
2554
+ /**
2555
+ * The type of related object. Ensure that it is account.
2556
+ */
2557
+ type?: string;
2558
+ }>;
2266
2559
  };
2267
- type UpdateAllOrNothingOptionsObject = {
2560
+ type CartsRelationshipsCustomersData = {
2561
+ data?: Array<{
2562
+ /**
2563
+ * The ID of the customer.
2564
+ */
2565
+ id?: string;
2566
+ /**
2567
+ * The type of related object. Ensure that it is customer.
2568
+ */
2569
+ type?: string;
2570
+ }>;
2571
+ };
2572
+ type CartsItemsTaxesObject = {
2268
2573
  /**
2269
- * When set to`true`, if an error occurs for any item, no items are updated in the cart. When set to `false`, valid items are updated in the cart and the items with errors are reported in the response. Default is `true`.
2574
+ * A unique tax code in this jurisdiction.
2270
2575
  */
2271
- update_all_or_nothing?: boolean;
2272
- };
2273
- type CartItemResponse = {
2576
+ code?: string;
2274
2577
  /**
2275
- * The unique ID of the product.
2578
+ * The relevant tax jurisdiction.
2276
2579
  */
2277
- readonly product_id?: string;
2580
+ jurisdiction?: string;
2278
2581
  /**
2279
- * The unique ID of the subscription offering for subscription items.
2582
+ * The name of the tax item.
2280
2583
  */
2281
- readonly subscription_offering_id?: string;
2584
+ name?: string;
2282
2585
  /**
2283
- * The name of this item
2586
+ * The tax rate represented as a decimal (12.5% -> 0.125). You can specify either `rate` or `amount`, but not both. Supplying both fields will result in an error.
2284
2587
  */
2285
- readonly name?: string;
2588
+ rate?: number;
2286
2589
  /**
2287
- * A description of the cart item.
2590
+ * The tax rate represented as a number ($10 -> 1000). You can specify either `rate` or `amount`, but not both. Supplying both fields will result in an error.
2288
2591
  */
2289
- readonly description?: string;
2592
+ amount?: number;
2290
2593
  /**
2291
- * The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.
2594
+ * The type of object being returned. Use `tax_item`.
2292
2595
  */
2293
- readonly catalog_id?: string;
2596
+ type: string;
2294
2597
  /**
2295
- * The catalog source. Always `pim` or `legacy`.
2598
+ * The unique identifier for this tax item.
2296
2599
  */
2297
- readonly catalog_source?: string;
2298
- readonly image?: {
2299
- /**
2300
- * The MIME type for the uploaded file.
2301
- */
2302
- readonly mime_type?: string;
2303
- /**
2304
- * The name of the image file that was uploaded.
2305
- */
2306
- readonly file_name?: string;
2307
- /**
2308
- * The link to the image.
2309
- */
2310
- readonly href?: string;
2311
- };
2312
- readonly manage_stock?: boolean;
2313
- unit_price?: ItemPriceData;
2314
- value?: ItemPriceData;
2315
- readonly links?: {
2316
- /**
2317
- * A URL related to the resource.
2318
- */
2319
- product?: string;
2320
- };
2321
- readonly meta?: {
2322
- display_price?: {
2323
- with_tax?: FormattedPriceData;
2324
- without_tax?: FormattedPriceData;
2325
- tax?: FormattedPriceData;
2326
- discount?: FormattedPriceData;
2327
- without_discount?: FormattedPriceData;
2328
- };
2329
- timestamps?: CartCheckoutTimestamps;
2330
- };
2600
+ readonly id?: string;
2331
2601
  };
2332
- type CartsResponse = {
2333
- data?: Array<CartItemsObjectResponse>;
2334
- meta?: {
2335
- display_price?: {
2336
- with_tax?: FormattedPriceData;
2337
- without_tax?: FormattedPriceData;
2338
- tax?: FormattedPriceData;
2339
- discount?: FormattedPriceData;
2340
- without_discount?: FormattedPriceData;
2341
- discounts?: {
2342
- [key: string]: {
2343
- amount?: number;
2344
- currency?: string;
2345
- formatted?: string;
2346
- };
2602
+ type CartItemTaxesEntityResponse = {
2603
+ data: CartsItemsTaxesObject;
2604
+ };
2605
+ type CartItemRelationship = {
2606
+ relationships?: {
2607
+ order?: {
2608
+ data?: {
2609
+ /**
2610
+ * This specifies the type of item.
2611
+ */
2612
+ type?: string;
2613
+ /**
2614
+ * This specifies the ID of the cart_item or custom_item in the cart.
2615
+ */
2616
+ id?: string;
2347
2617
  };
2348
2618
  };
2349
- timestamps?: CartTimestamps;
2350
2619
  };
2351
2620
  };
2352
- type ItemPriceData = {
2353
- /**
2354
- * The amount for this item as an integer.
2355
- */
2356
- readonly amount?: number;
2357
- /**
2358
- * The currency this item was added to the cart as.
2359
- */
2360
- readonly currency?: string;
2361
- /**
2362
- * Whether or not this price is tax inclusive.
2363
- */
2364
- readonly includes_tax?: boolean;
2365
- };
2366
- type CartsRelationshipsAccountsData = {
2367
- data?: Array<{
2368
- /**
2369
- * The ID of the account.
2370
- */
2371
- id?: string;
2372
- /**
2373
- * The type of related object. Ensure that it is account.
2374
- */
2375
- type?: string;
2376
- }>;
2377
- };
2378
- type CartsRelationshipsCustomersData = {
2379
- data?: Array<{
2380
- /**
2381
- * The ID of the customer.
2382
- */
2383
- id?: string;
2384
- /**
2385
- * The type of related object. Ensure that it is customer.
2386
- */
2387
- type?: string;
2388
- }>;
2389
- };
2390
- type CartsItemsTaxesObject = {
2391
- /**
2392
- * A unique tax code in this jurisdiction.
2393
- */
2394
- code?: string;
2395
- /**
2396
- * The relevant tax jurisdiction.
2397
- */
2398
- jurisdiction?: string;
2399
- /**
2400
- * The name of the tax item.
2401
- */
2402
- name?: string;
2403
- /**
2404
- * The tax rate represented as a decimal (12.5% -> 0.125).
2405
- */
2406
- rate: number;
2407
- /**
2408
- * The type of object being returned. Use `tax_item`.
2409
- */
2410
- type: string;
2411
- /**
2412
- * The unique identifier for this tax item.
2413
- */
2414
- readonly id?: string;
2415
- };
2416
- type CartsBulkCustomDiscounts = {
2417
- data?: Array<CartsCustomDiscountsObject & CartItemBulkCustomDiscountObject>;
2418
- options?: AddAllOrNothingOptionsObject;
2419
- };
2420
- type CartsBulkCustomDiscountsResponse = {
2421
- data?: Array<CartsCustomDiscountsResponse & CartItemBulkCustomDiscountResponse>;
2621
+ type CartsBulkTaxes = {
2622
+ data?: Array<CartsItemsTaxesObject & CartItemRelationship>;
2422
2623
  options?: AddAllOrNothingOptionsObject;
2423
2624
  };
2424
- type CartItemBulkCustomDiscountObject = CartsCustomDiscountsObject & CustomDiscountRelationshipsCartItemRequest;
2425
- type CartItemBulkCustomDiscountResponse = CartsCustomDiscountsResponse & CustomDiscountRelationshipsCartItemRequest;
2426
2625
  type CartsCustomDiscountsObject = {
2427
- /**
2428
- * Specifies an amount to be applied for the custom discount. It must be less than zero.
2429
- */
2430
- amount: number;
2626
+ amount: number | {
2627
+ amount?: number;
2628
+ currency?: string;
2629
+ formatted?: string;
2630
+ };
2431
2631
  /**
2432
2632
  * Specifies a description for the custom discount.
2433
2633
  */
@@ -2449,7 +2649,36 @@ type CartsCustomDiscountsObject = {
2449
2649
  */
2450
2650
  type: string;
2451
2651
  };
2452
- type CartsCustomDiscountsResponse = {
2652
+ type CustomDiscountRelationshipsCartItemRequest = {
2653
+ relationships?: {
2654
+ item?: {
2655
+ data?: {
2656
+ /**
2657
+ * Specifies the type of item. For example, `custom_item` or `cart_item`.
2658
+ */
2659
+ type?: string;
2660
+ /**
2661
+ * Specifies the unique identifier of the `cart_item` or `custom_item` in the cart.
2662
+ */
2663
+ id?: string;
2664
+ };
2665
+ };
2666
+ };
2667
+ };
2668
+ type CartItemBulkCustomDiscountObject = CartsCustomDiscountsObject & CustomDiscountRelationshipsCartItemRequest;
2669
+ type CartsBulkCustomDiscounts = {
2670
+ data?: Array<CartsCustomDiscountsObject & CartItemBulkCustomDiscountObject>;
2671
+ options?: AddAllOrNothingOptionsObject;
2672
+ };
2673
+ type CartsBulkCustomDiscountsResponse = {
2674
+ data?: CartsCustomDiscountsObject;
2675
+ options?: AddAllOrNothingOptionsObject;
2676
+ };
2677
+ type CartsBulkCustomDiscountsCollectionResponse = {
2678
+ data?: Array<CartsCustomDiscountsObject>;
2679
+ options?: AddAllOrNothingOptionsObject;
2680
+ };
2681
+ type CartsCustomDiscountsResponseObject = {
2453
2682
  amount?: {
2454
2683
  /**
2455
2684
  * Specifies an amount to be applied for the custom discount. It must be less than zero.
@@ -2489,144 +2718,177 @@ type CartsCustomDiscountsResponse = {
2489
2718
  */
2490
2719
  readonly id?: string;
2491
2720
  };
2492
- type CustomDiscountRelationshipsCartItemRequest = {
2493
- relationships?: {
2494
- item?: {
2495
- data?: {
2496
- /**
2497
- * Specifies the type of item. For example, `custom_item` or `cart_item`.
2498
- */
2499
- type?: string;
2500
- /**
2501
- * Specifies the unique identifier of the `cart_item` or `custom_item` in the cart.
2502
- */
2503
- id?: string;
2504
- };
2505
- };
2506
- };
2507
- };
2508
- type CartItemRelationship = {
2509
- relationships?: {
2510
- order?: {
2511
- data?: {
2512
- /**
2513
- * This specifies the type of item.
2514
- */
2515
- type?: string;
2516
- /**
2517
- * This specifies the ID of the cart_item or custom_item in the cart.
2518
- */
2519
- id?: string;
2520
- };
2521
- };
2522
- };
2721
+ type CartsCustomDiscountsEntityRequest = {
2722
+ data?: CartsCustomDiscountsResponseObject;
2523
2723
  };
2524
- type CartsBulkTaxes = {
2525
- data?: Array<CartsItemsTaxesObject & CartItemRelationship>;
2526
- options?: AddAllOrNothingOptionsObject;
2724
+ type CartsCustomDiscountsEntityResponse = {
2725
+ data?: CartsCustomDiscountsObject;
2527
2726
  };
2528
- type OrdersAnonymizeRequest = {
2529
- data?: OrdersAnonymizeData;
2727
+ type CartsCustomDiscountsCollectionResponse = {
2728
+ data?: Array<CartsCustomDiscountsObject>;
2530
2729
  };
2531
- type OrdersAnonymizeData = {
2730
+ type ShippingAddress = {
2532
2731
  /**
2533
- * The unique identifiers of the orders to be anonymized. You can anonymize multiple orders at the same time.
2732
+ * First name of the shipping recipient.
2534
2733
  */
2535
- order_ids?: Array<string>;
2734
+ first_name: string;
2735
+ /**
2736
+ * Last name of the shipping recipient.
2737
+ */
2738
+ last_name: string;
2739
+ /**
2740
+ * Phone number of the shipping recipient.
2741
+ */
2742
+ phone_number: string;
2743
+ /**
2744
+ * Company of the shipping recipient.
2745
+ */
2746
+ company_name: string;
2747
+ /**
2748
+ * First line of the shipping address.
2749
+ */
2750
+ line_1: string;
2751
+ /**
2752
+ * Second line of the shipping address.
2753
+ */
2754
+ line_2: string;
2755
+ /**
2756
+ * City of the shipping address.
2757
+ */
2758
+ city: string;
2759
+ /**
2760
+ * Post code of the shipping address.
2761
+ */
2762
+ postcode: string;
2763
+ /**
2764
+ * County of the shipping address.
2765
+ */
2766
+ county: string;
2767
+ /**
2768
+ * Country of the shipping address.
2769
+ */
2770
+ country: string;
2771
+ /**
2772
+ * State, province, or region of the shipping address.
2773
+ */
2774
+ region?: string;
2775
+ /**
2776
+ * Delivery instructions.
2777
+ */
2778
+ instructions: string;
2536
2779
  };
2537
- type OrdersUpdateRequest = {
2538
- data?: OrdersAddressData | OrdersCancelData | OrdersFulfilledData;
2780
+ type DeliveryEstimate = {
2781
+ start?: Date;
2782
+ end?: Date;
2539
2783
  };
2540
- type OrdersAddressData = {
2784
+ type Money = {
2541
2785
  /**
2542
- * Specifies a user-managed, optional field used as an alternative to the existing order_id. If provided, the order-number will be sent to Authorize.net instead of the order_id, and will appear as the invoice number in Authorize.net transactions.
2786
+ * Amount in minor currency units (e.g., cents).
2543
2787
  */
2544
- order_number?: string;
2788
+ amount: number;
2545
2789
  /**
2546
- * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2790
+ * ISO 4217 currency code (e.g., "USD").
2547
2791
  */
2548
- external_ref?: string;
2549
- shipping_address: {
2550
- /**
2551
- * Specifies the first name of the address holder.
2552
- */
2553
- first_name?: string;
2554
- /**
2555
- * Specifies the last name of the address holder.
2556
- */
2557
- last_name?: string;
2558
- /**
2559
- * Specifies the phone number of the address holder.
2560
- */
2561
- phone_number?: string;
2562
- /**
2563
- * Specifies the company name.
2564
- */
2565
- company_name?: string;
2566
- /**
2567
- * Specifies the first line of the address.
2568
- */
2569
- line_1?: string;
2570
- /**
2571
- * Specifies the second line of the address.
2572
- */
2573
- line_2?: string;
2574
- /**
2575
- * Specifies the name of the city in the shipping address.
2576
- */
2577
- city?: string;
2578
- /**
2579
- * Specifies the county of the shipping address.
2580
- */
2581
- county?: string;
2582
- /**
2583
- * Specifies the state, province, or region of the shipping address.
2584
- */
2585
- region?: string;
2586
- /**
2587
- * Specifies the postcode or ZIP code of the address.
2588
- */
2589
- postcode?: string;
2590
- /**
2591
- * Specifies the country in the shipping address.
2592
- */
2593
- country?: string;
2594
- /**
2595
- * Specifies any instructions provided with the shipping address.
2596
- */
2597
- instructions?: string;
2598
- };
2599
- };
2600
- type OrdersCancelData = {
2792
+ currency: string;
2601
2793
  /**
2602
- * The status of the order. You can only update the status to `cancelled`.
2794
+ * Whether the amount includes tax.
2603
2795
  */
2604
- status: string;
2796
+ includes_tax: boolean;
2797
+ };
2798
+ type Discount = {
2799
+ amount: Money;
2605
2800
  /**
2606
- * The type of the resource. You must use order.
2801
+ * The discount code used, if applicable.
2607
2802
  */
2608
- type: string;
2803
+ code?: string;
2609
2804
  /**
2610
- * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2805
+ * Unique identifier for the discount.
2611
2806
  */
2612
- external_ref?: string;
2613
- };
2614
- type OrdersFulfilledData = {
2807
+ id: string;
2615
2808
  /**
2616
- * The shipping status of the order. You can only update the shipping status to `fulfilled`.
2809
+ * The source or origin of the promotion, if applicable.
2617
2810
  */
2618
- shipping: string;
2811
+ promotion_source?: string;
2619
2812
  /**
2620
- * The type of the resource. You must use order.
2813
+ * Indicates whether the discount applies to the entire cart.
2621
2814
  */
2622
- type: string;
2815
+ is_cart_discount?: boolean;
2623
2816
  /**
2624
- * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2817
+ * Order in which the discount was applied.
2625
2818
  */
2626
- external_ref?: string;
2819
+ ordinal?: number;
2627
2820
  };
2628
- type PaymentsRequest = {
2629
- data?: DataPaymentObject;
2821
+ type Discounts = Array<Discount>;
2822
+ type ShippingPriceResponse = {
2823
+ total: FormattedPriceData;
2824
+ base: FormattedPriceData;
2825
+ tax?: FormattedPriceData;
2826
+ fees?: FormattedPriceData;
2827
+ discount?: FormattedPriceData;
2828
+ };
2829
+ type OrderPriceWrapperMeta = {
2830
+ with_tax: FormattedPriceData;
2831
+ without_tax: FormattedPriceData;
2832
+ tax: FormattedPriceData;
2833
+ discount: FormattedPriceData;
2834
+ balance_owing: FormattedPriceData;
2835
+ paid: FormattedPriceData;
2836
+ authorized: FormattedPriceData;
2837
+ without_discount: FormattedPriceData;
2838
+ shipping: FormattedPriceData;
2839
+ shipping_discount: FormattedPriceData;
2840
+ };
2841
+ type ShippingGroupMeta = {
2842
+ shipping_display_price?: ShippingPriceResponse;
2843
+ total_display_price?: OrderPriceWrapperMeta;
2844
+ };
2845
+ type ShippingGroupResponse = {
2846
+ type?: "shipping_group";
2847
+ id?: string;
2848
+ relation?: string;
2849
+ cart_id?: string;
2850
+ order_id?: string;
2851
+ shipping_type?: string;
2852
+ tracking_reference?: string;
2853
+ address?: ShippingAddress;
2854
+ delivery_estimate?: DeliveryEstimate;
2855
+ createdAt?: Date;
2856
+ updatedAt?: Date;
2857
+ relationships?: {
2858
+ cart?: RelationshipItem;
2859
+ order?: RelationshipItem;
2860
+ };
2861
+ discounts?: Discounts;
2862
+ meta?: ShippingGroupMeta;
2863
+ };
2864
+ type ShippingPriceRequest = {
2865
+ total?: number;
2866
+ base?: number;
2867
+ tax?: number;
2868
+ fees?: number;
2869
+ discount?: number;
2870
+ };
2871
+ type CreateShippingGroupRequest = {
2872
+ data?: {
2873
+ type?: "shipping_group";
2874
+ shipping_type?: string;
2875
+ tracking_reference?: string;
2876
+ shipping_price?: ShippingPriceRequest;
2877
+ address?: ShippingAddress;
2878
+ includes_tax?: boolean;
2879
+ delivery_estimate?: DeliveryEstimate;
2880
+ };
2881
+ };
2882
+ type UpdateCartShippingGroupRequest = {
2883
+ data?: {
2884
+ type?: "shipping_group";
2885
+ shipping_type?: string;
2886
+ tracking_reference?: string;
2887
+ shipping_price?: ShippingPriceRequest;
2888
+ address?: ShippingAddress;
2889
+ includes_tax?: boolean;
2890
+ delivery_estimate?: DeliveryEstimate;
2891
+ };
2630
2892
  };
2631
2893
  type Gateway = "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_connect" | "stripe_payment_intents";
2632
2894
  /**
@@ -2644,376 +2906,373 @@ type DataBasePayments = {
2644
2906
  */
2645
2907
  amount?: number;
2646
2908
  };
2647
- type DataAdyenPayment = DataBasePayments & {
2648
- /**
2649
- * Specifies the gateway. You must use `adyen`.
2650
- */
2651
- gateway: "adyen";
2652
- options?: {
2909
+ type ElasticPathPaymentsPoweredByStripePayment = {
2910
+ data?: DataBasePayments & {
2653
2911
  /**
2654
- * The shopper reference token associated with the saved payment method.
2912
+ * Specifies the gateway. You must use `elastic_path_payments_stripe`.
2655
2913
  */
2656
- shopper_reference?: string;
2914
+ gateway?: "elastic_path_payments_stripe";
2915
+ options?: {
2916
+ /**
2917
+ * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
2918
+ */
2919
+ receipt_email?: string;
2920
+ /**
2921
+ * Parent object determining whether to use Stripe's `automatic_payment_methods` setting.
2922
+ */
2923
+ automatic_payment_methods?: {
2924
+ /**
2925
+ * When set to true, it displays all enabled payment methods from the Stripe dashboard. When set to false, the Stripe default, which is card, is used.
2926
+ */
2927
+ enabled?: boolean;
2928
+ };
2929
+ };
2657
2930
  /**
2658
- * Enter CardOnFile for a one-time purchase.
2931
+ * Specifies the Stripe payment method types configured for the store. See [Stripe Documentation](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_types).
2659
2932
  */
2660
- recurring_processing_model?: string;
2661
- };
2662
- /**
2663
- * The Adyen recurringDetailReference payment method identifier.
2664
- */
2665
- payment: string;
2666
- };
2667
- type DataAuthorizeNetPayment = DataBasePayments & {
2668
- /**
2669
- * Specifies the gateway. You must use `authorize_net`.
2670
- */
2671
- gateway: "authorize_net";
2672
- options?: {
2933
+ payment_method_types?: Array<string>;
2673
2934
  /**
2674
- * The Authorize.net customer payment profile ID.
2935
+ * Specifies the Stripe token or source.
2675
2936
  */
2676
- customer_payment_profile_id?: string;
2937
+ payment?: string;
2677
2938
  };
2678
- /**
2679
- * The Authorize.net customer profile ID.
2680
- */
2681
- payment: string;
2682
2939
  };
2683
- type DataBraintreePayment = DataBasePayments & {
2940
+ type CartPaymentUpdate = {
2941
+ data: {
2942
+ gateway: string;
2943
+ method: string;
2944
+ payment_method_types: Array<string>;
2945
+ amount: number;
2946
+ options?: {
2947
+ [key: string]: unknown;
2948
+ };
2949
+ };
2950
+ };
2951
+ type BillingAddress = {
2684
2952
  /**
2685
- * Specifies the gateway. You must use `braintree`.
2953
+ * First name of the billing recipient.
2686
2954
  */
2687
- gateway: "braintree";
2955
+ first_name: string;
2688
2956
  /**
2689
- * The Braintree Customer ID that you want to bill.
2957
+ * Last name of the billing recipient.
2690
2958
  */
2691
- payment: string;
2692
- };
2693
- type DataCardConnectPayment = DataBasePayments & {
2959
+ last_name: string;
2694
2960
  /**
2695
- * Specifies the gateway. You must use `card_connect`.
2961
+ * Company name of the billing recipient.
2696
2962
  */
2697
- gateway: "card_connect";
2963
+ company_name: string;
2698
2964
  /**
2699
- * Enter account_id, profile_id from CardPointe API. For example, 1|16178397535388255208.
2965
+ * First line of the billing address.
2700
2966
  */
2701
- payment: string;
2702
- };
2703
- type DataCyberSourcePayment = DataBasePayments & {
2967
+ line_1: string;
2704
2968
  /**
2705
- * Specifies the gateway. You must use `cyber_source`.
2969
+ * Second line of the billing address.
2706
2970
  */
2707
- gateway: "cyber_source";
2971
+ line_2: string;
2708
2972
  /**
2709
- * The CyberSource token.
2973
+ * City of the billing address.
2710
2974
  */
2711
- payment: string;
2712
- };
2713
- type ElasticPathPaymentsPoweredByStripePayment = DataBasePayments & {
2975
+ city: string;
2714
2976
  /**
2715
- * Specifies the gateway. You must use `elastic_path_payments_stripe`.
2977
+ * Postcode of the billing address.
2716
2978
  */
2717
- gateway: "elastic_path_payments_stripe";
2718
- options?: {
2719
- /**
2720
- * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
2721
- */
2722
- receipt_email?: string;
2723
- /**
2724
- * Parent object determining whether to use Stripe's `automatic_payment_methods` setting.
2725
- */
2726
- automatic_payment_methods?: {
2727
- /**
2728
- * When set to true, it displays all enabled payment methods from the Stripe dashboard. When set to false, the Stripe default, which is card, is used.
2729
- */
2730
- enabled?: boolean;
2731
- };
2732
- };
2979
+ postcode: string;
2733
2980
  /**
2734
- * Specifies the Stripe payment method types configured for the store. See [Stripe Documentation](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_types).
2981
+ * County of the billing address.
2735
2982
  */
2736
- payment_method_types?: Array<string>;
2983
+ county: string;
2737
2984
  /**
2738
- * Specifies the Stripe token or source.
2985
+ * Country of the billing address.
2739
2986
  */
2740
- payment?: string;
2741
- };
2742
- type DataManualPayment = DataBasePayments & {
2987
+ country: string;
2743
2988
  /**
2744
- * Specifies the type of payment gateway. You must use `manual`.
2989
+ * State, province, or region of the billing address.
2745
2990
  */
2746
- gateway: "manual";
2747
- paymentmethod_meta?: {
2748
- /**
2749
- * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend not to include personal information in this field.
2750
- */
2751
- custom_reference?: string;
2752
- /**
2753
- * A custom name associated with the payment method.
2754
- */
2755
- name?: string;
2756
- };
2991
+ region?: string;
2757
2992
  };
2758
- type DataPayPalExpressCheckoutPayment = DataBasePayments & {
2759
- /**
2760
- * Specifies the type of payment gateway. You must use `paypal_express_checkout`.
2761
- */
2762
- gateway: "paypal_express_checkout";
2763
- options?: {
2993
+ type CustomerCheckout = {
2994
+ data?: {
2764
2995
  /**
2765
- * The description for the payment.
2996
+ * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
2766
2997
  */
2767
- description?: string;
2998
+ order_number?: string;
2768
2999
  /**
2769
- * The descriptor appended to PayPal generated descriptor that is visible on the card statement of the payer.
3000
+ * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2770
3001
  */
2771
- soft_descriptor?: string;
2772
- application_context?: {
3002
+ external_ref?: string;
3003
+ customer?: {
2773
3004
  /**
2774
- * The label that overrides the business name in the PayPal account on the PayPal site.
3005
+ * The ID of the customer.
2775
3006
  */
2776
- brand_name?: string;
3007
+ id?: string;
2777
3008
  /**
2778
- * The locale pages that appear based on language and country code. PayPal supports a five-character code. For example, ja-JP.
3009
+ * The email of the customer.
2779
3010
  */
2780
- locale?: string;
3011
+ email?: string;
2781
3012
  /**
2782
- * The type of landing page to show on the PayPal site for customer checkout. Use values LOGIN, BILLING, or NO_PREFERENCE.
3013
+ * The name of the customer.
2783
3014
  */
2784
- landing_page?: string;
3015
+ name?: string;
3016
+ };
3017
+ billing_address?: BillingAddress;
3018
+ shipping_address?: ShippingAddress;
3019
+ };
3020
+ };
3021
+ type AccountCheckout = {
3022
+ data?: {
3023
+ /**
3024
+ * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
3025
+ */
3026
+ order_number?: string;
3027
+ /**
3028
+ * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
3029
+ */
3030
+ external_ref?: string;
3031
+ account?: {
2785
3032
  /**
2786
- * The shipping preference. Use SET_PROVIDED_ADDRESS value. This parameter does allow the user to change their address on PayPal site.
3033
+ * The account ID.
2787
3034
  */
2788
- shipping_preference?: string;
3035
+ id?: string;
2789
3036
  /**
2790
- * If you set `useraction=commit` in the query string, the flow redirects the buyer to the PayPal payment page and displays a Pay Now button. When the shopper clicks **Pay Now**, call `DoExpressCheckoutPayment` to complete the payment without additional interaction from the shopper. Choose this flow when you know the final payment amount when you initiate the checkout flow.
3037
+ * The account member ID.
2791
3038
  */
2792
- user_action?: string;
3039
+ member_id?: string;
3040
+ };
3041
+ contact?: {
2793
3042
  /**
2794
- * The callback URL for PayPal to redirect the user in the case of approved payment.
3043
+ * The name of the account member.
2795
3044
  */
2796
- return_url?: string;
3045
+ name?: string;
2797
3046
  /**
2798
- * The callback URL for PayPal to redirect user in the case a cancelled payment.
3047
+ * The email address of the account member.
2799
3048
  */
2800
- cancel_url?: string;
3049
+ email?: string;
2801
3050
  };
3051
+ billing_address?: BillingAddress;
3052
+ shipping_address?: ShippingAddress;
2802
3053
  };
2803
3054
  };
2804
- type DataStripePayment = DataBasePayments & {
2805
- /**
2806
- * Specifies the type of payment gateway. You must use `stripe`.
2807
- */
2808
- gateway: "stripe";
2809
- options?: {
2810
- /**
2811
- * The option to provide an email for Stripe receipts. Specify live mode to access this feature.
2812
- */
2813
- receipt_email?: string;
3055
+ type OrderMeta = {
3056
+ timestamps?: CartCheckoutTimestamps;
3057
+ display_price?: {
3058
+ with_tax?: FormattedPriceData;
3059
+ without_tax?: FormattedPriceData;
3060
+ tax?: FormattedPriceData;
3061
+ discount?: FormattedPriceData;
3062
+ balance_owing?: FormattedPriceData;
3063
+ paid?: FormattedPriceData;
3064
+ authorized?: FormattedPriceData;
3065
+ without_discount?: FormattedPriceData;
3066
+ shipping?: FormattedPriceData;
3067
+ shipping_discount?: FormattedPriceData;
2814
3068
  };
2815
- /**
2816
- * The Stripe token or source.
2817
- */
2818
- payment?: string;
2819
3069
  };
2820
- type DataStripeConnectPayment = DataBasePayments & {
3070
+ type Contact = {
2821
3071
  /**
2822
- * Specifies the type of payment gateway. You must use `stripe_connect`.
3072
+ * The email address of the contact.
2823
3073
  */
2824
- gateway: "stripe_connect";
2825
- options?: {
2826
- /**
2827
- * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
2828
- */
2829
- receipt_email?: string;
2830
- };
3074
+ email?: string;
2831
3075
  /**
2832
- * Specifies the Stripe token or source.
3076
+ * The name of the contact.
2833
3077
  */
2834
- payment?: string;
3078
+ name?: string;
2835
3079
  };
2836
- type DataStripePaymentIntentsPayment = DataBasePayments & {
2837
- /**
2838
- * Specifies the type of payment gateway. You must use `stripe_payment_intents`.
2839
- */
2840
- gateway: "stripe_payment_intents";
2841
- options?: {
2842
- /**
2843
- * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
2844
- */
2845
- receipt_email?: string;
2846
- };
2847
- /**
2848
- * Specifies the Stripe token or source.
2849
- */
2850
- payment?: string;
3080
+ /**
3081
+ * Single relationship
3082
+ */
3083
+ type SingleRelationship = {
3084
+ data?: RelationshipItem;
2851
3085
  };
2852
- type DataPaymentObject = DataAdyenPayment | DataAuthorizeNetPayment | DataBraintreePayment | DataCardConnectPayment | DataCyberSourcePayment | ElasticPathPaymentsPoweredByStripePayment | DataManualPayment | DataPayPalExpressCheckoutPayment | DataStripePayment | DataStripeConnectPayment | DataStripePaymentIntentsPayment;
2853
- type TransactionResponse = {
2854
- /**
2855
- * The ID of the transaction.
2856
- */
2857
- readonly id?: string;
3086
+ /**
3087
+ * Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.
3088
+ */
3089
+ type Status = "complete" | "incomplete" | "cancelled" | "processing";
3090
+ /**
3091
+ * Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.
3092
+ */
3093
+ type Payment = "authorized" | "paid" | "unpaid" | "refunded" | "partially_paid" | "partially_authorized";
3094
+ /**
3095
+ * Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.
3096
+ */
3097
+ type Shipping = "unfulfilled" | "fulfilled";
3098
+ type OrderResponse = {
2858
3099
  /**
2859
- * The payment gateway reference.
3100
+ * Specifies the type of object being returned. You must use `order`.
2860
3101
  */
2861
- reference?: string;
3102
+ type?: "order";
2862
3103
  /**
2863
- * A custom name associated with the payment method.
3104
+ * Specifies a user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
2864
3105
  */
2865
- name?: string;
3106
+ order_number?: string;
2866
3107
  /**
2867
- * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend you not to include personal information in this field.
3108
+ * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2868
3109
  */
2869
- custom_reference?: string;
3110
+ external_ref?: string;
2870
3111
  /**
2871
- * The name of the payment gateway used.
3112
+ * Specifies the unique identifier of the order.
2872
3113
  */
2873
- gateway?: "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_connect" | "stripe_payment_intents";
3114
+ readonly id?: string;
2874
3115
  /**
2875
- * The amount for this transaction.
3116
+ * Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.
2876
3117
  */
2877
- amount?: number;
3118
+ status?: "complete" | "incomplete" | "cancelled" | "processing";
2878
3119
  /**
2879
- * The refunded amount.
3120
+ * Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.
2880
3121
  */
2881
- refunded_amount?: number;
3122
+ payment?: "authorized" | "paid" | "unpaid" | "refunded" | "partially_paid" | "partially_authorized";
2882
3123
  /**
2883
- * The transaction currency.
3124
+ * Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.
2884
3125
  */
2885
- currency?: string;
3126
+ shipping?: "unfulfilled" | "fulfilled";
2886
3127
  /**
2887
- * The type of transaction, such as `purchase`, `capture`, `authorize` or `refund`.
3128
+ * Specifies if the order is anonymized.
2888
3129
  */
2889
- "transaction-type"?: string;
3130
+ anonymized?: boolean;
2890
3131
  /**
2891
- * The status provided by the gateway for this transaction, such as `complete` or `failed`.
3132
+ * Stripe Payment Intent ID. Please see Stripe's Payment Intent [documentation](https://docs.stripe.com/api/payment_intents) for more information on Payment Intents.
2892
3133
  */
2893
- status?: string;
3134
+ payment_intent_id?: string;
3135
+ custom_attributes?: CustomAttributes;
3136
+ meta?: OrderMeta;
3137
+ billing_address?: BillingAddress;
3138
+ contact?: Contact;
3139
+ customer?: Contact;
3140
+ shipping_address?: ShippingAddress;
2894
3141
  relationships?: {
2895
- order?: {
2896
- data?: {
2897
- /**
2898
- * Represents the type of the object being returned. It is always `order`.
2899
- */
2900
- type?: string;
2901
- /**
2902
- * The ID of the order.
2903
- */
2904
- id?: string;
2905
- };
2906
- };
2907
- };
2908
- meta?: {
2909
- display_price?: FormattedPriceData;
2910
- display_refunded_amount?: FormattedPriceData;
2911
- timestamps?: CartCheckoutTimestamps;
3142
+ items?: RelationshipArray;
3143
+ custom_discounts?: RelationshipArray;
3144
+ promotions?: RelationshipArray;
3145
+ customer?: SingleRelationship;
3146
+ account?: SingleRelationship;
3147
+ account_member?: SingleRelationship;
2912
3148
  };
2913
3149
  };
2914
- type OrdersTransactionsConfirmRequest = {
2915
- data?: {
2916
- [key: string]: unknown;
2917
- };
3150
+ type OrderEntityResponse = {
3151
+ data?: OrderResponse;
2918
3152
  };
2919
- type OrdersTransactionsCaptureRequest = {
2920
- data?: {
2921
- options?: {
2922
- soft_descriptor?: string;
2923
- note_to_payer?: string;
2924
- };
2925
- };
3153
+ type ResponseMetaOrders = {
3154
+ page?: ResponsePaginationPage;
3155
+ results?: ResponsePaginationResults;
2926
3156
  };
2927
- type OrdersTransactionsRefundRequest = {
2928
- data?: {
3157
+ type OrderCollectionResponse = {
3158
+ data?: Array<OrderResponse>;
3159
+ links?: ResponsePageLinks;
3160
+ meta?: ResponseMetaOrders;
3161
+ };
3162
+ type OrdersAddressData = {
3163
+ /**
3164
+ * Specifies a user-managed, optional field used as an alternative to the existing order_id. If provided, the order-number will be sent to Authorize.net instead of the order_id, and will appear as the invoice number in Authorize.net transactions.
3165
+ */
3166
+ order_number?: string;
3167
+ /**
3168
+ * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
3169
+ */
3170
+ external_ref?: string;
3171
+ shipping_address: {
2929
3172
  /**
2930
- * The amount value to be refunded. If this field is not provided, it will be considered as manual refund (Mark as Refunded) and the refund process must be manually handled via payment provider. If the amount value is same as payment value, then it will be treated as a full refund and sent to the payment provider to process refund automatically.
3173
+ * Specifies the first name of the address holder.
2931
3174
  */
2932
- amount?: number;
2933
- options?: {
2934
- /**
2935
- * Provides comments about the refund. It is used by PayPal Express.
2936
- */
2937
- note?: string;
2938
- };
2939
- };
2940
- };
2941
- type OrdersTransactionsCancelRequest = {
2942
- data?: {
2943
- options?: {
2944
- [key: string]: unknown;
2945
- };
3175
+ first_name?: string;
2946
3176
  /**
2947
- * Specifies the reason for canceling the transaction. The reason may include `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`.
3177
+ * Specifies the last name of the address holder.
2948
3178
  */
2949
- reason?: string;
3179
+ last_name?: string;
3180
+ /**
3181
+ * Specifies the phone number of the address holder.
3182
+ */
3183
+ phone_number?: string;
3184
+ /**
3185
+ * Specifies the company name.
3186
+ */
3187
+ company_name?: string;
3188
+ /**
3189
+ * Specifies the first line of the address.
3190
+ */
3191
+ line_1?: string;
3192
+ /**
3193
+ * Specifies the second line of the address.
3194
+ */
3195
+ line_2?: string;
3196
+ /**
3197
+ * Specifies the name of the city in the shipping address.
3198
+ */
3199
+ city?: string;
3200
+ /**
3201
+ * Specifies the county of the shipping address.
3202
+ */
3203
+ county?: string;
3204
+ /**
3205
+ * Specifies the state, province, or region of the shipping address.
3206
+ */
3207
+ region?: string;
3208
+ /**
3209
+ * Specifies the postcode or ZIP code of the address.
3210
+ */
3211
+ postcode?: string;
3212
+ /**
3213
+ * Specifies the country in the shipping address.
3214
+ */
3215
+ country?: string;
3216
+ /**
3217
+ * Specifies any instructions provided with the shipping address.
3218
+ */
3219
+ instructions?: string;
2950
3220
  };
2951
3221
  };
2952
- type OrderPriceData = {
3222
+ type OrdersCancelData = {
2953
3223
  /**
2954
- * The amount for this item.
3224
+ * The status of the order. You can only update the status to `cancelled`.
2955
3225
  */
2956
- amount?: number;
3226
+ status: string;
2957
3227
  /**
2958
- * The currency this item.
3228
+ * The type of the resource. You must use order.
2959
3229
  */
2960
- currency?: string;
3230
+ type: string;
2961
3231
  /**
2962
- * Whether this price is tax inclusive.
3232
+ * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2963
3233
  */
2964
- includes_tax?: boolean;
3234
+ external_ref?: string;
2965
3235
  };
2966
- /**
2967
- * Relationship data entry
2968
- */
2969
- type RelationshipItem = {
3236
+ type OrdersFulfilledData = {
2970
3237
  /**
2971
- * The type of related resource.
3238
+ * The shipping status of the order. You can only update the shipping status to `fulfilled`.
2972
3239
  */
2973
- type?: string;
3240
+ shipping: string;
2974
3241
  /**
2975
- * The ID of the related resource.
3242
+ * The type of the resource. You must use order.
2976
3243
  */
2977
- id?: string;
2978
- };
2979
- /**
2980
- * Array of relationships
2981
- */
2982
- type RelationshipArray = {
3244
+ type: string;
2983
3245
  /**
2984
- * Individual relationships
3246
+ * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2985
3247
  */
2986
- data?: Array<RelationshipItem>;
3248
+ external_ref?: string;
2987
3249
  };
2988
- /**
2989
- * Single relationship
2990
- */
2991
- type SingleRelationship = {
2992
- data?: RelationshipItem;
3250
+ type OrdersUpdateRequest = {
3251
+ data?: OrdersAddressData | OrdersCancelData | OrdersFulfilledData;
2993
3252
  };
2994
- type FormattedPriceData = {
3253
+ type OrderPriceData = {
2995
3254
  /**
2996
- * The raw total of this cart.
3255
+ * The amount for this item.
2997
3256
  */
2998
3257
  amount?: number;
2999
3258
  /**
3000
- * The currency set for this cart.
3259
+ * The currency this item.
3001
3260
  */
3002
3261
  currency?: string;
3003
3262
  /**
3004
- * The tax inclusive formatted total based on the currency.
3263
+ * Whether this price is tax inclusive.
3005
3264
  */
3006
- formatted?: string;
3007
- };
3008
- type OrderItemFormattedUnitPriceData = {
3009
- unit?: FormattedPriceData;
3010
- value?: FormattedPriceData;
3265
+ includes_tax?: boolean;
3011
3266
  };
3012
3267
  type DiscountData = {
3013
3268
  amount?: OrderPriceData;
3014
3269
  code?: string;
3015
3270
  readonly id?: string;
3016
3271
  };
3272
+ type OrderItemFormattedUnitPriceData = {
3273
+ unit?: FormattedPriceData;
3274
+ value?: FormattedPriceData;
3275
+ };
3017
3276
  type OrderItemResponse = {
3018
3277
  /**
3019
3278
  * The type represents the object being returned.
@@ -3089,315 +3348,383 @@ type OrderItemResponse = {
3089
3348
  */
3090
3349
  catalog_source?: string;
3091
3350
  };
3092
- type OrderResponse = {
3351
+ type OrderItemCollectionResponse = {
3352
+ data?: Array<OrderItemResponse>;
3353
+ };
3354
+ type OrdersAnonymizeData = {
3093
3355
  /**
3094
- * Specifies the type of object being returned. You must use `order`.
3356
+ * The unique identifiers of the orders to be anonymized. You can anonymize multiple orders at the same time.
3095
3357
  */
3096
- type?: string;
3358
+ order_ids?: Array<string>;
3359
+ };
3360
+ type OrdersAnonymizeRequest = {
3361
+ data?: OrdersAnonymizeData;
3362
+ };
3363
+ type OrdersListResponse = {
3364
+ data: Array<OrderResponse>;
3365
+ };
3366
+ type DataAdyenPayment = DataBasePayments & {
3097
3367
  /**
3098
- * Specifies a user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
3368
+ * Specifies the gateway. You must use `adyen`.
3099
3369
  */
3100
- order_number?: string;
3370
+ gateway: "adyen";
3371
+ options?: {
3372
+ /**
3373
+ * The shopper reference token associated with the saved payment method.
3374
+ */
3375
+ shopper_reference?: string;
3376
+ /**
3377
+ * Enter CardOnFile for a one-time purchase.
3378
+ */
3379
+ recurring_processing_model?: string;
3380
+ };
3101
3381
  /**
3102
- * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
3382
+ * The Adyen recurringDetailReference payment method identifier.
3103
3383
  */
3104
- external_ref?: string;
3384
+ payment: string;
3385
+ };
3386
+ type DataAuthorizeNetPayment = DataBasePayments & {
3105
3387
  /**
3106
- * Specifies the unique identifier of the order.
3388
+ * Specifies the gateway. You must use `authorize_net`.
3107
3389
  */
3108
- readonly id?: string;
3390
+ gateway: "authorize_net";
3391
+ options?: {
3392
+ /**
3393
+ * The Authorize.net customer payment profile ID.
3394
+ */
3395
+ customer_payment_profile_id?: string;
3396
+ };
3109
3397
  /**
3110
- * Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.
3398
+ * The Authorize.net customer profile ID.
3111
3399
  */
3112
- status?: string;
3400
+ payment: string;
3401
+ };
3402
+ type DataBraintreePayment = DataBasePayments & {
3113
3403
  /**
3114
- * Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.
3404
+ * Specifies the gateway. You must use `braintree`.
3405
+ */
3406
+ gateway: "braintree";
3407
+ /**
3408
+ * The Braintree Customer ID that you want to bill.
3409
+ */
3410
+ payment: string;
3411
+ };
3412
+ type DataCardConnectPayment = DataBasePayments & {
3413
+ /**
3414
+ * Specifies the gateway. You must use `card_connect`.
3415
+ */
3416
+ gateway: "card_connect";
3417
+ /**
3418
+ * Enter account_id, profile_id from CardPointe API. For example, 1|16178397535388255208.
3419
+ */
3420
+ payment: string;
3421
+ };
3422
+ type DataCyberSourcePayment = DataBasePayments & {
3423
+ /**
3424
+ * Specifies the gateway. You must use `cyber_source`.
3115
3425
  */
3116
- payment?: string;
3426
+ gateway: "cyber_source";
3117
3427
  /**
3118
- * Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.
3428
+ * The CyberSource token.
3119
3429
  */
3120
- shipping?: string;
3430
+ payment: string;
3431
+ };
3432
+ type DataManualPayment = DataBasePayments & {
3121
3433
  /**
3122
- * Specifies if the order is anonymized.
3434
+ * Specifies the type of payment gateway. You must use `manual`.
3123
3435
  */
3124
- anonymized?: boolean;
3125
- meta?: OrderMeta;
3126
- billing_address?: BillingAddress;
3127
- contact?: Contact;
3128
- customer?: {
3436
+ gateway: "manual";
3437
+ paymentmethod_meta?: {
3129
3438
  /**
3130
- * The name of the customer.
3439
+ * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend not to include personal information in this field.
3131
3440
  */
3132
- name?: string;
3441
+ custom_reference?: string;
3133
3442
  /**
3134
- * The email address of the customer.
3443
+ * A custom name associated with the payment method.
3135
3444
  */
3136
- email?: string;
3137
- };
3138
- shipping_address?: ShippingAddress;
3139
- relationships?: {
3140
- items?: RelationshipArray;
3141
- custom_discounts?: RelationshipArray;
3142
- promotions?: RelationshipArray;
3143
- customer?: SingleRelationship;
3144
- account?: SingleRelationship;
3145
- account_member?: SingleRelationship;
3146
- };
3147
- };
3148
- type OrderMeta = {
3149
- timestamps?: CartCheckoutTimestamps;
3150
- display_price?: {
3151
- with_tax?: FormattedPriceData;
3152
- without_tax?: FormattedPriceData;
3153
- tax?: FormattedPriceData;
3154
- discount?: FormattedPriceData;
3155
- balance_owing?: FormattedPriceData;
3156
- paid?: FormattedPriceData;
3157
- authorized?: FormattedPriceData;
3158
- without_discount?: FormattedPriceData;
3159
- shipping?: FormattedPriceData;
3160
- shipping_discount?: FormattedPriceData;
3445
+ name?: string;
3161
3446
  };
3162
3447
  };
3163
- type CustomerCheckout = {
3164
- data?: {
3448
+ type DataPayPalExpressCheckoutPayment = DataBasePayments & {
3449
+ /**
3450
+ * Specifies the type of payment gateway. You must use `paypal_express_checkout`.
3451
+ */
3452
+ gateway: "paypal_express_checkout";
3453
+ options?: {
3165
3454
  /**
3166
- * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
3455
+ * The description for the payment.
3167
3456
  */
3168
- order_number?: string;
3457
+ description?: string;
3169
3458
  /**
3170
- * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
3459
+ * The descriptor appended to PayPal generated descriptor that is visible on the card statement of the payer.
3171
3460
  */
3172
- external_ref?: string;
3173
- customer?: {
3461
+ soft_descriptor?: string;
3462
+ application_context?: {
3174
3463
  /**
3175
- * The ID of the customer.
3464
+ * The label that overrides the business name in the PayPal account on the PayPal site.
3176
3465
  */
3177
- id?: string;
3178
- };
3179
- billing_address?: BillingAddress;
3180
- shipping_address?: ShippingAddress;
3181
- };
3182
- };
3183
- type AccountCheckout = {
3184
- data?: {
3185
- /**
3186
- * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
3187
- */
3188
- order_number?: string;
3189
- /**
3190
- * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
3191
- */
3192
- external_ref?: string;
3193
- account?: {
3466
+ brand_name?: string;
3194
3467
  /**
3195
- * The account ID.
3468
+ * The locale pages that appear based on language and country code. PayPal supports a five-character code. For example, ja-JP.
3196
3469
  */
3197
- id?: string;
3470
+ locale?: string;
3198
3471
  /**
3199
- * The account member ID.
3472
+ * The type of landing page to show on the PayPal site for customer checkout. Use values LOGIN, BILLING, or NO_PREFERENCE.
3200
3473
  */
3201
- member_id?: string;
3202
- };
3203
- contact?: {
3474
+ landing_page?: string;
3204
3475
  /**
3205
- * The name of the account member.
3476
+ * The shipping preference. Use SET_PROVIDED_ADDRESS value. This parameter does allow the user to change their address on PayPal site.
3206
3477
  */
3207
- name?: string;
3478
+ shipping_preference?: string;
3208
3479
  /**
3209
- * The email address of the account member.
3480
+ * If you set `useraction=commit` in the query string, the flow redirects the buyer to the PayPal payment page and displays a Pay Now button. When the shopper clicks **Pay Now**, call `DoExpressCheckoutPayment` to complete the payment without additional interaction from the shopper. Choose this flow when you know the final payment amount when you initiate the checkout flow.
3210
3481
  */
3211
- email?: string;
3482
+ user_action?: string;
3483
+ /**
3484
+ * The callback URL for PayPal to redirect the user in the case of approved payment.
3485
+ */
3486
+ return_url?: string;
3487
+ /**
3488
+ * The callback URL for PayPal to redirect user in the case a cancelled payment.
3489
+ */
3490
+ cancel_url?: string;
3212
3491
  };
3213
- billing_address?: BillingAddress;
3214
- shipping_address?: ShippingAddress;
3215
3492
  };
3216
3493
  };
3217
- type BillingAddress = {
3218
- /**
3219
- * First name of the billing recipient.
3220
- */
3221
- first_name: string;
3222
- /**
3223
- * Last name of the billing recipient.
3224
- */
3225
- last_name: string;
3226
- /**
3227
- * Company name of the billing recipient.
3228
- */
3229
- company_name: string;
3230
- /**
3231
- * First line of the billing address.
3232
- */
3233
- line_1: string;
3234
- /**
3235
- * Second line of the billing address.
3236
- */
3237
- line_2: string;
3238
- /**
3239
- * City of the billing address.
3240
- */
3241
- city: string;
3242
- /**
3243
- * Postcode of the billing address.
3244
- */
3245
- postcode: string;
3246
- /**
3247
- * County of the billing address.
3248
- */
3249
- county: string;
3494
+ type DataStripePayment = DataBasePayments & {
3250
3495
  /**
3251
- * Country of the billing address.
3496
+ * Specifies the type of payment gateway. You must use `stripe`.
3252
3497
  */
3253
- country: string;
3498
+ gateway: "stripe";
3499
+ options?: {
3500
+ /**
3501
+ * The option to provide an email for Stripe receipts. Specify live mode to access this feature.
3502
+ */
3503
+ receipt_email?: string;
3504
+ };
3254
3505
  /**
3255
- * State, province, or region of the billing address.
3506
+ * The Stripe token or source.
3256
3507
  */
3257
- region: string;
3508
+ payment?: string;
3258
3509
  };
3259
- type Contact = {
3510
+ type DataStripeConnectPayment = DataBasePayments & {
3260
3511
  /**
3261
- * The email address of the contact.
3512
+ * Specifies the type of payment gateway. You must use `stripe_connect`.
3262
3513
  */
3263
- email?: string;
3514
+ gateway: "stripe_connect";
3515
+ options?: {
3516
+ /**
3517
+ * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
3518
+ */
3519
+ receipt_email?: string;
3520
+ };
3264
3521
  /**
3265
- * The name of the contact.
3522
+ * Specifies the Stripe token or source.
3266
3523
  */
3267
- name?: string;
3524
+ payment?: string;
3268
3525
  };
3269
- type ShippingAddress = {
3526
+ type DataStripePaymentIntentsPayment = DataBasePayments & {
3270
3527
  /**
3271
- * First name of the shipping recipient.
3528
+ * Specifies the type of payment gateway. You must use `stripe_payment_intents`.
3272
3529
  */
3273
- first_name: string;
3530
+ gateway: "stripe_payment_intents";
3531
+ options?: {
3532
+ /**
3533
+ * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
3534
+ */
3535
+ receipt_email?: string;
3536
+ };
3274
3537
  /**
3275
- * Last name of the shipping recipient.
3538
+ * Specifies the Stripe token or source.
3276
3539
  */
3277
- last_name: string;
3540
+ payment?: string;
3541
+ };
3542
+ type DataPaymentObject = DataAdyenPayment | DataAuthorizeNetPayment | DataBraintreePayment | DataCardConnectPayment | DataCyberSourcePayment | ElasticPathPaymentsPoweredByStripePayment | DataManualPayment | DataPayPalExpressCheckoutPayment | DataStripePayment | DataStripeConnectPayment | DataStripePaymentIntentsPayment;
3543
+ type PaymentsRequest = {
3544
+ data?: DataPaymentObject;
3545
+ };
3546
+ type TransactionResponse = {
3278
3547
  /**
3279
- * Phone number of the shipping recipient.
3548
+ * The ID of the transaction.
3280
3549
  */
3281
- phone_number: string;
3550
+ readonly id?: string;
3282
3551
  /**
3283
- * Company of the shipping recipient.
3552
+ * The payment gateway reference.
3284
3553
  */
3285
- company_name: string;
3554
+ reference?: string;
3286
3555
  /**
3287
- * First line of the shipping address.
3556
+ * A custom name associated with the payment method.
3288
3557
  */
3289
- line_1: string;
3558
+ name?: string;
3290
3559
  /**
3291
- * Second line of the shipping address.
3560
+ * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend you not to include personal information in this field.
3292
3561
  */
3293
- line_2: string;
3562
+ custom_reference?: string;
3294
3563
  /**
3295
- * City of the shipping address.
3564
+ * The name of the payment gateway used.
3296
3565
  */
3297
- city: string;
3566
+ gateway?: "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_connect" | "stripe_payment_intents" | "stripe_platform_account";
3298
3567
  /**
3299
- * Post code of the shipping address.
3568
+ * The amount for this transaction.
3300
3569
  */
3301
- postcode: string;
3570
+ amount?: number;
3302
3571
  /**
3303
- * County of the shipping address.
3572
+ * The refunded amount.
3304
3573
  */
3305
- county: string;
3574
+ refunded_amount?: number;
3306
3575
  /**
3307
- * Country of the shipping address.
3576
+ * The transaction currency.
3308
3577
  */
3309
- country: string;
3578
+ currency?: string;
3310
3579
  /**
3311
- * State, province, or region of the shipping address.
3580
+ * The type of transaction, such as `purchase`, `capture`, `authorize` or `refund`.
3312
3581
  */
3313
- region: string;
3582
+ "transaction-type"?: string;
3314
3583
  /**
3315
- * Delivery instructions.
3584
+ * The status provided by the gateway for this transaction, such as `complete` or `failed`.
3316
3585
  */
3317
- instructions: string;
3586
+ status?: string;
3587
+ relationships?: {
3588
+ order?: {
3589
+ data?: {
3590
+ /**
3591
+ * Represents the type of the object being returned. It is always `order`.
3592
+ */
3593
+ type?: string;
3594
+ /**
3595
+ * The ID of the order.
3596
+ */
3597
+ id?: string;
3598
+ };
3599
+ };
3600
+ };
3601
+ meta?: {
3602
+ display_price?: FormattedPriceData;
3603
+ display_refunded_amount?: FormattedPriceData;
3604
+ timestamps?: CartCheckoutTimestamps;
3605
+ };
3606
+ };
3607
+ type TransactionEntityResponse = {
3608
+ data: TransactionResponse;
3609
+ };
3610
+ type OrdersTransactionsConfirmRequest = {
3611
+ data?: {
3612
+ [key: string]: unknown;
3613
+ };
3318
3614
  };
3319
- type ResponseMetaCarts = {
3320
- page?: ResponsePaginationPage;
3321
- results?: ResponsePaginationResults;
3615
+ type OrdersTransactionsCaptureRequest = {
3616
+ data?: {
3617
+ options?: {
3618
+ soft_descriptor?: string;
3619
+ note_to_payer?: string;
3620
+ };
3621
+ };
3322
3622
  };
3323
- type ResponseMetaOrders = {
3324
- page?: ResponsePaginationPage;
3325
- results?: ResponsePaginationResults;
3623
+ type OrdersTransactionsRefundRequest = {
3624
+ data?: {
3625
+ /**
3626
+ * The amount value to be refunded. If this field is not provided, it will be considered as manual refund (Mark as Refunded) and the refund process must be manually handled via payment provider. If the amount value is same as payment value, then it will be treated as a full refund and sent to the payment provider to process refund automatically.
3627
+ */
3628
+ amount?: number;
3629
+ options?: {
3630
+ /**
3631
+ * Provides comments about the refund. It is used by PayPal Express.
3632
+ */
3633
+ note?: string;
3634
+ };
3635
+ };
3326
3636
  };
3327
- type ResponsePaginationPage = {
3328
- /**
3329
- * The current page.
3330
- */
3331
- current?: number;
3332
- /**
3333
- * The maximum number of records per page for this response. You can set this value up to 100.
3334
- */
3335
- limit?: number;
3336
- /**
3337
- * The current offset by number of records, not pages. Offset is zero-based.
3338
- */
3339
- offset?: number;
3637
+ type TransactionListResponse = {
3638
+ data: Array<TransactionResponse>;
3639
+ };
3640
+ type ResponseData = {
3641
+ data?: unknown;
3642
+ };
3643
+ type OrdersTransactionsCancelRequest = {
3644
+ data?: {
3645
+ options?: {
3646
+ [key: string]: unknown;
3647
+ };
3648
+ /**
3649
+ * Specifies the reason for canceling the transaction. The reason may include `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`.
3650
+ */
3651
+ reason?: string;
3652
+ };
3653
+ };
3654
+ type UpdateOrderShippingGroupRequest = {
3655
+ data?: {
3656
+ type?: "shipping_group";
3657
+ shipping_type?: string;
3658
+ tracking_reference?: string;
3659
+ address?: ShippingAddress;
3660
+ delivery_estimate?: DeliveryEstimate;
3661
+ };
3662
+ };
3663
+ type CartCheckoutTimestamps = {
3340
3664
  /**
3341
- * The total page count.
3665
+ * The date this was created.
3342
3666
  */
3343
- total?: number;
3344
- };
3345
- type ResponsePaginationResults = {
3667
+ created_at?: string;
3346
3668
  /**
3347
- * The total page count.
3669
+ * The date this was last updated.
3348
3670
  */
3349
- total?: number;
3671
+ updated_at?: unknown;
3350
3672
  };
3351
- type ResponsePageLinks = {
3673
+ type CartIncludedPromotion = {
3352
3674
  /**
3353
- * Always the current page.
3675
+ * The unique identifier of the promotion.
3354
3676
  */
3355
- current?: string;
3677
+ id: string;
3356
3678
  /**
3357
- * Always the first page.
3679
+ * The name of the promotion.
3358
3680
  */
3359
- first?: string;
3681
+ name: string;
3360
3682
  /**
3361
- * If there is only one page, it is `null`.
3683
+ * A description of the promotion.
3362
3684
  */
3363
- last?: string;
3685
+ description?: string;
3364
3686
  /**
3365
- * If there is only one page, it is `null`.
3687
+ * Indicates if the promotion is automatic.
3366
3688
  */
3367
- next?: string;
3689
+ automatic: boolean;
3368
3690
  /**
3369
- * if the user is on the first page, it is `null`.
3691
+ * The source of the promotion.
3370
3692
  */
3371
- prev?: string;
3372
- };
3373
- type ResponseData = {
3374
- data?: unknown;
3375
- };
3376
- type ResponseError = Array<unknown>;
3377
- type CartTimestamps = {
3378
- created_at?: string;
3379
- updated_at?: unknown;
3380
- expires_at?: unknown;
3381
- };
3382
- type CartCheckoutTimestamps = {
3693
+ promotion_source: string;
3383
3694
  /**
3384
- * The date this was created.
3695
+ * The start date and time of the promotion.
3385
3696
  */
3386
- created_at?: string;
3697
+ start: Date;
3387
3698
  /**
3388
- * The date this was last updated.
3699
+ * The end date and time of the promotion.
3389
3700
  */
3390
- updated_at?: unknown;
3701
+ end: Date;
3391
3702
  };
3392
3703
  /**
3393
3704
  * Included is an array of resources that are included in the response.
3394
3705
  */
3395
- type CartInclude = {
3706
+ type CartIncluded = {
3396
3707
  /**
3397
3708
  * The cart items associated with a cart.
3398
3709
  */
3399
- items?: Array<CartItemsObjectResponse>;
3710
+ items?: Array<CartItemObject | CustomItemObject | SubscriptionItemObject | PromotionItemObject>;
3711
+ /**
3712
+ * The tax items associated with a cart.
3713
+ */
3714
+ tax_items?: Array<CartsItemsTaxesObject>;
3715
+ /**
3716
+ * The custom discounts associated with a cart.
3717
+ */
3718
+ custom_discounts?: Array<CartsCustomDiscountsObject>;
3719
+ /**
3720
+ * The promotions associated with a cart.
3721
+ */
3722
+ promotions?: Array<CartIncludedPromotion>;
3400
3723
  };
3724
+ /**
3725
+ * Whether a pricing option is active on a subscription using that offering. The `active_pricing_option` attribute is null if a pricing option is not active in a subscription.
3726
+ */
3727
+ type ActivePricingOption = boolean;
3401
3728
  /**
3402
3729
  * 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.
3403
3730
  */
@@ -3411,15 +3738,13 @@ type ExternalRef = string;
3411
3738
  */
3412
3739
  type ExternalRefUpdate = string | null;
3413
3740
  type SubscriptionType = "subscription";
3414
- type SubscriptionProductType = "subscription_product";
3415
3741
  type ProrationPolicyType = "subscription_proration_policy";
3416
3742
  type SubscriptionDunningRuleType = "subscription_dunning_rule";
3417
- type SubscriptionPlanType = "subscription_plan";
3418
3743
  type SubscriptionFeatureType = "subscription_feature";
3419
3744
  type SubscriptionOfferingType = "subscription_offering";
3420
3745
  type SubscriptionOfferingFeatureType = "subscription_offering_feature";
3421
- type SubscriptionOfferingProductType = "subscription_offering_product";
3422
3746
  type SubscriptionOfferingPlanType = "subscription_offering_plan";
3747
+ type SubscriptionOfferingPricingOptionType = "subscription_offering_pricing_option";
3423
3748
  type SubscriptionJobType = "subscription_job";
3424
3749
  type SubscriptionImportType = "subscription_import";
3425
3750
  type SubscriptionImportErrorType = "subscription_import_error";
@@ -3460,9 +3785,15 @@ type LinkObject = {
3460
3785
  /**
3461
3786
  * The status of a subscription, either `active` or `inactive`.
3462
3787
  */
3463
- type Status = "active" | "inactive";
3788
+ type Status2 = "active" | "inactive";
3789
+ /**
3790
+ * Enumerates a list of resources that are related.
3791
+ */
3792
+ type RelationshipsRequest = {
3793
+ data: Array<RelationshipData>;
3794
+ };
3464
3795
  /**
3465
- * Relationships are established between different subscription entities. For example, a product and a plan are related to an offering, as both are attached to it.
3796
+ * Relationships are established between different subscription entities. For example, a plan and a pricing option are related to an offering, as both are attached to it.
3466
3797
  */
3467
3798
  type Relationships = unknown;
3468
3799
  type Relationship = SubscriptionsSingleRelationship | ManyRelationship;
@@ -3528,7 +3859,7 @@ type SingleCurrencyPrice = {
3528
3859
  */
3529
3860
  type Unit = "day" | "month";
3530
3861
  /**
3531
- * The timeframe during which the product price is applicable. For example, for a streaming service, the price is $12.99 and the `unit` is `months` and the `amount` is `1`. In other words, the streaming service is available for $12.99 a month. You may want to specify a unit price if you have many products that all have different prices. Rather than having to create separate plans for each product, you can specify the timeframe during which the product price is applicable and then create one plan that determines the billing frequency for those products.
3862
+ * The timeframe during which the plan price is applicable. For example, for a streaming service, the price is $12.99 and the `unit` is `months` and the `amount` is `1`. In other words, the streaming service is available for $12.99 a month. You may want to specify a unit price if you have many plans that all have different prices. Rather than having to create separate pricing options for each plan, you can specify the timeframe during which the plan price is applicable and then create one pricing option that determines the billing frequency for those plans.
3532
3863
  */
3533
3864
  type PriceUnits = {
3534
3865
  /**
@@ -3541,7 +3872,7 @@ type PriceUnits = {
3541
3872
  amount: number;
3542
3873
  };
3543
3874
  /**
3544
- * The timeframe during which the product price is applicable. For example, for a streaming service, the price is $12.99 and the `unit` is `months` and the `amount` is `1`. In other words, the streaming service is available for $12.99 a month. You may want to specify a unit price if you have many products that all have different prices. Rather than having to create separate plans for each product, you can specify the timeframe during which the product price is applicable and then create one plan that determines the billing frequency for those products.
3875
+ * The timeframe during which the plan price is applicable. For example, for a streaming service, the price is $12.99 and the `unit` is `months` and the `amount` is `1`. In other words, the streaming service is available for $12.99 a month. You may want to specify a unit price if you have many plans that all have different prices. Rather than having to create separate pricing options for each plan, you can specify the timeframe during which the plan price is applicable and then create one pricing option that determines the billing frequency for those plans.
3545
3876
  */
3546
3877
  type NullablePriceUnits = {
3547
3878
  /**
@@ -3566,6 +3897,16 @@ type NullablePrice = {
3566
3897
  includes_tax?: boolean;
3567
3898
  } | null;
3568
3899
  } | null;
3900
+ /**
3901
+ * A list of plan prices for each of its pricing options.
3902
+ */
3903
+ type OfferingPlanPrices = {
3904
+ [key: string]: OfferingPlanPriceForPricingOption;
3905
+ };
3906
+ type OfferingPlanPriceForPricingOption = {
3907
+ price?: Price;
3908
+ display_price?: DisplayPrice2;
3909
+ };
3569
3910
  type DisplayPrice2 = {
3570
3911
  without_tax?: PriceFormatting;
3571
3912
  with_tax?: PriceFormatting;
@@ -3603,6 +3944,10 @@ type FeatureUpdate = {
3603
3944
  type: SubscriptionFeatureType;
3604
3945
  attributes: FeatureUpdateAttributes;
3605
3946
  };
3947
+ type OfferingFeatureCreate = {
3948
+ type: SubscriptionOfferingFeatureType;
3949
+ attributes: FeatureAttributes;
3950
+ };
3606
3951
  type FeatureResponseAttributes = FeatureAttributes;
3607
3952
  /**
3608
3953
  * A tag to add to the customer's account when entitled to the feature.
@@ -3672,82 +4017,83 @@ type FeatureUpdateAttributes = {
3672
4017
  description?: string | null;
3673
4018
  configuration?: FeatureConfiguration;
3674
4019
  };
3675
- type Product2 = {
3676
- id?: SubscriptionsUuid;
3677
- type: SubscriptionProductType;
3678
- attributes: ProductResponseAttributes;
3679
- meta: ProductMeta2;
3680
- };
3681
- type ProductMeta2 = {
4020
+ type PlanMeta = {
4021
+ prices?: OfferingPlanPrices;
3682
4022
  display_price?: DisplayPrice2;
3683
4023
  owner: OwnerMeta;
3684
4024
  timestamps: SubscriptionsTimestamps;
4025
+ active_plan?: ActivePlan;
3685
4026
  };
3686
- type ProductCreate = {
3687
- type: SubscriptionProductType;
3688
- attributes: ProductAttributes2;
4027
+ type OfferingPlanCreate = {
4028
+ type: SubscriptionOfferingPlanType;
4029
+ attributes: OfferingPlanAttributes;
4030
+ relationships?: Relationships;
3689
4031
  };
3690
- type ProductUpdate = {
3691
- id: SubscriptionsUuid;
3692
- type: SubscriptionProductType;
3693
- attributes: ProductUpdateAttributes;
4032
+ type OfferingPlanAttributes = PlanAttributes & OfferingPlanExtraAttributes;
4033
+ type OfferingPlanResponseAttributes = PlanResponseAttributes & OfferingPlanResponseExtraAttributes;
4034
+ type OfferingPlanExtraAttributes = {
4035
+ /**
4036
+ * A map of configurations indicating which features are available for the plan
4037
+ */
4038
+ feature_configurations?: {
4039
+ [key: string]: FeaturePlanConfiguration;
4040
+ };
3694
4041
  };
3695
- type OfferingProductResponseAttributes = ProductResponseAttributes & OfferingProductResponseExtraAttributes;
3696
- type OfferingProductResponseExtraAttributes = {
4042
+ type OfferingPlanResponseExtraAttributes = {
3697
4043
  /**
3698
- * A map of configurations indicating which features are available for the product
4044
+ * A map of configurations indicating which features are available for the plan
3699
4045
  */
3700
4046
  feature_configurations: {
3701
- [key: string]: FeatureProductConfiguration;
4047
+ [key: string]: FeaturePlanConfiguration;
3702
4048
  };
3703
4049
  };
3704
- type ProductResponseAttributes = ProductAttributes2 & SubscriptionsTimestamps;
3705
- type ProductAttributes2 = {
4050
+ type PlanResponseAttributes = PlanAttributes & SubscriptionsTimestamps;
4051
+ type PlanAttributes = {
3706
4052
  external_ref?: ExternalRef;
3707
4053
  /**
3708
- * The name of the product.
4054
+ * The name of the plan.
3709
4055
  */
3710
4056
  name: string;
3711
4057
  /**
3712
- * The product or service description to display to customers.
4058
+ * The plan or service description to display to customers.
3713
4059
  */
3714
4060
  description?: string;
3715
4061
  /**
3716
- * A stock keeping unit for the product, if appropriate.
4062
+ * A stock keeping unit for the plan, if appropriate.
3717
4063
  */
3718
4064
  sku?: string;
3719
4065
  /**
3720
- * A URL from which an image or file for the product can be fetched. You can either upload your images and files to Commerce using the Commerce Files API or you can use your own content delivery network. If you are using the Commerce Files API, use [**Create a File**](/docs/api/pxm/files/create-a-file) to upload your file and return an HREF link in the response. An extensive range of [**media and file extensions**](/docs/api/pxm/files/files-service-api) are supported.
4066
+ * A URL from which an image or file for the plan can be fetched. You can either upload your images and files to Commerce using the Commerce Files API or you can use your own content delivery network. If you are using the Commerce Files API, use [**Create a File**](/docs/api/pxm/files/create-a-file) to upload your file and return an HREF link in the response. An extensive range of [**media and file extensions**](/docs/api/pxm/files/files-service-api) are supported.
3721
4067
  */
3722
4068
  main_image?: string;
3723
4069
  price?: Price;
3724
4070
  price_units?: PriceUnits;
3725
4071
  };
3726
- type OfferingProductUpdateAttributes = ProductUpdateAttributes & OfferingProductUpdateExtraAttributes;
3727
- type OfferingProductUpdateExtraAttributes = {
4072
+ type OfferingPlanUpdateAttributes = PlanUpdateAttributes & OfferingPlanUpdateExtraAttributes;
4073
+ type OfferingPlanUpdateExtraAttributes = {
3728
4074
  /**
3729
- * A map of configurations indicating which features are available for the product
4075
+ * A map of configurations indicating which features are available for the plan
3730
4076
  */
3731
4077
  feature_configurations?: {
3732
- [key: string]: FeatureProductConfigurationUpdate;
4078
+ [key: string]: FeaturePlanConfigurationUpdate;
3733
4079
  };
3734
4080
  };
3735
- type ProductUpdateAttributes = {
4081
+ type PlanUpdateAttributes = {
3736
4082
  external_ref?: ExternalRefUpdate;
3737
4083
  /**
3738
- * The name of the product.
4084
+ * The name of the plan.
3739
4085
  */
3740
4086
  name?: string;
3741
4087
  /**
3742
- * The product or service description to display to customers.
4088
+ * The plan or service description to display to customers.
3743
4089
  */
3744
4090
  description?: string | null;
3745
4091
  /**
3746
- * A stock keeping unit for the product, if appropriate.
4092
+ * A stock keeping unit for the plan, if appropriate.
3747
4093
  */
3748
4094
  sku?: string | null;
3749
4095
  /**
3750
- * A URL from which an image or file for the product can be fetched. You can either upload your images and files to Commerce using the Commerce Files API or you can use your own content delivery network. If you are using the Commerce Files API, use [**Create a File**](/docs/api/pxm/files/create-a-file) to upload your file and return an HREF link in the response. An extensive range of [**media and file extensions**](/docs/api/pxm/files/files-service-api) are supported.
4096
+ * A URL from which an image or file for the plan can be fetched. You can either upload your images and files to Commerce using the Commerce Files API or you can use your own content delivery network. If you are using the Commerce Files API, use [**Create a File**](/docs/api/pxm/files/create-a-file) to upload your file and return an HREF link in the response. An extensive range of [**media and file extensions**](/docs/api/pxm/files/files-service-api) are supported.
3751
4097
  */
3752
4098
  main_image?: string | null;
3753
4099
  price?: NullablePrice;
@@ -3925,26 +4271,11 @@ type ProrationPolicyMeta = {
3925
4271
  owner: OwnerMeta;
3926
4272
  timestamps: SubscriptionsTimestamps;
3927
4273
  };
3928
- type Plan = {
3929
- id?: SubscriptionsUuid;
3930
- type: SubscriptionPlanType;
3931
- attributes: PlanResponseAttributes;
3932
- meta: PlanMeta;
3933
- };
3934
- type PlanMeta = {
3935
- owner: OwnerMeta;
3936
- timestamps: SubscriptionsTimestamps;
3937
- };
3938
- type PlanCreate = {
3939
- type: SubscriptionPlanType;
3940
- attributes: PlanAttributes;
3941
- };
3942
- type PlanUpdate = {
3943
- id: SubscriptionsUuid;
3944
- type: SubscriptionPlanType;
3945
- attributes: PlanUpdateAttributes;
4274
+ type OfferingPricingOptionCreate = {
4275
+ type: SubscriptionOfferingPricingOptionType;
4276
+ attributes: PricingOptionAttributes;
3946
4277
  };
3947
- type PlanResponseAttributes = PlanAttributes & SubscriptionsTimestamps;
4278
+ type PricingOptionResponseAttributes = PricingOptionAttributes & SubscriptionsTimestamps;
3948
4279
  /**
3949
4280
  * The unit of time that billing intervals are measured.
3950
4281
  */
@@ -3953,14 +4284,14 @@ type BillingIntervalType = "day" | "week" | "month" | "year";
3953
4284
  * Enables you to specify recurring payments. If `end_behavior` is `roll`, customers pay regularly and repeatedly. If `end_behavior` is `close`, customers pay a total amount in a limited number of partial payments.
3954
4285
  */
3955
4286
  type EndBehavior = "close" | "roll";
3956
- type PlanAttributes = {
4287
+ type PricingOptionAttributes = {
3957
4288
  external_ref?: ExternalRef;
3958
4289
  /**
3959
- * A name for the plan.
4290
+ * A name for the pricing option.
3960
4291
  */
3961
4292
  name: string;
3962
4293
  /**
3963
- * The plan description to display to customers.
4294
+ * The pricing option description to display to customers.
3964
4295
  */
3965
4296
  description?: string;
3966
4297
  /**
@@ -3996,16 +4327,16 @@ type PlanAttributes = {
3996
4327
  */
3997
4328
  can_cancel: boolean;
3998
4329
  /**
3999
- * A percentage discount on the total cost of any products within an offering. For example, you can configure a percentage that equates the cost of a plan to the total value of all products within the offering, reduced by a percentage. For example, if you specify `10`, a 10% discount is applied to the total value of all repeat products in an offering.
4330
+ * A percentage discount on the total cost of any plans within an offering. For example, you can configure a percentage that equates the cost of a pricing option to the total value of all plans within the offering, reduced by a percentage. For example, if you specify `10`, a 10% discount is applied to the total value of all repeat plans in an offering.
4000
4331
  */
4001
4332
  base_price_percentage?: number;
4002
4333
  fixed_price?: Price;
4003
4334
  };
4004
- type PlanUpdateAttributes = {
4335
+ type PricingOptionUpdateAttributes = {
4005
4336
  external_ref?: ExternalRefUpdate;
4006
4337
  name?: string;
4007
4338
  /**
4008
- * The plan description to display to customers.
4339
+ * The pricing option description to display to customers.
4009
4340
  */
4010
4341
  description?: string | null;
4011
4342
  /**
@@ -4041,7 +4372,7 @@ type PlanUpdateAttributes = {
4041
4372
  */
4042
4373
  can_cancel?: boolean;
4043
4374
  /**
4044
- * A percentage discount on the total cost of any products within an offering. For example, you can configure a percentage that equates the cost of a plan to the total value of all products within the offering, reduced by a percentage. For example, if you specify `10`, a 10% discount is applied to the total value of all repeat products in an offering.
4375
+ * A percentage discount on the total cost of any plans within an offering. For example, you can configure a percentage that equates the cost of a pricing option to the total value of all plans within the offering, reduced by a percentage. For example, if you specify `10`, a 10% discount is applied to the total value of all repeat plans in an offering.
4045
4376
  */
4046
4377
  base_price_percentage?: number | null;
4047
4378
  fixed_price?: NullablePrice;
@@ -4060,18 +4391,20 @@ type BuildOffering = {
4060
4391
  * The unique ID or external ref of the proration policy
4061
4392
  */
4062
4393
  proration_policy_id?: string;
4394
+ configured_features?: OfferingBuildConfiguredFeatures;
4395
+ pricing_option_associations?: OfferingBuildPricingOptionAssociations;
4063
4396
  /**
4064
4397
  * Either references of existing features (id or external_ref) to be attached to the offering or feature information to be created directly within the offering
4065
4398
  */
4066
4399
  features?: Array<ExternalRef | FeatureAttributes | SubscriptionsUuid>;
4067
4400
  /**
4068
- * Either references of existing products (id or external_ref) to be attached to the offering or product information to be created directly within the offering
4401
+ * Plan information to be created within the offering
4069
4402
  */
4070
- products: Array<ExternalRef | ProductAttributes2 | SubscriptionsUuid>;
4403
+ plans: Array<OfferingPlanAttributes>;
4071
4404
  /**
4072
- * Either references of existing plans (id or external_ref) to be attached to the offering or plan information to be created directly within the offering
4405
+ * Pricing options information to be created within the offering
4073
4406
  */
4074
- plans: Array<ExternalRef | PlanAttributes | SubscriptionsUuid>;
4407
+ pricing_options: Array<PricingOptionAttributes>;
4075
4408
  };
4076
4409
  type Offering = {
4077
4410
  id?: SubscriptionsUuid;
@@ -4082,11 +4415,11 @@ type Offering = {
4082
4415
  };
4083
4416
  type OfferingIncludes = {
4084
4417
  features?: Array<OfferingFeature>;
4085
- products?: Array<OfferingProduct>;
4086
4418
  plans?: Array<OfferingPlan>;
4419
+ pricing_options?: Array<OfferingPricingOption>;
4087
4420
  };
4088
4421
  type OfferingMeta = {
4089
- external_product_refs: Array<OfferingProductExternalRefMeta>;
4422
+ external_plan_refs: Array<OfferingPlanExternalRefMeta>;
4090
4423
  owner: OwnerMeta;
4091
4424
  timestamps: SubscriptionsTimestamps;
4092
4425
  };
@@ -4095,26 +4428,26 @@ type OfferingCreate = {
4095
4428
  attributes: OfferingAttributes;
4096
4429
  relationships?: OfferingRelationships;
4097
4430
  };
4098
- type OfferingProductUpdate = {
4431
+ type OfferingPlanUpdate = {
4099
4432
  id: SubscriptionsUuid;
4100
- type: SubscriptionOfferingProductType;
4101
- attributes: OfferingProductUpdateAttributes;
4433
+ type: SubscriptionOfferingPlanType;
4434
+ attributes: OfferingPlanUpdateAttributes;
4102
4435
  };
4103
4436
  /**
4104
- * Configures an access feature against a product in an offering, indicating that the referenced feature is a benefit of that product.
4437
+ * Configures an access feature against a plan in an offering, indicating that the referenced feature is a benefit of that plan.
4105
4438
  */
4106
4439
  type FeatureConfigAccessAttributes = {
4107
4440
  type: "access";
4108
4441
  };
4109
4442
  /**
4110
- * Configures a promotion feature against a product in an offering, indicating that the referenced feature is a benefit of that product. The tag of the specific promotion that it to be made available must be supplied.
4443
+ * Configures a promotion feature against a plan in an offering, indicating that the referenced feature is a benefit of that plan. The tag of the specific promotion that it to be made available must be supplied.
4111
4444
  */
4112
4445
  type FeatureConfigPromotionAttributes = {
4113
4446
  type: "promotion";
4114
4447
  tag: FeatureTag;
4115
4448
  };
4116
4449
  /**
4117
- * Configures a usgae feature against a product in an offering, indicating that the referenced feature is a benefit of that product. The default value that the usage metrics adopts must be supplied.
4450
+ * Configures a usage feature against a plan in an offering, indicating that the referenced feature is a benefit of that plan. The default value that the usage metrics adopts must be supplied.
4118
4451
  */
4119
4452
  type FeatureConfigUsageAttributes = {
4120
4453
  type: "usage";
@@ -4123,7 +4456,7 @@ type FeatureConfigUsageAttributes = {
4123
4456
  */
4124
4457
  default_value: number;
4125
4458
  };
4126
- type FeatureProductConfiguration = (({
4459
+ type FeaturePlanConfiguration = (({
4127
4460
  type?: "access";
4128
4461
  } & FeatureConfigAccessAttributes) | ({
4129
4462
  type?: "promotion";
@@ -4135,7 +4468,7 @@ type FeatureProductConfiguration = (({
4135
4468
  */
4136
4469
  type: "access" | "promotion" | "usage";
4137
4470
  };
4138
- type FeatureProductConfigurationUpdate = (({
4471
+ type FeaturePlanConfigurationUpdate = (({
4139
4472
  type?: "access";
4140
4473
  } & FeatureConfigAccessAttributes) | ({
4141
4474
  type?: "promotion";
@@ -4147,6 +4480,25 @@ type FeatureProductConfigurationUpdate = (({
4147
4480
  */
4148
4481
  type: "access" | "promotion" | "usage";
4149
4482
  };
4483
+ type OfferingBuildPlanPricingOptions = Array<string>;
4484
+ /**
4485
+ * A map of plans keyed by plan UUID or external_ref to a list of associated pricing options, similarly keyed.
4486
+ */
4487
+ type OfferingBuildPricingOptionAssociations = {
4488
+ [key: string]: OfferingBuildPlanPricingOptions;
4489
+ };
4490
+ /**
4491
+ * Map of feature configurations keyed by plan UUID or external_ref
4492
+ */
4493
+ type OfferingBuildConfiguredFeatures = {
4494
+ [key: string]: OfferingBuildPlanFeatures;
4495
+ };
4496
+ /**
4497
+ * A map of configurations indicating which features are available for the plan
4498
+ */
4499
+ type OfferingBuildPlanFeatures = {
4500
+ [key: string]: FeaturePlanConfiguration;
4501
+ };
4150
4502
  type OfferingFeatureUpdate = {
4151
4503
  id: SubscriptionsUuid;
4152
4504
  type: SubscriptionOfferingFeatureType;
@@ -4159,55 +4511,48 @@ type OfferingFeature = {
4159
4511
  relationships?: Relationships;
4160
4512
  meta: FeatureMeta;
4161
4513
  };
4162
- type OfferingProduct = {
4514
+ type OfferingPlan = {
4163
4515
  id?: SubscriptionsUuid;
4164
- type: SubscriptionOfferingProductType;
4165
- attributes: OfferingProductResponseAttributes;
4516
+ type: SubscriptionOfferingPlanType;
4517
+ attributes: OfferingPlanResponseAttributes;
4166
4518
  relationships?: Relationships;
4167
- meta: ProductMeta2;
4519
+ meta: PlanMeta;
4168
4520
  };
4169
- type OfferingPlanUpdate = {
4521
+ type OfferingPricingOptionUpdate = {
4170
4522
  id: SubscriptionsUuid;
4171
- type: SubscriptionOfferingPlanType;
4172
- attributes: PlanUpdateAttributes;
4523
+ type: SubscriptionOfferingPricingOptionType;
4524
+ attributes: PricingOptionUpdateAttributes;
4173
4525
  };
4174
- type OfferingPlan = {
4526
+ type OfferingPricingOption = {
4175
4527
  id?: SubscriptionsUuid;
4176
- type: SubscriptionOfferingPlanType;
4177
- attributes: PlanResponseAttributes;
4528
+ type: SubscriptionOfferingPricingOptionType;
4529
+ attributes: PricingOptionResponseAttributes;
4178
4530
  relationships?: Relationships;
4179
- meta: OfferingPlanMeta;
4531
+ meta: OfferingPricingOptionMeta;
4180
4532
  };
4181
- type OfferingPlanMeta = {
4533
+ type OfferingPricingOptionMeta = {
4534
+ prices?: OfferingPricingOptionPrices;
4182
4535
  price?: Price;
4183
4536
  display_price?: DisplayPrice2;
4184
- active_plan?: ActivePlan;
4537
+ active_pricing_option?: ActivePricingOption;
4185
4538
  owner: OwnerMeta;
4186
4539
  timestamps: SubscriptionsTimestamps;
4187
4540
  };
4188
4541
  /**
4189
- * A list of feature IDs to attach to the offering. See [**List Features**](/docs/api/subscriptions/list-features).
4190
- */
4191
- type OfferingFeatureAttach = {
4192
- features: Array<SubscriptionsUuid>;
4193
- };
4194
- /**
4195
- * A list of plan IDs to attach to the offering. See [**List Plans**](/docs/api/subscriptions/list-plans).
4542
+ * The price of each plan within the offering that this pricing option may be applied to.
4196
4543
  */
4197
- type OfferingPlanAttach = {
4198
- plans: Array<SubscriptionsUuid>;
4544
+ type OfferingPricingOptionPrices = {
4545
+ [key: string]: OfferingPricingOptionPriceForPlan;
4199
4546
  };
4200
- /**
4201
- * A list of product IDs to attach to the offering. See [**List Products**](/docs/api/subscriptions/list-products).
4202
- */
4203
- type OfferingProductAttach = {
4204
- products: Array<SubscriptionsUuid>;
4547
+ type OfferingPricingOptionPriceForPlan = {
4548
+ price?: Price;
4549
+ display_price?: DisplayPrice2;
4205
4550
  };
4206
4551
  /**
4207
- * A list of product IDs to replace on the offering. See [**List Products**](/docs/api/subscriptions/list-products).
4552
+ * A list of feature IDs to attach to the offering. See [**List Features**](/docs/api/subscriptions/list-features).
4208
4553
  */
4209
- type OfferingProductReplace = {
4210
- products: Array<SubscriptionsUuid>;
4554
+ type OfferingFeatureAttach = {
4555
+ features: Array<SubscriptionsUuid>;
4211
4556
  };
4212
4557
  type OfferingUpdate = unknown & {
4213
4558
  id: SubscriptionsUuid;
@@ -4244,6 +4589,13 @@ type OfferingRelationships = {
4244
4589
  type OfferingUpdateRelationships = {
4245
4590
  proration_policy?: ProrationPolicyUpdateRelationshipAttributes;
4246
4591
  };
4592
+ /**
4593
+ * A subscription may optionally be associated with an item in an order by supplying both the order ID and the ID of the item within that order.
4594
+ */
4595
+ type BuildSubscriptionOrder = {
4596
+ order_id: SubscriptionsUuid;
4597
+ order_item_id: SubscriptionsUuid;
4598
+ };
4247
4599
  type BuildSubscription = {
4248
4600
  external_ref?: ExternalRef;
4249
4601
  account_id: SubscriptionsUuid;
@@ -4251,6 +4603,7 @@ type BuildSubscription = {
4251
4603
  offering_external_ref?: ExternalRef;
4252
4604
  offering_id?: SubscriptionsUuid;
4253
4605
  plan_id?: SubscriptionsUuid;
4606
+ pricing_option_id?: SubscriptionsUuid;
4254
4607
  currency: CurrencyIdentifier;
4255
4608
  payment_authority?: PaymentAuthority;
4256
4609
  manual_payments: ManualPayments;
@@ -4269,18 +4622,27 @@ type BuildSubscription = {
4269
4622
  */
4270
4623
  started_at?: string;
4271
4624
  offering?: OfferingAttributes;
4272
- products?: Array<ProductAttributes2>;
4625
+ /**
4626
+ * Either references of existing features (id or external_ref) to be attached to the offering or feature information to be created directly within the offering
4627
+ */
4628
+ features?: Array<ExternalRef | FeatureAttributes | SubscriptionsUuid>;
4273
4629
  plans?: Array<PlanAttributesAndSelectedMeta>;
4630
+ pricing_options?: Array<PricingOptionAttributesAndSelectedMeta>;
4631
+ configured_features?: OfferingBuildConfiguredFeatures;
4632
+ pricing_option_associations?: OfferingBuildPricingOptionAssociations;
4274
4633
  selected_plan?: ExternalRef;
4634
+ selected_pricing_option?: ExternalRef;
4635
+ order?: BuildSubscriptionOrder;
4275
4636
  meta?: SubscriptionMeta;
4276
4637
  };
4277
- type PlanAttributesAndSelectedMeta = PlanAttributes & SelectedPlanMeta;
4278
- type SelectedPlanMeta = {
4279
- meta?: SelectedPlanMetaAttributes;
4638
+ type PricingOptionAttributesAndSelectedMeta = PricingOptionAttributes & SelectedMeta;
4639
+ type PlanAttributesAndSelectedMeta = PlanAttributes & SelectedMeta;
4640
+ type SelectedMeta = {
4641
+ meta?: SelectedMetaAttributes;
4280
4642
  };
4281
- type SelectedPlanMetaAttributes = {
4643
+ type SelectedMetaAttributes = {
4282
4644
  /**
4283
- * One plan must be selected for use in the subscription
4645
+ * One item must be selected for use in the subscription
4284
4646
  */
4285
4647
  selected?: boolean;
4286
4648
  };
@@ -4291,9 +4653,9 @@ type Subscription = {
4291
4653
  relationships?: Relationships;
4292
4654
  meta: SubscriptionMeta;
4293
4655
  };
4294
- type ManageSubscriptionProducts = {
4295
- type: "attach" | "detach" | "replace";
4296
- products: Array<SubscriptionsUuid>;
4656
+ type ManageSubscriptionPlans = {
4657
+ type: "detach";
4658
+ plans: Array<SubscriptionsUuid>;
4297
4659
  };
4298
4660
  type SubscriptionUpdate = {
4299
4661
  id: SubscriptionsUuid;
@@ -4301,6 +4663,7 @@ type SubscriptionUpdate = {
4301
4663
  attributes: SubscriptionUpdateAttributes;
4302
4664
  };
4303
4665
  type SubscriptionUpdateAttributes = {
4666
+ pricing_option_id?: unknown;
4304
4667
  plan_id?: unknown;
4305
4668
  address_id?: string | null;
4306
4669
  payment_authority?: PaymentAuthority;
@@ -4310,13 +4673,13 @@ type SubscriptionUpdateAttributes = {
4310
4673
  go_live_after?: string | null;
4311
4674
  };
4312
4675
  type SubscriptionIncludes = {
4313
- products?: Array<OfferingProduct>;
4314
4676
  plans?: Array<OfferingPlan>;
4677
+ pricing_options?: Array<OfferingPricingOption>;
4315
4678
  };
4316
4679
  type SubscriptionMeta = {
4317
4680
  owner: OwnerMeta;
4318
4681
  timestamps: SubscriptionTimestamps;
4319
- status: Status;
4682
+ status: Status2;
4320
4683
  state?: SubscriptionState;
4321
4684
  manual_payments: ManualPayments;
4322
4685
  /**
@@ -4379,6 +4742,7 @@ type SubscriptionAttributes = {
4379
4742
  account_id: SubscriptionsUuid;
4380
4743
  address_id?: SubscriptionsUuid;
4381
4744
  offering: Offering;
4745
+ pricing_option_id: SubscriptionsUuid;
4382
4746
  plan_id: SubscriptionsUuid;
4383
4747
  currency: CurrencyIdentifier;
4384
4748
  payment_authority?: PaymentAuthority;
@@ -4395,7 +4759,7 @@ type SubscriptionStateAttributes = {
4395
4759
  */
4396
4760
  type SubscriptionStateType = "subscription_state";
4397
4761
  /**
4398
- * The subscription lifecycle is the states that a subscription can go through when a customer subscribes to a service or a product.
4762
+ * The subscription lifecycle is the states that a subscription can go through when a customer subscribes to a service or a plan.
4399
4763
  *
4400
4764
  * A subscription can have the following states; `canceled`, `paused`, or `resumed`.
4401
4765
  *
@@ -4473,15 +4837,6 @@ type Import = {
4473
4837
  attributes: ImportAttributes;
4474
4838
  meta: ImportMeta;
4475
4839
  };
4476
- /**
4477
- * The status of job.
4478
- * - **pending** - Commerce has received the request but is currently busy processing other requests.
4479
- * - **started** - Commerce has started processing the job.
4480
- * - **success** - The job has successfully completed.
4481
- * - **failed** - The job has failed.
4482
- *
4483
- */
4484
- type Status2 = "pending" | "started" | "success" | "failed";
4485
4840
  type ImportAttributes = {
4486
4841
  external_ref?: ExternalRef;
4487
4842
  /**
@@ -4505,13 +4860,9 @@ type ImportMeta = {
4505
4860
  type ImportRecords = {
4506
4861
  uploaded: {
4507
4862
  /**
4508
- * The total number of products uploaded.
4509
- */
4510
- subscription_product: number;
4511
- /**
4512
- * The total number of plans uploaded.
4863
+ * The total number of features uploaded.
4513
4864
  */
4514
- subscription_plan: number;
4865
+ subscription_feature: number;
4515
4866
  /**
4516
4867
  * The total number of subscribers uploaded.
4517
4868
  */
@@ -4527,13 +4878,9 @@ type ImportRecords = {
4527
4878
  };
4528
4879
  imported: {
4529
4880
  /**
4530
- * The total number of products imported.
4531
- */
4532
- subscription_product: number;
4533
- /**
4534
- * The total number of plans imported.
4881
+ * The total number of features uploaded.
4535
4882
  */
4536
- subscription_plan: number;
4883
+ subscription_feature: number;
4537
4884
  /**
4538
4885
  * The total number of subscribers imported.
4539
4886
  */
@@ -4666,6 +5013,7 @@ type SubscriptionInvoice = {
4666
5013
  id?: SubscriptionsUuid;
4667
5014
  type: SubscriptionInvoiceType;
4668
5015
  attributes: SubscriptionInvoiceAttributes;
5016
+ relationships?: Relationships;
4669
5017
  meta: SubscriptionInvoiceMeta;
4670
5018
  };
4671
5019
  type UpdateInvoicePayment = {
@@ -4714,11 +5062,11 @@ type ProrationEvent = {
4714
5062
  /**
4715
5063
  * The value as a whole number of the currency's smallest subdivision.
4716
5064
  */
4717
- refunded_amount_for_unused_plan: BigInt;
5065
+ refunded_amount_for_unused_pricing_option: BigInt;
4718
5066
  /**
4719
5067
  * The value as a whole number of the currency's smallest subdivision.
4720
5068
  */
4721
- new_plan_cost: BigInt;
5069
+ new_pricing_option_cost: BigInt;
4722
5070
  /**
4723
5071
  * The date and time the subscription was prorated.
4724
5072
  */
@@ -4812,7 +5160,7 @@ type SubscriptionInvoiceItem = {
4812
5160
  */
4813
5161
  description: string;
4814
5162
  price: SingleCurrencyPrice;
4815
- product_id?: SubscriptionsUuid;
5163
+ plan_id?: SubscriptionsUuid;
4816
5164
  /**
4817
5165
  * The start date and time of the billing period in this price
4818
5166
  */
@@ -4831,9 +5179,9 @@ type CurrencyIdentifier = string;
4831
5179
  */
4832
5180
  type OwnerMeta = string;
4833
5181
  /**
4834
- * The offerings product external_ref value
5182
+ * The offerings plan external_ref value
4835
5183
  */
4836
- type OfferingProductExternalRefMeta = string;
5184
+ type OfferingPlanExternalRefMeta = string;
4837
5185
  type Subscriber = {
4838
5186
  id?: SubscriptionsUuid;
4839
5187
  type: SubscriptionSubscriberType;
@@ -4841,6 +5189,10 @@ type Subscriber = {
4841
5189
  meta: SubscriberMeta;
4842
5190
  };
4843
5191
  type SubscriberMeta = {
5192
+ /**
5193
+ * A list of entitlement tags currently active for the subscriber
5194
+ */
5195
+ feature_entitlements?: Array<FeatureTag>;
4844
5196
  owner: OwnerMeta;
4845
5197
  timestamps: SubscriptionsTimestamps;
4846
5198
  };
@@ -6096,6 +6448,7 @@ type SelfLink2 = {
6096
6448
  */
6097
6449
  self?: string;
6098
6450
  };
6451
+ type ResponseError = Array<unknown>;
6099
6452
  type File = {
6100
6453
  /**
6101
6454
  * The unique identifier for this file.
@@ -6302,11 +6655,15 @@ type PricebookIdsForPriceSegmentationPreview = Array<string>;
6302
6655
  * Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.
6303
6656
  */
6304
6657
  type Tag = string;
6305
- type CartInclude2 = Array<"items">;
6658
+ type CartInclude = Array<"items" | "tax_items" | "custom_discounts" | "promotions">;
6306
6659
  /**
6307
6660
  * A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
6308
6661
  */
6309
- type Include2 = string;
6662
+ type OfferingInclude = Array<"plans" | "pricing_options" | "features">;
6663
+ /**
6664
+ * A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
6665
+ */
6666
+ type SubscriptionInclude = Array<"plans" | "pricing_options">;
6310
6667
  /**
6311
6668
  * 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.
6312
6669
  *
@@ -8393,23 +8750,26 @@ type GetCartsData = {
8393
8750
  };
8394
8751
  type GetCartsErrors = {
8395
8752
  /**
8396
- * Unauthorized
8753
+ * Bad Request
8397
8754
  */
8398
- 401: ResponseError;
8755
+ 400: {
8756
+ errors?: Array<{
8757
+ detail?: string;
8758
+ title?: string;
8759
+ }>;
8760
+ };
8761
+ /**
8762
+ * Unauthorized call
8763
+ */
8764
+ 403: ResponseErrorResponse;
8399
8765
  };
8400
8766
  type GetCartsError = GetCartsErrors[keyof GetCartsErrors];
8401
8767
  type GetCartsResponses = {
8402
- 200: ResponseData & {
8403
- data?: Array<CartResponse>;
8404
- links?: ResponsePageLinks;
8405
- meta?: ResponseMetaCarts;
8406
- };
8768
+ 200: CartCollectionResponse;
8407
8769
  };
8408
8770
  type GetCartsResponse = GetCartsResponses[keyof GetCartsResponses];
8409
8771
  type CreateACartData = {
8410
- body?: ResponseData & {
8411
- data?: CartsRequest;
8412
- };
8772
+ body?: CartsRequest;
8413
8773
  headers?: {
8414
8774
  /**
8415
8775
  * A customer token to be associated with the cart.
@@ -8422,15 +8782,23 @@ type CreateACartData = {
8422
8782
  };
8423
8783
  type CreateACartErrors = {
8424
8784
  /**
8425
- * Unauthorized
8785
+ * Bad Request
8426
8786
  */
8427
- 401: ResponseError;
8787
+ 400: {
8788
+ errors?: Array<{
8789
+ detail?: string;
8790
+ status?: number;
8791
+ title?: string;
8792
+ }>;
8793
+ };
8794
+ /**
8795
+ * Unauthorized call
8796
+ */
8797
+ 403: ResponseErrorResponse;
8428
8798
  };
8429
8799
  type CreateACartError = CreateACartErrors[keyof CreateACartErrors];
8430
8800
  type CreateACartResponses = {
8431
- 200: ResponseData & {
8432
- data?: CartResponse;
8433
- };
8801
+ 201: CartEntityResponse;
8434
8802
  };
8435
8803
  type CreateACartResponse = CreateACartResponses[keyof CreateACartResponses];
8436
8804
  type DeleteACartData = {
@@ -8446,9 +8814,9 @@ type DeleteACartData = {
8446
8814
  };
8447
8815
  type DeleteACartErrors = {
8448
8816
  /**
8449
- * Unauthorized
8817
+ * Bad Request
8450
8818
  */
8451
- 401: ResponseError;
8819
+ 400: ResponseErrorResponse;
8452
8820
  };
8453
8821
  type DeleteACartError = DeleteACartErrors[keyof DeleteACartErrors];
8454
8822
  type DeleteACartResponses = {
@@ -8458,7 +8826,7 @@ type DeleteACartResponses = {
8458
8826
  204: void;
8459
8827
  };
8460
8828
  type DeleteACartResponse = DeleteACartResponses[keyof DeleteACartResponses];
8461
- type GetCartData = {
8829
+ type GetACartData = {
8462
8830
  body?: never;
8463
8831
  path: {
8464
8832
  /**
@@ -8467,29 +8835,30 @@ type GetCartData = {
8467
8835
  cartID: string;
8468
8836
  };
8469
8837
  query?: {
8470
- include?: Array<"items">;
8838
+ include?: Array<"items" | "tax_items" | "custom_discounts" | "promotions">;
8471
8839
  };
8472
8840
  url: "/v2/carts/{cartID}";
8473
8841
  };
8474
- type GetCartErrors = {
8842
+ type GetACartErrors = {
8475
8843
  /**
8476
- * Unauthorized
8844
+ * Bad Request
8477
8845
  */
8478
- 401: ResponseError;
8846
+ 400: {
8847
+ errors?: Array<{
8848
+ detail?: string;
8849
+ status?: number;
8850
+ title?: string;
8851
+ }>;
8852
+ };
8479
8853
  };
8480
- type GetCartError = GetCartErrors[keyof GetCartErrors];
8481
- type GetCartResponses = {
8854
+ type GetACartError = GetACartErrors[keyof GetACartErrors];
8855
+ type GetACartResponses = {
8482
8856
  /**
8483
8857
  * OK
8484
8858
  */
8485
- 200: ResponseData & {
8486
- data?: CartResponse;
8487
- } & {
8488
- data?: CartResponse;
8489
- included?: CartInclude;
8490
- };
8859
+ 200: CartEntityResponse;
8491
8860
  };
8492
- type GetCartResponse = GetCartResponses[keyof GetCartResponses];
8861
+ type GetACartResponse = GetACartResponses[keyof GetACartResponses];
8493
8862
  type UpdateACartData = {
8494
8863
  body?: CartsRequest;
8495
8864
  path: {
@@ -8503,15 +8872,23 @@ type UpdateACartData = {
8503
8872
  };
8504
8873
  type UpdateACartErrors = {
8505
8874
  /**
8506
- * Unauthorized
8875
+ * Unauthorized call
8507
8876
  */
8508
- 401: ResponseError;
8877
+ 403: ResponseErrorResponse;
8878
+ /**
8879
+ * Unprocessable Content
8880
+ */
8881
+ 422: {
8882
+ errors?: Array<{
8883
+ detail?: string;
8884
+ status?: number;
8885
+ title?: string;
8886
+ }>;
8887
+ };
8509
8888
  };
8510
8889
  type UpdateACartError = UpdateACartErrors[keyof UpdateACartErrors];
8511
8890
  type UpdateACartResponses = {
8512
- 200: ResponseData & {
8513
- data?: CartResponse;
8514
- };
8891
+ 200: CartEntityResponse;
8515
8892
  };
8516
8893
  type UpdateACartResponse = UpdateACartResponses[keyof UpdateACartResponses];
8517
8894
  type DeleteAllCartItemsData = {
@@ -8527,9 +8904,9 @@ type DeleteAllCartItemsData = {
8527
8904
  };
8528
8905
  type DeleteAllCartItemsErrors = {
8529
8906
  /**
8530
- * Unauthorized
8907
+ * Unprocessable Entity
8531
8908
  */
8532
- 401: ResponseError;
8909
+ 422: ResponseErrorResponse;
8533
8910
  };
8534
8911
  type DeleteAllCartItemsError = DeleteAllCartItemsErrors[keyof DeleteAllCartItemsErrors];
8535
8912
  type DeleteAllCartItemsResponses = {
@@ -8550,19 +8927,12 @@ type GetCartItemsData = {
8550
8927
  query?: never;
8551
8928
  url: "/v2/carts/{cartID}/items";
8552
8929
  };
8553
- type GetCartItemsErrors = {
8554
- /**
8555
- * Unauthorized
8556
- */
8557
- 401: ResponseError;
8558
- };
8559
- type GetCartItemsError = GetCartItemsErrors[keyof GetCartItemsErrors];
8560
8930
  type GetCartItemsResponses = {
8561
- 200: CartsResponse;
8931
+ 200: CartItemsResponse;
8562
8932
  };
8563
8933
  type GetCartItemsResponse = GetCartItemsResponses[keyof GetCartItemsResponses];
8564
8934
  type ManageCartsData = {
8565
- body?: CartItemsObjectRequest | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject | BulkAddItemsRequest;
8935
+ body?: CartItemObjectRequest | SubscriptionItemObject | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject | BulkAddItemsRequest;
8566
8936
  path: {
8567
8937
  /**
8568
8938
  * The unique identifier of the cart that you created.
@@ -8574,13 +8944,25 @@ type ManageCartsData = {
8574
8944
  };
8575
8945
  type ManageCartsErrors = {
8576
8946
  /**
8577
- * Unauthorized
8947
+ * Bad Request
8578
8948
  */
8579
- 401: ResponseError;
8949
+ 400: ResponseErrorResponse;
8950
+ /**
8951
+ * Not Found
8952
+ */
8953
+ 404: ResponseErrorResponse;
8954
+ /**
8955
+ * Unprocessable Entity
8956
+ */
8957
+ 422: ResponseErrorResponse;
8958
+ /**
8959
+ * Internal Server Error
8960
+ */
8961
+ 500: ResponseErrorResponse;
8580
8962
  };
8581
8963
  type ManageCartsError = ManageCartsErrors[keyof ManageCartsErrors];
8582
8964
  type ManageCartsResponses = {
8583
- 200: CartsResponse;
8965
+ 201: CartsResponse;
8584
8966
  };
8585
8967
  type ManageCartsResponse = ManageCartsResponses[keyof ManageCartsResponses];
8586
8968
  type BulkUpdateItemsInCartData = {
@@ -8596,9 +8978,17 @@ type BulkUpdateItemsInCartData = {
8596
8978
  };
8597
8979
  type BulkUpdateItemsInCartErrors = {
8598
8980
  /**
8599
- * Unauthorized
8981
+ * Insufficient Stock
8600
8982
  */
8601
- 401: ResponseError;
8983
+ 400: ResponseErrorResponse;
8984
+ /**
8985
+ * Not Found
8986
+ */
8987
+ 404: ResponseErrorResponse;
8988
+ /**
8989
+ * Unprocessable Entity
8990
+ */
8991
+ 422: ResponseErrorResponse;
8602
8992
  };
8603
8993
  type BulkUpdateItemsInCartError = BulkUpdateItemsInCartErrors[keyof BulkUpdateItemsInCartErrors];
8604
8994
  type BulkUpdateItemsInCartResponses = {
@@ -8619,18 +9009,8 @@ type DeleteACartItemData = {
8619
9009
  query?: never;
8620
9010
  url: "/v2/carts/{cartID}/items/{cartitemID}";
8621
9011
  };
8622
- type DeleteACartItemErrors = {
8623
- /**
8624
- * Unauthorized
8625
- */
8626
- 401: ResponseError;
8627
- };
8628
- type DeleteACartItemError = DeleteACartItemErrors[keyof DeleteACartItemErrors];
8629
9012
  type DeleteACartItemResponses = {
8630
- /**
8631
- * No Content
8632
- */
8633
- 204: void;
9013
+ 200: CartsResponse;
8634
9014
  };
8635
9015
  type DeleteACartItemResponse = DeleteACartItemResponses[keyof DeleteACartItemResponses];
8636
9016
  type UpdateACartItemData = {
@@ -8650,9 +9030,13 @@ type UpdateACartItemData = {
8650
9030
  };
8651
9031
  type UpdateACartItemErrors = {
8652
9032
  /**
8653
- * Unauthorized
9033
+ * Bad Request
8654
9034
  */
8655
- 401: ResponseError;
9035
+ 400: ResponseErrorResponse;
9036
+ /**
9037
+ * Not Found
9038
+ */
9039
+ 404: ResponseErrorResponse;
8656
9040
  };
8657
9041
  type UpdateACartItemError = UpdateACartItemErrors[keyof UpdateACartItemErrors];
8658
9042
  type UpdateACartItemResponses = {
@@ -8678,9 +9062,13 @@ type DeleteAccountCartAssociationData = {
8678
9062
  };
8679
9063
  type DeleteAccountCartAssociationErrors = {
8680
9064
  /**
8681
- * Unauthorized
9065
+ * Bad Request
8682
9066
  */
8683
- 401: ResponseError;
9067
+ 400: ResponseErrorResponse;
9068
+ /**
9069
+ * Forbidden
9070
+ */
9071
+ 403: ResponseErrorResponse;
8684
9072
  };
8685
9073
  type DeleteAccountCartAssociationError = DeleteAccountCartAssociationErrors[keyof DeleteAccountCartAssociationErrors];
8686
9074
  type DeleteAccountCartAssociationResponses = {
@@ -8709,9 +9097,17 @@ type CreateAccountCartAssociationData = {
8709
9097
  };
8710
9098
  type CreateAccountCartAssociationErrors = {
8711
9099
  /**
8712
- * Unauthorized
9100
+ * Bad Request
8713
9101
  */
8714
- 401: ResponseError;
9102
+ 400: ResponseErrorResponse;
9103
+ /**
9104
+ * Forbidden
9105
+ */
9106
+ 403: ResponseErrorResponse;
9107
+ /**
9108
+ * Unprocessable Entity
9109
+ */
9110
+ 422: ResponseErrorResponse;
8715
9111
  };
8716
9112
  type CreateAccountCartAssociationError = CreateAccountCartAssociationErrors[keyof CreateAccountCartAssociationErrors];
8717
9113
  type CreateAccountCartAssociationResponses = {
@@ -8744,9 +9140,13 @@ type DeleteCustomerCartAssociationData = {
8744
9140
  };
8745
9141
  type DeleteCustomerCartAssociationErrors = {
8746
9142
  /**
8747
- * Unauthorized
9143
+ * Bad Request
8748
9144
  */
8749
- 401: ResponseError;
9145
+ 400: ResponseErrorResponse;
9146
+ /**
9147
+ * Forbidden
9148
+ */
9149
+ 403: ResponseErrorResponse;
8750
9150
  };
8751
9151
  type DeleteCustomerCartAssociationError = DeleteCustomerCartAssociationErrors[keyof DeleteCustomerCartAssociationErrors];
8752
9152
  type DeleteCustomerCartAssociationResponses = {
@@ -8774,10 +9174,18 @@ type CreateCustomerCartAssociationData = {
8774
9174
  url: "/v2/carts/{cartID}/relationships/customers";
8775
9175
  };
8776
9176
  type CreateCustomerCartAssociationErrors = {
9177
+ /**
9178
+ * Bad Request
9179
+ */
9180
+ 400: ResponseErrorResponse;
9181
+ /**
9182
+ * Forbidden
9183
+ */
9184
+ 403: ResponseErrorResponse;
8777
9185
  /**
8778
9186
  * Unauthorized
8779
9187
  */
8780
- 401: ResponseError;
9188
+ 422: ResponseErrorResponse;
8781
9189
  };
8782
9190
  type CreateCustomerCartAssociationError = CreateCustomerCartAssociationErrors[keyof CreateCustomerCartAssociationErrors];
8783
9191
  type CreateCustomerCartAssociationResponses = {
@@ -8785,6 +9193,10 @@ type CreateCustomerCartAssociationResponses = {
8785
9193
  * OK
8786
9194
  */
8787
9195
  200: CartsRelationshipsCustomersData;
9196
+ /**
9197
+ * No Content
9198
+ */
9199
+ 204: void;
8788
9200
  };
8789
9201
  type CreateCustomerCartAssociationResponse = CreateCustomerCartAssociationResponses[keyof CreateCustomerCartAssociationResponses];
8790
9202
  type DeleteAPromotionViaPromotionCodeData = {
@@ -8802,13 +9214,6 @@ type DeleteAPromotionViaPromotionCodeData = {
8802
9214
  query?: never;
8803
9215
  url: "/v2/carts/{cartID}/discounts/{promoCode}";
8804
9216
  };
8805
- type DeleteAPromotionViaPromotionCodeErrors = {
8806
- /**
8807
- * Unauthorized
8808
- */
8809
- 401: ResponseError;
8810
- };
8811
- type DeleteAPromotionViaPromotionCodeError = DeleteAPromotionViaPromotionCodeErrors[keyof DeleteAPromotionViaPromotionCodeErrors];
8812
9217
  type DeleteAPromotionViaPromotionCodeResponses = {
8813
9218
  /**
8814
9219
  * No Content
@@ -8817,9 +9222,7 @@ type DeleteAPromotionViaPromotionCodeResponses = {
8817
9222
  };
8818
9223
  type DeleteAPromotionViaPromotionCodeResponse = DeleteAPromotionViaPromotionCodeResponses[keyof DeleteAPromotionViaPromotionCodeResponses];
8819
9224
  type AddTaxItemToCartData = {
8820
- body?: ResponseData & {
8821
- data?: CartsItemsTaxesObject;
8822
- };
9225
+ body?: CartItemTaxesEntityResponse;
8823
9226
  path: {
8824
9227
  /**
8825
9228
  * The unique identifier of the cart.
@@ -8837,17 +9240,15 @@ type AddTaxItemToCartErrors = {
8837
9240
  /**
8838
9241
  * Unauthorized
8839
9242
  */
8840
- 401: ResponseError;
8841
- /**
8842
- * Unauthorized
8843
- */
8844
- 422: ResponseError;
9243
+ 422: ResponseErrorResponse;
8845
9244
  };
8846
9245
  type AddTaxItemToCartError = AddTaxItemToCartErrors[keyof AddTaxItemToCartErrors];
8847
9246
  type AddTaxItemToCartResponses = {
8848
- 200: ResponseData & {
8849
- data?: CartsItemsTaxesObject;
8850
- };
9247
+ 200: CartItemTaxesEntityResponse;
9248
+ /**
9249
+ * Created
9250
+ */
9251
+ 201: CartItemTaxesEntityResponse;
8851
9252
  };
8852
9253
  type AddTaxItemToCartResponse = AddTaxItemToCartResponses[keyof AddTaxItemToCartResponses];
8853
9254
  type BulkDeleteTaxItemsFromCartData = {
@@ -8861,13 +9262,6 @@ type BulkDeleteTaxItemsFromCartData = {
8861
9262
  query?: never;
8862
9263
  url: "/v2/carts/{cartID}/taxes";
8863
9264
  };
8864
- type BulkDeleteTaxItemsFromCartErrors = {
8865
- /**
8866
- * Unauthorized
8867
- */
8868
- 401: ResponseError;
8869
- };
8870
- type BulkDeleteTaxItemsFromCartError = BulkDeleteTaxItemsFromCartErrors[keyof BulkDeleteTaxItemsFromCartErrors];
8871
9265
  type BulkDeleteTaxItemsFromCartResponses = {
8872
9266
  /**
8873
9267
  * No Content
@@ -8888,13 +9282,17 @@ type BulkAddTaxItemsToCartData = {
8888
9282
  };
8889
9283
  type BulkAddTaxItemsToCartErrors = {
8890
9284
  /**
8891
- * Unauthorized
9285
+ * Unprocessable Entity
8892
9286
  */
8893
- 401: ResponseError;
9287
+ 422: ResponseErrorResponse;
8894
9288
  };
8895
9289
  type BulkAddTaxItemsToCartError = BulkAddTaxItemsToCartErrors[keyof BulkAddTaxItemsToCartErrors];
8896
9290
  type BulkAddTaxItemsToCartResponses = {
8897
9291
  200: CartsBulkTaxes;
9292
+ /**
9293
+ * Created
9294
+ */
9295
+ 201: CartsBulkTaxes;
8898
9296
  };
8899
9297
  type BulkAddTaxItemsToCartResponse = BulkAddTaxItemsToCartResponses[keyof BulkAddTaxItemsToCartResponses];
8900
9298
  type DeleteATaxItemData = {
@@ -8916,13 +9314,6 @@ type DeleteATaxItemData = {
8916
9314
  query?: never;
8917
9315
  url: "/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}";
8918
9316
  };
8919
- type DeleteATaxItemErrors = {
8920
- /**
8921
- * Unauthorized
8922
- */
8923
- 401: ResponseError;
8924
- };
8925
- type DeleteATaxItemError = DeleteATaxItemErrors[keyof DeleteATaxItemErrors];
8926
9317
  type DeleteATaxItemResponses = {
8927
9318
  /**
8928
9319
  * No Content
@@ -8931,9 +9322,7 @@ type DeleteATaxItemResponses = {
8931
9322
  };
8932
9323
  type DeleteATaxItemResponse = DeleteATaxItemResponses[keyof DeleteATaxItemResponses];
8933
9324
  type UpdateATaxItemData = {
8934
- body?: ResponseData & {
8935
- data?: CartsItemsTaxesObject;
8936
- };
9325
+ body?: CartItemTaxesEntityResponse;
8937
9326
  path: {
8938
9327
  /**
8939
9328
  * The unique identifier of the cart.
@@ -8951,17 +9340,8 @@ type UpdateATaxItemData = {
8951
9340
  query?: never;
8952
9341
  url: "/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}";
8953
9342
  };
8954
- type UpdateATaxItemErrors = {
8955
- /**
8956
- * Unauthorized
8957
- */
8958
- 401: ResponseError;
8959
- };
8960
- type UpdateATaxItemError = UpdateATaxItemErrors[keyof UpdateATaxItemErrors];
8961
9343
  type UpdateATaxItemResponses = {
8962
- 200: ResponseData & {
8963
- data?: CartsItemsTaxesObject;
8964
- };
9344
+ 200: CartItemTaxesEntityResponse;
8965
9345
  };
8966
9346
  type UpdateATaxItemResponse = UpdateATaxItemResponses[keyof UpdateATaxItemResponses];
8967
9347
  type BulkDeleteCustomDiscountsFromCartData = {
@@ -8975,13 +9355,6 @@ type BulkDeleteCustomDiscountsFromCartData = {
8975
9355
  query?: never;
8976
9356
  url: "/v2/carts/{cartID}/custom-discounts";
8977
9357
  };
8978
- type BulkDeleteCustomDiscountsFromCartErrors = {
8979
- /**
8980
- * Unauthorized
8981
- */
8982
- 401: ResponseError;
8983
- };
8984
- type BulkDeleteCustomDiscountsFromCartError = BulkDeleteCustomDiscountsFromCartErrors[keyof BulkDeleteCustomDiscountsFromCartErrors];
8985
9358
  type BulkDeleteCustomDiscountsFromCartResponses = {
8986
9359
  /**
8987
9360
  * No Content
@@ -9002,13 +9375,17 @@ type BulkAddCustomDiscountsToCartData = {
9002
9375
  };
9003
9376
  type BulkAddCustomDiscountsToCartErrors = {
9004
9377
  /**
9005
- * Unauthorized
9378
+ * Could not apply custom discount
9006
9379
  */
9007
- 401: ResponseError;
9380
+ 400: ResponseErrorResponse;
9381
+ /**
9382
+ * Could not apply custom discount
9383
+ */
9384
+ 422: ResponseErrorResponse;
9008
9385
  };
9009
9386
  type BulkAddCustomDiscountsToCartError = BulkAddCustomDiscountsToCartErrors[keyof BulkAddCustomDiscountsToCartErrors];
9010
9387
  type BulkAddCustomDiscountsToCartResponses = {
9011
- 200: CartsBulkCustomDiscountsResponse;
9388
+ 201: CartsBulkCustomDiscountsResponse | CartsBulkCustomDiscountsCollectionResponse;
9012
9389
  };
9013
9390
  type BulkAddCustomDiscountsToCartResponse = BulkAddCustomDiscountsToCartResponses[keyof BulkAddCustomDiscountsToCartResponses];
9014
9391
  type DeleteCustomDiscountFromCartData = {
@@ -9026,13 +9403,6 @@ type DeleteCustomDiscountFromCartData = {
9026
9403
  query?: never;
9027
9404
  url: "/v2/carts/{cartID}/custom-discounts/{customdiscountID}";
9028
9405
  };
9029
- type DeleteCustomDiscountFromCartErrors = {
9030
- /**
9031
- * Unauthorized
9032
- */
9033
- 401: ResponseError;
9034
- };
9035
- type DeleteCustomDiscountFromCartError = DeleteCustomDiscountFromCartErrors[keyof DeleteCustomDiscountFromCartErrors];
9036
9406
  type DeleteCustomDiscountFromCartResponses = {
9037
9407
  /**
9038
9408
  * No Content
@@ -9041,9 +9411,7 @@ type DeleteCustomDiscountFromCartResponses = {
9041
9411
  };
9042
9412
  type DeleteCustomDiscountFromCartResponse = DeleteCustomDiscountFromCartResponses[keyof DeleteCustomDiscountFromCartResponses];
9043
9413
  type UpdateCustomDiscountForCartData = {
9044
- body?: ResponseData & {
9045
- data?: CartsCustomDiscountsObject;
9046
- };
9414
+ body?: CartsCustomDiscountsEntityRequest;
9047
9415
  path: {
9048
9416
  /**
9049
9417
  * Specifies the unique ID for the cart.
@@ -9057,17 +9425,8 @@ type UpdateCustomDiscountForCartData = {
9057
9425
  query?: never;
9058
9426
  url: "/v2/carts/{cartID}/custom-discounts/{customdiscountID}";
9059
9427
  };
9060
- type UpdateCustomDiscountForCartErrors = {
9061
- /**
9062
- * Unauthorized
9063
- */
9064
- 401: ResponseError;
9065
- };
9066
- type UpdateCustomDiscountForCartError = UpdateCustomDiscountForCartErrors[keyof UpdateCustomDiscountForCartErrors];
9067
9428
  type UpdateCustomDiscountForCartResponses = {
9068
- 200: ResponseData & {
9069
- data?: CartsCustomDiscountsResponse;
9070
- };
9429
+ 200: CartsCustomDiscountsEntityResponse;
9071
9430
  };
9072
9431
  type UpdateCustomDiscountForCartResponse = UpdateCustomDiscountForCartResponses[keyof UpdateCustomDiscountForCartResponses];
9073
9432
  type AddCustomDiscountToCartItemData = {
@@ -9087,15 +9446,20 @@ type AddCustomDiscountToCartItemData = {
9087
9446
  };
9088
9447
  type AddCustomDiscountToCartItemErrors = {
9089
9448
  /**
9090
- * Unauthorized
9449
+ * Bad Request
9091
9450
  */
9092
- 401: ResponseError;
9451
+ 400: ResponseErrorResponse;
9452
+ /**
9453
+ * Bad Request
9454
+ */
9455
+ 422: ResponseErrorResponse;
9093
9456
  };
9094
9457
  type AddCustomDiscountToCartItemError = AddCustomDiscountToCartItemErrors[keyof AddCustomDiscountToCartItemErrors];
9095
9458
  type AddCustomDiscountToCartItemResponses = {
9096
- 200: ResponseData & {
9097
- data?: CartsCustomDiscountsResponse;
9098
- };
9459
+ /**
9460
+ * Successful request
9461
+ */
9462
+ 201: CartsCustomDiscountsCollectionResponse | CartsCustomDiscountsEntityResponse;
9099
9463
  };
9100
9464
  type AddCustomDiscountToCartItemResponse = AddCustomDiscountToCartItemResponses[keyof AddCustomDiscountToCartItemResponses];
9101
9465
  type DeleteCustomDiscountFromCartItemData = {
@@ -9117,13 +9481,6 @@ type DeleteCustomDiscountFromCartItemData = {
9117
9481
  query?: never;
9118
9482
  url: "/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}";
9119
9483
  };
9120
- type DeleteCustomDiscountFromCartItemErrors = {
9121
- /**
9122
- * Unauthorized
9123
- */
9124
- 401: ResponseError;
9125
- };
9126
- type DeleteCustomDiscountFromCartItemError = DeleteCustomDiscountFromCartItemErrors[keyof DeleteCustomDiscountFromCartItemErrors];
9127
9484
  type DeleteCustomDiscountFromCartItemResponses = {
9128
9485
  /**
9129
9486
  * No Content
@@ -9132,9 +9489,7 @@ type DeleteCustomDiscountFromCartItemResponses = {
9132
9489
  };
9133
9490
  type DeleteCustomDiscountFromCartItemResponse = DeleteCustomDiscountFromCartItemResponses[keyof DeleteCustomDiscountFromCartItemResponses];
9134
9491
  type UpdateCustomDiscountForCartItemData = {
9135
- body?: ResponseData & {
9136
- data?: CartsCustomDiscountsObject;
9137
- };
9492
+ body?: CartsCustomDiscountsEntityRequest;
9138
9493
  path: {
9139
9494
  /**
9140
9495
  * Specifies the ID for the cart.
@@ -9152,19 +9507,163 @@ type UpdateCustomDiscountForCartItemData = {
9152
9507
  query?: never;
9153
9508
  url: "/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}";
9154
9509
  };
9155
- type UpdateCustomDiscountForCartItemErrors = {
9510
+ type UpdateCustomDiscountForCartItemResponses = {
9511
+ 200: CartsCustomDiscountsEntityResponse;
9512
+ };
9513
+ type UpdateCustomDiscountForCartItemResponse = UpdateCustomDiscountForCartItemResponses[keyof UpdateCustomDiscountForCartItemResponses];
9514
+ type GetShippingGroupsData = {
9515
+ body?: never;
9516
+ path: {
9517
+ /**
9518
+ * The ID of the cart
9519
+ */
9520
+ cartID: string;
9521
+ };
9522
+ query?: never;
9523
+ url: "/v2/carts/{cartID}/shipping-groups";
9524
+ };
9525
+ type GetShippingGroupsErrors = {
9156
9526
  /**
9157
- * Unauthorized
9527
+ * Cart not found
9158
9528
  */
9159
- 401: ResponseError;
9529
+ 404: ResponseErrorResponse;
9160
9530
  };
9161
- type UpdateCustomDiscountForCartItemError = UpdateCustomDiscountForCartItemErrors[keyof UpdateCustomDiscountForCartItemErrors];
9162
- type UpdateCustomDiscountForCartItemResponses = {
9163
- 200: ResponseData & {
9164
- data?: CartsCustomDiscountsResponse;
9531
+ type GetShippingGroupsError = GetShippingGroupsErrors[keyof GetShippingGroupsErrors];
9532
+ type GetShippingGroupsResponses = {
9533
+ /**
9534
+ * A list of shipping groups
9535
+ */
9536
+ 200: {
9537
+ data?: Array<ShippingGroupResponse>;
9165
9538
  };
9166
9539
  };
9167
- type UpdateCustomDiscountForCartItemResponse = UpdateCustomDiscountForCartItemResponses[keyof UpdateCustomDiscountForCartItemResponses];
9540
+ type GetShippingGroupsResponse = GetShippingGroupsResponses[keyof GetShippingGroupsResponses];
9541
+ type CreateShippingGroupData = {
9542
+ body: CreateShippingGroupRequest;
9543
+ path: {
9544
+ /**
9545
+ * The ID of the cart
9546
+ */
9547
+ cartID: string;
9548
+ };
9549
+ query?: never;
9550
+ url: "/v2/carts/{cartID}/shipping-groups";
9551
+ };
9552
+ type CreateShippingGroupErrors = {
9553
+ /**
9554
+ * Invalid request
9555
+ */
9556
+ 400: ResponseErrorResponse;
9557
+ /**
9558
+ * Cart not found
9559
+ */
9560
+ 404: ResponseErrorResponse;
9561
+ };
9562
+ type CreateShippingGroupError = CreateShippingGroupErrors[keyof CreateShippingGroupErrors];
9563
+ type CreateShippingGroupResponses = {
9564
+ /**
9565
+ * Shipping group created successfully
9566
+ */
9567
+ 201: ShippingGroupResponse;
9568
+ };
9569
+ type CreateShippingGroupResponse = CreateShippingGroupResponses[keyof CreateShippingGroupResponses];
9570
+ type DeleteCartShippingGroupData = {
9571
+ body?: never;
9572
+ path: {
9573
+ /**
9574
+ * The ID of the cart
9575
+ */
9576
+ cartId: string;
9577
+ /**
9578
+ * The ID of the shipping group to delete
9579
+ */
9580
+ shippingGroupId: string;
9581
+ };
9582
+ query?: never;
9583
+ url: "/v2/carts/{cartId}/shipping-groups/{shippingGroupId}";
9584
+ };
9585
+ type DeleteCartShippingGroupErrors = {
9586
+ /**
9587
+ * Cannot delete shipping group that is attached to cart items
9588
+ */
9589
+ 400: ResponseErrorResponse;
9590
+ /**
9591
+ * Cart or shipping group not found
9592
+ */
9593
+ 404: ResponseErrorResponse;
9594
+ };
9595
+ type DeleteCartShippingGroupError = DeleteCartShippingGroupErrors[keyof DeleteCartShippingGroupErrors];
9596
+ type DeleteCartShippingGroupResponses = {
9597
+ /**
9598
+ * Successfully deleted the shipping group
9599
+ */
9600
+ 204: void;
9601
+ };
9602
+ type DeleteCartShippingGroupResponse = DeleteCartShippingGroupResponses[keyof DeleteCartShippingGroupResponses];
9603
+ type GetShippingGroupByIdData = {
9604
+ body?: never;
9605
+ path: {
9606
+ /**
9607
+ * The ID of the cart
9608
+ */
9609
+ cartId: string;
9610
+ /**
9611
+ * The ID of the shipping group
9612
+ */
9613
+ shippingGroupId: string;
9614
+ };
9615
+ query?: never;
9616
+ url: "/v2/carts/{cartId}/shipping-groups/{shippingGroupId}";
9617
+ };
9618
+ type GetShippingGroupByIdErrors = {
9619
+ /**
9620
+ * Shipping group or cart not found
9621
+ */
9622
+ 404: ResponseErrorResponse;
9623
+ };
9624
+ type GetShippingGroupByIdError = GetShippingGroupByIdErrors[keyof GetShippingGroupByIdErrors];
9625
+ type GetShippingGroupByIdResponses = {
9626
+ /**
9627
+ * Shipping group details
9628
+ */
9629
+ 200: {
9630
+ data?: ShippingGroupResponse;
9631
+ };
9632
+ };
9633
+ type GetShippingGroupByIdResponse = GetShippingGroupByIdResponses[keyof GetShippingGroupByIdResponses];
9634
+ type UpdateShippingGroupData = {
9635
+ body: UpdateCartShippingGroupRequest;
9636
+ path: {
9637
+ /**
9638
+ * The ID of the cart
9639
+ */
9640
+ cartId: string;
9641
+ /**
9642
+ * The ID of the shipping group
9643
+ */
9644
+ shippingGroupId: string;
9645
+ };
9646
+ query?: never;
9647
+ url: "/v2/carts/{cartId}/shipping-groups/{shippingGroupId}";
9648
+ };
9649
+ type UpdateShippingGroupErrors = {
9650
+ /**
9651
+ * Invalid request
9652
+ */
9653
+ 400: ResponseErrorResponse;
9654
+ /**
9655
+ * Shipping group or cart not found
9656
+ */
9657
+ 404: ResponseErrorResponse;
9658
+ };
9659
+ type UpdateShippingGroupError = UpdateShippingGroupErrors[keyof UpdateShippingGroupErrors];
9660
+ type UpdateShippingGroupResponses = {
9661
+ /**
9662
+ * Shipping group updated successfully
9663
+ */
9664
+ 200: ShippingGroupResponse;
9665
+ };
9666
+ type UpdateShippingGroupResponse = UpdateShippingGroupResponses[keyof UpdateShippingGroupResponses];
9168
9667
  type CreateCartPaymentIntentData = {
9169
9668
  body?: ElasticPathPaymentsPoweredByStripePayment;
9170
9669
  path: {
@@ -9176,13 +9675,6 @@ type CreateCartPaymentIntentData = {
9176
9675
  query?: never;
9177
9676
  url: "/v2/carts/{cartID}/payments";
9178
9677
  };
9179
- type CreateCartPaymentIntentErrors = {
9180
- /**
9181
- * Unauthorized
9182
- */
9183
- 401: ResponseError;
9184
- };
9185
- type CreateCartPaymentIntentError = CreateCartPaymentIntentErrors[keyof CreateCartPaymentIntentErrors];
9186
9678
  type CreateCartPaymentIntentResponses = {
9187
9679
  /**
9188
9680
  * Payment Intent created successfully.
@@ -9190,6 +9682,28 @@ type CreateCartPaymentIntentResponses = {
9190
9682
  201: CartResponse;
9191
9683
  };
9192
9684
  type CreateCartPaymentIntentResponse = CreateCartPaymentIntentResponses[keyof CreateCartPaymentIntentResponses];
9685
+ type UpdateCartPaymentIntentData = {
9686
+ body: CartPaymentUpdate;
9687
+ path: {
9688
+ /**
9689
+ * The unique identifier of the cart.
9690
+ */
9691
+ cartID: string;
9692
+ /**
9693
+ * The unique identifier of the payment intent.
9694
+ */
9695
+ paymentIntentID: string;
9696
+ };
9697
+ query?: never;
9698
+ url: "/v2/carts/{cartID}/payments/{paymentIntentID}";
9699
+ };
9700
+ type UpdateCartPaymentIntentResponses = {
9701
+ /**
9702
+ * Payment updated successfully
9703
+ */
9704
+ 200: CartResponse;
9705
+ };
9706
+ type UpdateCartPaymentIntentResponse = UpdateCartPaymentIntentResponses[keyof UpdateCartPaymentIntentResponses];
9193
9707
  type CheckoutApiData = {
9194
9708
  body?: CustomerCheckout | AccountCheckout;
9195
9709
  headers?: {
@@ -9209,18 +9723,20 @@ type CheckoutApiData = {
9209
9723
  };
9210
9724
  type CheckoutApiErrors = {
9211
9725
  /**
9212
- * Unauthorized
9726
+ * Bad Request
9213
9727
  */
9214
- 401: ResponseError;
9728
+ 400: ResponseErrorResponse;
9729
+ /**
9730
+ * Internal Server Error
9731
+ */
9732
+ 500: ResponseErrorResponse;
9215
9733
  };
9216
9734
  type CheckoutApiError = CheckoutApiErrors[keyof CheckoutApiErrors];
9217
9735
  type CheckoutApiResponses = {
9218
9736
  /**
9219
9737
  * OK
9220
- */
9221
- 200: ResponseData & {
9222
- data?: OrderResponse;
9223
- };
9738
+ */
9739
+ 201: OrderEntityResponse;
9224
9740
  };
9225
9741
  type CheckoutApiResponse = CheckoutApiResponses[keyof CheckoutApiResponses];
9226
9742
  type GetCustomerOrdersData = {
@@ -9232,38 +9748,11 @@ type GetCustomerOrdersData = {
9232
9748
  "x-moltin-customer-token"?: string;
9233
9749
  };
9234
9750
  path?: never;
9235
- query?: {
9236
- /**
9237
- * The number of records to offset the results by.
9238
- */
9239
- "page[offset]"?: BigInt;
9240
- /**
9241
- * The number of records per page. The maximum limit is 100.
9242
- */
9243
- "page[limit]"?: BigInt;
9244
- /**
9245
- * A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
9246
- */
9247
- include?: string;
9248
- };
9751
+ query?: never;
9249
9752
  url: "/v2/orders";
9250
9753
  };
9251
- type GetCustomerOrdersErrors = {
9252
- /**
9253
- * Unauthorized
9254
- */
9255
- 401: ResponseError;
9256
- };
9257
- type GetCustomerOrdersError = GetCustomerOrdersErrors[keyof GetCustomerOrdersErrors];
9258
9754
  type GetCustomerOrdersResponses = {
9259
- 200: ResponseData & {
9260
- data?: Array<OrderResponse>;
9261
- links?: ResponsePageLinks;
9262
- meta?: ResponseMetaOrders;
9263
- included?: {
9264
- items?: Array<OrderItemResponse>;
9265
- };
9266
- };
9755
+ 200: OrderCollectionResponse;
9267
9756
  };
9268
9757
  type GetCustomerOrdersResponse = GetCustomerOrdersResponses[keyof GetCustomerOrdersResponses];
9269
9758
  type GetAnOrderData = {
@@ -9274,39 +9763,21 @@ type GetAnOrderData = {
9274
9763
  */
9275
9764
  orderID: string;
9276
9765
  };
9277
- query?: {
9278
- /**
9279
- * The number of records to offset the results by.
9280
- */
9281
- "page[offset]"?: BigInt;
9282
- /**
9283
- * The number of records per page. The maximum limit is 100.
9284
- */
9285
- "page[limit]"?: BigInt;
9286
- /**
9287
- * A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
9288
- */
9289
- include?: string;
9290
- };
9766
+ query?: never;
9291
9767
  url: "/v2/orders/{orderID}";
9292
9768
  };
9293
9769
  type GetAnOrderErrors = {
9294
9770
  /**
9295
- * Unauthorized
9771
+ * Not Found
9296
9772
  */
9297
- 401: ResponseError;
9773
+ 404: ResponseErrorResponse;
9298
9774
  };
9299
9775
  type GetAnOrderError = GetAnOrderErrors[keyof GetAnOrderErrors];
9300
9776
  type GetAnOrderResponses = {
9301
9777
  /**
9302
9778
  * OK
9303
9779
  */
9304
- 200: ResponseData & {
9305
- data?: OrderResponse;
9306
- included?: {
9307
- items?: Array<OrderItemResponse>;
9308
- };
9309
- };
9780
+ 200: OrderEntityResponse;
9310
9781
  };
9311
9782
  type GetAnOrderResponse = GetAnOrderResponses[keyof GetAnOrderResponses];
9312
9783
  type UpdateAnOrderData = {
@@ -9322,18 +9793,20 @@ type UpdateAnOrderData = {
9322
9793
  };
9323
9794
  type UpdateAnOrderErrors = {
9324
9795
  /**
9325
- * Unauthorized
9796
+ * Bad Request
9326
9797
  */
9327
- 401: ResponseError;
9798
+ 400: ResponseErrorResponse;
9799
+ /**
9800
+ * Unprocessable Entity
9801
+ */
9802
+ 422: ResponseErrorResponse;
9328
9803
  };
9329
9804
  type UpdateAnOrderError = UpdateAnOrderErrors[keyof UpdateAnOrderErrors];
9330
9805
  type UpdateAnOrderResponses = {
9331
9806
  /**
9332
9807
  * OK
9333
9808
  */
9334
- 200: ResponseData & {
9335
- data?: OrderResponse;
9336
- };
9809
+ 200: OrderEntityResponse;
9337
9810
  };
9338
9811
  type UpdateAnOrderResponse = UpdateAnOrderResponses[keyof UpdateAnOrderResponses];
9339
9812
  type GetOrderItemsData = {
@@ -9347,17 +9820,8 @@ type GetOrderItemsData = {
9347
9820
  query?: never;
9348
9821
  url: "/v2/orders/{orderID}/items";
9349
9822
  };
9350
- type GetOrderItemsErrors = {
9351
- /**
9352
- * Unauthorized
9353
- */
9354
- 401: ResponseError;
9355
- };
9356
- type GetOrderItemsError = GetOrderItemsErrors[keyof GetOrderItemsErrors];
9357
9823
  type GetOrderItemsResponses = {
9358
- 200: ResponseData & {
9359
- data?: Array<OrderItemResponse>;
9360
- };
9824
+ 200: OrderItemCollectionResponse;
9361
9825
  };
9362
9826
  type GetOrderItemsResponse = GetOrderItemsResponses[keyof GetOrderItemsResponses];
9363
9827
  type AnonymizeOrdersData = {
@@ -9368,24 +9832,51 @@ type AnonymizeOrdersData = {
9368
9832
  };
9369
9833
  type AnonymizeOrdersErrors = {
9370
9834
  /**
9371
- * Unauthorized
9372
- */
9373
- 401: ResponseError;
9374
- /**
9375
- * Not Found
9835
+ * Unprocessable Entity
9376
9836
  */
9377
- 422: ResponseError;
9837
+ 422: ResponseErrorResponse;
9378
9838
  };
9379
9839
  type AnonymizeOrdersError = AnonymizeOrdersErrors[keyof AnonymizeOrdersErrors];
9380
9840
  type AnonymizeOrdersResponses = {
9381
9841
  /**
9382
9842
  * OK
9383
9843
  */
9384
- 200: ResponseData & {
9385
- data?: OrderResponse;
9386
- };
9844
+ 200: OrdersListResponse;
9387
9845
  };
9388
9846
  type AnonymizeOrdersResponse = AnonymizeOrdersResponses[keyof AnonymizeOrdersResponses];
9847
+ type ConfirmOrderData = {
9848
+ body?: never;
9849
+ path: {
9850
+ /**
9851
+ * The unique identifier of the order to confirm.
9852
+ */
9853
+ orderID: string;
9854
+ };
9855
+ query?: never;
9856
+ url: "/v2/orders/{orderID}/confirm";
9857
+ };
9858
+ type ConfirmOrderErrors = {
9859
+ /**
9860
+ * Bad Request
9861
+ */
9862
+ 400: ResponseErrorResponse;
9863
+ /**
9864
+ * Not Found
9865
+ */
9866
+ 404: ResponseErrorResponse;
9867
+ /**
9868
+ * Unprocessable Entity
9869
+ */
9870
+ 422: ResponseErrorResponse;
9871
+ };
9872
+ type ConfirmOrderError = ConfirmOrderErrors[keyof ConfirmOrderErrors];
9873
+ type ConfirmOrderResponses = {
9874
+ /**
9875
+ * Order confirmed successfully
9876
+ */
9877
+ 200: OrderResponse;
9878
+ };
9879
+ type ConfirmOrderResponse = ConfirmOrderResponses[keyof ConfirmOrderResponses];
9389
9880
  type PaymentSetupData = {
9390
9881
  body?: PaymentsRequest;
9391
9882
  path: {
@@ -9399,18 +9890,24 @@ type PaymentSetupData = {
9399
9890
  };
9400
9891
  type PaymentSetupErrors = {
9401
9892
  /**
9402
- * Unauthorized
9893
+ * Bad Request
9403
9894
  */
9404
- 401: ResponseError;
9895
+ 400: ResponseErrorResponse;
9896
+ /**
9897
+ * Conflict
9898
+ */
9899
+ 409: ResponseErrorResponse;
9900
+ /**
9901
+ * Unprocessable Entity
9902
+ */
9903
+ 422: ResponseErrorResponse;
9405
9904
  };
9406
9905
  type PaymentSetupError = PaymentSetupErrors[keyof PaymentSetupErrors];
9407
9906
  type PaymentSetupResponses = {
9408
9907
  /**
9409
9908
  * OK
9410
9909
  */
9411
- 200: ResponseData & {
9412
- data?: TransactionResponse;
9413
- };
9910
+ 200: TransactionEntityResponse;
9414
9911
  };
9415
9912
  type PaymentSetupResponse = PaymentSetupResponses[keyof PaymentSetupResponses];
9416
9913
  type ConfirmPaymentData = {
@@ -9430,15 +9927,13 @@ type ConfirmPaymentData = {
9430
9927
  };
9431
9928
  type ConfirmPaymentErrors = {
9432
9929
  /**
9433
- * Unauthorized
9930
+ * Bad Request
9434
9931
  */
9435
- 401: ResponseError;
9932
+ 400: ResponseErrorResponse;
9436
9933
  };
9437
9934
  type ConfirmPaymentError = ConfirmPaymentErrors[keyof ConfirmPaymentErrors];
9438
9935
  type ConfirmPaymentResponses = {
9439
- 200: ResponseData & {
9440
- data?: TransactionResponse;
9441
- };
9936
+ 200: TransactionEntityResponse;
9442
9937
  };
9443
9938
  type ConfirmPaymentResponse = ConfirmPaymentResponses[keyof ConfirmPaymentResponses];
9444
9939
  type CaptureATransactionData = {
@@ -9458,15 +9953,13 @@ type CaptureATransactionData = {
9458
9953
  };
9459
9954
  type CaptureATransactionErrors = {
9460
9955
  /**
9461
- * Unauthorized
9956
+ * Bad Request
9462
9957
  */
9463
- 401: ResponseError;
9958
+ 400: ResponseErrorResponse;
9464
9959
  };
9465
9960
  type CaptureATransactionError = CaptureATransactionErrors[keyof CaptureATransactionErrors];
9466
9961
  type CaptureATransactionResponses = {
9467
- 200: ResponseData & {
9468
- data?: TransactionResponse;
9469
- };
9962
+ 200: TransactionEntityResponse;
9470
9963
  };
9471
9964
  type CaptureATransactionResponse = CaptureATransactionResponses[keyof CaptureATransactionResponses];
9472
9965
  type RefundATransactionData = {
@@ -9486,15 +9979,17 @@ type RefundATransactionData = {
9486
9979
  };
9487
9980
  type RefundATransactionErrors = {
9488
9981
  /**
9489
- * Unauthorized
9982
+ * Bad Request
9490
9983
  */
9491
- 401: ResponseError;
9984
+ 400: ResponseErrorResponse;
9985
+ /**
9986
+ * Unprocessable Entity
9987
+ */
9988
+ 422: ResponseErrorResponse;
9492
9989
  };
9493
9990
  type RefundATransactionError = RefundATransactionErrors[keyof RefundATransactionErrors];
9494
9991
  type RefundATransactionResponses = {
9495
- 200: ResponseData & {
9496
- data?: TransactionResponse;
9497
- };
9992
+ 200: TransactionEntityResponse;
9498
9993
  };
9499
9994
  type RefundATransactionResponse = RefundATransactionResponses[keyof RefundATransactionResponses];
9500
9995
  type GetOrderTransactionsData = {
@@ -9510,15 +10005,13 @@ type GetOrderTransactionsData = {
9510
10005
  };
9511
10006
  type GetOrderTransactionsErrors = {
9512
10007
  /**
9513
- * Unauthorized
10008
+ * Bad Request
9514
10009
  */
9515
- 401: ResponseError;
10010
+ 400: ResponseErrorResponse;
9516
10011
  };
9517
10012
  type GetOrderTransactionsError = GetOrderTransactionsErrors[keyof GetOrderTransactionsErrors];
9518
10013
  type GetOrderTransactionsResponses = {
9519
- 200: ResponseData & {
9520
- data?: Array<TransactionResponse>;
9521
- };
10014
+ 200: TransactionListResponse;
9522
10015
  };
9523
10016
  type GetOrderTransactionsResponse = GetOrderTransactionsResponses[keyof GetOrderTransactionsResponses];
9524
10017
  type GetATransactionData = {
@@ -9536,13 +10029,6 @@ type GetATransactionData = {
9536
10029
  query?: never;
9537
10030
  url: "/v2/orders/{orderID}/transactions/{transactionID}";
9538
10031
  };
9539
- type GetATransactionErrors = {
9540
- /**
9541
- * Unauthorized
9542
- */
9543
- 401: ResponseError;
9544
- };
9545
- type GetATransactionError = GetATransactionErrors[keyof GetATransactionErrors];
9546
10032
  type GetATransactionResponses = {
9547
10033
  200: ResponseData & {
9548
10034
  data?: TransactionResponse;
@@ -9566,87 +10052,174 @@ type CancelATransactionData = {
9566
10052
  };
9567
10053
  type CancelATransactionErrors = {
9568
10054
  /**
9569
- * Unauthorized
10055
+ * Bad Request
9570
10056
  */
9571
- 401: ResponseError;
10057
+ 400: ResponseErrorResponse;
9572
10058
  };
9573
10059
  type CancelATransactionError = CancelATransactionErrors[keyof CancelATransactionErrors];
9574
10060
  type CancelATransactionResponses = {
9575
- 200: ResponseData & {
9576
- data?: TransactionResponse;
9577
- };
10061
+ 200: TransactionEntityResponse;
9578
10062
  };
9579
10063
  type CancelATransactionResponse = CancelATransactionResponses[keyof CancelATransactionResponses];
9580
- type GetSubscriptionProductData = {
10064
+ type GetOrderShippingGroupsData = {
9581
10065
  body?: never;
9582
10066
  path: {
9583
10067
  /**
9584
- * The unique identifier of a product.
10068
+ * The ID of the order
9585
10069
  */
9586
- product_uuid: SubscriptionsUuid;
10070
+ orderID: string;
9587
10071
  };
9588
10072
  query?: never;
9589
- url: "/v2/subscriptions/products/{product_uuid}";
10073
+ url: "/v2/orders/{orderID}/shipping-groups";
9590
10074
  };
9591
- type GetSubscriptionProductErrors = {
10075
+ type GetOrderShippingGroupsErrors = {
9592
10076
  /**
9593
- * Bad request. The request failed validation.
10077
+ * Order not found
9594
10078
  */
9595
- 400: SubscriptionsErrorResponse;
10079
+ 404: ResponseErrorResponse;
10080
+ };
10081
+ type GetOrderShippingGroupsError = GetOrderShippingGroupsErrors[keyof GetOrderShippingGroupsErrors];
10082
+ type GetOrderShippingGroupsResponses = {
9596
10083
  /**
9597
- * Not found. The requested entity does not exist.
10084
+ * A list of shipping groups
9598
10085
  */
9599
- 404: SubscriptionsErrorResponse;
10086
+ 200: {
10087
+ data?: Array<ShippingGroupResponse>;
10088
+ };
10089
+ };
10090
+ type GetOrderShippingGroupsResponse = GetOrderShippingGroupsResponses[keyof GetOrderShippingGroupsResponses];
10091
+ type CreateOrderShippingGroupData = {
9600
10092
  /**
9601
- * Internal server error. There was a system failure in the platform.
10093
+ * Shipping group details
9602
10094
  */
9603
- 500: SubscriptionsErrorResponse;
10095
+ body?: {
10096
+ data?: {
10097
+ type: "shipping_group";
10098
+ /**
10099
+ * The shipping type for this group
10100
+ */
10101
+ shipping_type?: string;
10102
+ /**
10103
+ * Tracking reference for the shipment
10104
+ */
10105
+ tracking_reference?: string;
10106
+ address?: {
10107
+ first_name?: string;
10108
+ last_name?: string;
10109
+ phone_number?: string;
10110
+ company_name?: string;
10111
+ line_1?: string;
10112
+ line_2?: string;
10113
+ city?: string;
10114
+ postcode?: string;
10115
+ county?: string;
10116
+ country?: string;
10117
+ region?: string;
10118
+ instructions?: string;
10119
+ };
10120
+ delivery_estimate?: {
10121
+ start?: Date;
10122
+ end?: Date;
10123
+ };
10124
+ };
10125
+ };
10126
+ path: {
10127
+ /**
10128
+ * The ID of the order
10129
+ */
10130
+ orderID: string;
10131
+ };
10132
+ query?: never;
10133
+ url: "/v2/orders/{orderID}/shipping-groups";
9604
10134
  };
9605
- type GetSubscriptionProductError = GetSubscriptionProductErrors[keyof GetSubscriptionProductErrors];
9606
- type GetSubscriptionProductResponses = {
10135
+ type CreateOrderShippingGroupErrors = {
9607
10136
  /**
9608
- * Success. The product details are returned.
10137
+ * Bad Request
9609
10138
  */
9610
- 200: {
9611
- data?: Product2;
10139
+ 400: ResponseErrorResponse;
10140
+ /**
10141
+ * Order not found
10142
+ */
10143
+ 404: ResponseErrorResponse;
10144
+ /**
10145
+ * Unprocessable Entity
10146
+ */
10147
+ 422: ResponseErrorResponse;
10148
+ };
10149
+ type CreateOrderShippingGroupError = CreateOrderShippingGroupErrors[keyof CreateOrderShippingGroupErrors];
10150
+ type CreateOrderShippingGroupResponses = {
10151
+ /**
10152
+ * Shipping group created
10153
+ */
10154
+ 201: {
10155
+ data?: ShippingGroupResponse;
9612
10156
  };
9613
10157
  };
9614
- type GetSubscriptionProductResponse = GetSubscriptionProductResponses[keyof GetSubscriptionProductResponses];
9615
- type GetPlanData = {
10158
+ type CreateOrderShippingGroupResponse = CreateOrderShippingGroupResponses[keyof CreateOrderShippingGroupResponses];
10159
+ type GetShippingGroupsByIdData = {
9616
10160
  body?: never;
9617
10161
  path: {
9618
10162
  /**
9619
- * The unique identifier of the plan.
10163
+ * The ID of the order
9620
10164
  */
9621
- plan_uuid: SubscriptionsUuid;
10165
+ orderID: string;
10166
+ /**
10167
+ * The ID of the shipping group
10168
+ */
10169
+ shippingGroupID: string;
9622
10170
  };
9623
10171
  query?: never;
9624
- url: "/v2/subscriptions/plans/{plan_uuid}";
10172
+ url: "/v2/orders/{orderID}/shipping-groups/{shippingGroupID}";
9625
10173
  };
9626
- type GetPlanErrors = {
10174
+ type GetShippingGroupsByIdErrors = {
9627
10175
  /**
9628
- * Bad request. The request failed validation.
10176
+ * Shipping group or order not found
9629
10177
  */
9630
- 400: SubscriptionsErrorResponse;
10178
+ 404: ResponseErrorResponse;
10179
+ };
10180
+ type GetShippingGroupsByIdError = GetShippingGroupsByIdErrors[keyof GetShippingGroupsByIdErrors];
10181
+ type GetShippingGroupsByIdResponses = {
9631
10182
  /**
9632
- * Not found. The requested entity does not exist.
10183
+ * Shipping group details
9633
10184
  */
9634
- 404: SubscriptionsErrorResponse;
10185
+ 200: {
10186
+ data?: ShippingGroupResponse;
10187
+ };
10188
+ };
10189
+ type GetShippingGroupsByIdResponse = GetShippingGroupsByIdResponses[keyof GetShippingGroupsByIdResponses];
10190
+ type PutShippingGroupByIdData = {
10191
+ body: UpdateOrderShippingGroupRequest;
10192
+ path: {
10193
+ /**
10194
+ * The ID of the order
10195
+ */
10196
+ orderID: string;
10197
+ /**
10198
+ * The ID of the shipping group
10199
+ */
10200
+ shippingGroupID: string;
10201
+ };
10202
+ query?: never;
10203
+ url: "/v2/orders/{orderID}/shipping-groups/{shippingGroupID}";
10204
+ };
10205
+ type PutShippingGroupByIdErrors = {
9635
10206
  /**
9636
- * Internal server error. There was a system failure in the platform.
10207
+ * Invalid request
9637
10208
  */
9638
- 500: SubscriptionsErrorResponse;
10209
+ 400: ResponseErrorResponse;
10210
+ /**
10211
+ * Shipping group or order not found
10212
+ */
10213
+ 404: ResponseErrorResponse;
9639
10214
  };
9640
- type GetPlanError = GetPlanErrors[keyof GetPlanErrors];
9641
- type GetPlanResponses = {
10215
+ type PutShippingGroupByIdError = PutShippingGroupByIdErrors[keyof PutShippingGroupByIdErrors];
10216
+ type PutShippingGroupByIdResponses = {
9642
10217
  /**
9643
- * Success. The details of the plan are returned.
10218
+ * Shipping group updated successfully
9644
10219
  */
9645
- 200: {
9646
- data?: Plan;
9647
- };
10220
+ 200: ShippingGroupResponse;
9648
10221
  };
9649
- type GetPlanResponse = GetPlanResponses[keyof GetPlanResponses];
10222
+ type PutShippingGroupByIdResponse = PutShippingGroupByIdResponses[keyof PutShippingGroupByIdResponses];
9650
10223
  type ListOfferingsData = {
9651
10224
  body?: never;
9652
10225
  path?: never;
@@ -9667,7 +10240,7 @@ type ListOfferingsData = {
9667
10240
  /**
9668
10241
  * A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
9669
10242
  */
9670
- include?: string;
10243
+ include?: Array<"plans" | "pricing_options" | "features">;
9671
10244
  };
9672
10245
  url: "/v2/subscriptions/offerings";
9673
10246
  };
@@ -9705,7 +10278,7 @@ type GetOfferingData = {
9705
10278
  /**
9706
10279
  * A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
9707
10280
  */
9708
- include?: string;
10281
+ include?: Array<"plans" | "pricing_options" | "features">;
9709
10282
  };
9710
10283
  url: "/v2/subscriptions/offerings/{offering_uuid}";
9711
10284
  };
@@ -9734,7 +10307,7 @@ type GetOfferingResponses = {
9734
10307
  };
9735
10308
  };
9736
10309
  type GetOfferingResponse = GetOfferingResponses[keyof GetOfferingResponses];
9737
- type ListOfferingPlansData = {
10310
+ type ListOfferingPricingOptionsData = {
9738
10311
  body?: never;
9739
10312
  path: {
9740
10313
  /**
@@ -9752,9 +10325,9 @@ type ListOfferingPlansData = {
9752
10325
  */
9753
10326
  "page[limit]"?: BigInt;
9754
10327
  };
9755
- url: "/v2/subscriptions/offerings/{offering_uuid}/plans";
10328
+ url: "/v2/subscriptions/offerings/{offering_uuid}/pricing-options";
9756
10329
  };
9757
- type ListOfferingPlansErrors = {
10330
+ type ListOfferingPricingOptionsErrors = {
9758
10331
  /**
9759
10332
  * Not found. The requested entity does not exist.
9760
10333
  */
@@ -9764,17 +10337,17 @@ type ListOfferingPlansErrors = {
9764
10337
  */
9765
10338
  500: SubscriptionsErrorResponse;
9766
10339
  };
9767
- type ListOfferingPlansError = ListOfferingPlansErrors[keyof ListOfferingPlansErrors];
9768
- type ListOfferingPlansResponses = {
10340
+ type ListOfferingPricingOptionsError = ListOfferingPricingOptionsErrors[keyof ListOfferingPricingOptionsErrors];
10341
+ type ListOfferingPricingOptionsResponses = {
9769
10342
  /**
9770
- * Success. A list of plans attached with the offering is returned.
10343
+ * Success. A list of pricing options attached with the offering is returned.
9771
10344
  */
9772
10345
  200: {
9773
- data?: Array<OfferingPlan>;
10346
+ data?: Array<OfferingPricingOption>;
9774
10347
  links?: Links2;
9775
10348
  };
9776
10349
  };
9777
- type ListOfferingPlansResponse = ListOfferingPlansResponses[keyof ListOfferingPlansResponses];
10350
+ type ListOfferingPricingOptionsResponse = ListOfferingPricingOptionsResponses[keyof ListOfferingPricingOptionsResponses];
9778
10351
  type ListOfferingFeaturesData = {
9779
10352
  body?: never;
9780
10353
  path: {
@@ -9816,7 +10389,7 @@ type ListOfferingFeaturesResponses = {
9816
10389
  };
9817
10390
  };
9818
10391
  type ListOfferingFeaturesResponse = ListOfferingFeaturesResponses[keyof ListOfferingFeaturesResponses];
9819
- type ListOfferingProductsData = {
10392
+ type ListOfferingPlansData = {
9820
10393
  body?: never;
9821
10394
  path: {
9822
10395
  /**
@@ -9834,9 +10407,9 @@ type ListOfferingProductsData = {
9834
10407
  */
9835
10408
  "page[limit]"?: BigInt;
9836
10409
  };
9837
- url: "/v2/subscriptions/offerings/{offering_uuid}/products";
10410
+ url: "/v2/subscriptions/offerings/{offering_uuid}/plans";
9838
10411
  };
9839
- type ListOfferingProductsErrors = {
10412
+ type ListOfferingPlansErrors = {
9840
10413
  /**
9841
10414
  * Not found. The requested entity does not exist.
9842
10415
  */
@@ -9846,17 +10419,52 @@ type ListOfferingProductsErrors = {
9846
10419
  */
9847
10420
  500: SubscriptionsErrorResponse;
9848
10421
  };
9849
- type ListOfferingProductsError = ListOfferingProductsErrors[keyof ListOfferingProductsErrors];
9850
- type ListOfferingProductsResponses = {
10422
+ type ListOfferingPlansError = ListOfferingPlansErrors[keyof ListOfferingPlansErrors];
10423
+ type ListOfferingPlansResponses = {
9851
10424
  /**
9852
- * Success. A list of subscription products attached to the offering is returned.
10425
+ * Success. A list of subscription plans attached to the offering is returned.
9853
10426
  */
9854
10427
  200: {
9855
- data?: Array<OfferingProduct>;
10428
+ data?: Array<OfferingPlan>;
9856
10429
  links?: Links2;
9857
10430
  };
9858
10431
  };
9859
- type ListOfferingProductsResponse = ListOfferingProductsResponses[keyof ListOfferingProductsResponses];
10432
+ type ListOfferingPlansResponse = ListOfferingPlansResponses[keyof ListOfferingPlansResponses];
10433
+ type ListOfferingPlanPricingOptionsData = {
10434
+ body?: never;
10435
+ path: {
10436
+ /**
10437
+ * The unique identifier of the offering.
10438
+ */
10439
+ offering_uuid: SubscriptionsUuid;
10440
+ /**
10441
+ * The unique identifier of the plan.
10442
+ */
10443
+ plan_uuid: SubscriptionsUuid;
10444
+ };
10445
+ query?: never;
10446
+ url: "/v2/subscriptions/offerings/{offering_uuid}/plans/{plan_uuid}/relationships/pricing_options";
10447
+ };
10448
+ type ListOfferingPlanPricingOptionsErrors = {
10449
+ /**
10450
+ * Not found. The requested entity does not exist.
10451
+ */
10452
+ 404: SubscriptionsErrorResponse;
10453
+ /**
10454
+ * Internal server error. There was a system failure in the platform.
10455
+ */
10456
+ 500: SubscriptionsErrorResponse;
10457
+ };
10458
+ type ListOfferingPlanPricingOptionsError = ListOfferingPlanPricingOptionsErrors[keyof ListOfferingPlanPricingOptionsErrors];
10459
+ type ListOfferingPlanPricingOptionsResponses = {
10460
+ /**
10461
+ * Success. The pricing option relationships are returned
10462
+ */
10463
+ 200: {
10464
+ data?: Array<RelationshipData>;
10465
+ };
10466
+ };
10467
+ type ListOfferingPlanPricingOptionsResponse = ListOfferingPlanPricingOptionsResponses[keyof ListOfferingPlanPricingOptionsResponses];
9860
10468
  type ListSubscriptionsData = {
9861
10469
  body?: never;
9862
10470
  path?: never;
@@ -9877,7 +10485,7 @@ type ListSubscriptionsData = {
9877
10485
  /**
9878
10486
  * A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
9879
10487
  */
9880
- include?: string;
10488
+ include?: Array<"plans" | "pricing_options">;
9881
10489
  };
9882
10490
  url: "/v2/subscriptions/subscriptions";
9883
10491
  };
@@ -9915,7 +10523,7 @@ type GetSubscriptionData = {
9915
10523
  /**
9916
10524
  * A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
9917
10525
  */
9918
- include?: string;
10526
+ include?: Array<"plans" | "pricing_options">;
9919
10527
  };
9920
10528
  url: "/v2/subscriptions/subscriptions/{subscription_uuid}";
9921
10529
  };
@@ -9944,7 +10552,7 @@ type GetSubscriptionResponses = {
9944
10552
  };
9945
10553
  };
9946
10554
  type GetSubscriptionResponse = GetSubscriptionResponses[keyof GetSubscriptionResponses];
9947
- type ListSubscriptionProductsData = {
10555
+ type ListSubscriptionPlansData = {
9948
10556
  body?: never;
9949
10557
  path: {
9950
10558
  /**
@@ -9953,9 +10561,9 @@ type ListSubscriptionProductsData = {
9953
10561
  subscription_uuid: SubscriptionsUuid;
9954
10562
  };
9955
10563
  query?: never;
9956
- url: "/v2/subscriptions/subscriptions/{subscription_uuid}/products";
10564
+ url: "/v2/subscriptions/subscriptions/{subscription_uuid}/plans";
9957
10565
  };
9958
- type ListSubscriptionProductsErrors = {
10566
+ type ListSubscriptionPlansErrors = {
9959
10567
  /**
9960
10568
  * Bad request. The request failed validation.
9961
10569
  */
@@ -9969,17 +10577,17 @@ type ListSubscriptionProductsErrors = {
9969
10577
  */
9970
10578
  500: SubscriptionsErrorResponse;
9971
10579
  };
9972
- type ListSubscriptionProductsError = ListSubscriptionProductsErrors[keyof ListSubscriptionProductsErrors];
9973
- type ListSubscriptionProductsResponses = {
10580
+ type ListSubscriptionPlansError = ListSubscriptionPlansErrors[keyof ListSubscriptionPlansErrors];
10581
+ type ListSubscriptionPlansResponses = {
9974
10582
  /**
9975
- * Success. A list of subscription products is returned.
10583
+ * Success. A list of subscription plans is returned.
9976
10584
  */
9977
10585
  200: {
9978
- data?: Array<OfferingProduct>;
10586
+ data?: Array<OfferingPlan>;
9979
10587
  };
9980
10588
  };
9981
- type ListSubscriptionProductsResponse = ListSubscriptionProductsResponses[keyof ListSubscriptionProductsResponses];
9982
- type ListSubscriptionPlansData = {
10589
+ type ListSubscriptionPlansResponse = ListSubscriptionPlansResponses[keyof ListSubscriptionPlansResponses];
10590
+ type ListSubscriptionPricingOptionsData = {
9983
10591
  body?: never;
9984
10592
  path: {
9985
10593
  /**
@@ -9988,9 +10596,9 @@ type ListSubscriptionPlansData = {
9988
10596
  subscription_uuid: SubscriptionsUuid;
9989
10597
  };
9990
10598
  query?: never;
9991
- url: "/v2/subscriptions/subscriptions/{subscription_uuid}/plans";
10599
+ url: "/v2/subscriptions/subscriptions/{subscription_uuid}/pricing-options";
9992
10600
  };
9993
- type ListSubscriptionPlansErrors = {
10601
+ type ListSubscriptionPricingOptionsErrors = {
9994
10602
  /**
9995
10603
  * Bad request. The request failed validation.
9996
10604
  */
@@ -10004,16 +10612,16 @@ type ListSubscriptionPlansErrors = {
10004
10612
  */
10005
10613
  500: SubscriptionsErrorResponse;
10006
10614
  };
10007
- type ListSubscriptionPlansError = ListSubscriptionPlansErrors[keyof ListSubscriptionPlansErrors];
10008
- type ListSubscriptionPlansResponses = {
10615
+ type ListSubscriptionPricingOptionsError = ListSubscriptionPricingOptionsErrors[keyof ListSubscriptionPricingOptionsErrors];
10616
+ type ListSubscriptionPricingOptionsResponses = {
10009
10617
  /**
10010
- * Success. A list of subscription plans is returned.
10618
+ * Success. A list of subscription pricing options is returned.
10011
10619
  */
10012
10620
  200: {
10013
- data?: Array<OfferingPlan>;
10621
+ data?: Array<OfferingPricingOption>;
10014
10622
  };
10015
10623
  };
10016
- type ListSubscriptionPlansResponse = ListSubscriptionPlansResponses[keyof ListSubscriptionPlansResponses];
10624
+ type ListSubscriptionPricingOptionsResponse = ListSubscriptionPricingOptionsResponses[keyof ListSubscriptionPricingOptionsResponses];
10017
10625
  type ListSubscriptionStatesData = {
10018
10626
  body?: never;
10019
10627
  path: {
@@ -11215,4 +11823,4 @@ type GetAFileResponses = {
11215
11823
  };
11216
11824
  type GetAFileResponse = GetAFileResponses[keyof GetAFileResponses];
11217
11825
 
11218
- export type { AcceptLanguage, AccessTokenRequest, AccessTokenResponse, Account, AccountAddressResponse, AccountAddressesError, AccountAddressesErrorResponse, AccountAddressesMetaTimestamps, AccountAuthenticationSettings, AccountAuthenticationSettingsResponse, AccountCheckout, AccountManagementAuthenticationToken, AccountManagementAuthenticationTokenResponse, AccountManagementError, AccountManagementErrorResponse, AccountManagementMetaTimestamps, AccountMember, AccountMemberResponse, AccountMemberSelfManagement, AccountMembership, AccountMembershipResponse, AccountMembershipResponseUsingAccountMemberId, AccountMembershipSettings, AccountResponse, Action, ActivePlan, AddAllOrNothingOptionsObject, AddCustomDiscountToCartItemData, AddCustomDiscountToCartItemError, AddCustomDiscountToCartItemErrors, AddCustomDiscountToCartItemResponse, AddCustomDiscountToCartItemResponses, AddTaxItemToCartData, AddTaxItemToCartError, AddTaxItemToCartErrors, AddTaxItemToCartResponse, AddTaxItemToCartResponses, Address, AddressResponse, Amount, AnonymizeOrdersData, AnonymizeOrdersError, AnonymizeOrdersErrors, AnonymizeOrdersResponse, AnonymizeOrdersResponses, AuthenticationRealm, AuthenticationRealmListResponse, AuthenticationRealmResponse, AuthenticationRealmUpdateRequest, BillingAddress, BillingIntervalType, BillingRunReport, BuildOffering, BuildSubscription, BulkAddCustomDiscountsToCartData, BulkAddCustomDiscountsToCartError, BulkAddCustomDiscountsToCartErrors, BulkAddCustomDiscountsToCartResponse, BulkAddCustomDiscountsToCartResponses, BulkAddItemsRequest, BulkAddTaxItemsToCartData, BulkAddTaxItemsToCartError, BulkAddTaxItemsToCartErrors, BulkAddTaxItemsToCartResponse, BulkAddTaxItemsToCartResponses, BulkDeleteCustomDiscountsFromCartData, BulkDeleteCustomDiscountsFromCartError, BulkDeleteCustomDiscountsFromCartErrors, BulkDeleteCustomDiscountsFromCartResponse, BulkDeleteCustomDiscountsFromCartResponses, BulkDeleteTaxItemsFromCartData, BulkDeleteTaxItemsFromCartError, BulkDeleteTaxItemsFromCartErrors, BulkDeleteTaxItemsFromCartResponse, BulkDeleteTaxItemsFromCartResponses, BulkUpdateCartsItems, BulkUpdateItemsInCartData, BulkUpdateItemsInCartError, BulkUpdateItemsInCartErrors, BulkUpdateItemsInCartResponses, BundleConfiguration, BundleConfigurationData, BundleConfigurationData2, CancelATransactionData, CancelATransactionError, CancelATransactionErrors, CancelATransactionResponse, CancelATransactionResponses, CaptureATransactionData, CaptureATransactionError, CaptureATransactionErrors, CaptureATransactionResponse, CaptureATransactionResponses, CartCheckoutTimestamps, CartContact, CartInclude, CartInclude2, CartItemBulkCustomDiscountObject, CartItemBulkCustomDiscountResponse, CartItemObject, CartItemObjectData, CartItemRelationship, CartItemResponse, CartItemResponseObject, CartItemsObjectRequest, CartItemsObjectResponse, CartMergeObject, CartMergeObjectRequest, CartResponse, CartTimestamps, CartsBulkCustomDiscounts, CartsBulkCustomDiscountsResponse, CartsBulkTaxes, CartsCustomDiscountsObject, CartsCustomDiscountsResponse, CartsItemsTaxesObject, CartsRelationshipsAccountsData, CartsRelationshipsCustomersData, CartsRequest, CartsResponse, Catalog, CatalogCreateData, CatalogData, CatalogListData, CatalogReleaseCreateData, CatalogUpdateData, ChangeState, Channel, CheckoutApiData, CheckoutApiError, CheckoutApiErrors, CheckoutApiResponse, CheckoutApiResponses, ComponentProduct, ComponentProductOption, ComponentProductsRelationship, Components, ConfigureByContextProductData, ConfigureByContextProductError, ConfigureByContextProductErrors, ConfigureByContextProductResponse, ConfigureByContextProductResponses, ConfirmPaymentData, ConfirmPaymentError, ConfirmPaymentErrors, ConfirmPaymentResponse, ConfirmPaymentResponses, Contact, CreateACartData, CreateACartError, CreateACartErrors, CreateACartResponse, CreateACartResponses, CreateAccountCartAssociationData, CreateAccountCartAssociationError, CreateAccountCartAssociationErrors, CreateAccountCartAssociationResponse, CreateAccountCartAssociationResponses, CreateAnAccessTokenData, CreateAnAccessTokenError, CreateAnAccessTokenErrors, CreateAnAccessTokenResponse, CreateAnAccessTokenResponses, CreateCartPaymentIntentData, CreateCartPaymentIntentError, CreateCartPaymentIntentErrors, CreateCartPaymentIntentResponse, CreateCartPaymentIntentResponses, CreateCatalogData, CreateCatalogError, CreateCatalogErrors, CreateCatalogResponse, CreateCatalogResponses, CreateCustomerCartAssociationData, CreateCustomerCartAssociationError, CreateCustomerCartAssociationErrors, CreateCustomerCartAssociationResponse, CreateCustomerCartAssociationResponses, CreateOneTimePasswordTokenRequestData, CreateOneTimePasswordTokenRequestResponses, CreateRuleData, CreateRuleError, CreateRuleErrors, CreateRuleResponse, CreateRuleResponses, Currencies, CurrencyIdentifier, CustomAttributes, CustomDiscountRelationshipsCartItemRequest, CustomInput, CustomInputValidationRule, CustomInputValidationRuleOptions, CustomInputs, CustomItemObject, CustomItemObjectData, CustomItemResponseObject, CustomRelationship, CustomRelationshipLinks, CustomerCheckout, DataAdyenPayment, DataAuthorizeNetPayment, DataBasePayments, DataBraintreePayment, DataCardConnectPayment, DataCreateCurrencies, DataCyberSourcePayment, DataManualPayment, DataPayPalExpressCheckoutPayment, DataPaymentObject, DataStripeConnectPayment, DataStripePayment, DataStripePaymentIntentsPayment, DataUpdateCurrencies, DeleteACartData, DeleteACartError, DeleteACartErrors, DeleteACartItemData, DeleteACartItemError, DeleteACartItemErrors, DeleteACartItemResponse, DeleteACartItemResponses, DeleteACartResponse, DeleteACartResponses, DeleteAPromotionViaPromotionCodeData, DeleteAPromotionViaPromotionCodeError, DeleteAPromotionViaPromotionCodeErrors, DeleteAPromotionViaPromotionCodeResponse, DeleteAPromotionViaPromotionCodeResponses, DeleteATaxItemData, DeleteATaxItemError, DeleteATaxItemErrors, DeleteATaxItemResponse, DeleteATaxItemResponses, DeleteAccountCartAssociationData, DeleteAccountCartAssociationError, DeleteAccountCartAssociationErrors, DeleteAccountCartAssociationResponse, DeleteAccountCartAssociationResponses, DeleteAllCartItemsData, DeleteAllCartItemsError, DeleteAllCartItemsErrors, DeleteAllCartItemsResponse, DeleteAllCartItemsResponses, DeleteCatalogByIdData, DeleteCatalogByIdError, DeleteCatalogByIdErrors, DeleteCatalogByIdResponse, DeleteCatalogByIdResponses, DeleteCustomDiscountFromCartData, DeleteCustomDiscountFromCartError, DeleteCustomDiscountFromCartErrors, DeleteCustomDiscountFromCartItemData, DeleteCustomDiscountFromCartItemError, DeleteCustomDiscountFromCartItemErrors, DeleteCustomDiscountFromCartItemResponse, DeleteCustomDiscountFromCartItemResponses, DeleteCustomDiscountFromCartResponse, DeleteCustomDiscountFromCartResponses, DeleteCustomerCartAssociationData, DeleteCustomerCartAssociationError, DeleteCustomerCartAssociationErrors, DeleteCustomerCartAssociationResponse, DeleteCustomerCartAssociationResponses, DeleteReleaseByIdData, DeleteReleaseByIdError, DeleteReleaseByIdErrors, DeleteReleaseByIdResponse, DeleteReleaseByIdResponses, DeleteReleasesData, DeleteReleasesError, DeleteReleasesErrors, DeleteReleasesResponse, DeleteReleasesResponses, DeleteRuleByIdData, DeleteRuleByIdError, DeleteRuleByIdErrors, DeleteRuleByIdResponse, DeleteRuleByIdResponses, DeleteV2AccountAddressData, DeleteV2AccountAddressError, DeleteV2AccountAddressErrors, DeleteV2AccountAddressResponse, DeleteV2AccountAddressResponses, DiffListData, DiscountData, DiscountSettings, DisplayPrice, DisplayPrice2, DunningRule, DunningRuleAttributes, DunningRuleCreate, DunningRuleMeta, DunningRuleUpdate, DunningRuleUpdateAttributes, ElasticPathFile, ElasticPathPaymentsPoweredByStripePayment, EndBehavior, Error2, ErrorBadRequest, ErrorNotFound, ErrorResponse, ErrorResponse2, Extension, Extensions, ExternalRef, ExternalRefUpdate, Feature, FeatureAccessAttributes, FeatureAttributes, FeatureConfigAccessAttributes, FeatureConfigPromotionAttributes, FeatureConfigUsageAttributes, FeatureConfiguration, FeatureCreate, FeatureMeta, FeatureProductConfiguration, FeatureProductConfigurationUpdate, FeaturePromotion, FeaturePromotionAttributes, FeatureResponseAttributes, FeatureTag, FeatureUpdate, FeatureUpdateAttributes, FeatureUsageAttributes, File, FileLink, FileMeta, FileReference, FilesError, FilesErrorResponse, FilesLinks, FilesRelationship, FilesUuid, Filesfilter, FilespageLimit, FilespageOffset, Filter, FilterCatalog, FilterHierarchy, FilterNode, FilterProduct, FilterRule, FormattedPrice, FormattedPriceData, Gateway, GeolocationDetails, GetACurrencyData, GetACurrencyError, GetACurrencyErrors, GetACurrencyResponse, GetACurrencyResponses, GetAFileData, GetAFileError, GetAFileErrors, GetAFileResponse, GetAFileResponses, GetATransactionData, GetATransactionError, GetATransactionErrors, GetATransactionResponse, GetATransactionResponses, GetAllCurrenciesData, GetAllCurrenciesError, GetAllCurrenciesErrors, GetAllCurrenciesResponse, GetAllCurrenciesResponses, GetAllFilesData, GetAllFilesError, GetAllFilesErrors, GetAllFilesResponse, GetAllFilesResponses, GetAllHierarchiesData, GetAllHierarchiesError, GetAllHierarchiesErrors, GetAllHierarchiesResponse, GetAllHierarchiesResponses, GetAllNodesData, GetAllNodesError, GetAllNodesErrors, GetAllNodesResponse, GetAllNodesResponses, GetAllProductsData, GetAllProductsError, GetAllProductsErrors, GetAllProductsResponse, GetAllProductsResponses, GetAllRelatedProductsData, GetAllRelatedProductsError, GetAllRelatedProductsErrors, GetAllRelatedProductsResponse, GetAllRelatedProductsResponses, GetAnOrderData, GetAnOrderError, GetAnOrderErrors, GetAnOrderResponse, GetAnOrderResponses, GetByContextAllHierarchiesData, GetByContextAllHierarchiesError, GetByContextAllHierarchiesErrors, GetByContextAllHierarchiesResponse, GetByContextAllHierarchiesResponses, GetByContextAllNodesData, GetByContextAllNodesError, GetByContextAllNodesErrors, GetByContextAllNodesResponse, GetByContextAllNodesResponses, GetByContextAllProductsData, GetByContextAllProductsError, GetByContextAllProductsErrors, GetByContextAllProductsResponse, GetByContextAllProductsResponses, GetByContextAllRelatedProductsData, GetByContextAllRelatedProductsError, GetByContextAllRelatedProductsErrors, GetByContextAllRelatedProductsResponse, GetByContextAllRelatedProductsResponses, GetByContextChildNodesData, GetByContextChildNodesError, GetByContextChildNodesErrors, GetByContextChildNodesResponse, GetByContextChildNodesResponses, GetByContextChildProductsData, GetByContextChildProductsError, GetByContextChildProductsErrors, GetByContextChildProductsResponse, GetByContextChildProductsResponses, GetByContextComponentProductIdsData, GetByContextComponentProductIdsError, GetByContextComponentProductIdsErrors, GetByContextComponentProductIdsResponse, GetByContextComponentProductIdsResponses, GetByContextHierarchyChildNodesData, GetByContextHierarchyChildNodesError, GetByContextHierarchyChildNodesErrors, GetByContextHierarchyChildNodesResponse, GetByContextHierarchyChildNodesResponses, GetByContextHierarchyData, GetByContextHierarchyError, GetByContextHierarchyErrors, GetByContextHierarchyNodesData, GetByContextHierarchyNodesError, GetByContextHierarchyNodesErrors, GetByContextHierarchyNodesResponse, GetByContextHierarchyNodesResponses, GetByContextHierarchyResponse, GetByContextHierarchyResponses, GetByContextNodeData, GetByContextNodeError, GetByContextNodeErrors, GetByContextNodeResponse, GetByContextNodeResponses, GetByContextProductData, GetByContextProductError, GetByContextProductErrors, GetByContextProductResponse, GetByContextProductResponses, GetByContextProductsForHierarchyData, GetByContextProductsForHierarchyError, GetByContextProductsForHierarchyErrors, GetByContextProductsForHierarchyResponse, GetByContextProductsForHierarchyResponses, GetByContextProductsForNodeData, GetByContextProductsForNodeError, GetByContextProductsForNodeErrors, GetByContextProductsForNodeResponse, GetByContextProductsForNodeResponses, GetByContextReleaseData, GetByContextReleaseError, GetByContextReleaseErrors, GetByContextReleaseResponse, GetByContextReleaseResponses, GetCartData, GetCartError, GetCartErrors, GetCartItemsData, GetCartItemsError, GetCartItemsErrors, GetCartItemsResponse, GetCartItemsResponses, GetCartResponse, GetCartResponses, GetCartsData, GetCartsError, GetCartsErrors, GetCartsResponse, GetCartsResponses, GetCatalogByIdData, GetCatalogByIdError, GetCatalogByIdErrors, GetCatalogByIdResponse, GetCatalogByIdResponses, GetCatalogsData, GetCatalogsError, GetCatalogsErrors, GetCatalogsResponse, GetCatalogsResponses, GetChildNodesData, GetChildNodesError, GetChildNodesErrors, GetChildNodesResponse, GetChildNodesResponses, GetChildProductsData, GetChildProductsError, GetChildProductsErrors, GetChildProductsResponse, GetChildProductsResponses, GetComponentProductIdsData, GetComponentProductIdsError, GetComponentProductIdsErrors, GetComponentProductIdsResponse, GetComponentProductIdsResponses, GetCustomerOrdersData, GetCustomerOrdersError, GetCustomerOrdersErrors, GetCustomerOrdersResponse, GetCustomerOrdersResponses, GetFeatureData, GetFeatureError, GetFeatureErrors, GetFeatureResponse, GetFeatureResponses, GetHierarchyChildNodesData, GetHierarchyChildNodesError, GetHierarchyChildNodesErrors, GetHierarchyChildNodesResponse, GetHierarchyChildNodesResponses, GetHierarchyData, GetHierarchyError, GetHierarchyErrors, GetHierarchyNodesData, GetHierarchyNodesError, GetHierarchyNodesErrors, GetHierarchyNodesResponse, GetHierarchyNodesResponses, GetHierarchyResponse, GetHierarchyResponses, GetInvoiceData, GetInvoiceError, GetInvoiceErrors, GetInvoiceResponse, GetInvoiceResponses, GetNodeData, GetNodeError, GetNodeErrors, GetNodeResponse, GetNodeResponses, GetOfferingData, GetOfferingError, GetOfferingErrors, GetOfferingResponse, GetOfferingResponses, GetOrderItemsData, GetOrderItemsError, GetOrderItemsErrors, GetOrderItemsResponse, GetOrderItemsResponses, GetOrderTransactionsData, GetOrderTransactionsError, GetOrderTransactionsErrors, GetOrderTransactionsResponse, GetOrderTransactionsResponses, GetPlanData, GetPlanError, GetPlanErrors, GetPlanResponse, GetPlanResponses, GetProductData, GetProductError, GetProductErrors, GetProductResponse, GetProductResponses, GetProductsForHierarchyData, GetProductsForHierarchyError, GetProductsForHierarchyErrors, GetProductsForHierarchyResponse, GetProductsForHierarchyResponses, GetProductsForNodeData, GetProductsForNodeError, GetProductsForNodeErrors, GetProductsForNodeResponse, GetProductsForNodeResponses, GetReleaseByIdData, GetReleaseByIdError, GetReleaseByIdErrors, GetReleaseByIdResponse, GetReleaseByIdResponses, GetReleasesData, GetReleasesError, GetReleasesErrors, GetReleasesResponse, GetReleasesResponses, GetRuleByIdData, GetRuleByIdError, GetRuleByIdErrors, GetRuleByIdResponse, GetRuleByIdResponses, GetRulesData, GetRulesError, GetRulesErrors, GetRulesResponse, GetRulesResponses, GetStockData, GetStockError, GetStockErrors, GetStockResponse, GetStockResponses, GetSubscriptionData, GetSubscriptionError, GetSubscriptionErrors, GetSubscriptionInvoiceData, GetSubscriptionInvoiceError, GetSubscriptionInvoiceErrors, GetSubscriptionInvoicePaymentData, GetSubscriptionInvoicePaymentError, GetSubscriptionInvoicePaymentErrors, GetSubscriptionInvoicePaymentResponse, GetSubscriptionInvoicePaymentResponses, GetSubscriptionInvoiceResponse, GetSubscriptionInvoiceResponses, GetSubscriptionProductData, GetSubscriptionProductError, GetSubscriptionProductErrors, GetSubscriptionProductResponse, GetSubscriptionProductResponses, GetSubscriptionResponse, GetSubscriptionResponses, GetSubscriptionStateData, GetSubscriptionStateError, GetSubscriptionStateErrors, GetSubscriptionStateResponse, GetSubscriptionStateResponses, GetV2AccountAddressData, GetV2AccountAddressError, GetV2AccountAddressErrors, GetV2AccountAddressResponse, GetV2AccountAddressResponses, GetV2AccountAddressesData, GetV2AccountAddressesError, GetV2AccountAddressesErrors, GetV2AccountAddressesResponse, GetV2AccountAddressesResponses, GetV2AccountMembersAccountMemberIdData, GetV2AccountMembersAccountMemberIdError, GetV2AccountMembersAccountMemberIdErrors, GetV2AccountMembersAccountMemberIdResponse, GetV2AccountMembersAccountMemberIdResponses, GetV2AccountMembersData, GetV2AccountMembersError, GetV2AccountMembersErrors, GetV2AccountMembersResponse, GetV2AccountMembersResponses, GetV2AccountsAccountIdAccountMembershipsData, GetV2AccountsAccountIdAccountMembershipsError, GetV2AccountsAccountIdAccountMembershipsErrors, GetV2AccountsAccountIdAccountMembershipsResponse, GetV2AccountsAccountIdAccountMembershipsResponses, GetV2AccountsAccountIdData, GetV2AccountsAccountIdError, GetV2AccountsAccountIdErrors, GetV2AccountsAccountIdResponse, GetV2AccountsAccountIdResponses, GetV2AccountsData, GetV2AccountsError, GetV2AccountsErrors, GetV2AccountsResponse, GetV2AccountsResponses, Hierarchy, HierarchyAttributes, HierarchyData, HierarchyListData, HierarchyMeta, HierarchyRelationships, Import, ImportAttributes, ImportMeta, ImportRecords, Include, Include2, IncludeAccount, IncludeAccountMember, IncludedResponse, InventoriesError, InventoriesErrorResponse, InventoriesFilter, InventoriesPageLimit, InventoriesPageOffset, InventoriesTimestamps, InventoriesTransactionResponse, InventoriesUuid, InventoryLocationType, InvoicePaymentTimestamps, InvoiceTaxItems, InvoiceTimestamps, ItemPriceData, Job, JobAttributes, JobCreate, JobCreateAttributes, JobMeta, JobReport, JobResponseAttributes, JobTimestamps, JobType, Limit, Link, LinkObject, LinkUri, Links, Links2, ListInvoicesData, ListInvoicesError, ListInvoicesErrors, ListInvoicesResponse, ListInvoicesResponses, ListLocationsData, ListLocationsError, ListLocationsErrors, ListLocationsResponse, ListLocationsResponses, ListOfferingFeaturesData, ListOfferingFeaturesError, ListOfferingFeaturesErrors, ListOfferingFeaturesResponse, ListOfferingFeaturesResponses, ListOfferingPlansData, ListOfferingPlansError, ListOfferingPlansErrors, ListOfferingPlansResponse, ListOfferingPlansResponses, ListOfferingProductsData, ListOfferingProductsError, ListOfferingProductsErrors, ListOfferingProductsResponse, ListOfferingProductsResponses, ListOfferingsData, ListOfferingsError, ListOfferingsErrors, ListOfferingsResponse, ListOfferingsResponses, ListSubscriptionInvoicePaymentsData, ListSubscriptionInvoicePaymentsResponse, ListSubscriptionInvoicePaymentsResponses, ListSubscriptionInvoicesData, ListSubscriptionInvoicesError, ListSubscriptionInvoicesErrors, ListSubscriptionInvoicesResponse, ListSubscriptionInvoicesResponses, ListSubscriptionPlansData, ListSubscriptionPlansError, ListSubscriptionPlansErrors, ListSubscriptionPlansResponse, ListSubscriptionPlansResponses, ListSubscriptionProductsData, ListSubscriptionProductsError, ListSubscriptionProductsErrors, ListSubscriptionProductsResponse, ListSubscriptionProductsResponses, ListSubscriptionStatesData, ListSubscriptionStatesError, ListSubscriptionStatesErrors, ListSubscriptionStatesResponse, ListSubscriptionStatesResponses, ListSubscriptionsData, ListSubscriptionsError, ListSubscriptionsErrors, ListSubscriptionsResponse, ListSubscriptionsResponses, Location, LocationAttributes, LocationRequest, LocationUpdateAttributes, LocationUpdateRequest, MainImageRelationship, ManageCartsData, ManageCartsError, ManageCartsErrors, ManageCartsResponse, ManageCartsResponses, ManageSubscriptionProducts, ManualPayments, ManyRelationship, Meta, MetaAccountMemberId, MetaList, MetaListPage, MetaListResults, Method, MultipleProducts, Node, NodeAttributes, NodeCreateData, NodeData, NodeListData, NodeMeta, NodeReference, NodeRelationships, NodeRelationshipsData, NullableLocation, NullableLocations, NullablePaymentAuthority, NullablePrice, NullablePriceUnits, Offering, OfferingAttributes, OfferingCreate, OfferingFeature, OfferingFeatureAttach, OfferingFeatureUpdate, OfferingIncludes, OfferingMeta, OfferingPlan, OfferingPlanAttach, OfferingPlanMeta, OfferingPlanUpdate, OfferingProduct, OfferingProductAttach, OfferingProductExternalRefMeta, OfferingProductReplace, OfferingProductResponseAttributes, OfferingProductResponseExtraAttributes, OfferingProductUpdate, OfferingProductUpdateAttributes, OfferingProductUpdateExtraAttributes, OfferingRelationships, OfferingResponseAttributes, OfferingUpdate, OfferingUpdateAttributes, OfferingUpdateRelationships, Offset, OidcProfile, OidcProfileCreateRequestWrapper, OidcProfileListResponse, OidcProfileResponse, OidcProfileUpdateRequestWrapper, OneTimePasswordTokenRequest, OpenIdConnectRequest, OrderItemFormattedUnitPriceData, OrderItemResponse, OrderMeta, OrderPriceData, OrderResponse, OrdersAddressData, OrdersAnonymizeData, OrdersAnonymizeRequest, OrdersCancelData, OrdersFulfilledData, OrdersTransactionsCancelRequest, OrdersTransactionsCaptureRequest, OrdersTransactionsConfirmRequest, OrdersTransactionsRefundRequest, OrdersUpdateRequest, Owner, OwnerMeta, PageLimit, PageMeta, PageOffset, PasswordProfile, PasswordProfileCreateRequestWrapper, PasswordProfileInfo, PasswordProfileInfoCreateRequest, PasswordProfileInfoCreateRequestWrapper, PasswordProfileInfoListResponse, PasswordProfileInfoResponse, PasswordProfileInfoUpdateRequest, PasswordProfileInfoUpdateRequestWrapper, PasswordProfileListResponse, PasswordProfileResponse, PasswordProfileUpdateRequestWrapper, PasswordRequest, PasswordlessRequest, PaymentAuthority, PaymentAuthorityAuthorizeNet, PaymentAuthorityStripe, PaymentFailureDetail, PaymentRetryType, PaymentRetryUnit, PaymentRunReport, PaymentSetupData, PaymentSetupError, PaymentSetupErrors, PaymentSetupResponse, PaymentSetupResponses, PaymentsRequest, Plan, PlanAttributes, PlanAttributesAndSelectedMeta, PlanCreate, PlanMeta, PlanResponseAttributes, PlanUpdate, PlanUpdateAttributes, PostV2AccountAddressData, PostV2AccountAddressError, PostV2AccountAddressErrors, PostV2AccountAddressResponse, PostV2AccountAddressResponses, PostV2AccountMembersTokensData, PostV2AccountMembersTokensError, PostV2AccountMembersTokensErrors, PostV2AccountMembersTokensResponse, PostV2AccountMembersTokensResponses, PostV2AccountsData, PostV2AccountsError, PostV2AccountsErrors, PostV2AccountsResponse, PostV2AccountsResponses, Price, PriceFormatting, PriceUnits, Pricebook, PricebookCreateData, PricebookData, PricebookIdsForPriceSegmentationPreview, PricebookPrice, PricebookPriceCreateData, PricebookPriceData, PrioritizedPricebooks, Product, Product2, ProductAttributes, ProductAttributes2, ProductCreate, ProductCreateData, ProductData, ProductDiff, ProductListData, ProductMeta, ProductMeta2, ProductReference, ProductReferenceListData, ProductReferences, ProductRelationships, ProductRelationshipsData, ProductResponseAttributes, ProductUpdate, ProductUpdateAttributes, ProductsForCart, ProductsForCartConfiguration, ProductsForCartConfiguration2, PromotionItemObject, PromotionItemObjectData, PromotionItemResponseObject, ProrationEvent, ProrationPolicy, ProrationPolicyAttributes, ProrationPolicyCreate, ProrationPolicyMeta, ProrationPolicyRelationshipAttributes, ProrationPolicyResponseAttributes, ProrationPolicyType, ProrationPolicyUpdate, ProrationPolicyUpdateAttributes, ProrationPolicyUpdateRelationshipAttributes, PublishReleaseData, PublishReleaseError, PublishReleaseErrors, PublishReleaseResponse, PublishReleaseResponses, Purpose, PutV2AccountAddressData, PutV2AccountAddressError, PutV2AccountAddressErrors, PutV2AccountAddressResponse, PutV2AccountAddressResponses, PutV2AccountsAccountIdData, PutV2AccountsAccountIdError, PutV2AccountsAccountIdErrors, PutV2AccountsAccountIdResponse, PutV2AccountsAccountIdResponses, ReOrderObject, ReOrderObjectRequest, ReadOnlyParentId, RefundATransactionData, RefundATransactionError, RefundATransactionErrors, RefundATransactionResponse, RefundATransactionResponses, RelatedLink, Relationship, RelationshipArray, RelationshipData, RelationshipItem, RelationshipLinks, Relationships, Release, ReleaseData, ReleaseListData, ReleaseMeta, ReleaseRelationships, ReleaseStatus, RequestCreateCurrencies, RequestUpdateCurrencies, ResponseCurrency, ResponseData, ResponseError, ResponseMetaCarts, ResponseMetaCurrency, ResponseMetaOrders, ResponsePageLinks, ResponsePaginationPage, ResponsePaginationResults, ResultsLinks, ResultsMeta, Rounding, Rule, RuleCreateData, RuleData, RuleListData, RuleSchedule, RuleUpdateData, Sale, Sales, Schedule, Schedule2, ScheduleAttributes, ScheduleCreate, ScheduleJob, ScheduleMeta, ScheduleResponseAttributes, ScheduleUpdate, ScheduleUpdateAttributes, SelectedPlanMeta, SelectedPlanMetaAttributes, SelfLink, SelfLink2, SelfSignupRequest, ShippingAddress, ShopperAttributes, SingleCurrencyPrice, SingleRelationship, Sort, StateMeta, Status, Status2, StockCreate, StockCreateAttributes, StockLocations, StockMeta, StockResponse, StockResponseAttributes, StockTransactionType, StockType, StockUpdateAttributes, StockUpdateRequest, Subscriber, SubscriberAttributes, SubscriberCreate, SubscriberMeta, SubscriberResponseAttributes, SubscriberUpdate, SubscriberUpdateAttributes, Subscription, SubscriptionAttributes, SubscriptionDunningRuleType, SubscriptionFeatureType, SubscriptionImportError, SubscriptionImportErrorMeta, SubscriptionImportErrorType, SubscriptionImportType, SubscriptionIncludes, SubscriptionInvoice, SubscriptionInvoiceAttributes, SubscriptionInvoiceItem, SubscriptionInvoiceMeta, SubscriptionInvoicePayment, SubscriptionInvoicePaymentAttributes, SubscriptionInvoicePaymentMeta, SubscriptionInvoicePaymentType, SubscriptionInvoiceType, SubscriptionItemObject, SubscriptionItemObjectData, SubscriptionItemResponseObject, SubscriptionJobType, SubscriptionMeta, SubscriptionOfferingFeatureType, SubscriptionOfferingPlanType, SubscriptionOfferingProductType, SubscriptionOfferingType, SubscriptionPlanType, SubscriptionProductType, SubscriptionScheduleType, SubscriptionState, SubscriptionStateAction, SubscriptionStateAttributes, SubscriptionStateType, SubscriptionSubscriberType, SubscriptionTimestamps, SubscriptionType, SubscriptionUpdate, SubscriptionUpdateAttributes, SubscriptionsError, SubscriptionsErrorResponse, SubscriptionsFilter, SubscriptionsPageLimit, SubscriptionsPageOffset, SubscriptionsSingleRelationship, SubscriptionsTimestamps, SubscriptionsUuid, SwitchingAccountRequest, Tag, TaxItem, TaxRunReport, Tier, TieredAmount, TieredCurrencies, Tiers, TimePeriod, Timestamps, TransactionCreate, TransactionCreateAttributes, TransactionResponse, TransactionResponseAttributes, Type, Unit, UpdateACartData, UpdateACartError, UpdateACartErrors, UpdateACartItemData, UpdateACartItemError, UpdateACartItemErrors, UpdateACartItemResponse, UpdateACartItemResponses, UpdateACartResponse, UpdateACartResponses, UpdateATaxItemData, UpdateATaxItemError, UpdateATaxItemErrors, UpdateATaxItemResponse, UpdateATaxItemResponses, UpdateAllOrNothingOptionsObject, UpdateAnOrderData, UpdateAnOrderError, UpdateAnOrderErrors, UpdateAnOrderResponse, UpdateAnOrderResponses, UpdateCartsItems, UpdateCatalogData, UpdateCatalogError, UpdateCatalogErrors, UpdateCatalogResponse, UpdateCatalogResponses, UpdateCustomDiscountForCartData, UpdateCustomDiscountForCartError, UpdateCustomDiscountForCartErrors, UpdateCustomDiscountForCartItemData, UpdateCustomDiscountForCartItemError, UpdateCustomDiscountForCartItemErrors, UpdateCustomDiscountForCartItemResponse, UpdateCustomDiscountForCartItemResponses, UpdateCustomDiscountForCartResponse, UpdateCustomDiscountForCartResponses, UpdateInvoicePayment, UpdateInvoicePaymentAttributes, UpdatePasswordProfileInfoData, UpdatePasswordProfileInfoErrors, UpdatePasswordProfileInfoResponse, UpdatePasswordProfileInfoResponses, UpdateRuleData, UpdateRuleError, UpdateRuleErrors, UpdateRuleResponse, UpdateRuleResponses, UserAuthenticationInfo, UserAuthenticationInfoCreateRequestWrapper, UserAuthenticationInfoListResponse, UserAuthenticationInfoResponse, UserAuthenticationInfoUpdateRequestWrapper, UserAuthenticationOidcProfileInfo, UserAuthenticationOidcProfileInfoCreateRequestWrapper, UserAuthenticationOidcProfileInfoListResponse, UserAuthenticationOidcProfileInfoResponse, UserAuthenticationOidcProfileInfoUpdateRequestWrapper, Uuid, Variation, VariationOption, WritableParentId, _Error };
11826
+ export type { AcceptLanguage, AccessTokenRequest, AccessTokenResponse, Account, AccountAddressResponse, AccountAddressesError, AccountAddressesErrorResponse, AccountAddressesMetaTimestamps, AccountAuthenticationSettings, AccountAuthenticationSettingsResponse, AccountCheckout, AccountManagementAuthenticationToken, AccountManagementAuthenticationTokenResponse, AccountManagementError, AccountManagementErrorResponse, AccountManagementMetaTimestamps, AccountMember, AccountMemberResponse, AccountMemberSelfManagement, AccountMembership, AccountMembershipResponse, AccountMembershipResponseUsingAccountMemberId, AccountMembershipSettings, AccountResponse, Action, ActivePlan, ActivePricingOption, AddAllOrNothingOptionsObject, AddCustomDiscountToCartItemData, AddCustomDiscountToCartItemError, AddCustomDiscountToCartItemErrors, AddCustomDiscountToCartItemResponse, AddCustomDiscountToCartItemResponses, AddTaxItemToCartData, AddTaxItemToCartError, AddTaxItemToCartErrors, AddTaxItemToCartResponse, AddTaxItemToCartResponses, Address, AddressResponse, Amount, AnonymizeOrdersData, AnonymizeOrdersError, AnonymizeOrdersErrors, AnonymizeOrdersResponse, AnonymizeOrdersResponses, AuthenticationRealm, AuthenticationRealmListResponse, AuthenticationRealmResponse, AuthenticationRealmUpdateRequest, BillingAddress, BillingIntervalType, BillingRunReport, BuildOffering, BuildSubscription, BuildSubscriptionOrder, BulkAddCustomDiscountsToCartData, BulkAddCustomDiscountsToCartError, BulkAddCustomDiscountsToCartErrors, BulkAddCustomDiscountsToCartResponse, BulkAddCustomDiscountsToCartResponses, BulkAddItemsRequest, BulkAddTaxItemsToCartData, BulkAddTaxItemsToCartError, BulkAddTaxItemsToCartErrors, BulkAddTaxItemsToCartResponse, BulkAddTaxItemsToCartResponses, BulkDeleteCustomDiscountsFromCartData, BulkDeleteCustomDiscountsFromCartResponse, BulkDeleteCustomDiscountsFromCartResponses, BulkDeleteTaxItemsFromCartData, BulkDeleteTaxItemsFromCartResponse, BulkDeleteTaxItemsFromCartResponses, BulkUpdateCartsItems, BulkUpdateItemsInCartData, BulkUpdateItemsInCartError, BulkUpdateItemsInCartErrors, BulkUpdateItemsInCartResponses, BundleConfiguration, BundleConfigurationData, BundleConfigurationData2, CancelATransactionData, CancelATransactionError, CancelATransactionErrors, CancelATransactionResponse, CancelATransactionResponses, CaptureATransactionData, CaptureATransactionError, CaptureATransactionErrors, CaptureATransactionResponse, CaptureATransactionResponses, CartCheckoutTimestamps, CartCollectionResponse, CartContact, CartEntityResponse, CartInclude, CartIncluded, CartIncludedPromotion, CartItemBulkCustomDiscountObject, CartItemFormattedPriceData, CartItemObject, CartItemObjectData, CartItemObjectRequest, CartItemRelationship, CartItemResponse, CartItemTaxesEntityResponse, CartItemsResponse, CartMergeObject, CartMergeObjectRequest, CartPaymentUpdate, CartResponse, CartTimestamps, CartsBulkCustomDiscounts, CartsBulkCustomDiscountsCollectionResponse, CartsBulkCustomDiscountsResponse, CartsBulkTaxes, CartsCustomDiscountsCollectionResponse, CartsCustomDiscountsEntityRequest, CartsCustomDiscountsEntityResponse, CartsCustomDiscountsObject, CartsCustomDiscountsResponseObject, CartsItemsTaxesObject, CartsRelationshipsAccountsData, CartsRelationshipsCustomersData, CartsRequest, CartsResponse, Catalog, CatalogCreateData, CatalogData, CatalogListData, CatalogReleaseCreateData, CatalogUpdateData, ChangeState, Channel, CheckoutApiData, CheckoutApiError, CheckoutApiErrors, CheckoutApiResponse, CheckoutApiResponses, ComponentProduct, ComponentProductOption, ComponentProductsRelationship, Components, ConfigureByContextProductData, ConfigureByContextProductError, ConfigureByContextProductErrors, ConfigureByContextProductResponse, ConfigureByContextProductResponses, ConfirmOrderData, ConfirmOrderError, ConfirmOrderErrors, ConfirmOrderResponse, ConfirmOrderResponses, ConfirmPaymentData, ConfirmPaymentError, ConfirmPaymentErrors, ConfirmPaymentResponse, ConfirmPaymentResponses, Contact, CreateACartData, CreateACartError, CreateACartErrors, CreateACartResponse, CreateACartResponses, CreateAccountCartAssociationData, CreateAccountCartAssociationError, CreateAccountCartAssociationErrors, CreateAccountCartAssociationResponse, CreateAccountCartAssociationResponses, CreateAnAccessTokenData, CreateAnAccessTokenError, CreateAnAccessTokenErrors, CreateAnAccessTokenResponse, CreateAnAccessTokenResponses, CreateCartPaymentIntentData, CreateCartPaymentIntentResponse, CreateCartPaymentIntentResponses, CreateCatalogData, CreateCatalogError, CreateCatalogErrors, CreateCatalogResponse, CreateCatalogResponses, CreateCustomerCartAssociationData, CreateCustomerCartAssociationError, CreateCustomerCartAssociationErrors, CreateCustomerCartAssociationResponse, CreateCustomerCartAssociationResponses, CreateOneTimePasswordTokenRequestData, CreateOneTimePasswordTokenRequestResponses, CreateOrderShippingGroupData, CreateOrderShippingGroupError, CreateOrderShippingGroupErrors, CreateOrderShippingGroupResponse, CreateOrderShippingGroupResponses, CreateRuleData, CreateRuleError, CreateRuleErrors, CreateRuleResponse, CreateRuleResponses, CreateShippingGroupData, CreateShippingGroupError, CreateShippingGroupErrors, CreateShippingGroupRequest, CreateShippingGroupResponse, CreateShippingGroupResponses, Currencies, CurrencyIdentifier, CustomAttributes, CustomDiscountRelationshipsCartItemRequest, CustomInput, CustomInputValidationRule, CustomInputValidationRuleOptions, CustomInputs, CustomItemObject, CustomItemObjectData, CustomRelationship, CustomRelationshipLinks, CustomerCheckout, DataAdyenPayment, DataAuthorizeNetPayment, DataBasePayments, DataBraintreePayment, DataCardConnectPayment, DataCreateCurrencies, DataCyberSourcePayment, DataManualPayment, DataPayPalExpressCheckoutPayment, DataPaymentObject, DataStripeConnectPayment, DataStripePayment, DataStripePaymentIntentsPayment, DataUpdateCurrencies, DeleteACartData, DeleteACartError, DeleteACartErrors, DeleteACartItemData, DeleteACartItemResponse, DeleteACartItemResponses, DeleteACartResponse, DeleteACartResponses, DeleteAPromotionViaPromotionCodeData, DeleteAPromotionViaPromotionCodeResponse, DeleteAPromotionViaPromotionCodeResponses, DeleteATaxItemData, DeleteATaxItemResponse, DeleteATaxItemResponses, DeleteAccountCartAssociationData, DeleteAccountCartAssociationError, DeleteAccountCartAssociationErrors, DeleteAccountCartAssociationResponse, DeleteAccountCartAssociationResponses, DeleteAllCartItemsData, DeleteAllCartItemsError, DeleteAllCartItemsErrors, DeleteAllCartItemsResponse, DeleteAllCartItemsResponses, DeleteCartShippingGroupData, DeleteCartShippingGroupError, DeleteCartShippingGroupErrors, DeleteCartShippingGroupResponse, DeleteCartShippingGroupResponses, DeleteCatalogByIdData, DeleteCatalogByIdError, DeleteCatalogByIdErrors, DeleteCatalogByIdResponse, DeleteCatalogByIdResponses, DeleteCustomDiscountFromCartData, DeleteCustomDiscountFromCartItemData, DeleteCustomDiscountFromCartItemResponse, DeleteCustomDiscountFromCartItemResponses, DeleteCustomDiscountFromCartResponse, DeleteCustomDiscountFromCartResponses, DeleteCustomerCartAssociationData, DeleteCustomerCartAssociationError, DeleteCustomerCartAssociationErrors, DeleteCustomerCartAssociationResponse, DeleteCustomerCartAssociationResponses, DeleteReleaseByIdData, DeleteReleaseByIdError, DeleteReleaseByIdErrors, DeleteReleaseByIdResponse, DeleteReleaseByIdResponses, DeleteReleasesData, DeleteReleasesError, DeleteReleasesErrors, DeleteReleasesResponse, DeleteReleasesResponses, DeleteRuleByIdData, DeleteRuleByIdError, DeleteRuleByIdErrors, DeleteRuleByIdResponse, DeleteRuleByIdResponses, DeleteV2AccountAddressData, DeleteV2AccountAddressError, DeleteV2AccountAddressErrors, DeleteV2AccountAddressResponse, DeleteV2AccountAddressResponses, DeliveryEstimate, DiffListData, Discount, DiscountData, DiscountSettings, Discounts, DisplayPrice, DisplayPrice2, DunningRule, DunningRuleAttributes, DunningRuleCreate, DunningRuleMeta, DunningRuleUpdate, DunningRuleUpdateAttributes, ElasticPathFile, ElasticPathPaymentsPoweredByStripePayment, EndBehavior, Error2, ErrorBadRequest, ErrorNotFound, ErrorResponse, ErrorResponse2, Extension, Extensions, ExternalRef, ExternalRefUpdate, Feature, FeatureAccessAttributes, FeatureAttributes, FeatureConfigAccessAttributes, FeatureConfigPromotionAttributes, FeatureConfigUsageAttributes, FeatureConfiguration, FeatureCreate, FeatureMeta, FeaturePlanConfiguration, FeaturePlanConfigurationUpdate, FeaturePromotion, FeaturePromotionAttributes, FeatureResponseAttributes, FeatureTag, FeatureUpdate, FeatureUpdateAttributes, FeatureUsageAttributes, File, FileLink, FileMeta, FileReference, FilesError, FilesErrorResponse, FilesLinks, FilesRelationship, FilesUuid, Filesfilter, FilespageLimit, FilespageOffset, Filter, FilterCatalog, FilterHierarchy, FilterNode, FilterProduct, FilterRule, FormattedPrice, FormattedPriceData, Gateway, GeolocationDetails, GetACartData, GetACartError, GetACartErrors, GetACartResponse, GetACartResponses, GetACurrencyData, GetACurrencyError, GetACurrencyErrors, GetACurrencyResponse, GetACurrencyResponses, GetAFileData, GetAFileError, GetAFileErrors, GetAFileResponse, GetAFileResponses, GetATransactionData, GetATransactionResponse, GetATransactionResponses, GetAllCurrenciesData, GetAllCurrenciesError, GetAllCurrenciesErrors, GetAllCurrenciesResponse, GetAllCurrenciesResponses, GetAllFilesData, GetAllFilesError, GetAllFilesErrors, GetAllFilesResponse, GetAllFilesResponses, GetAllHierarchiesData, GetAllHierarchiesError, GetAllHierarchiesErrors, GetAllHierarchiesResponse, GetAllHierarchiesResponses, GetAllNodesData, GetAllNodesError, GetAllNodesErrors, GetAllNodesResponse, GetAllNodesResponses, GetAllProductsData, GetAllProductsError, GetAllProductsErrors, GetAllProductsResponse, GetAllProductsResponses, GetAllRelatedProductsData, GetAllRelatedProductsError, GetAllRelatedProductsErrors, GetAllRelatedProductsResponse, GetAllRelatedProductsResponses, GetAnOrderData, GetAnOrderError, GetAnOrderErrors, GetAnOrderResponse, GetAnOrderResponses, GetByContextAllHierarchiesData, GetByContextAllHierarchiesError, GetByContextAllHierarchiesErrors, GetByContextAllHierarchiesResponse, GetByContextAllHierarchiesResponses, GetByContextAllNodesData, GetByContextAllNodesError, GetByContextAllNodesErrors, GetByContextAllNodesResponse, GetByContextAllNodesResponses, GetByContextAllProductsData, GetByContextAllProductsError, GetByContextAllProductsErrors, GetByContextAllProductsResponse, GetByContextAllProductsResponses, GetByContextAllRelatedProductsData, GetByContextAllRelatedProductsError, GetByContextAllRelatedProductsErrors, GetByContextAllRelatedProductsResponse, GetByContextAllRelatedProductsResponses, GetByContextChildNodesData, GetByContextChildNodesError, GetByContextChildNodesErrors, GetByContextChildNodesResponse, GetByContextChildNodesResponses, GetByContextChildProductsData, GetByContextChildProductsError, GetByContextChildProductsErrors, GetByContextChildProductsResponse, GetByContextChildProductsResponses, GetByContextComponentProductIdsData, GetByContextComponentProductIdsError, GetByContextComponentProductIdsErrors, GetByContextComponentProductIdsResponse, GetByContextComponentProductIdsResponses, GetByContextHierarchyChildNodesData, GetByContextHierarchyChildNodesError, GetByContextHierarchyChildNodesErrors, GetByContextHierarchyChildNodesResponse, GetByContextHierarchyChildNodesResponses, GetByContextHierarchyData, GetByContextHierarchyError, GetByContextHierarchyErrors, GetByContextHierarchyNodesData, GetByContextHierarchyNodesError, GetByContextHierarchyNodesErrors, GetByContextHierarchyNodesResponse, GetByContextHierarchyNodesResponses, GetByContextHierarchyResponse, GetByContextHierarchyResponses, GetByContextNodeData, GetByContextNodeError, GetByContextNodeErrors, GetByContextNodeResponse, GetByContextNodeResponses, GetByContextProductData, GetByContextProductError, GetByContextProductErrors, GetByContextProductResponse, GetByContextProductResponses, GetByContextProductsForHierarchyData, GetByContextProductsForHierarchyError, GetByContextProductsForHierarchyErrors, GetByContextProductsForHierarchyResponse, GetByContextProductsForHierarchyResponses, GetByContextProductsForNodeData, GetByContextProductsForNodeError, GetByContextProductsForNodeErrors, GetByContextProductsForNodeResponse, GetByContextProductsForNodeResponses, GetByContextReleaseData, GetByContextReleaseError, GetByContextReleaseErrors, GetByContextReleaseResponse, GetByContextReleaseResponses, GetCartItemsData, GetCartItemsResponse, GetCartItemsResponses, GetCartsData, GetCartsError, GetCartsErrors, GetCartsResponse, GetCartsResponses, GetCatalogByIdData, GetCatalogByIdError, GetCatalogByIdErrors, GetCatalogByIdResponse, GetCatalogByIdResponses, GetCatalogsData, GetCatalogsError, GetCatalogsErrors, GetCatalogsResponse, GetCatalogsResponses, GetChildNodesData, GetChildNodesError, GetChildNodesErrors, GetChildNodesResponse, GetChildNodesResponses, GetChildProductsData, GetChildProductsError, GetChildProductsErrors, GetChildProductsResponse, GetChildProductsResponses, GetComponentProductIdsData, GetComponentProductIdsError, GetComponentProductIdsErrors, GetComponentProductIdsResponse, GetComponentProductIdsResponses, GetCustomerOrdersData, GetCustomerOrdersResponse, GetCustomerOrdersResponses, GetFeatureData, GetFeatureError, GetFeatureErrors, GetFeatureResponse, GetFeatureResponses, GetHierarchyChildNodesData, GetHierarchyChildNodesError, GetHierarchyChildNodesErrors, GetHierarchyChildNodesResponse, GetHierarchyChildNodesResponses, GetHierarchyData, GetHierarchyError, GetHierarchyErrors, GetHierarchyNodesData, GetHierarchyNodesError, GetHierarchyNodesErrors, GetHierarchyNodesResponse, GetHierarchyNodesResponses, GetHierarchyResponse, GetHierarchyResponses, GetInvoiceData, GetInvoiceError, GetInvoiceErrors, GetInvoiceResponse, GetInvoiceResponses, GetNodeData, GetNodeError, GetNodeErrors, GetNodeResponse, GetNodeResponses, GetOfferingData, GetOfferingError, GetOfferingErrors, GetOfferingResponse, GetOfferingResponses, GetOrderItemsData, GetOrderItemsResponse, GetOrderItemsResponses, GetOrderShippingGroupsData, GetOrderShippingGroupsError, GetOrderShippingGroupsErrors, GetOrderShippingGroupsResponse, GetOrderShippingGroupsResponses, GetOrderTransactionsData, GetOrderTransactionsError, GetOrderTransactionsErrors, GetOrderTransactionsResponse, GetOrderTransactionsResponses, GetProductData, GetProductError, GetProductErrors, GetProductResponse, GetProductResponses, GetProductsForHierarchyData, GetProductsForHierarchyError, GetProductsForHierarchyErrors, GetProductsForHierarchyResponse, GetProductsForHierarchyResponses, GetProductsForNodeData, GetProductsForNodeError, GetProductsForNodeErrors, GetProductsForNodeResponse, GetProductsForNodeResponses, GetReleaseByIdData, GetReleaseByIdError, GetReleaseByIdErrors, GetReleaseByIdResponse, GetReleaseByIdResponses, GetReleasesData, GetReleasesError, GetReleasesErrors, GetReleasesResponse, GetReleasesResponses, GetRuleByIdData, GetRuleByIdError, GetRuleByIdErrors, GetRuleByIdResponse, GetRuleByIdResponses, GetRulesData, GetRulesError, GetRulesErrors, GetRulesResponse, GetRulesResponses, GetShippingGroupByIdData, GetShippingGroupByIdError, GetShippingGroupByIdErrors, GetShippingGroupByIdResponse, GetShippingGroupByIdResponses, GetShippingGroupsByIdData, GetShippingGroupsByIdError, GetShippingGroupsByIdErrors, GetShippingGroupsByIdResponse, GetShippingGroupsByIdResponses, GetShippingGroupsData, GetShippingGroupsError, GetShippingGroupsErrors, GetShippingGroupsResponse, GetShippingGroupsResponses, GetStockData, GetStockError, GetStockErrors, GetStockResponse, GetStockResponses, GetSubscriptionData, GetSubscriptionError, GetSubscriptionErrors, GetSubscriptionInvoiceData, GetSubscriptionInvoiceError, GetSubscriptionInvoiceErrors, GetSubscriptionInvoicePaymentData, GetSubscriptionInvoicePaymentError, GetSubscriptionInvoicePaymentErrors, GetSubscriptionInvoicePaymentResponse, GetSubscriptionInvoicePaymentResponses, GetSubscriptionInvoiceResponse, GetSubscriptionInvoiceResponses, GetSubscriptionResponse, GetSubscriptionResponses, GetSubscriptionStateData, GetSubscriptionStateError, GetSubscriptionStateErrors, GetSubscriptionStateResponse, GetSubscriptionStateResponses, GetV2AccountAddressData, GetV2AccountAddressError, GetV2AccountAddressErrors, GetV2AccountAddressResponse, GetV2AccountAddressResponses, GetV2AccountAddressesData, GetV2AccountAddressesError, GetV2AccountAddressesErrors, GetV2AccountAddressesResponse, GetV2AccountAddressesResponses, GetV2AccountMembersAccountMemberIdData, GetV2AccountMembersAccountMemberIdError, GetV2AccountMembersAccountMemberIdErrors, GetV2AccountMembersAccountMemberIdResponse, GetV2AccountMembersAccountMemberIdResponses, GetV2AccountMembersData, GetV2AccountMembersError, GetV2AccountMembersErrors, GetV2AccountMembersResponse, GetV2AccountMembersResponses, GetV2AccountsAccountIdAccountMembershipsData, GetV2AccountsAccountIdAccountMembershipsError, GetV2AccountsAccountIdAccountMembershipsErrors, GetV2AccountsAccountIdAccountMembershipsResponse, GetV2AccountsAccountIdAccountMembershipsResponses, GetV2AccountsAccountIdData, GetV2AccountsAccountIdError, GetV2AccountsAccountIdErrors, GetV2AccountsAccountIdResponse, GetV2AccountsAccountIdResponses, GetV2AccountsData, GetV2AccountsError, GetV2AccountsErrors, GetV2AccountsResponse, GetV2AccountsResponses, Hierarchy, HierarchyAttributes, HierarchyData, HierarchyListData, HierarchyMeta, HierarchyRelationships, Import, ImportAttributes, ImportMeta, ImportRecords, Include, IncludeAccount, IncludeAccountMember, IncludedResponse, InventoriesError, InventoriesErrorResponse, InventoriesFilter, InventoriesPageLimit, InventoriesPageOffset, InventoriesTimestamps, InventoriesTransactionResponse, InventoriesUuid, InventoryLocationType, InventorySettings, InvoicePaymentTimestamps, InvoiceTaxItems, InvoiceTimestamps, ItemPriceData, Job, JobAttributes, JobCreate, JobCreateAttributes, JobMeta, JobReport, JobResponseAttributes, JobTimestamps, JobType, Limit, Link, LinkObject, LinkUri, Links, Links2, ListInvoicesData, ListInvoicesError, ListInvoicesErrors, ListInvoicesResponse, ListInvoicesResponses, ListLocationsData, ListLocationsError, ListLocationsErrors, ListLocationsResponse, ListLocationsResponses, ListOfferingFeaturesData, ListOfferingFeaturesError, ListOfferingFeaturesErrors, ListOfferingFeaturesResponse, ListOfferingFeaturesResponses, ListOfferingPlanPricingOptionsData, ListOfferingPlanPricingOptionsError, ListOfferingPlanPricingOptionsErrors, ListOfferingPlanPricingOptionsResponse, ListOfferingPlanPricingOptionsResponses, ListOfferingPlansData, ListOfferingPlansError, ListOfferingPlansErrors, ListOfferingPlansResponse, ListOfferingPlansResponses, ListOfferingPricingOptionsData, ListOfferingPricingOptionsError, ListOfferingPricingOptionsErrors, ListOfferingPricingOptionsResponse, ListOfferingPricingOptionsResponses, ListOfferingsData, ListOfferingsError, ListOfferingsErrors, ListOfferingsResponse, ListOfferingsResponses, ListSubscriptionInvoicePaymentsData, ListSubscriptionInvoicePaymentsResponse, ListSubscriptionInvoicePaymentsResponses, ListSubscriptionInvoicesData, ListSubscriptionInvoicesError, ListSubscriptionInvoicesErrors, ListSubscriptionInvoicesResponse, ListSubscriptionInvoicesResponses, ListSubscriptionPlansData, ListSubscriptionPlansError, ListSubscriptionPlansErrors, ListSubscriptionPlansResponse, ListSubscriptionPlansResponses, ListSubscriptionPricingOptionsData, ListSubscriptionPricingOptionsError, ListSubscriptionPricingOptionsErrors, ListSubscriptionPricingOptionsResponse, ListSubscriptionPricingOptionsResponses, ListSubscriptionStatesData, ListSubscriptionStatesError, ListSubscriptionStatesErrors, ListSubscriptionStatesResponse, ListSubscriptionStatesResponses, ListSubscriptionsData, ListSubscriptionsError, ListSubscriptionsErrors, ListSubscriptionsResponse, ListSubscriptionsResponses, Location, LocationAttributes, LocationRequest, LocationUpdateAttributes, LocationUpdateRequest, MainImageRelationship, ManageCartsData, ManageCartsError, ManageCartsErrors, ManageCartsResponse, ManageCartsResponses, ManageSubscriptionPlans, ManualPayments, ManyRelationship, Meta, MetaAccountMemberId, MetaList, MetaListPage, MetaListResults, Method, Money, MultipleProducts, Node, NodeAttributes, NodeCreateData, NodeData, NodeListData, NodeMeta, NodeReference, NodeRelationships, NodeRelationshipsData, NullableLocation, NullableLocations, NullablePaymentAuthority, NullablePrice, NullablePriceUnits, Offering, OfferingAttributes, OfferingBuildConfiguredFeatures, OfferingBuildPlanFeatures, OfferingBuildPlanPricingOptions, OfferingBuildPricingOptionAssociations, OfferingCreate, OfferingFeature, OfferingFeatureAttach, OfferingFeatureCreate, OfferingFeatureUpdate, OfferingInclude, OfferingIncludes, OfferingMeta, OfferingPlan, OfferingPlanAttributes, OfferingPlanCreate, OfferingPlanExternalRefMeta, OfferingPlanExtraAttributes, OfferingPlanPriceForPricingOption, OfferingPlanPrices, OfferingPlanResponseAttributes, OfferingPlanResponseExtraAttributes, OfferingPlanUpdate, OfferingPlanUpdateAttributes, OfferingPlanUpdateExtraAttributes, OfferingPricingOption, OfferingPricingOptionCreate, OfferingPricingOptionMeta, OfferingPricingOptionPriceForPlan, OfferingPricingOptionPrices, OfferingPricingOptionUpdate, OfferingRelationships, OfferingResponseAttributes, OfferingUpdate, OfferingUpdateAttributes, OfferingUpdateRelationships, Offset, OidcProfile, OidcProfileCreateRequestWrapper, OidcProfileListResponse, OidcProfileResponse, OidcProfileUpdateRequestWrapper, OneTimePasswordTokenRequest, OpenIdConnectRequest, OrderCollectionResponse, OrderEntityResponse, OrderItemCollectionResponse, OrderItemFormattedUnitPriceData, OrderItemResponse, OrderMeta, OrderPriceData, OrderPriceWrapperMeta, OrderResponse, OrdersAddressData, OrdersAnonymizeData, OrdersAnonymizeRequest, OrdersCancelData, OrdersFulfilledData, OrdersListResponse, OrdersTransactionsCancelRequest, OrdersTransactionsCaptureRequest, OrdersTransactionsConfirmRequest, OrdersTransactionsRefundRequest, OrdersUpdateRequest, Owner, OwnerMeta, PageLimit, PageMeta, PageOffset, PasswordProfile, PasswordProfileCreateRequestWrapper, PasswordProfileInfo, PasswordProfileInfoCreateRequest, PasswordProfileInfoCreateRequestWrapper, PasswordProfileInfoListResponse, PasswordProfileInfoResponse, PasswordProfileInfoUpdateRequest, PasswordProfileInfoUpdateRequestWrapper, PasswordProfileListResponse, PasswordProfileResponse, PasswordProfileUpdateRequestWrapper, PasswordRequest, PasswordlessRequest, Payment, PaymentAuthority, PaymentAuthorityAuthorizeNet, PaymentAuthorityStripe, PaymentFailureDetail, PaymentRetryType, PaymentRetryUnit, PaymentRunReport, PaymentSetupData, PaymentSetupError, PaymentSetupErrors, PaymentSetupResponse, PaymentSetupResponses, PaymentsRequest, PlanAttributes, PlanAttributesAndSelectedMeta, PlanMeta, PlanResponseAttributes, PlanUpdateAttributes, PostV2AccountAddressData, PostV2AccountAddressError, PostV2AccountAddressErrors, PostV2AccountAddressResponse, PostV2AccountAddressResponses, PostV2AccountMembersTokensData, PostV2AccountMembersTokensError, PostV2AccountMembersTokensErrors, PostV2AccountMembersTokensResponse, PostV2AccountMembersTokensResponses, PostV2AccountsData, PostV2AccountsError, PostV2AccountsErrors, PostV2AccountsResponse, PostV2AccountsResponses, Price, PriceFormatting, PriceUnits, Pricebook, PricebookCreateData, PricebookData, PricebookIdsForPriceSegmentationPreview, PricebookPrice, PricebookPriceCreateData, PricebookPriceData, PricingOptionAttributes, PricingOptionAttributesAndSelectedMeta, PricingOptionResponseAttributes, PricingOptionUpdateAttributes, PrioritizedPricebooks, Product, ProductAttributes, ProductCreateData, ProductData, ProductDiff, ProductListData, ProductMeta, ProductReference, ProductReferenceListData, ProductReferences, ProductRelationships, ProductRelationshipsData, ProductsForCart, ProductsForCartConfiguration, ProductsForCartConfiguration2, PromotionItemObject, PromotionItemObjectData, ProrationEvent, ProrationPolicy, ProrationPolicyAttributes, ProrationPolicyCreate, ProrationPolicyMeta, ProrationPolicyRelationshipAttributes, ProrationPolicyResponseAttributes, ProrationPolicyType, ProrationPolicyUpdate, ProrationPolicyUpdateAttributes, ProrationPolicyUpdateRelationshipAttributes, PublishReleaseData, PublishReleaseError, PublishReleaseErrors, PublishReleaseResponse, PublishReleaseResponses, Purpose, PutShippingGroupByIdData, PutShippingGroupByIdError, PutShippingGroupByIdErrors, PutShippingGroupByIdResponse, PutShippingGroupByIdResponses, PutV2AccountAddressData, PutV2AccountAddressError, PutV2AccountAddressErrors, PutV2AccountAddressResponse, PutV2AccountAddressResponses, PutV2AccountsAccountIdData, PutV2AccountsAccountIdError, PutV2AccountsAccountIdErrors, PutV2AccountsAccountIdResponse, PutV2AccountsAccountIdResponses, ReOrderObject, ReOrderObjectRequest, ReadOnlyParentId, RefundATransactionData, RefundATransactionError, RefundATransactionErrors, RefundATransactionResponse, RefundATransactionResponses, RelatedLink, Relationship, RelationshipArray, RelationshipData, RelationshipItem, RelationshipLinks, Relationships, RelationshipsRequest, Release, ReleaseData, ReleaseListData, ReleaseMeta, ReleaseRelationships, ReleaseStatus, RequestCreateCurrencies, RequestUpdateCurrencies, ResponseCurrency, ResponseData, ResponseError, ResponseErrorItem, ResponseErrorResponse, ResponseMetaCarts, ResponseMetaCurrency, ResponseMetaOrders, ResponsePageLinks, ResponsePaginationPage, ResponsePaginationResults, ResultsLinks, ResultsMeta, Rounding, Rule, RuleCreateData, RuleData, RuleListData, RuleSchedule, RuleUpdateData, Sale, Sales, Schedule, Schedule2, ScheduleAttributes, ScheduleCreate, ScheduleJob, ScheduleMeta, ScheduleResponseAttributes, ScheduleUpdate, ScheduleUpdateAttributes, SelectedMeta, SelectedMetaAttributes, SelfLink, SelfLink2, SelfSignupRequest, Shipping, ShippingAddress, ShippingGroupMeta, ShippingGroupResponse, ShippingPriceRequest, ShippingPriceResponse, ShopperAttributes, SingleCurrencyPrice, SingleRelationship, Sort, StateMeta, Status, Status2, StockCreate, StockCreateAttributes, StockLocations, StockMeta, StockResponse, StockResponseAttributes, StockTransactionType, StockType, StockUpdateAttributes, StockUpdateRequest, Subscriber, SubscriberAttributes, SubscriberCreate, SubscriberMeta, SubscriberResponseAttributes, SubscriberUpdate, SubscriberUpdateAttributes, Subscription, SubscriptionAttributes, SubscriptionDunningRuleType, SubscriptionFeatureType, SubscriptionImportError, SubscriptionImportErrorMeta, SubscriptionImportErrorType, SubscriptionImportType, SubscriptionInclude, SubscriptionIncludes, SubscriptionInvoice, SubscriptionInvoiceAttributes, SubscriptionInvoiceItem, SubscriptionInvoiceMeta, SubscriptionInvoicePayment, SubscriptionInvoicePaymentAttributes, SubscriptionInvoicePaymentMeta, SubscriptionInvoicePaymentType, SubscriptionInvoiceType, SubscriptionItemObject, SubscriptionItemObjectData, SubscriptionJobType, SubscriptionMeta, SubscriptionOfferingFeatureType, SubscriptionOfferingPlanType, SubscriptionOfferingPricingOptionType, SubscriptionOfferingType, SubscriptionScheduleType, SubscriptionState, SubscriptionStateAction, SubscriptionStateAttributes, SubscriptionStateType, SubscriptionSubscriberType, SubscriptionTimestamps, SubscriptionType, SubscriptionUpdate, SubscriptionUpdateAttributes, SubscriptionsError, SubscriptionsErrorResponse, SubscriptionsFilter, SubscriptionsPageLimit, SubscriptionsPageOffset, SubscriptionsSingleRelationship, SubscriptionsTimestamps, SubscriptionsUuid, SwitchingAccountRequest, Tag, TaxItem, TaxRunReport, Tier, TieredAmount, TieredCurrencies, Tiers, TimePeriod, Timestamps, TransactionCreate, TransactionCreateAttributes, TransactionEntityResponse, TransactionListResponse, TransactionResponse, TransactionResponseAttributes, Type, Unit, UpdateACartData, UpdateACartError, UpdateACartErrors, UpdateACartItemData, UpdateACartItemError, UpdateACartItemErrors, UpdateACartItemResponse, UpdateACartItemResponses, UpdateACartResponse, UpdateACartResponses, UpdateATaxItemData, UpdateATaxItemResponse, UpdateATaxItemResponses, UpdateAllOrNothingOptionsObject, UpdateAnOrderData, UpdateAnOrderError, UpdateAnOrderErrors, UpdateAnOrderResponse, UpdateAnOrderResponses, UpdateCartPaymentIntentData, UpdateCartPaymentIntentResponse, UpdateCartPaymentIntentResponses, UpdateCartShippingGroupRequest, UpdateCartsItems, UpdateCatalogData, UpdateCatalogError, UpdateCatalogErrors, UpdateCatalogResponse, UpdateCatalogResponses, UpdateCustomDiscountForCartData, UpdateCustomDiscountForCartItemData, UpdateCustomDiscountForCartItemResponse, UpdateCustomDiscountForCartItemResponses, UpdateCustomDiscountForCartResponse, UpdateCustomDiscountForCartResponses, UpdateInvoicePayment, UpdateInvoicePaymentAttributes, UpdateOrderShippingGroupRequest, UpdatePasswordProfileInfoData, UpdatePasswordProfileInfoErrors, UpdatePasswordProfileInfoResponse, UpdatePasswordProfileInfoResponses, UpdateRuleData, UpdateRuleError, UpdateRuleErrors, UpdateRuleResponse, UpdateRuleResponses, UpdateShippingGroupData, UpdateShippingGroupError, UpdateShippingGroupErrors, UpdateShippingGroupResponse, UpdateShippingGroupResponses, UserAuthenticationInfo, UserAuthenticationInfoCreateRequestWrapper, UserAuthenticationInfoListResponse, UserAuthenticationInfoResponse, UserAuthenticationInfoUpdateRequestWrapper, UserAuthenticationOidcProfileInfo, UserAuthenticationOidcProfileInfoCreateRequestWrapper, UserAuthenticationOidcProfileInfoListResponse, UserAuthenticationOidcProfileInfoResponse, UserAuthenticationOidcProfileInfoUpdateRequestWrapper, Uuid, Variation, VariationOption, WritableParentId, _Error };