chore(shipping): SHIPPING-3163 Add documentation for checkout setting…

…s endpoint

reference/shipping.v3.yml

@@ -3,13 +3,14 @@ info:
   version: ''
   title: Shipping V3
   description: V3 REST API shipping endpoints.
-  termsOfService: 'http://www.bigcommerce.com/terms' 
-  contact: 
-    name: BigCommerce 
-    url: 'https://www.bigcommerce.com' 
-    email: [email protected] 
+  termsOfService: 'http://www.bigcommerce.com/terms'
+  contact:
+    name: BigCommerce
+    url: 'https://www.bigcommerce.com'
+    email: [email protected]
 tags:
   - name: Customs Information
+  - name: Checkout Settings
 security:
   - X-Auth-Token: []
 servers:
@@ -142,6 +143,61 @@ paths:
                     CA: '508313'
                     AU: '817355'
                     ALL: '501000'
+
+  '/shipping/settings':
+    parameters:
+      - $ref: '#/components/parameters/Accept'
+
+    get:
+      operationId: getCheckoutSettings
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/checkoutSettings'
+                  meta:
+                    $ref: '#/components/schemas/metaCollection'
+      description: |-
+        Get checkout settings.
+      tags:
+        - Checkout Settings
+      summary: Get Checkout Settings
+    post:
+      operationId: updateCheckoutSettings
+      parameters:
+        - $ref: '#/components/parameters/ContentType'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/checkoutSettings'
+              examples: { }
+      summary: Update Checkout Settings
+      description: |-
+        Updates checkout settings.
+      tags:
+        - Checkout Settings
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/checkoutSettings_request'
 components:
   parameters:
     store_hash:
@@ -281,7 +337,7 @@ components:
           schema:
             $ref: '#/components/schemas/error_Full'
     405_Method_Not_Allowed:
-      description: The resource was found, but doesnʼt support the request method. Issued when either a specific method isnʼt yet implemented on a resource, or the resource doesnʼt support the method at all. For example, a PUT request to `/orders` is invalid, but a PUT request to `/orders/{order_id}` is valid. 
+      description: The resource was found, but doesnʼt support the request method. Issued when either a specific method isnʼt yet implemented on a resource, or the resource doesnʼt support the method at all. For example, a PUT request to `/orders` is invalid, but a PUT request to `/orders/{order_id}` is valid.
       content:
         application/json:
           schema:
@@ -323,7 +379,6 @@ components:
       title: customsInformationRequest
       description: Data about the customs information object.
       type: object
-      x-internal: false
       properties:
         product_id:
           description: The product ID to which the customs information data applies.
@@ -355,11 +410,17 @@ components:
         - commodity_description
         - international_shipping
         - hs_codes
+    checkoutSettings_request:
+      title: checkoutSettingsRequest
+      description: Data about the checkout settings object.
+      type: object
+      properties:
+        checkout:
+          $ref: '#/components/schemas/countryListStrategy'
     customsInformation:
       title: customsInformation
       description: Data about the customs information object.
       type: object
-      x-internal: false
       properties:
         product_id:
           description: The ID of the product which the customs information data will apply to.
@@ -397,6 +458,25 @@ components:
           readOnly: true
           format: date-time
           example: 2022-09-21T14:15:00+00:00
+    checkoutSettings:
+      title: checkoutSettings
+      description: Checkout settings related to shipping.
+      type: object
+      properties:
+        checkout:
+          $ref: '#/components/schemas/countryListStrategy'
+    countryListStrategy:
+      title: countryListStrategy
+      description: The shipping-specific approach of displaying the list of countries at checkout.
+      type: object
+      properties:
+        country_list_strategy:
+          description: The approach for displaying the list of countries at checkout.
+          type: string
+          enum:
+          - DISPLAY_ALL_COUNTRIES
+          - DISPLAY_ONLY_SHIPPABLE_COUNTRIES
+          example: DISPLAY_ALL_COUNTRIES
     harmonizedSystemCodes:
       title: harmonizedSystemCodes
       description: |-
@@ -415,7 +495,6 @@ components:
         CA: '508313'
         US: '641000'
         AU: '817355'
-      x-internal: false
     metaCollection:
       title: metaCollection
       description: Meta data relating to pagination.
@@ -459,11 +538,9 @@ components:
                   type: string
                   description: Query string appended to the resource to show the current page.
                   example: '?limit=1&page=2'
-      x-internal: false
     error_Full:
       title: Error
       description: ''
       type: object
       properties: {}
       additionalProperties: true
-      x-internal: false