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,101 @@
+title: Money Amount
+description: >-
+  A Money Amount represent a price amount, for example, a product variant's
+  price or a price in a price list. Each Money Amount either has a Currency or
+  Region associated with it to indicate the pricing in a given Currency or, for
+  fully region-based pricing, the given price in a specific Region. If
+  region-based pricing is used, the amount will be in the currency defined for
+  the Region.
+type: object
+required:
+  - amount
+  - created_at
+  - currency_code
+  - deleted_at
+  - id
+  - max_quantity
+  - min_quantity
+  - price_list_id
+  - region_id
+  - updated_at
+  - variant_id
+properties:
+  id:
+    description: The money amount's ID
+    type: string
+    example: ma_01F0YESHRFQNH5S8Q0PK84YYZN
+  currency_code:
+    description: The 3 character currency code that the money amount may belong to.
+    type: string
+    example: usd
+    externalDocs:
+      url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
+      description: See a list of codes.
+  currency:
+    description: The details of the currency that the money amount may belong to.
+    x-expandable: currency
+    nullable: true
+    $ref: ./Currency.yaml
+  amount:
+    description: >-
+      The amount in the smallest currecny unit (e.g. cents 100 cents to charge
+      $1) that the Product Variant will cost.
+    type: integer
+    example: 100
+  min_quantity:
+    description: >-
+      The minimum quantity that the Money Amount applies to. If this value is
+      not set, the Money Amount applies to all quantities.
+    nullable: true
+    type: integer
+    example: 1
+  max_quantity:
+    description: >-
+      The maximum quantity that the Money Amount applies to. If this value is
+      not set, the Money Amount applies to all quantities.
+    nullable: true
+    type: integer
+    example: 1
+  price_list_id:
+    description: The ID of the price list that the money amount may belong to.
+    nullable: true
+    type: string
+    example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
+  price_list:
+    description: The details of the price list that the money amount may belong to.
+    x-expandable: price_list
+    nullable: true
+    type: object
+  variant_id:
+    description: The ID of the Product Variant contained in the Line Item.
+    nullable: true
+    type: string
+    example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
+  variant:
+    description: The details of the product variant that the money amount may belong to.
+    x-expandable: variant
+    nullable: true
+    type: object
+  region_id:
+    description: The region's ID
+    nullable: true
+    type: string
+    example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
+  region:
+    description: The details of the region that the money amount may belong to.
+    x-expandable: region
+    nullable: true
+    type: object
+  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