chore(docs): Generated API Reference (#3061)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

docs/api/store/components/schemas/PricedProduct.yaml

@@ -0,0 +1,10 @@
+title: Priced Product
+type: object
+allOf:
+  - $ref: ./Product.yaml
+  - type: object
+    properties:
+      variants:
+        type: array
+        items:
+          $ref: ./PricedVariant.yaml

docs/api/store/components/schemas/PricedVariant.yaml

@@ -0,0 +1,41 @@
+title: Priced Product Variant
+type: object
+allOf:
+  - $ref: ./ProductVariant.yaml
+  - type: object
+    properties:
+      original_price:
+        type: number
+        description: >-
+          The original price of the variant without any discounted prices
+          applied.
+      calculated_price:
+        type: number
+        description: The calculated price of the variant. Can be a discounted price.
+      original_price_incl_tax:
+        type: number
+        description: The original price of the variant including taxes.
+      calculated_price_incl_tax:
+        type: number
+        description: The calculated price of the variant including taxes.
+      original_tax:
+        type: number
+        description: The taxes applied on the original price.
+      calculated_tax:
+        type: number
+        description: The taxes applied on the calculated price.
+      tax_rates:
+        type: array
+        description: An array of applied tax rates
+        items:
+          type: object
+          properties:
+            rate:
+              type: number
+              description: The tax rate value
+            name:
+              type: string
+              description: The name of the tax rate
+            code:
+              type: string
+              description: The code of the tax rate

docs/api/store/components/schemas/ProductVariantInventoryItem.yaml

@@ -0,0 +1,34 @@
+title: Product Variant Inventory Item
+description: >-
+  Product Variant Inventory Items link variants with inventory items and denote
+  the number of inventory items constituting a variant.
+type: object
+properties:
+  id:
+    type: string
+    description: The product variant inventory item's ID
+    example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A
+  inventory_item_id:
+    description: The id of the inventory item
+    type: string
+  variant_id:
+    description: The id of the variant.
+    type: string
+  required_quantity:
+    description: >-
+      The quantity of an inventory item required for one quantity of the
+      variant.
+    type: integer
+    default: 1
+  created_at:
+    type: string
+    description: The date with timezone at which the resource was created.
+    format: date-time
+  updated_at:
+    type: string
+    description: The date with timezone at which the resource was updated.
+    format: date-time
+  deleted_at:
+    type: string
+    description: The date with timezone at which the resource was deleted.
+    format: date-time

docs/api/store/components/schemas/ProductVariantPricesFields.yaml

@@ -1,37 +0,0 @@
-title: Product Variant Prices Fields
-description: Product Variants Prices Fields that are only available in some requests.
-type: object
-properties:
-  original_price:
-    type: number
-    description: The original price of the variant without any discounted prices applied.
-  calculated_price:
-    type: number
-    description: The calculated price of the variant. Can be a discounted price.
-  original_price_incl_tax:
-    type: number
-    description: The original price of the variant including taxes.
-  calculated_price_incl_tax:
-    type: number
-    description: The calculated price of the variant including taxes.
-  original_tax:
-    type: number
-    description: The taxes applied on the original price.
-  calculated_tax:
-    type: number
-    description: The taxes applied on the calculated price.
-  tax_rates:
-    type: array
-    description: An array of applied tax rates
-    items:
-      type: object
-      properties:
-        rate:
-          type: number
-          description: The tax rate value
-        name:
-          type: string
-          description: The name of the tax rate
-        code:
-          type: string
-          description: The code of the tax rate

docs/api/store/components/schemas/ReservationItemDTO.yaml

@@ -0,0 +1,38 @@
+title: Reservation item
+description: Represents a reservation of an inventory item at a stock location
+type: object
+required:
+  - id
+  - location_id
+  - inventory_item_id
+  - quantity
+properties:
+  id:
+    description: The id of the reservation item
+    type: string
+  location_id:
+    description: The id of the location of the reservation
+    type: string
+  inventory_item_id:
+    description: The id of the inventory item the reservation relates to
+    type: string
+  quantity:
+    description: The id of the reservation item
+    type: number
+  metadata:
+    type: object
+    description: An optional key-value map with additional details
+    example:
+      car: white
+  created_at:
+    type: string
+    description: The date with timezone at which the resource was created.
+    format: date-time
+  updated_at:
+    type: string
+    description: The date with timezone at which the resource was updated.
+    format: date-time
+  deleted_at:
+    type: string
+    description: The date with timezone at which the resource was deleted.
+    format: date-time

docs/api/store/components/schemas/StoreAuthRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  customer:
+    $ref: ./Customer.yaml

docs/api/store/components/schemas/StoreCartsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  cart:
+    $ref: ./Cart.yaml

docs/api/store/components/schemas/StoreCollectionsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  collections:
+    type: array
+    items:
+      $ref: ./ProductCollection.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/store/components/schemas/StoreCollectionsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  collection:
+    $ref: ./ProductCollection.yaml

docs/api/store/components/schemas/StoreCompleteCartRes.yaml

@@ -0,0 +1,29 @@
+type: object
+properties:
+  type:
+    type: string
+    description: The type of the data property.
+    enum:
+      - order
+      - cart
+      - swap
+  data:
+    type: object
+    description: The data of the result object. Its type depends on the type field.
+    oneOf:
+      - type: object
+        allOf:
+          - description: >-
+              Cart was successfully authorized and order was placed
+              successfully.
+          - $ref: ./Order.yaml
+      - type: object
+        allOf:
+          - description: Cart was successfully authorized but requires further actions.
+          - $ref: ./Cart.yaml
+      - type: object
+        allOf:
+          - description: >-
+              When cart is used for a swap and it has been completed
+              successfully.
+          - $ref: ./Swap.yaml

docs/api/store/components/schemas/StoreCustomersListOrdersRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  orders:
+    type: array
+    items:
+      $ref: ./Order.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  payment_methods:
+    type: array
+    items:
+      type: object
+      properties:
+        provider_id:
+          type: string
+          description: The id of the Payment Provider where the payment method is saved.
+        data:
+          type: object
+          description: >-
+            The data needed for the Payment Provider to use the saved payment
+            method.

docs/api/store/components/schemas/StoreCustomersRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  customer:
+    $ref: ./Customer.yaml

docs/api/store/components/schemas/StoreGetAuthEmailRes.yaml

@@ -0,0 +1,5 @@
+type: object
+properties:
+  exists:
+    type: boolean
+    description: Whether email exists or not.

docs/api/store/components/schemas/StoreGetProductCategoryRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  product_category:
+    $ref: ./ProductCategory.yaml

docs/api/store/components/schemas/StoreGiftCardsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  gift_card:
+    $ref: ./GiftCard.yaml

docs/api/store/components/schemas/StoreOrderEditsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  order_edit:
+    $ref: ./OrderEdit.yaml

docs/api/store/components/schemas/StoreOrdersRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  order:
+    $ref: ./Order.yaml

docs/api/store/components/schemas/StorePaymentCollectionsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  payment_collection:
+    $ref: ./PaymentCollection.yaml

docs/api/store/components/schemas/StorePaymentCollectionsSessionRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  payment_session:
+    $ref: ./PaymentSession.yaml

docs/api/store/components/schemas/StorePostSearchRes.yaml

@@ -0,0 +1,7 @@
+type: object
+properties:
+  hits:
+    type: array
+    description: >-
+      Array of results. The format of the items depends on the search engine
+      installed on the server.

docs/api/store/components/schemas/StoreProductTypesListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  product_types:
+    type: array
+    items:
+      $ref: ./ProductType.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/store/components/schemas/StoreProductsListRes.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  products:
+    type: array
+    items:
+      $ref: ./PricedProduct.yaml
+  count:
+    type: integer
+    description: The total number of items available
+  offset:
+    type: integer
+    description: The number of items skipped before these items
+  limit:
+    type: integer
+    description: The number of items per page

docs/api/store/components/schemas/StoreProductsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  product:
+    $ref: ./PricedProduct.yaml

docs/api/store/components/schemas/StoreRegionsListRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  regions:
+    type: array
+    items:
+      $ref: ./Region.yaml

docs/api/store/components/schemas/StoreRegionsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  region:
+    $ref: ./Region.yaml

docs/api/store/components/schemas/StoreReturnReasonsListRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  return_reasons:
+    type: array
+    items:
+      $ref: ./ReturnReason.yaml

docs/api/store/components/schemas/StoreReturnReasonsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  return_reason:
+    $ref: ./ReturnReason.yaml

docs/api/store/components/schemas/StoreReturnsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  return:
+    $ref: ./Return.yaml

docs/api/store/components/schemas/StoreShippingOptionsListRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  shipping_options:
+    type: array
+    items:
+      $ref: ./ShippingOption.yaml

docs/api/store/components/schemas/StoreSwapsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  swap:
+    $ref: ./Swap.yaml

docs/api/store/components/schemas/StoreVariantsListRes.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  variants:
+    type: array
+    items:
+      $ref: ./PricedVariant.yaml

docs/api/store/components/schemas/StoreVariantsRes.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  variant:
+    $ref: ./PricedVariant.yaml