From 29e463e8c34acd710046f0eaebbe631049bb9143 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 4 Dec 2024 20:26:43 +0200 Subject: [PATCH] chore(docs): Generated DML JSON files (automated) (#10436) * chore(docs): Generated DML JSON files (automated) * fixes --------- Co-authored-by: olivermrbl Co-authored-by: Shahed Nasser --- www/utils/generated/dml-output/auth.json | 21 +++++++ www/utils/generated/dml-output/pricing.json | 68 +++++++++++++++++++++ www/utils/generated/dml-output/product.json | 2 +- www/utils/generated/dml-output/user.json | 24 ++++++++ 4 files changed, 114 insertions(+), 1 deletion(-) create mode 100644 www/utils/generated/dml-output/auth.json create mode 100644 www/utils/generated/dml-output/pricing.json create mode 100644 www/utils/generated/dml-output/user.json diff --git a/www/utils/generated/dml-output/auth.json b/www/utils/generated/dml-output/auth.json new file mode 100644 index 0000000000..ff588ccfe1 --- /dev/null +++ b/www/utils/generated/dml-output/auth.json @@ -0,0 +1,21 @@ +{ + "ProviderIdentity": { + "filePath": "packages/modules/auth/src/models/provider-identity.ts", + "properties": { + "id": "The ID of the provider identity.", + "entity_id": "The entity ID of the provider identity", + "provider": "The ID of the provider that created this identity.", + "auth_identity": "The associated `AuthIdentity`.\n\n@expandable", + "user_metadata": "The user metadata of the provider identity.", + "provider_metadata": "The provider metadata of the provider identity." + } + }, + "AuthIdentity": { + "filePath": "packages/modules/auth/src/models/auth-identity.ts", + "properties": { + "id": "The ID of the auth identity.", + "provider_identities": "The associated `ProviderIdentity` records.\n\n@expandable", + "app_metadata": "The app metadata of the auth identity" + } + } +} \ No newline at end of file diff --git a/www/utils/generated/dml-output/pricing.json b/www/utils/generated/dml-output/pricing.json new file mode 100644 index 0000000000..9fd77057aa --- /dev/null +++ b/www/utils/generated/dml-output/pricing.json @@ -0,0 +1,68 @@ +{ + "PriceListRule": { + "filePath": "packages/modules/pricing/src/models/price-list-rule.ts", + "properties": { + "id": "The ID of the price list rule.", + "attribute": "The attribute of the price list rule. For example, `region_id`.", + "value": "The value of the price list rule. For example, `reg_123`.", + "price_list": "The associated `PriceList`.\n\n@expandable" + } + }, + "PriceList": { + "filePath": "packages/modules/pricing/src/models/price-list.ts", + "properties": { + "id": "The ID of the price list.", + "title": "The title of the price list.", + "description": "The description of the price list.", + "status": "The status of the price list.", + "type": "The type of the price list.", + "starts_at": "The date the price list starts.", + "ends_at": "The date the price list ends.", + "rules_count": "The total number of rules of the price list.", + "prices": "The associated `Price` records.\n\n@expandable", + "price_list_rules": "The associated `PriceListRule` records.\n\n@expandable" + } + }, + "PriceRule": { + "filePath": "packages/modules/pricing/src/models/price-rule.ts", + "properties": { + "id": "The ID of the price rule.", + "attribute": "The attribute of the price rule. For example, `region_id`.", + "value": "The value of the price rule. For example, `reg_123`.", + "operator": "The operator of the price rule. For example, `eq`.", + "priority": "The priority of the price rule.", + "price": "The associated `Price`.\n\n@expandable" + } + }, + "PriceSet": { + "filePath": "packages/modules/pricing/src/models/price-set.ts", + "properties": { + "id": "The ID of the price set.", + "prices": "The associated `Price` records.\n\n@expandable" + } + }, + "Price": { + "filePath": "packages/modules/pricing/src/models/price.ts", + "properties": { + "id": "The ID of the price.", + "title": "The title of the price", + "currency_code": "The currency code of the price. For example, `usd`.", + "amount": "The amount of the price.", + "min_quantity": "The minimum quantity that must be available in the cart for the price to be applied.", + "max_quantity": "The maximum quantity allowed to be available in the cart for the price to be applied.", + "rules_count": "The total number of rules of the price.", + "price_set": "The associated `PriceSet`.\n\n@expandable", + "price_rules": "The associated `PriceRule` records.\n\n@expandable", + "price_list": "The associated `PriceList`.\n\n@expandable" + } + }, + "PricePreference": { + "filePath": "packages/modules/pricing/src/models/price-preference.ts", + "properties": { + "id": "The ID of the price preference.", + "attribute": "The attribute of the price preference. For example, `region_id`.", + "value": "The value of the price preference. For example, `reg_123`.", + "is_tax_inclusive": "Whether prices matching this preference include taxes." + } + } +} \ No newline at end of file diff --git a/www/utils/generated/dml-output/product.json b/www/utils/generated/dml-output/product.json index a46f1e4285..c5c68b40c1 100644 --- a/www/utils/generated/dml-output/product.json +++ b/www/utils/generated/dml-output/product.json @@ -130,4 +130,4 @@ "categories": "The associated categories.\n\n@expandable" } } -} +} \ No newline at end of file diff --git a/www/utils/generated/dml-output/user.json b/www/utils/generated/dml-output/user.json new file mode 100644 index 0000000000..34b8d52eba --- /dev/null +++ b/www/utils/generated/dml-output/user.json @@ -0,0 +1,24 @@ +{ + "User": { + "filePath": "packages/modules/user/src/models/user.ts", + "properties": { + "id": "The ID of the user.", + "first_name": "The first name of the user.", + "last_name": "The last name of the user.", + "email": "The email of the user.", + "avatar_url": "The image URL of the user's avatar.", + "metadata": "Holds custom data in key-value pairs." + } + }, + "Invite": { + "filePath": "packages/modules/user/src/models/invite.ts", + "properties": { + "id": "The ID of the invite.", + "email": "The email of the invited user.", + "accepted": "Whether the invite is accepted.", + "token": "The token of the invite.", + "expires_at": "When the invite expires.", + "metadata": "Holds custom data in key-value pairs." + } + } +} \ No newline at end of file