[nightly] generate types against bigcommerce/docs@f23f355

.changeset/quick-wasps-stare.md

@@ -0,0 +1,5 @@
+---
+'bigrequest': patch
+---
+
+bigcommerce/docs#351, bigcommerce/docs#337, bigcommerce/docs#322, bigcommerce/docs#330, bigcommerce/docs#356, bigcommerce/docs#355, bigcommerce/docs#359, bigcommerce/docs#353, bigcommerce/docs#364, bigcommerce/docs#363, bigcommerce/docs#345, bigcommerce/docs#368

src/generated/access-tokens_payments.v3.ts

@@ -13,7 +13,7 @@ export interface paths {
      *
      * 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).
      *
-     * After the token is created, use the token to [Process a payment](/docs/rest-payments/processing#process-payment).
+     * 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.
      *
      * **Required Fields**
      * * order_id
@@ -70,7 +70,7 @@ export interface operations {
    *
    * 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).
    *
-   * After the token is created, use the token to [Process a payment](/docs/rest-payments/processing#process-payment).
+   * 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.
    *
    * **Required Fields**
    * * order_id

src/generated/brands_catalog.v3.ts

@@ -827,6 +827,14 @@ export interface components {
     MetafieldNamespaceParam?: string;
     /** @description Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter. */
     MetafieldNamespaceInParam?: string[];
+    /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */
+    date_created_min?: string;
+    /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */
+    date_created_max?: string;
+    /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */
+    date_modified_max?: string;
+    /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */
+    date_modified_min?: string;
     /** @description Sort direction. Acceptable values are: `asc`, `desc`. */
     DirectionParam?: "asc" | "desc";
     /** @description Filter items by ID. */
@@ -1333,6 +1341,8 @@ export interface operations {
         };
       };
       207: components["responses"]["MultiStatus"];
+      401: components["responses"]["UnauthorizedError"];
+      403: components["responses"]["Error"];
       /** @description The resource was not found. */
       404: {
         content: {

src/generated/carts.v3.ts

@@ -78,7 +78,7 @@ export interface paths {
      * **Usage Notes**
      *
      * * Redirect URLs can also be created with **Create a Cart** requests by appending `include=redirect_urls`.
-     * * A **Carts** redirect URL may only be used once.
+     * * A **Carts** redirect URL is valid for 30 days and may only be used once.
      * * Redirect URLs point to either a shared checkout domain or a channel-specific domain, depending on the storefront configuration.
      * * Once a redirect URL has been visited, it will be invalidated and cannot be used again.
      * * If your application requires URLs to be visited more than once, consider generating a fresh one each time you need to restore a cart, and redirecting to the URL from your own application.
@@ -1982,6 +1982,14 @@ export interface components {
     MetafieldNamespaceInParam?: string[];
     /** @description Controls the number of items per page in a limited (paginated) list of products. */
     LimitParam?: number;
+    /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */
+    date_created_min?: string;
+    /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */
+    date_created_max?: string;
+    /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */
+    date_modified_max?: string;
+    /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */
+    date_modified_min?: string;
     /** @description Sort direction. Acceptable values are: `asc`, `desc`. */
     DirectionParam?: "asc" | "desc";
     /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */
@@ -2106,7 +2114,7 @@ export interface operations {
    * **Usage Notes**
    *
    * * Redirect URLs can also be created with **Create a Cart** requests by appending `include=redirect_urls`.
-   * * A **Carts** redirect URL may only be used once.
+   * * A **Carts** redirect URL is valid for 30 days and may only be used once.
    * * Redirect URLs point to either a shared checkout domain or a channel-specific domain, depending on the storefront configuration.
    * * Once a redirect URL has been visited, it will be invalidated and cannot be used again.
    * * If your application requires URLs to be visited more than once, consider generating a fresh one each time you need to restore a cart, and redirecting to the URL from your own application.
@@ -2696,6 +2704,10 @@ export interface operations {
         "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"];
         direction?: components["parameters"]["DirectionParam"];
         include_fields?: components["parameters"]["IncludeFieldsParamMetafields"];
+        "date_modified:min"?: components["parameters"]["date_modified_min"];
+        "date_modified:max"?: components["parameters"]["date_modified_max"];
+        "date_created:min"?: components["parameters"]["date_created_min"];
+        "date_created:max"?: components["parameters"]["date_created_max"];
       };
     };
     responses: {

src/generated/categories_catalog.v3.ts

@@ -1047,6 +1047,14 @@ export interface components {
     LimitParam?: number;
     /** @description Sort direction. Acceptable values are: `asc`, `desc`. */
     DirectionParam?: "asc" | "desc";
+    /** @description 'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.' */
+    date_created_min?: string;
+    /** @description 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.' */
+    date_created_max?: string;
+    /** @description 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.' */
+    date_modified_max?: string;
+    /** @description 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.' */
+    date_modified_min?: string;
     /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */
     IncludeFieldsParam?: string[];
     /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */
@@ -2184,6 +2192,10 @@ export interface operations {
         "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"];
         direction?: components["parameters"]["DirectionParam"];
         include_fields?: components["parameters"]["IncludeFieldsParamMetafields"];
+        "date_modified:min"?: components["parameters"]["date_modified_min"];
+        "date_modified:max"?: components["parameters"]["date_modified_max"];
+        "date_created:min"?: components["parameters"]["date_created_min"];
+        "date_created:max"?: components["parameters"]["date_created_max"];
       };
       header: {
         Accept: components["parameters"]["Accept"];

src/generated/channels.v3.ts

@@ -1631,17 +1631,17 @@ export interface components {
     type_in?: ("marketplace" | "marketing" | "pos" | "storefront")[];
     /** @description Filter items by a comma-separated list of platforms. For a list of supported platforms, see [Platform](/docs/rest-management/channels#platform). */
     platform_in?: string[];
-    /** @description Filter items by date_created. For example, `date_created=2019-09-04T00:00:00`, `date_created=2019-09-04`, or `date_created=1567573200` */
+    /** @description Filter items by date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. */
     date_created?: string;
-    /** @description Filter items by minimum date_created. For example, `date_created:min=2019-09-04T00:00:00`, `date_created:min=2019-09-04`, or `date_created:min=1567573200` */
+    /** @description Filter items by minimum date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields created after this date. */
     date_created_min?: string;
-    /** @description Filter items by maximum date_created. For example, `date_created:max=2019-09-04T00:00:00`, `date_created:max=2019-09-04`, or `date_created:max=1567573200` */
+    /** @description Filter items by maximum date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields created before this date. */
     date_created_max?: string;
-    /** @description Filter items by date_modified. For example, `date_modified=2019-09-04T00:00:00`, `date_modified=2019-09-04`, or `date_modified=1567573200` */
+    /** @description Filter items by date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. */
     date_modified?: string;
-    /** @description Filter items by minimum date_modified. For example, `date_modified:min=2019-09-04T00:00:00`, `date_modified:min=2019-09-04`, or `date_modified:min=1567573200` */
+    /** @description Filter items by minimum date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields modified after this date. */
     date_modified_min?: string;
-    /** @description Filter items by maximum date_modified. For example, `date_modified:max=2019-09-04T00:00:00`, `date_modified:max=2019-09-04`, or `date_modified:max=1567573200` */
+    /** @description Filter items by maximum date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields modified before this date. */
     date_modified_max?: string;
     /** @description Controls the number of items per page for paginated responses. */
     limit?: number;
@@ -2449,6 +2449,10 @@ export interface operations {
         "namespace:in"?: components["parameters"]["MetafieldNamespaceInParam"];
         direction?: components["parameters"]["DirectionParam"];
         include_fields?: components["parameters"]["IncludeFieldsParamMetafields"];
+        "date_modified:min"?: components["parameters"]["date_modified_min"];
+        "date_modified:max"?: components["parameters"]["date_modified_max"];
+        "date_created:min"?: components["parameters"]["date_created_min"];
+        "date_created:max"?: components["parameters"]["date_created_max"];
       };
     };
     responses: {

src/generated/checkouts.v3.ts

@@ -320,15 +320,15 @@ export interface components {
               url?: string;
               is_taxable?: boolean;
               image_url?: string;
-              discounts?: {
-                  /** @description ID of the applied discount. */
-                  id?: number;
+              discounts?: ({
+                  /** @description The string value is always equal to "manual-discount" regardless of the input. */
+                  id?: string | number;
                   /**
                    * Format: double
                    * @description The discounted amount applied within a given context.
                    */
                   discounted_amount?: number;
-                }[];
+                })[];
               /**
                * Format: double
                * @description The total value of all discounts applied to this item.
@@ -1015,6 +1015,18 @@ export interface operations {
     };
     requestBody?: {
       content: {
+        /**
+         * @example {
+         *   "carts": {
+         *     "discounts": [
+         *       {
+         *         "discounted_amount": 10,
+         *         "name": "manual-discount"
+         *       }
+         *     ]
+         *   }
+         * }
+         */
         "application/json": {
           cart?: {
             discounts?: {