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/components/schemas/AdminBatchInventoryItemLocationsLevel.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchInventoryItemLocationsLevel.yaml
@@ -0,0 +1,63 @@
+type: object
+description: The inventory levels to create, update, 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.
+        location_id:
+          type: string
+          title: location_id
+          description: The associated stock location's ID.
+        id:
+          type: string
+          title: id
+          description: The ID of the location level.
+      required:
+        - location_id
+  delete:
+    type: array
+    description: 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-schemaName: AdminBatchInventoryItemLocationsLevel
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml
@@ -1,5 +1,5 @@
 type: object
-description: The reservation's inventory item.
+description: The inventory item's details.
 x-schemaName: AdminInventoryItem
 required:
  - id
@@ -20,15 +20,15 @@ properties:
  hs_code:
    type: string
    title: hs_code
-    description: The inventory item's hs code.
+    description: The inventory item's HS code.
  requires_shipping:
    type: boolean
    title: requires_shipping
-    description: The inventory item's requires shipping.
+    description: Whether the inventory item requires shipping.
  mid_code:
    type: string
    title: mid_code
-    description: The inventory item's mid code.
+    description: The inventory item's MID code.
  material:
    type: string
    title: material
@@ -60,10 +60,12 @@ properties:
  thumbnail:
    type: string
    title: thumbnail
-    description: The inventory item's thumbnail.
+    description: The thumbnail URL of the inventory item.
  metadata:
    type: object
-    description: The inventory item's metadata.
+    description: >-
+      Custom key-value pairs, used to store additional information about the
+      inventory item.
  location_levels:
    type: array
    description: The inventory item's location levels.
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml
@@ -27,22 +27,6 @@ properties:
    type: string
    title: provider_id
    description: The ID of the payment provider used to process this payment.
-  cart_id:
-    type: string
-    title: cart_id
-    description: The ID of the associated cart.
-  order_id:
-    type: string
-    title: order_id
-    description: The ID of the associated order.
-  order_edit_id:
-    type: string
-    title: order_edit_id
-    description: The ID of the associated order edit.
-  customer_id:
-    type: string
-    title: customer_id
-    description: ID of the associated customer.
  data:
    type: object
    description: The payment's data, useful for processing by the payment provider.
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml
@@ -5,7 +5,6 @@ required:
  - payment_providers
  - id
  - currency_code
-  - region_id
  - amount
  - status
 properties:
@@ -17,10 +16,6 @@ properties:
    type: string
    title: currency_code
    description: The payment collection's currency code.
-  region_id:
-    type: string
-    title: region_id
-    description: The ID of the region this payment collection is associated with.
  amount:
    type: number
    title: amount
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml
@@ -136,3 +136,8 @@ properties:
  metadata:
    type: object
    description: The variant's metadata, can hold custom key-value pairs.
+  inventory_items:
+    type: array
+    description: The variant's inventory items.
+    items:
+      $ref: ./AdminProductVariantInventoryItemLink.yaml
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryItemLink.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryItemLink.yaml
@@ -0,0 +1,24 @@
+type: object
+description: An association between a product variant and an inventory item.
+x-schemaName: AdminProductVariantInventoryItemLink
+required:
+  - id
+  - variant_id
+  - inventory_item_id
+properties:
+  id:
+    type: string
+    title: id
+    description: The ID of the association.
+  variant_id:
+    type: string
+    title: variant_id
+    description: The associated product variant's ID.
+  variant:
+    type: object
+  inventory_item_id:
+    type: string
+    title: inventory_item_id
+    description: The associated inventory item's ID.
+  inventory:
+    $ref: ./AdminInventoryItem.yaml
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml
@@ -56,3 +56,10 @@ properties:
    format: date-time
    title: deleted_at
    description: The date the promotion was deleted.
+  status:
+    type: string
+    description: The promotion's status.
+    enum:
+      - draft
+      - active
+      - inactive
--- a/www/apps/api-reference/specs/admin/components/schemas/BasePayment.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/BasePayment.yaml
@@ -27,22 +27,6 @@ properties:
    type: string
    title: provider_id
    description: The ID of the payment provider used to process this payment.
-  cart_id:
-    type: string
-    title: cart_id
-    description: The ID of the associated cart.
-  order_id:
-    type: string
-    title: order_id
-    description: The ID of the associated order.
-  order_edit_id:
-    type: string
-    title: order_edit_id
-    description: The ID of the associated order edit.
-  customer_id:
-    type: string
-    title: customer_id
-    description: ID of the associated customer.
  data:
    type: object
    description: The payment's data, useful for processing by the payment provider.
--- a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml
@@ -4,7 +4,6 @@ x-schemaName: BasePaymentCollection
 required:
  - id
  - currency_code
-  - region_id
  - amount
  - status
  - payment_providers
@@ -17,10 +16,6 @@ properties:
    type: string
    title: currency_code
    description: The payment collection's currency code.
-  region_id:
-    type: string
-    title: region_id
-    description: The ID of the region this payment collection is associated with.
  amount:
    type: number
    title: amount
--- a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml
@@ -5,7 +5,6 @@ required:
  - payment_providers
  - id
  - currency_code
-  - region_id
  - amount
  - status
 properties:
@@ -17,10 +16,6 @@ properties:
    type: string
    title: currency_code
    description: The payment collection's currency code.
-  region_id:
-    type: string
-    title: region_id
-    description: The ID of the region this payment collection is associated with.
  amount:
    type: number
    title: amount