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,75 @@
+title: Price List
+description: >-
+  Price Lists represents a set of prices that overrides the default price for
+  one or more product variants.
+type: object
+required:
+  - name
+  - description
+properties:
+  id:
+    type: string
+    description: The price list's ID
+    example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
+  name:
+    type: string
+    description: The price list's name
+    example: VIP Prices
+  description:
+    type: string
+    description: The price list's description
+    example: Prices for VIP customers
+  type:
+    description: The type of Price List. This can be one of either `sale` or `override`.
+    type: string
+    enum:
+      - sale
+      - override
+    default: sale
+  status:
+    description: The status of the Price List
+    type: string
+    enum:
+      - active
+      - draft
+    default: draft
+  starts_at:
+    description: The date with timezone that the Price List starts being valid.
+    type: string
+    format: date-time
+  ends_at:
+    description: The date with timezone that the Price List stops being valid.
+    type: string
+    format: date-time
+  customer_groups:
+    description: >-
+      The Customer Groups that the Price List applies to. Available if the
+      relation `customer_groups` is expanded.
+    type: array
+    items:
+      type: object
+      description: A customer group object.
+  prices:
+    description: >-
+      The Money Amounts that are associated with the Price List. Available if
+      the relation `prices` is expanded.
+    type: array
+    items:
+      oneOf:
+        - $ref: ./MoneyAmount.yaml
+        - $ref: ./CustomerGroup.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.
+    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