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,130 @@
+title: Region
+description: >-
+  A region holds settings specific to a geographical location, including the
+  currency, tax rates, and fulfillment and payment providers. A Region can
+  consist of multiple countries to accomodate common shopping settings across
+  countries.
+type: object
+required:
+  - automatic_taxes
+  - created_at
+  - currency_code
+  - deleted_at
+  - gift_cards_taxable
+  - id
+  - metadata
+  - name
+  - tax_code
+  - tax_provider_id
+  - tax_rate
+  - updated_at
+properties:
+  id:
+    description: The region's ID
+    type: string
+    example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
+  name:
+    description: >-
+      The name of the region as displayed to the customer. If the Region only
+      has one country it is recommended to write the country name.
+    type: string
+    example: EU
+  currency_code:
+    description: The 3 character currency code used in the region.
+    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 used in the region.
+    x-expandable: currency
+    nullable: true
+    $ref: ./Currency.yaml
+  tax_rate:
+    description: The tax rate that should be charged on purchases in the Region.
+    type: number
+    example: 0
+  tax_rates:
+    description: >-
+      The details of the tax rates used in the region, aside from the default
+      rate.
+    type: array
+    x-expandable: tax_rates
+    items:
+      $ref: ./TaxRate.yaml
+  tax_code:
+    description: >-
+      The tax code used on purchases in the Region. This may be used by other
+      systems for accounting purposes.
+    nullable: true
+    type: string
+    example: null
+  gift_cards_taxable:
+    description: Whether the gift cards are taxable or not in this region.
+    type: boolean
+    default: true
+  automatic_taxes:
+    description: Whether taxes should be automated in this region.
+    type: boolean
+    default: true
+  countries:
+    description: The details of the countries included in this region.
+    type: array
+    x-expandable: countries
+    items:
+      $ref: ./Country.yaml
+  tax_provider_id:
+    description: The ID of the tax provider used in this region
+    nullable: true
+    type: string
+    example: null
+  tax_provider:
+    description: The details of the tax provider used in the region.
+    x-expandable: tax_provider
+    nullable: true
+    $ref: ./TaxProvider.yaml
+  payment_providers:
+    description: >-
+      The details of the payment providers that can be used to process payments
+      in the region.
+    type: array
+    x-expandable: payment_providers
+    items:
+      $ref: ./PaymentProvider.yaml
+  fulfillment_providers:
+    description: >-
+      The details of the fulfillment providers that can be used to fulfill items
+      of orders and similar resources in the region.
+    type: array
+    x-expandable: fulfillment_providers
+    items:
+      $ref: ./FulfillmentProvider.yaml
+  includes_tax:
+    description: Whether the prices for the region include tax
+    type: boolean
+    x-featureFlag: tax_inclusive_pricing
+    default: false
+  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