[nightly] generate types against bigcommerce/docs@be86060

.changeset/cold-coats-poke.md

@@ -0,0 +1,5 @@
+---
+'bigrequest': patch
+---
+
+bigcommerce/docs#469, bigcommerce/docs#379, bigcommerce/docs#473, bigcommerce/docs#464, bigcommerce/docs#375, bigcommerce/docs#462, bigcommerce/docs#479, bigcommerce/docs#475, bigcommerce/docs#482, bigcommerce/docs#485

src/generated/brands_catalog.v3.ts

@@ -415,58 +415,58 @@ export interface components {
        *
        * @enum {string}
        */
-      permission_set: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access";
+      permission_set?: "app_only" | "read" | "write" | "read_and_sf_access" | "write_and_sf_access";
       /**
        * @description Namespace for the metafield, for organizational purposes.
        *
        * @example Sales Department
        */
-      namespace: string;
+      namespace?: string;
       /**
        * @description The name of the field, for example: `location_id`, `color`.
        *
        * @example Staff Name
        */
-      key: string;
+      key?: string;
       /**
        * @description The value of the field, for example: `1`, `blue`.
        *
        * @example Ronaldo
        */
-      value: string;
+      value?: string;
       /**
        * @description Description for the metafields.
        *
        * @example order
        */
-      description: string;
+      description?: string;
       /**
        * @description The type of resource with which the metafield is associated.
        *
        * @example cart
        * @enum {string}
        */
-      resource_type: "brand" | "product" | "variant" | "category" | "cart" | "channel" | "location" | "order" | "customer";
+      resource_type?: "brand" | "product" | "variant" | "category" | "cart" | "channel" | "location" | "order" | "customer";
       /**
        * @description The unique identifier for the resource with which the metafield is associated.
        *
        * @example 424242
        */
-      resource_id: number;
+      resource_id?: number;
       /** @description The unique identifier for the metafield. */
-      id: number;
+      id?: number;
       /**
        * Format: date-time
        * @description Date and time of the metafieldʼs creation.
        * @example 2022-06-16T18:39:00+00:00
        */
-      date_created: string;
+      date_created?: string;
       /**
        * Format: date-time
        * @description Date and time when the metafield was last updated.
        * @example 2022-06-16T18:39:00+00:00
        */
-      date_modified: string;
+      date_modified?: string;
       /**
        * @description Client ID for the metafieldʼs creator.
        * @example asdfasdfasdfasdfasdfasdfasdf

src/generated/carts.v3.ts

@@ -173,7 +173,6 @@ export interface paths {
      * Get Global Cart Settings
      * @description Returns the global cart settings of a store.
      *
-     *   *Authentication*
      *   ### OAuth scopes
      *
      *   | UI Name | Permission | Parameter |
@@ -205,7 +204,6 @@ export interface paths {
      * Get Channel Cart Settings
      * @description Returns the per-channel overrides for the cart settings of a store.
      *
-     *   *Authentication*
      *   ### OAuth scopes
      *
      *   | UI Name | Permission | Parameter |
@@ -218,7 +216,6 @@ export interface paths {
      * Update Channel Cart Settings
      * @description Update the per-channel overrides for the cart settings of a store.
      *
-     * *Authentication*
      * ### OAuth scopes
      *
      * | UI Name | Permission | Parameter |
@@ -235,7 +232,6 @@ export interface paths {
         /**
          * @description The channel ID of the settings overrides.
          *
-         *   *Authentication*
          * ### OAuth scopes
          *
          * | UI Name | Permission | Parameter |
@@ -2402,7 +2398,6 @@ export interface operations {
    * Get Global Cart Settings
    * @description Returns the global cart settings of a store.
    *
-   *   *Authentication*
    *   ### OAuth scopes
    *
    *   | UI Name | Permission | Parameter |
@@ -2490,7 +2485,6 @@ export interface operations {
    * Get Channel Cart Settings
    * @description Returns the per-channel overrides for the cart settings of a store.
    *
-   *   *Authentication*
    *   ### OAuth scopes
    *
    *   | UI Name | Permission | Parameter |
@@ -2507,7 +2501,6 @@ export interface operations {
         /**
          * @description The channel ID of the settings overrides.
          *
-         *   *Authentication*
          * ### OAuth scopes
          *
          * | UI Name | Permission | Parameter |
@@ -2537,7 +2530,6 @@ export interface operations {
    * Update Channel Cart Settings
    * @description Update the per-channel overrides for the cart settings of a store.
    *
-   * *Authentication*
    * ### OAuth scopes
    *
    * | UI Name | Permission | Parameter |
@@ -2555,7 +2547,6 @@ export interface operations {
         /**
          * @description The channel ID of the settings overrides.
          *
-         *   *Authentication*
          * ### OAuth scopes
          *
          * | UI Name | Permission | Parameter |

src/generated/channels.v3.ts

@@ -809,7 +809,7 @@ export interface components {
     PutCheckoutUrl: {
       /**
        * Format: uri
-       * @description Unique site checkout URL. Must be valid and a sub-domain of primary channel URL.
+       * @description Unique site checkout URL. It must be valid and a sub-domain of the primary channel URL. Note: The API will change all URLs using the HTTP protocol to HTTPS.
        * @example https://checkout.kittens.mybigcommerce.com
        */
       url?: string;
@@ -1139,7 +1139,7 @@ export interface components {
       id?: number;
       /**
        * @description The fully qualified URL (including host and scheme) where this site is hosted. All URLs generated for this site will be appended to this.
-       * @example http://kittens.mybigcommerce.com/
+       * @example https://kittens.mybigcommerce.com/
        */
       url?: string;
       /** @description The channel to which this site is attached. Each site belongs to a single channel, and each channel can have either zero or more sites. */
@@ -1167,13 +1167,16 @@ export interface components {
       is_checkout_url_customized?: boolean;
     };
     Url: {
-      /** @description URL of site */
+      /**
+       * @description URL of site
+       * @example https://kittens.mybigcommerce.com/
+       */
       url?: string;
       /**
        * @description URL type
        * @enum {string}
        */
-      type?: "primary" | "canonical" | "checkout";
+      type?: "checkout" | "primary" | "canonical";
       /**
        * Format: date-time
        * @description The date-time that this URL was created, formatted as an [RFC-3339](https://www.ietf.org/rfc/rfc3339.txt) string.
@@ -1196,7 +1199,7 @@ export interface components {
     site_Post: {
       /**
        * @description The Fully Qualified URL (including host and scheme) where this site is hosted. All URLs generated for this site will be appended to this.
-       * @example http://kittens.mybigcommerce.com/
+       * @example https://kittens.mybigcommerce.com/
        */
       url?: string;
       /** @description The channel this site is attached to. Each site belongs to a single channel, and each channel can have either zero or one sites. */

src/generated/customers.v2.ts

@@ -500,7 +500,7 @@ export interface components {
           method?: "percent" | "fixed" | "price";
           /**
            * @description A float that specifies the value applied to the price modified. (Float, Float as String, Integer)
-           * @example "5.0000"
+           * @example 5.0000
            */
           amount?: string;
           /**
@@ -595,10 +595,10 @@ export interface components {
       country_id?: number;
     };
     /**
-     * customerGroup_Post
+     * customerGroup_Post_Put
      * @description When creating a customer group category discount using the API it defaults to "products in this category and its subcategories". In the [store control panel](https://support.bigcommerce.com/s/article/Customer-Groups#pricing), this can be changed to either "products in this category only" or "products in this category and its subcategories". There are currently no settings to change this behavior with the API.
      */
-    customerGroup_Post: {
+    customerGroup_Post_Put: {
       /**
        * @description Name of the group.
        * @example Wholesale
@@ -618,7 +618,7 @@ export interface components {
           method?: "percent" | "fixed" | "price";
           /**
            * @description A float that specifies the value applied to the price modified. (Float, Float as String, Integer)
-           * @example "5.0000"
+           * @example 5.0000
            */
           amount?: string;
           /**
@@ -627,16 +627,6 @@ export interface components {
            */
           price_list_id?: number;
         })[];
-      /**
-       * @description Date on which the customer group was created.
-       * @example "2023-07-17T06:30:41.000Z"
-       */
-      date_created?: string;
-      /**
-       * @description Date on which the customer group was last modified.
-       * @example "2023-07-25T01:15:19.000Z"
-       */
-      date_modified?: string;
       /** @description Describes whether the group is for guests. There can only be one customer group for guests at a time. */
       is_group_for_guests?: boolean;
     };
@@ -1581,7 +1571,7 @@ export interface operations {
     };
     requestBody: {
       content: {
-        "application/json": components["schemas"]["customerGroup_Post"];
+        "application/json": components["schemas"]["customerGroup_Post_Put"];
       };
     };
     responses: {
@@ -1671,7 +1661,7 @@ export interface operations {
     };
     requestBody?: {
       content: {
-        "application/json": components["schemas"]["customerGroup_Full"];
+        "application/json": components["schemas"]["customerGroup_Post_Put"];
       };
     };
     responses: {

src/generated/orders.v2.oas2.ts

@@ -1488,11 +1488,8 @@ export interface components {
        * @example false
        */
       order_is_digital?: boolean;
-      /**
-       * @description The payment method for this order. Can be one of the following: `Manual`, `Credit Card`, `cash`, `Test Payment Gateway`, etc.
-       * @enum {string}
-       */
-      payment_method?: "Credit Card" | "Cash" | "Test Payment Gateway" | "Manual";
+      /** @description The payment method for this order. Can be one of the following: `Manual`, `Credit Card`, `cash`, `Test Payment Gateway`, etc. */
+      payment_method?: string;
       /**
        * @description The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used).
        * @example

src/generated/orders.v3.ts

@@ -792,11 +792,6 @@ export interface components {
       gateway: "2checkout" | "adyen" | "amazon" | "authorizenet" | "bankdeposit" | "braintree" | "cheque" | "cod" | "custom" | "firstdatagge4" | "giftcertificate" | "hps" | "instore" | "klarna" | "migs" | "moneyorder" | "nmi" | "paypalexpress" | "paypalpaymentsprous" | "paypalpaymentsprouk" | "plugnpay" | "qbmsv2" | "securenet" | "square" | "storecredit" | "stripe" | "testgateway" | "usaepay";
       /** @description The transaction ID returned by the payment gateway for this transaction item. */
       gateway_transaction_id?: string;
-      /**
-       * Format: date-time
-       * @description The date/time of the transaction.
-       */
-      date_created?: string;
       /** @description True if the transaction performed was a test, or if the gateway is in test mode. */
       test?: boolean;
       /**

src/generated/products_catalog.v3.ts

@@ -3018,7 +3018,7 @@ export interface components {
     /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */
     IncludeFieldsParam?: ("name" | "type" | "sku" | "description" | "weight" | "width" | "depth" | "height" | "price" | "cost_price" | "retail_price" | "sale_price" | "map_price" | "tax_class_id" | "product_tax_code" | "calculated_price" | "categories" | "brand_id" | "option_set_id" | "option_set_display" | "inventory_level" | "inventory_warning_level" | "inventory_tracking" | "reviews_rating_sum" | "reviews_count" | "total_sold" | "fixed_cost_shipping_price" | "is_free_shipping" | "is_visible" | "is_featured" | "related_products" | "warranty" | "bin_picking_number" | "layout_file" | "upc" | "mpn" | "gtin" | "date_last_imported" | "search_keywords" | "availability" | "availability_description" | "condition" | "is_condition_shown" | "order_quantity_minimum" | "order_quantity_maximum" | "page_title" | "meta_keywords" | "meta_description" | "date_created" | "date_modified" | "view_count" | "preorder_release_date" | "preorder_message" | "is_preorder_only" | "is_price_hidden" | "price_hidden_label" | "custom_url" | "base_variant_id" | "open_graph_type" | "open_graph_title" | "open_graph_description" | "open_graph_use_meta_description" | "open_graph_use_product_name" | "open_graph_use_image")[];
     /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */
-    IncludeFieldsParamMetafields?: ("resource_id" | "key" | "value" | "namespace" | "permission_set" | "resource_type" | "description" | "owner_client_id" | "date_created" | "date_modified")[];
+    IncludeFieldsParamMetafields?: ("resource_id" | "resource_id:in" | "key" | "value" | "namespace" | "permission_set" | "resource_type" | "description" | "owner_client_id" | "date_created" | "date_modified")[];
     /** @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. */
     IncludeFieldsEnumParam?: ("variants" | "images" | "custom_fields" | "bulk_pricing_rules" | "primary_image" | "modifiers" | "options" | "videos")[];
     /** @description Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. */

src/generated/store_information.v2.ts

@@ -88,6 +88,11 @@ export interface components {
        * @example AU
        */
       country_code?: string;
+      /**
+       * @description The infrastructure region where the store is located. Use this to determine where to place supporting infrastructure for minimum latency to the store. Compare against GCP regions on https://cloud.google.com/compute/docs/regions-zones
+       * @example us-central1
+       */
+      infrastructure_region?: string;
       /** @description Display phone number. */
       phone?: string;
       /**