chore(docs): Updated API Reference (v2) (#8609)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-08-15 14:31:35 +00:00
parent 4bd0917aed
commit b23ddcdde8
1211 changed files with 92070 additions and 5062 deletions
@@ -0,0 +1,75 @@
+/**
+ * @schema AdminPriceList
+ * type: object
+ * description: The price list's details.
+ * x-schemaName: AdminPriceList
+ * required:
+ *   - id
+ *   - title
+ *   - description
+ *   - rules
+ *   - starts_at
+ *   - ends_at
+ *   - status
+ *   - type
+ *   - prices
+ *   - created_at
+ *   - updated_at
+ *   - deleted_at
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The price list's ID.
+ *   title:
+ *     type: string
+ *     title: title
+ *     description: The price list's title.
+ *   description:
+ *     type: string
+ *     title: description
+ *     description: The price list's description.
+ *   rules:
+ *     type: object
+ *     description: The price list's rules.
+ *   starts_at:
+ *     type: string
+ *     title: starts_at
+ *     description: The price list's starts at.
+ *   ends_at:
+ *     type: string
+ *     title: ends_at
+ *     description: The price list's ends at.
+ *   status:
+ *     type: string
+ *     enum:
+ *       - draft
+ *       - active
+ *   type:
+ *     type: string
+ *     enum:
+ *       - sale
+ *       - override
+ *   prices:
+ *     type: array
+ *     description: The price list's prices.
+ *     items:
+ *       $ref: "#/components/schemas/AdminPriceListPrice"
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The price list's created at.
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The price list's updated at.
+ *   deleted_at:
+ *     type: string
+ *     format: date-time
+ *     title: deleted_at
+ *     description: The price list's deleted at.
+ * 
+*/
+