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
--- a/www/apps/api-reference/specs/admin/components/schemas/Notification.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/Notification.yaml
@@ -0,0 +1,93 @@
+title: Notification
+description: >-
+  A notification is an alert sent, typically to customers, using the installed
+  Notification Provider as a reaction to internal events such as `order.placed`.
+  Notifications can be resent.
+type: object
+required:
+  - created_at
+  - customer_id
+  - data
+  - event_name
+  - id
+  - parent_id
+  - provider_id
+  - resource_type
+  - resource_id
+  - to
+  - updated_at
+properties:
+  id:
+    description: The notification's ID
+    type: string
+    example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
+  event_name:
+    description: The name of the event that the notification was sent for.
+    nullable: true
+    type: string
+    example: order.placed
+  resource_type:
+    description: The type of resource that the Notification refers to.
+    type: string
+    example: order
+  resource_id:
+    description: The ID of the resource that the Notification refers to.
+    type: string
+    example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+  customer_id:
+    description: The ID of the customer that this notification was sent to.
+    nullable: true
+    type: string
+    example: cus_01G2SG30J8C85S4A5CHM2S1NS2
+  customer:
+    description: The details of the customer that this notification was sent to.
+    x-expandable: customer
+    nullable: true
+    $ref: ./Customer.yaml
+  to:
+    description: >-
+      The address that the Notification was sent to. This will usually be an
+      email address, but can represent other addresses such as a chat bot user
+      ID.
+    type: string
+    example: user@example.com
+  data:
+    description: >-
+      The data that the Notification was sent with. This contains all the data
+      necessary for the Notification Provider to initiate a resend.
+    type: object
+    example: {}
+  parent_id:
+    description: The notification's parent ID
+    nullable: true
+    type: string
+    example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
+  parent_notification:
+    description: The details of the parent notification.
+    x-expandable: parent_notification
+    nullable: true
+    type: object
+  resends:
+    description: The details of all resends of the notification.
+    type: array
+    x-expandable: resends
+    items:
+      type: object
+  provider_id:
+    description: The ID of the notification provider used to send the notification.
+    nullable: true
+    type: string
+    example: sengrid
+  provider:
+    description: The notification provider used to send the notification.
+    x-expandable: provider
+    nullable: true
+    $ref: ./NotificationProvider.yaml
+  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