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,105 @@
+title: Payment Session
+description: >-
+  A Payment Session is created when a Customer initilizes the checkout flow, and
+  can be used to hold the state of a payment flow. Each Payment Session is
+  controlled by a Payment Provider, which is responsible for the communication
+  with external payment services. Authorized Payment Sessions will eventually
+  get promoted to Payments to indicate that they are authorized for payment
+  processing such as capture or refund. Payment sessions can also be used as
+  part of payment collections.
+type: object
+required:
+  - amount
+  - cart_id
+  - created_at
+  - data
+  - id
+  - is_initiated
+  - is_selected
+  - idempotency_key
+  - payment_authorized_at
+  - provider_id
+  - status
+  - updated_at
+properties:
+  id:
+    description: The payment session's ID
+    type: string
+    example: ps_01G901XNSRM2YS3ASN9H5KG3FZ
+  cart_id:
+    description: The ID of the cart that the payment session was created for.
+    nullable: true
+    type: string
+    example: cart_01G8ZH853Y6TFXWPG5EYE81X63
+  cart:
+    description: The details of the cart that the payment session was created for.
+    x-expandable: cart
+    nullable: true
+    $ref: ./Cart.yaml
+  provider_id:
+    description: The ID of the Payment Provider that is responsible for the Payment Session
+    type: string
+    example: manual
+  is_selected:
+    description: >-
+      A flag to indicate if the Payment Session has been selected as the method
+      that will be used to complete the purchase.
+    nullable: true
+    type: boolean
+    example: true
+  is_initiated:
+    description: >-
+      A flag to indicate if a communication with the third party provider has
+      been initiated.
+    type: boolean
+    default: false
+    example: true
+  status:
+    description: >-
+      Indicates the status of the Payment Session. Will default to `pending`,
+      and will eventually become `authorized`. Payment Sessions may have the
+      status of `requires_more` to indicate that further actions are to be
+      completed by the Customer.
+    type: string
+    enum:
+      - authorized
+      - pending
+      - requires_more
+      - error
+      - canceled
+    example: pending
+  data:
+    description: >-
+      The data required for the Payment Provider to identify, modify and process
+      the Payment Session. Typically this will be an object that holds an id to
+      the external payment session, but can be an empty object if the Payment
+      Provider doesn't hold any state.
+    type: object
+    example: {}
+  idempotency_key:
+    description: >-
+      Randomly generated key used to continue the completion of a cart in case
+      of failure.
+    nullable: true
+    type: string
+    externalDocs:
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
+      description: Learn more how to use the idempotency key.
+  amount:
+    description: The amount that the Payment Session has been authorized for.
+    nullable: true
+    type: integer
+    example: 100
+  payment_authorized_at:
+    description: The date with timezone at which the Payment Session was authorized.
+    nullable: true
+    type: string
+    format: date-time
+  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