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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-12-22 17:09:49 +02:00
parent 233d6904f8
commit 4814045036
477 changed files with 17312 additions and 17713 deletions
@@ -0,0 +1,43 @@
+title: Shipping Option Requirement
+description: >-
+  A requirement that a Cart must satisfy for the Shipping Option to be available
+  to the Cart.
+type: object
+required:
+  - shipping_option_id
+  - type
+  - amount
+properties:
+  id:
+    type: string
+    description: The shipping option requirement's ID
+    example: sor_01G1G5V29AB4CTNDRFSRWSRKWD
+  shipping_option_id:
+    description: >-
+      The id of the Shipping Option that the hipping option requirement belongs
+      to
+    type: string
+    example: so_01G1G5V27GYX4QXNARRQCW1N8T
+  shipping_option:
+    description: Available if the relation `shipping_option` is expanded.
+    $ref: ./ShippingOption.yaml
+  type:
+    description: >-
+      The type of the requirement, this defines how the value will be compared
+      to the Cart's total. `min_subtotal` requirements define the minimum
+      subtotal that is needed for the Shipping Option to be available, while the
+      `max_subtotal` defines the maximum subtotal that the Cart can have for the
+      Shipping Option to be available.
+    type: string
+    enum:
+      - min_subtotal
+      - max_subtotal
+    example: min_subtotal
+  amount:
+    description: The amount to compare the Cart subtotal to.
+    type: integer
+    example: 100
+  deleted_at:
+    type: string
+    description: The date with timezone at which the resource was deleted.
+    format: date-time