Skip to content

Commit

Permalink
[nightly] generate types against bigcommerce/docs@ed263d1 (#422)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and github-actions[bot] authored Oct 20, 2024
1 parent 77ba130 commit 02abae2
Show file tree
Hide file tree
Showing 19 changed files with 1,287 additions and 905 deletions.
5 changes: 5 additions & 0 deletions .changeset/khaki-peaches-matter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'bigrequest': patch
---

bigcommerce/docs#477, bigcommerce/docs#509, bigcommerce/docs#499, bigcommerce/docs#515, bigcommerce/docs#513, bigcommerce/docs#507, bigcommerce/docs#468, bigcommerce/docs#518, bigcommerce/docs#517, bigcommerce/docs#476, bigcommerce/docs#523, bigcommerce/docs#526, bigcommerce/docs#370, bigcommerce/docs#525, bigcommerce/docs#527, bigcommerce/docs#530, bigcommerce/docs#536, bigcommerce/docs#361, bigcommerce/docs#551, bigcommerce/docs#555, bigcommerce/docs#560, bigcommerce/docs#559, bigcommerce/docs#570, bigcommerce/docs#582, bigcommerce/docs#573, bigcommerce/docs#199, bigcommerce/docs#588
1 change: 0 additions & 1 deletion src/generated/brands_catalog.v3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1698,7 +1698,6 @@ export interface operations {
parameters: {
header: {
Accept: components["parameters"]["Accept"];
"Content-Type": components["parameters"]["ContentType"];
};
path: {
brand_id: components["parameters"]["BrandIdPath"];
Expand Down
10 changes: 3 additions & 7 deletions src/generated/carts.v3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1666,7 +1666,7 @@ export interface components {
/** @description Response payload for the BigCommerce API. */
MetafieldResponse: {
data?: components["schemas"]["Metafield"];
} & components["schemas"]["metaCollection_open"];
};
/** @description Allows app partners to write custom data to various resources in the API. */
Metafield: components["schemas"]["MetafieldBase"] & {
/** @description The unique identifier for the metafield. */
Expand All @@ -1693,6 +1693,7 @@ export interface components {
MetafieldBase: {
/**
* @description Determines the visibility and writeability of the field by other API consumers.
*
* | Value | Description |
* | :--- | :--- |
* | `app_only` | Private to the app that owns the field. |
Expand Down Expand Up @@ -1746,6 +1747,7 @@ export interface components {
MetafieldBase_Post: {
/**
* @description Determines the visibility and writeability of the field by other API consumers.
*
* | Value | Description |
* | :--- | :--- |
* | `app_only` | Private to the app that owns the field. |
Expand Down Expand Up @@ -2772,12 +2774,6 @@ export interface operations {
};
};
};
/** @description The `Metafield` was not found. */
404: {
content: {
"application/json": components["schemas"]["NotFound"];
};
};
/** @description Response object for metafields creation with partial success. */
422: {
content: {
Expand Down
3 changes: 1 addition & 2 deletions src/generated/categories_catalog.v3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1207,7 +1207,7 @@ export interface operations {
*/
name: string;
/**
* @description The product description, which can include HTML formatting.
* @description The category description, which can include HTML formatting.
*
* @example <p>We offer a wide variety of products perfect for relaxing</p>
*/
Expand Down Expand Up @@ -1991,7 +1991,6 @@ export interface operations {
parameters: {
header: {
Accept: components["parameters"]["Accept"];
"Content-Type": components["parameters"]["ContentType"];
};
path: {
category_id: components["parameters"]["CategoryIdParam"];
Expand Down
5 changes: 2 additions & 3 deletions src/generated/category-trees_catalog.v3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -353,14 +353,13 @@ export interface components {
category_id: number;
/**
* Parent ID
* @description The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog.
* Required in a POST if creating a child category.
* @description The unique numeric ID of the category parent. To create a top-level category, specify the `tree_id`. Otherwise, you can specify the `parent_id`. Required in a POST if creating a child category.
* @example 0
*/
parent_id: number;
/**
* Tree ID
* @description The ID of the category tree.
* @description The ID of the category tree. To create a top-level category, specify the `tree_id`. Otherwise, you can specify the `parent_id`.
* @example 1
*/
tree_id: number;
Expand Down
2 changes: 1 addition & 1 deletion src/generated/channels.v3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1068,7 +1068,7 @@ export interface components {
variants?: components["schemas"]["ChannelProductVariantFull"][];
};
/** @description List of channel-specific control panel menu navigation items and corresponding settings pages an app developer can choose to enable for the subject channel. Protected settings override any settings set in those UI sections at the storewide level. Learn more in the [Building Storefront Channels](/docs/integrations/channels/guide/storefronts#protected-ui-sections) tutorial. */
BigCommerceProtectedAppSections: ("storefront_settings" | "social" | "carousel" | "domains" | "currencies" | "notifications")[];
BigCommerceProtectedAppSections: ("overview" | "storefront_settings" | "localization" | "carousel" | "script_manager" | "currencies" | "payments" | "checkout" | "domains" | "notifications" | "social" | "pages" | "data_solutions")[];
channel_menus_Post: {
bigcommerce_protected_app_sections?: components["schemas"]["BigCommerceProtectedAppSections"];
custom_app_sections?: components["schemas"]["CustomAppSections"];
Expand Down
Loading

0 comments on commit 02abae2

Please sign in to comment.