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

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

docs/api/admin/components/schemas/currency.yaml

@@ -26,3 +26,6 @@ properties:
     description: The written name of the currency
     type: string
     example: US Dollar
+  includes_tax:
+    description: '[EXPERIMENTAL] Does the currency prices include tax'
+    type: boolean

docs/api/admin/components/schemas/custom_shipping_option.yaml

@@ -51,3 +51,6 @@ properties:
     description: An optional key-value map with additional details
     example:
       car: white
+  includes_tax:
+    description: '[EXPERIMENTAL] Indicates if the custom shipping option price include tax'
+    type: boolean

docs/api/admin/components/schemas/line_item.yaml

@@ -157,6 +157,9 @@ properties:
     type: integer
     description: The total of the gift card of the line item
     example: 0
+  includes_tax:
+    description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax'
+    type: boolean
   created_at:
     type: string
     description: The date with timezone at which the resource was created.

docs/api/admin/components/schemas/order.yaml

@@ -187,6 +187,13 @@ properties:
       is expanded.
     items:
       $ref: ./line_item.yaml
+  edits:
+    type: array
+    description: >-
+      [EXPERIMENTAL] Order edits done on the order. Available if the relation
+      `edits` is expanded.
+    items:
+      $ref: ./order_edit.yaml
   gift_card_transactions:
     type: array
     description: >-

docs/api/admin/components/schemas/order_edit.yaml

@@ -0,0 +1,87 @@
+title: Order Edit
+description: Order edit keeps track of order items changes.
+x-resourceId: order_edit
+required:
+  - order_id
+  - order
+  - changes
+  - created_by
+properties:
+  id:
+    type: string
+    description: The order edit's ID
+    example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK
+  order_id:
+    type: string
+    description: The ID of the order that is edited
+    example: order_01G2SG30J8C85S4A5CHM2S1NS2
+  order:
+    description: Order object
+    $ref: ./order.yaml
+  changes:
+    type: array
+    description: Line item changes array.
+    items:
+      $ref: ./order_item_change.yaml
+  internal_note:
+    description: An optional note with additional details about the order edit.
+    type: string
+    example: Included two more items B to the order.
+  created_by:
+    type: string
+    description: The unique identifier of the user or customer who created the order edit.
+  requested_by:
+    type: string
+    description: >-
+      The unique identifier of the user or customer who requested the order
+      edit.
+  requested_at:
+    type: string
+    description: The date with timezone at which the edit was requested.
+    format: date-time
+  confirmed_by:
+    type: string
+    description: >-
+      The unique identifier of the user or customer who confirmed the order
+      edit.
+  confirmed_at:
+    type: string
+    description: The date with timezone at which the edit was confirmed.
+    format: date-time
+  declined_by:
+    type: string
+    description: The unique identifier of the user or customer who declined the order edit.
+  declined_at:
+    type: string
+    description: The date with timezone at which the edit was declined.
+    format: date-time
+  declined_reason:
+    description: An optional note why  the order edit is declined.
+    type: string
+  subtotal:
+    type: integer
+    description: The subtotal for line items computed from changes.
+    example: 8000
+  discount_total:
+    type: integer
+    description: The total of discount
+    example: 800
+  tax_total:
+    type: integer
+    description: The total of tax
+    example: 0
+  total:
+    type: integer
+    description: The total amount of the edited order.
+    example: 8200
+  difference_due:
+    type: integer
+    description: >-
+      The difference between the total amount of the order and total amount of
+      edited order.
+    example: 8200
+  items:
+    type: array
+    description: Computed line items from the changes.
+    items:
+      $ref: ./line_item.yaml

docs/api/admin/components/schemas/order_item_change.yaml

@@ -0,0 +1,39 @@
+title: Order Item Change
+description: Represents an order edit item change
+x-resourceId: order_item_change
+required:
+  - type
+  - order_edit_id
+properties:
+  id:
+    type: string
+    description: The order item change's ID
+    example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK
+  type:
+    type: string
+    description: The order's status
+    enum:
+      - item_add
+      - item_remove
+      - item_update
+  order_edit_id:
+    type: string
+    description: The ID of the order edit
+    example: oe_01G2SG30J8C85S4A5CHM2S1NS2
+  order_edit:
+    description: Order edit object
+    $ref: ./order_edit.yaml
+  original_line_item_id:
+    type: string
+    description: The ID of the original line item in the order
+    example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
+  original_line_item:
+    description: Original line item object.
+    $ref: ./line_item.yaml
+  line_item_id:
+    type: string
+    description: The ID of the cloned line item.
+    example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
+  line_item:
+    description: Line item object.
+    $ref: ./line_item.yaml

docs/api/admin/components/schemas/price_list.yaml

@@ -55,7 +55,12 @@ properties:
       the relation `prices` is expanded.
     type: array
     items:
-      $ref: ./money_amount.yaml
+      oneOf:
+        - $ref: ./money_amount.yaml
+        - $ref: ./customer_group.yaml
+  includes_tax:
+    description: '[EXPERIMENTAL] Does the price list prices include tax'
+    type: boolean
   created_at:
     type: string
     description: The date with timezone at which the resource was created.

docs/api/admin/components/schemas/region.yaml

@@ -83,6 +83,9 @@ properties:
     type: array
     items:
       $ref: ./fulfillment_provider.yaml
+  includes_tax:
+    description: '[EXPERIMENTAL] Does the prices for the region include tax'
+    type: boolean
   created_at:
     type: string
     description: The date with timezone at which the resource was created.

docs/api/admin/components/schemas/shipping_method.yaml

@@ -74,3 +74,6 @@ properties:
       may contain information such as a drop point id.
     type: object
     example: {}
+  includes_tax:
+    description: '[EXPERIMENTAL] Indicates if the shipping method price include tax'
+    type: boolean

docs/api/admin/components/schemas/shipping_option.yaml

@@ -84,6 +84,9 @@ properties:
       Option.
     type: object
     example: {}
+  includes_tax:
+    description: '[EXPERIMENTAL] Does the shipping option price include tax'
+    type: boolean
   created_at:
     type: string
     description: The date with timezone at which the resource was created.