Skip to content

Commit cad81fd

Browse files
tvheestvhees
authored
Merge pull request #15 from aligent/release/1.1.0
Release/1.1.0
2 parents 97266cb + dbbc5fa commit cad81fd

File tree

12 files changed

+960
-387
lines changed

12 files changed

+960
-387
lines changed

‎docs/changelog/1.1.0.md‎

Lines changed: 421 additions & 0 deletions
Large diffs are not rendered by default.

‎package.json‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@aligent/bigcommerce-api",
3-
"version": "1.0.0",
3+
"version": "1.1.0",
44
"type": "module",
55
"scripts": {
66
"test": "tsd",
@@ -47,24 +47,24 @@
4747
"author": "Aligent",
4848
"license": "MIT",
4949
"devDependencies": {
50-
"@aligent/ts-code-standards": "^4.0.0",
51-
"@types/node": "^22.13.14",
52-
"diff": "^8.0.0-beta",
53-
"eslint": "^9.25.1",
54-
"openapi-typescript": "^7.6.1",
55-
"prettier": "^3.5.3",
50+
"@aligent/ts-code-standards": "^4.0.2",
51+
"@types/node": "^22.16.5",
52+
"diff": "^8.0.2",
53+
"eslint": "^9.31.0",
54+
"openapi-typescript": "^7.8.0",
55+
"prettier": "^3.6.2",
5656
"rimraf": "^6.0.1",
57-
"simple-git": "^3.27.0",
57+
"simple-git": "^3.28.0",
5858
"ts-morph": "^26.0.0",
5959
"tsd": "^0.32.0",
6060
"tshy": "^3.0.2",
61-
"typescript": "^5.8.2",
61+
"typescript": "^5.8.3",
6262
"uuid": "^11.1.0"
6363
},
6464
"dependencies": {
65-
"form-data": "^4.0.2",
65+
"form-data": "^4.0.4",
6666
"node-fetch": "^3.3.2",
67-
"query-string": "^9.1.1"
67+
"query-string": "^9.2.2"
6868
},
6969
"packageManager": "[email protected]"
7070
}

‎src/internal/reference/generated/catalog/products_catalog.v3.ts‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4637,8 +4637,11 @@ export interface operations {
46374637
readonly updateProduct: {
46384638
readonly parameters: {
46394639
readonly query?: {
4640-
/** @description Sub-resources to include on a product, in a comma-separated list. If `options` or `modifiers` is used, results are limited to 10 per page. The ID and the specified fields will be returned. */
4641-
readonly include_fields?: components["parameters"]["IncludeFieldsEnumParam"];
4640+
/** @description A comma-separated list of sub-resources to return with a product object.
4641+
* When you specify `options` or `modifiers`, results are limited to 10 per page. */
4642+
readonly include?: components["parameters"]["IncludeParamGetProducts"];
4643+
/** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */
4644+
readonly include_fields?: components["parameters"]["IncludeFieldsParam"];
46424645
};
46434646
readonly header?: {
46444647
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */

‎src/internal/reference/generated/checkouts.v3.ts‎

Lines changed: 103 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,27 @@ export interface paths {
270270
*/
271271
readonly put: operations["updateCheckoutSettings"];
272272
};
273+
readonly "/checkouts/settings/channels/{channelId}": {
274+
readonly parameters: {
275+
readonly query?: never;
276+
readonly path: {
277+
readonly channelId: number;
278+
};
279+
readonly cookie?: never;
280+
};
281+
/**
282+
* Get Channel-Specific Checkout Settings
283+
* @description Returns the checkout settings for a given channel (storefront) by channelId.
284+
*/
285+
readonly get: operations["get-channel-checkout-settings"];
286+
/**
287+
* Update Channel-Specific Checkout Settings
288+
* @description Updates the checkout settings for a given channel (storefront) by channelId.
289+
*
290+
* This endpoint will update all settings included in the request body. Any settings excluded will remain unchanged. All non-boolean
291+
*/
292+
readonly put: operations["put-channel-checkout-settings"];
293+
};
273294
readonly "/checkouts/{checkoutId}/token": {
274295
readonly parameters: {
275296
readonly query?: never;
@@ -1086,6 +1107,19 @@ export interface components {
10861107
readonly custom_checkout_sri_hash?: string;
10871108
readonly custom_order_confirmation_sri_hash?: string;
10881109
};
1110+
/** Channel-Specific Checkouts Settings */
1111+
readonly ChannelCheckoutsSettings: {
1112+
readonly checkout_type?: string;
1113+
readonly guest_checkout_type?: string;
1114+
readonly guest_checkout_for_existing_accounts?: string;
1115+
readonly policy_consent?: string;
1116+
readonly order_confirmation_contact_email?: string;
1117+
readonly is_order_terms_and_conditions_enabled?: boolean;
1118+
readonly order_terms_and_conditions_type?: string;
1119+
readonly order_terms_and_conditions_link?: string;
1120+
readonly order_terms_and_conditions_textarea?: string;
1121+
readonly should_redirect_to_storefront_for_auth?: boolean;
1122+
} & components["schemas"]["CheckoutsSettings"];
10891123
/** Checkouts settings request */
10901124
readonly CheckoutsSettingsRequest: {
10911125
/** @description Custom checkout script URL to replace our default checkout. To reset a store to optimized one-page checkout, pass an empty string for `custom_checkout_script_url` and `custom_order_confirmation_script_url`. */
@@ -4162,8 +4196,7 @@ export interface operations {
41624196
* "cart": {
41634197
* "discounts": [
41644198
* {
4165-
* "discounted_amount": 10,
4166-
* "name": "manual-discount"
4199+
* "discounted_amount": 10
41674200
* }
41684201
* ]
41694202
* },
@@ -4174,8 +4207,6 @@ export interface operations {
41744207
readonly discounts?: readonly {
41754208
/** @example 10 */
41764209
readonly discounted_amount: number;
4177-
/** @example manual */
4178-
readonly name?: string;
41794210
}[];
41804211
readonly line_items?: readonly {
41814212
/** @example 8edef915-8e8e-4ebd-bece-31fbb1191a7e */
@@ -12087,6 +12118,74 @@ export interface operations {
1208712118
};
1208812119
};
1208912120
};
12121+
readonly "get-channel-checkout-settings": {
12122+
readonly parameters: {
12123+
readonly query?: never;
12124+
readonly header?: never;
12125+
readonly path: {
12126+
readonly channelId: number;
12127+
};
12128+
readonly cookie?: never;
12129+
};
12130+
readonly requestBody?: never;
12131+
readonly responses: {
12132+
/** @description Channel checkout settings retrieved successfully */
12133+
readonly 200: {
12134+
headers: {
12135+
readonly [name: string]: unknown;
12136+
};
12137+
content: {
12138+
readonly "application/json": {
12139+
readonly data?: components["schemas"]["ChannelCheckoutsSettings"];
12140+
readonly meta?: components["schemas"]["MetaOpen"];
12141+
};
12142+
};
12143+
};
12144+
/** @description Invalid channelId or invalid request */
12145+
readonly 422: {
12146+
headers: {
12147+
readonly [name: string]: unknown;
12148+
};
12149+
content?: never;
12150+
};
12151+
};
12152+
};
12153+
readonly "put-channel-checkout-settings": {
12154+
readonly parameters: {
12155+
readonly query?: never;
12156+
readonly header?: never;
12157+
readonly path: {
12158+
readonly channelId: number;
12159+
};
12160+
readonly cookie?: never;
12161+
};
12162+
readonly requestBody?: {
12163+
readonly content: {
12164+
readonly "application/json": components["schemas"]["ChannelCheckoutsSettings"];
12165+
};
12166+
};
12167+
readonly responses: {
12168+
/** @description Channel checkout settings updated successfully */
12169+
readonly 200: {
12170+
headers: {
12171+
readonly [name: string]: unknown;
12172+
};
12173+
content: {
12174+
readonly "application/json": {
12175+
readonly data?: components["schemas"]["ChannelCheckoutsSettings"];
12176+
readonly meta?: components["schemas"]["MetaOpen"];
12177+
};
12178+
};
12179+
};
12180+
/** @description Invalid channelId or invalid request */
12181+
readonly 422: {
12182+
headers: {
12183+
readonly [name: string]: unknown;
12184+
};
12185+
content?: never;
12186+
};
12187+
};
12188+
};
1209012189
readonly createCheckoutToken: {
1209112190
readonly parameters: {
1209212191
readonly query?: never;

‎src/internal/reference/generated/orders.v2.oas2.ts‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,8 @@ export interface paths {
170170
*
171171
* The V2 Orders API will not trigger the typical [Order Email](https://support.bigcommerce.com/s/article/Customizing-Emails?language=en_US) when creating orders. To create an order that does trigger this email, you can instead [create a cart](/docs/rest-management/carts/carts-single#create-a-cart) and [convert that cart into an order](/docs/rest-management/checkouts/checkout-orders#create-an-order).
172172
*
173+
* If you are building an app that creates orders, it must include your app's ID in the `external_source` field of new orders to be approved for the App Marketplace. See [App Store Approval Requirements](/docs/integrations/apps/guide/requirements#functionality) to learn more.
174+
*
173175
* > #### Note
174176
* > * If historical orders processed on another eCommerce platform are being migrated to BigCommerce, supply the `external_source` field with the code **M-MIG**. This code will exclude the historical orders from the store’s GMV/order count, which factors into pricing.
175177
*/
@@ -1830,7 +1832,11 @@ export interface components {
18301832
readonly id?: number;
18311833
/** @description A read-only value representing the last modification of the order. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822 */
18321834
readonly date_modified?: string;
1833-
/** @description A read-only value representing the date of shipment. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822 */
1835+
/**
1836+
* @description A read-only value representing the date when the order is fully shipped. Do not attempt to modify or set this value in a POST or PUT request. RFC-2822
1837+
*
1838+
* @example Wed, 25 Jun 2025 05:22:10 +0000
1839+
*/
18341840
readonly date_shipped?: string;
18351841
/**
18361842
* @description The cart ID from which this order originated, if applicable. Correlates with the Cart API. This is a read-only field; do not set or modify its value in a POST or PUT request.

‎src/internal/reference/generated/pages.v3.ts‎

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ export interface components {
154154
*
155155
*/
156156
readonly PagesCollectionResponse: {
157-
readonly data?: readonly (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeFeed"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"])[];
157+
readonly data?: readonly (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"])[];
158158
readonly meta?: components["schemas"]["ResponseMeta"];
159159
};
160160
/**
@@ -163,7 +163,7 @@ export interface components {
163163
*
164164
*/
165165
readonly SinglePageResponse: {
166-
readonly data?: components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeFeed"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"];
166+
readonly data?: components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"];
167167
readonly meta?: components["schemas"]["ResponseMeta"];
168168
};
169169
/** @description Properties of the page modification request body. */
@@ -205,7 +205,7 @@ export interface components {
205205
* @example page
206206
* @enum {string}
207207
*/
208-
readonly type?: "page" | "raw" | "contact_form" | "feed" | "link" | "blog";
208+
readonly type?: "page" | "raw" | "contact_form" | "link" | "blog";
209209
/**
210210
* @description HTML or variable that populates the element of this page, in default/desktop view. Required in a `POST` request if the page type is `raw`.
211211
*
@@ -221,9 +221,6 @@ export interface components {
221221
/** @description Applicable when the page type is `contact_form`: contact email address that receives messages sent via the form. Must be unique. */
222222
readonly email?: string;
223223
readonly meta_title?: string | null;
224-
/** @description The URL of the RSS feed. Required in a `POST` request if the page type is `feed`.
225-
* */
226-
readonly feed?: string;
227224
/** @description Required in a `POST` request to create a link if the page type is `link`.
228225
* */
229226
readonly link?: string;
@@ -300,7 +297,7 @@ export interface components {
300297
* @example page
301298
* @enum {string}
302299
*/
303-
readonly type: "page" | "raw" | "contact_form" | "feed" | "link" | "blog";
300+
readonly type: "page" | "raw" | "contact_form" | "link" | "blog";
304301
/**
305302
* @description Determines whether this page loads at the siteʼs root route. For example, at `https://example.com/`.
306303
* @default false
@@ -358,15 +355,6 @@ export interface components {
358355
*/
359356
readonly contact_fields?: string;
360357
};
361-
/**
362-
* feed
363-
* @description `type: feed`. Makes RSS-syndicated content feeds available in the menu of other pages that contain markup. No page body.
364-
*/
365-
readonly typeFeed: components["schemas"]["anyTypePage"] & components["schemas"]["pageMeta"] & components["schemas"]["searchKeywords"] & {
366-
/** @description The URL of the RSS feed. Required in a `POST` request if the page type is `feed`.
367-
* */
368-
readonly feed: string;
369-
};
370358
/**
371359
* raw
372360
* @description `type: raw`. A user-defined page with a body that contains HTML markup or other stringified code.
@@ -440,7 +428,7 @@ export interface components {
440428
};
441429
content: {
442430
readonly "application/json": {
443-
readonly data?: components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeFeed"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"];
431+
readonly data?: components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"];
444432
readonly meta?: components["schemas"]["ResponseMeta"];
445433
};
446434
};
@@ -606,7 +594,7 @@ export interface operations {
606594
};
607595
readonly requestBody: {
608596
readonly content: {
609-
readonly "application/json": (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeFeed"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"]) | readonly (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeFeed"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"])[];
597+
readonly "application/json": (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"]) | readonly (components["schemas"]["typePage"] | components["schemas"]["typeBlog"] | components["schemas"]["typeContactForm"] | components["schemas"]["typeRaw"] | components["schemas"]["typeLink"])[];
610598
};
611599
};
612600
readonly responses: {

‎src/internal/reference/generated/payments/access_tokens_payments.v3.ts‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ export interface paths {
1818
* Create Payment Access Token
1919
* @description Use this endpoint to create a payment access token. A payment access token is required to process payments with the BigCommerce API.
2020
*
21-
* You can also generate a payment access token during checkout by using the `completeCheckout` mutation in the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront#handling-payments).
22-
*
23-
* After the token is created, use the token to [Process a payment](/docs/rest-payments/processing#process-payment). The token is valid for one hour.
24-
*
2521
* **Required Fields**
2622
* * order_id
2723
*/

0 commit comments

Comments
 (0)