chore(docs): Generated DML JSON files (#8343)

This PR holds all generated DML JSON files for the upcoming release. Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-07-30 11:47:57 +00:00
parent 70d48a91b3
commit 8a5751c115
3 changed files with 69 additions and 0 deletions
@@ -0,0 +1,13 @@
+{
+	"Currency": {
+		"filePath": "packages/modules/currency/src/models/currency.ts",
+		"properties": {
+			"code": "The ISO 3-character currency code. For example, `USD`.",
+			"symbol": "The symbol of the currency. For example, `$`.",
+			"symbol_native": "The native symbol of the currency, if it has a different local symbol.",
+			"name": "The name of the currency",
+			"decimal_digits": "How many digits are after the decimal separator for prices in this currency.",
+			"rounding": "The rounding percision of prices in this currency."
+		}
+	}
+}
@@ -0,0 +1,31 @@
+{
+	"notification provider": {
+		"filePath": "packages/modules/notification/src/models/notification-provider.ts",
+		"properties": {
+			"id": "The ID of the notification provider.",
+			"handle": "The handle of the notification provider",
+			"name": "The name of the notification provider",
+			"is_enabled": "Whether the notification provider is enabled.",
+			"channels": "The channels the notification provider can be used for. For example, `email`.",
+			"notifications": "The associated notifications.\n\n@expandable"
+		}
+	},
+	"Notification": {
+		"filePath": "packages/modules/notification/src/models/notification.ts",
+		"properties": {
+			"id": "The ID of the notification.",
+			"to": "The to of the notification",
+			"channel": "The channel of the notification. For example, `email`.",
+			"template": "The template of the notification. For example, if you're using a service like SendGrid, this would be the template ID of the notification.",
+			"data": "The data payload sent with the notification",
+			"trigger_type": "The event name, the workflow, or anything else that can help to identify what triggered the notification.",
+			"resource_id": "The ID of the resource this notification is for, if applicable.",
+			"resource_type": "The type of the resource this notification is for, if applicable. For example, `order`.",
+			"receiver_id": "The ID of the customer this notification is for, if applicable.",
+			"original_notification_id": "The ID of the original notification, in case this is a retried notification.",
+			"idempotency_key": "The idempotency key of the notification.",
+			"external_id": "The id of the notification in the external system.",
+			"provider": "The associated provider used to send the notification.\n\n@expandable"
+		}
+	}
+}
@@ -0,0 +1,25 @@
+{
+	"Region": {
+		"filePath": "packages/modules/region/src/models/region.ts",
+		"properties": {
+			"id": "The ID of the region.",
+			"name": "The name of the region",
+			"currency_code": "The ISO 3-character currency code of the region",
+			"automatic_taxes": "Whether taxes are calculated automatically during checkout in the region.",
+			"countries": "The countries that belong to the region.\n\n@expandable",
+			"metadata": "Holds custom data in key-value pairs."
+		}
+	},
+	"Country": {
+		"filePath": "packages/modules/region/src/models/country.ts",
+		"properties": {
+			"iso_2": "The ISO 2-character code of the country",
+			"iso_3": "The ISO 3-character code of the country",
+			"num_code": "The ISO numeric code of the country",
+			"name": "The name of the country",
+			"display_name": "The display name of the country",
+			"region": "The region it belongs to.\n\n@expandable",
+			"metadata": "Holds custom data in key-value pairs."
+		}
+	}
+}