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,92 @@
+title: Discount Condition
+description: Holds rule conditions for when a discount is applicable
+type: object
+required:
+  - type
+  - operator
+  - discount_rule_id
+properties:
+  id:
+    type: string
+    description: The discount condition's ID
+    example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
+  type:
+    description: The type of the Condition
+    type: string
+    enum:
+      - products
+      - product_types
+      - product_collections
+      - product_tags
+      - customer_groups
+  operator:
+    description: The operator of the Condition
+    type: string
+    enum:
+      - in
+      - not_in
+  discount_rule_id:
+    type: string
+    description: The ID of the discount rule associated with the condition
+    example: dru_01F0YESMVK96HVX7N419E3CJ7C
+  discount_rule:
+    description: Available if the relation `discount_rule` is expanded.
+    $ref: ./DiscountRule.yaml
+  products:
+    description: >-
+      products associated with this condition if type = products. Available if
+      the relation `products` is expanded.
+    type: array
+    items:
+      type: object
+      description: A product object.
+  product_types:
+    description: >-
+      product types associated with this condition if type = product_types.
+      Available if the relation `product_types` is expanded.
+    type: array
+    items:
+      type: object
+      description: A product type object.
+  product_tags:
+    description: >-
+      product tags associated with this condition if type = product_tags.
+      Available if the relation `product_tags` is expanded.
+    type: array
+    items:
+      type: object
+      description: A product tag object.
+  product_collections:
+    description: >-
+      product collections associated with this condition if type =
+      product_collections. Available if the relation `product_collections` is
+      expanded.
+    type: array
+    items:
+      type: object
+      description: A product collection object.
+  customer_groups:
+    description: >-
+      customer groups associated with this condition if type = customer_groups.
+      Available if the relation `customer_groups` is expanded.
+    type: array
+    items:
+      type: object
+      description: A customer group object.
+  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
+  metadata:
+    type: object
+    description: An optional key-value map with additional details
+    example:
+      car: white