docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
2023-09-21 20:57:15 +03:00
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,121 @@
+title: Discount
+description: A discount can be applied to a cart for promotional purposes.
+type: object
+required:
+  - code
+  - created_at
+  - deleted_at
+  - ends_at
+  - id
+  - is_disabled
+  - is_dynamic
+  - metadata
+  - parent_discount_id
+  - rule_id
+  - starts_at
+  - updated_at
+  - usage_count
+  - usage_limit
+  - valid_duration
+properties:
+  id:
+    description: The discount's ID
+    type: string
+    example: disc_01F0YESMW10MGHWJKZSDDMN0VN
+  code:
+    description: >-
+      A unique code for the discount - this will be used by the customer to
+      apply the discount
+    type: string
+    example: 10DISC
+  is_dynamic:
+    description: >-
+      A flag to indicate if multiple instances of the discount can be generated.
+      I.e. for newsletter discounts
+    type: boolean
+    example: false
+  rule_id:
+    description: >-
+      The ID of the discount rule that defines how the discount will be applied
+      to a cart.
+    nullable: true
+    type: string
+    example: dru_01F0YESMVK96HVX7N419E3CJ7C
+  rule:
+    description: >-
+      The details of the discount rule that defines how the discount will be
+      applied to a cart..
+    x-expandable: rule
+    nullable: true
+    $ref: ./DiscountRule.yaml
+  is_disabled:
+    description: >-
+      Whether the Discount has been disabled. Disabled discounts cannot be
+      applied to carts
+    type: boolean
+    example: false
+  parent_discount_id:
+    description: >-
+      The Discount that the discount was created from. This will always be a
+      dynamic discount
+    nullable: true
+    type: string
+    example: disc_01G8ZH853YPY9B94857DY91YGW
+  parent_discount:
+    description: The details of the parent discount that this discount was created from.
+    x-expandable: parent_discount
+    nullable: true
+    type: object
+  starts_at:
+    description: The time at which the discount can be used.
+    type: string
+    format: date-time
+  ends_at:
+    description: The time at which the discount can no longer be used.
+    nullable: true
+    type: string
+    format: date-time
+  valid_duration:
+    description: Duration the discount runs between
+    nullable: true
+    type: string
+    example: P3Y6M4DT12H30M5S
+  regions:
+    description: The details of the regions in which the Discount can be used.
+    type: array
+    x-expandable: regions
+    items:
+      $ref: ./Region.yaml
+  usage_limit:
+    description: The maximum number of times that a discount can be used.
+    nullable: true
+    type: integer
+    example: 100
+  usage_count:
+    description: The number of times a discount has been used.
+    type: integer
+    example: 50
+    default: 0
+  created_at:
+    description: The date with timezone at which the resource was created.
+    type: string
+    format: date-time
+  updated_at:
+    description: The date with timezone at which the resource was updated.
+    type: string
+    format: date-time
+  deleted_at:
+    description: The date with timezone at which the resource was deleted.
+    nullable: true
+    type: string
+    format: date-time
+  metadata:
+    description: An optional key-value map with additional details
+    nullable: true
+    type: object
+    example:
+      car: white
+    externalDocs:
+      description: Learn about the metadata attribute, and how to delete and update it.
+      url: >-
+        https://docs.medusajs.com/development/entities/overview#metadata-attribute