chore(docs): Updated API Reference (automated) (#11030)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-01-17 16:35:02 +00:00
parent bff8c0bc93
commit 24441e48df
42 changed files with 953 additions and 460 deletions
--- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml
+++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml
@@ -1,7 +1,10 @@
 post:
  operationId: PostCustomersIdCustomerGroups
-  summary: Add Customer Group to Customer
-  description: Add a Customer Group to a customer
+  x-sidebar-summary: Manage Customer Groups
+  summary: Manage Customer Groups of Customer
+  description: >-
+    Manage the customer groups of a customer, adding or removing the customer
+    from those groups.
  x-authenticated: true
  parameters:
    - name: id
@@ -45,18 +48,18 @@ post:
          properties:
            add:
              type: array
-              description: The customer's add.
+              description: The customer groups to add the customer to.
              items:
                type: string
                title: add
-                description: The add's details.
+                description: The ID of the group to add the customer to.
            remove:
              type: array
-              description: The customer's remove.
+              description: The customer groups to remove the customer from.
              items:
                type: string
                title: remove
-                description: The remove's details.
+                description: The ID of the group to remove the customer from.
  x-codeSamples:
    - lang: Shell
      label: cURL
--- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_location-levels_batch.yaml
+++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_location-levels_batch.yaml
@@ -0,0 +1,106 @@
+post:
+  operationId: PostInventoryItemsLocationLevelsBatch
+  summary: Manage Inventory Levels
+  description: Manage inventory levels to create, update, or delete them.
+  x-authenticated: true
+  parameters: []
+  security:
+    - api_token: []
+    - cookie_auth: []
+    - jwt_token: []
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: object
+          description: The inventory levels to manage.
+          properties:
+            create:
+              type: array
+              description: The inventory levels to create.
+              items:
+                type: object
+                description: The details of an inventory level to create.
+                required:
+                  - location_id
+                  - inventory_item_id
+                properties:
+                  location_id:
+                    type: string
+                    title: location_id
+                    description: The ID of the associated stock location.
+                  inventory_item_id:
+                    type: string
+                    title: inventory_item_id
+                    description: The ID of the associated inventory item.
+                  stocked_quantity:
+                    type: number
+                    title: stocked_quantity
+                    description: The stocked quantity.
+                  incoming_quantity:
+                    type: number
+                    title: incoming_quantity
+                    description: The incoming quantity to be added to stock.
+            update:
+              type: array
+              description: The inventory levels to update.
+              items:
+                type: object
+                description: The details of an inventory level to update.
+                required:
+                  - location_id
+                  - inventory_item_id
+                properties:
+                  location_id:
+                    type: string
+                    title: location_id
+                    description: The ID of the associated stock location.
+                  inventory_item_id:
+                    type: string
+                    title: inventory_item_id
+                    description: The ID of the associated inventory item.
+                  stocked_quantity:
+                    type: number
+                    title: stocked_quantity
+                    description: The stocked quantity.
+                  incoming_quantity:
+                    type: number
+                    title: incoming_quantity
+                    description: The incoming quantity to be added to stock.
+            delete:
+              type: array
+              description: The IDs of the inventory levels to delete.
+              items:
+                type: string
+                title: delete
+                description: The ID of the inventory level to delete.
+            force:
+              type: boolean
+              title: force
+              description: >-
+                Whether to delete specified inventory levels even if they have a
+                non-zero stocked quantity.
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/admin_inventory-items_location-levels_batch/post.sh
+  tags:
+    - Inventory Items
+  responses:
+    '200':
+      description: OK
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
+  x-workflow: batchInventoryItemLevelsWorkflow
--- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml
+++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml
@@ -19,52 +19,7 @@ post:
    content:
      application/json:
        schema:
-          type: object
-          description: The inventory levels to create or delete.
-          properties:
-            create:
-              type: array
-              description: The inventory levels to create.
-              items:
-                type: object
-                description: The inventory level's details.
-                required:
-                  - location_id
-                properties:
-                  location_id:
-                    type: string
-                    title: location_id
-                    description: The ID of the associated location.
-                  stocked_quantity:
-                    type: number
-                    title: stocked_quantity
-                    description: The inventory level's stocked quantity.
-                  incoming_quantity:
-                    type: number
-                    title: incoming_quantity
-                    description: The inventory level's incoming quantity.
-            update:
-              type: array
-              description: The inventory levels to update.
-              items:
-                type: object
-                description: The inventory level's details.
-                properties:
-                  stocked_quantity:
-                    type: number
-                    title: stocked_quantity
-                    description: The inventory level's stocked quantity.
-                  incoming_quantity:
-                    type: number
-                    title: incoming_quantity
-                    description: The inventory level's incoming quantity.
-            delete:
-              type: array
-              description: The inventory levels to delete.
-              items:
-                type: string
-                title: delete
-                description: The ID of the inventory level to delete.
+          $ref: ../components/schemas/AdminBatchInventoryItemLocationsLevel.yaml
  x-codeSamples:
    - lang: Shell
      label: cURL
@@ -74,19 +29,6 @@ post:
  tags:
    - Inventory Items
  responses:
-    '200':
-      description: OK
-      content:
-        application/json:
-          schema:
-            type: object
-            description: The inventory item's details.
-            required:
-              - inventory_item
-            properties:
-              inventory_item:
-                type: object
-                description: The inventory item's details.
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
@@ -99,4 +41,4 @@ post:
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml
-  x-workflow: bulkCreateDeleteLevelsWorkflow
+  x-workflow: batchInventoryItemLevelsWorkflow
--- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml
+++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml
@@ -197,4 +197,4 @@ delete:
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml
-  x-workflow: deleteReturnReasonsWorkflow
+  x-workflow: deleteRefundReasonsWorkflow