From 0a40b692764cd84d31616e9d90de8820ee0ab683 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 17 Dec 2024 18:22:20 +0200 Subject: [PATCH] chore(docs): Generated DML JSON files (automated) (#10634) * chore(docs): Generated DML JSON files (automated) * fixes --------- Co-authored-by: olivermrbl Co-authored-by: Shahed Nasser --- www/utils/generated/dml-output/customer.json | 59 ++++++++++ www/utils/generated/dml-output/inventory.json | 55 +++++++++ www/utils/generated/dml-output/payment.json | 108 ++++++++++++++++++ www/utils/generated/dml-output/promotion.json | 76 ++++++++++++ .../generated/dml-output/stock-location.json | 27 +++++ www/utils/generated/dml-output/tax.json | 50 ++++++++ 6 files changed, 375 insertions(+) create mode 100644 www/utils/generated/dml-output/customer.json create mode 100644 www/utils/generated/dml-output/inventory.json create mode 100644 www/utils/generated/dml-output/payment.json create mode 100644 www/utils/generated/dml-output/promotion.json create mode 100644 www/utils/generated/dml-output/stock-location.json create mode 100644 www/utils/generated/dml-output/tax.json diff --git a/www/utils/generated/dml-output/customer.json b/www/utils/generated/dml-output/customer.json new file mode 100644 index 0000000000..035b0c06ab --- /dev/null +++ b/www/utils/generated/dml-output/customer.json @@ -0,0 +1,59 @@ +{ + "CustomerGroup": { + "filePath": "packages/modules/customer/src/models/customer-group.ts", + "properties": { + "id": "The ID of the customer group.", + "name": "The name of the customer group", + "metadata": "Holds custom data in key-value pairs.", + "created_by": "The ID of the user that created the customer group.", + "customers": "The associated customers.\n\n@expandable" + } + }, + "CustomerGroupCustomer": { + "filePath": "packages/modules/customer/src/models/customer-group-customer.ts", + "properties": { + "id": "The ID of the group-customer pairing.", + "created_by": "The ID of the user that added the customer to the group.", + "metadata": "Holds custom data in key-value pairs.", + "customer": "The associated customer.\n\n@expandable", + "customer_group": "The associated customer group.\n\n@expandable" + } + }, + "Customer": { + "filePath": "packages/modules/customer/src/models/customer.ts", + "properties": { + "id": "The ID of the customer.", + "company_name": "The company name of the customer", + "first_name": "The first name of the customer", + "last_name": "The last name of the customer", + "email": "The email of the customer", + "phone": "The phone of the customer", + "has_account": "Whether the customer has account. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/customer/customer-accounts)", + "metadata": "Holds custom data in key-value pairs.", + "created_by": "The ID of the user that created the customer.", + "groups": "The associated groups.\n\n@expandable", + "addresses": "The associated addresses.\n\n@expandable" + } + }, + "CustomerAddress": { + "filePath": "packages/modules/customer/src/models/address.ts", + "properties": { + "id": "The ID of the customer address.", + "address_name": "The name of the customer address", + "is_default_shipping": "Whether the customer address is used by default for shipping.", + "is_default_billing": "Whether the customer address is used by default for billing.", + "company": "The company of the customer address", + "first_name": "The first name of the customer address", + "last_name": "The last name of the customer address", + "address_1": "The first line of the customer address", + "address_2": "The second line of the customer address", + "city": "The city of the customer address", + "country_code": "The country code of the customer address.\n\n@example us", + "province": "The province of the customer address", + "postal_code": "The postal code of the customer address", + "phone": "The phone of the customer address", + "metadata": "Holds custom data in key-value pairs.", + "customer": "The associated customer.\n\n@expandable" + } + } +} \ No newline at end of file diff --git a/www/utils/generated/dml-output/inventory.json b/www/utils/generated/dml-output/inventory.json new file mode 100644 index 0000000000..4731d633de --- /dev/null +++ b/www/utils/generated/dml-output/inventory.json @@ -0,0 +1,55 @@ +{ + "InventoryLevel": { + "filePath": "packages/modules/inventory/src/models/inventory-level.ts", + "properties": { + "id": "The ID of the inventory level.", + "location_id": "The ID of the inventory level's location. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.", + "stocked_quantity": "The stocked quantity of the inventory level", + "reserved_quantity": "The reserved quantity of the inventory level", + "incoming_quantity": "The incoming quantity of the inventory level", + "metadata": "Holds custom data in key-value pairs.", + "inventory_item": "The associated inventory item.\n\n@expandable", + "available_quantity": "The available quantity of the inventory level" + } + }, + "ReservationItem": { + "filePath": "packages/modules/inventory/src/models/reservation-item.ts", + "properties": { + "id": "The ID of the reservation item.", + "line_item_id": "The ID of the reservation item's line item.", + "allow_backorder": "Whether the underlying item can still be ordered despite the reserved quantity.", + "location_id": "The ID of the location that the quantity is reserved from. When used with the [Stock Location Module](https://docs.medusajs.com/resources/commerce-modules/stock-location), the ID will be a `StockLocation`'s ID.", + "quantity": "The reserved quantity.", + "raw_quantity": "The raw reserved quantity.", + "external_id": "The external ID of the reservation item. Can store an ID from a third-party system.", + "description": "The description of the reservation item", + "created_by": "The ID of the user that created the reservation item.", + "metadata": "Holds custom data in key-value pairs.", + "inventory_item": "The associated inventory item.\n\n@expandable" + } + }, + "InventoryItem": { + "filePath": "packages/modules/inventory/src/models/inventory-item.ts", + "properties": { + "id": "The ID of the inventory item.", + "sku": "The SKU of the inventory item", + "origin_country": "The origin country of the inventory item", + "hs_code": "The HS code of the inventory item", + "mid_code": "The MID code of the inventory item", + "material": "The material of the inventory item", + "weight": "The weight of the inventory item", + "length": "The length of the inventory item", + "height": "The height of the inventory item", + "width": "The width of the inventory item", + "requires_shipping": "Whether the inventory item requires shipping.", + "description": "The description of the inventory item", + "title": "The title of the inventory item", + "thumbnail": "The thumbnail URL of the inventory item", + "metadata": "Holds custom data in key-value pairs.", + "location_levels": "The associated location levels.\n\n@expandable", + "reservation_items": "The associated reservation items.\n\n@expandable", + "reserved_quantity": "The reserved quantity of the inventory item", + "stocked_quantity": "The stocked quantity of the inventory item" + } + } +} \ No newline at end of file diff --git a/www/utils/generated/dml-output/payment.json b/www/utils/generated/dml-output/payment.json new file mode 100644 index 0000000000..5f757f7451 --- /dev/null +++ b/www/utils/generated/dml-output/payment.json @@ -0,0 +1,108 @@ +{ + "PaymentProvider": { + "filePath": "packages/modules/payment/src/models/payment-provider.ts", + "properties": { + "id": "The ID of the payment provider.", + "is_enabled": "Whether the payment provider is enabled.", + "payment_collections": "The associated payment collections.\n\n@expandable" + } + }, + "PaymentSession": { + "filePath": "packages/modules/payment/src/models/payment-session.ts", + "properties": { + "id": "The ID of the payment session.", + "currency_code": "The currency code of the payment session.\n\n@example usd", + "amount": "The authorized amount.", + "provider_id": "The ID of the Payment Module Provider used to process the payment.", + "data": "The data of the payment session that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)", + "context": "The context of the payment session, such as the billing address or the customer's email.", + "status": "The status of the payment session", + "authorized_at": "The date the payment session was authorized.", + "payment_collection": "The associated payment collection.\n\n@expandable", + "payment": "The associated payment.\n\n@expandable", + "metadata": "Holds custom data in key-value pairs." + } + }, + "PaymentCollection": { + "filePath": "packages/modules/payment/src/models/payment-collection.ts", + "properties": { + "id": "The ID of the payment collection.", + "currency_code": "The currency code of the payment collection.\n\n@example usd", + "amount": "The amount of the payment collection", + "authorized_amount": "The authorized amount of the payment collection", + "captured_amount": "The captured amount of the payment collection", + "refunded_amount": "The refunded amount of the payment collection", + "region_id": "The ID of the payment collection's region.", + "completed_at": "The date the payment collection was completed", + "status": "The status of the payment collection", + "metadata": "Holds custom data in key-value pairs.", + "payment_providers": "The associated payment providers.\n\n@expandable", + "payment_sessions": "The associated payment sessions.\n\n@expandable", + "payments": "The associated payments.\n\n@expandable" + } + }, + "RefundReason": { + "filePath": "packages/modules/payment/src/models/refund-reason.ts", + "properties": { + "id": "The ID of the refund reason.", + "label": "The label of the refund reason", + "description": "The description of the refund reason", + "metadata": "Holds custom data in key-value pairs.", + "refunds": "The associated refunds.\n\n@expandable" + } + }, + "Refund": { + "filePath": "packages/modules/payment/src/models/refund.ts", + "properties": { + "id": "The ID of the refund.", + "amount": "The refunded amount.", + "payment": "The associated payment.\n\n@expandable", + "refund_reason": "The associated refund reason.\n\n@expandable", + "note": "A note with more explanation about the refund", + "created_by": "The ID of the user that created the refund.", + "metadata": "Holds custom data in key-value pairs." + } + }, + "Payment": { + "filePath": "packages/modules/payment/src/models/payment.ts", + "properties": { + "id": "The ID of the payment.", + "amount": "The amount of the payment", + "currency_code": "The currency code of the payment.\n\n@example usd", + "provider_id": "The ID of the Payment Module Provider used to process the payment.", + "cart_id": "The ID of the cart this payment was created for", + "order_id": "The ID of the order this payment was created for.", + "customer_id": "The ID of the customer making the payment", + "data": "The data of the payment that's useful for processing with third-party services. Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/payment-session#data-property)", + "metadata": "Holds custom data in key-value pairs.", + "captured_at": "The date that the payment was captured.", + "canceled_at": "The date that the payment was canceled.", + "payment_collection": "The associated payment collection.\n\n@expandable", + "payment_session": "The associated payment session.\n\n@expandable", + "refunds": "The associated refunds.\n\n@expandable", + "captures": "The associated captures.\n\n@expandable" + } + }, + "Capture": { + "filePath": "packages/modules/payment/src/models/capture.ts", + "properties": { + "id": "The ID of the capture.", + "amount": "The captured amount.", + "payment": "The associated payment.\n\n@expandable", + "metadata": "Holds custom data in key-value pairs.", + "created_by": "The created by of the capture" + } + }, + "PaymentMethodToken": { + "filePath": "packages/modules/payment/src/models/payment-method-token.ts", + "properties": { + "id": "The ID of the payment method token.", + "provider_id": "The ID of the Payment Module Provider this token belongs to.", + "data": "The data of the payment method token useful for retrieving the payment details from the third-party service.", + "name": "The name of the associated saved payment method.", + "type_detail": "The details of the saved payment method's type.", + "description_detail": "The details of the saved payment method's description.", + "metadata": "Holds custom data in key-value pairs." + } + } +} \ No newline at end of file diff --git a/www/utils/generated/dml-output/promotion.json b/www/utils/generated/dml-output/promotion.json new file mode 100644 index 0000000000..01ab874a88 --- /dev/null +++ b/www/utils/generated/dml-output/promotion.json @@ -0,0 +1,76 @@ +{ + "CampaignBudget": { + "filePath": "packages/modules/promotion/src/models/campaign-budget.ts", + "properties": { + "id": "The ID of the campaign budget.", + "type": "The type of the campaign budget", + "currency_code": "The currency code of the campaign budget.\n\n@example usd", + "limit": "The limit of the campaign budget", + "used": "How much of the budget has been used. if the `limit` is `spend`, this property holds the total amount discounted so far. if the `limit` is `usage`, it holds the number of times the campaign's promotions have been used so far.", + "campaign": "The associated campaign.\n\n@expandable" + } + }, + "Campaign": { + "filePath": "packages/modules/promotion/src/models/campaign.ts", + "properties": { + "id": "The ID of the campaign.", + "name": "The name of the campaign", + "description": "The description of the campaign", + "campaign_identifier": "The campaign's identifier, such as a Google Tag ID.", + "starts_at": "The date that the campaign starts.", + "ends_at": "The date that the campaign ends.", + "budget": "The associated budget.\n\n@expandable", + "promotions": "The associated promotions.\n\n@expandable" + } + }, + "PromotionRuleValue": { + "filePath": "packages/modules/promotion/src/models/promotion-rule-value.ts", + "properties": { + "id": "The ID of the promotion rule value.", + "value": "The value of the promotion rule.", + "promotion_rule": "The associated promotion rule.\n\n@expandable" + } + }, + "PromotionRule": { + "filePath": "packages/modules/promotion/src/models/promotion-rule.ts", + "properties": { + "id": "The ID of the promotion rule.", + "description": "The description of the promotion rule", + "attribute": "The attribute of the promotion rule.\n\n@example customer_group_id", + "operator": "The operator of the promotion rule.\n\n@example in", + "values": "The associated values.\n\n@expandable", + "promotions": "The associated promotions.\n\n@expandable", + "method_target_rules": "The associated method target rules.\n\n@expandable", + "method_buy_rules": "The associated method buy rules.\n\n@expandable" + } + }, + "Promotion": { + "filePath": "packages/modules/promotion/src/models/promotion.ts", + "properties": { + "id": "The ID of the promotion.", + "code": "The code of the promotion", + "is_automatic": "Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.", + "type": "The type of the promotion", + "campaign": "The associated campaign.\n\n@expandable", + "application_method": "The associated application method.\n\n@expandable", + "rules": "The associated rules.\n\n@expandable" + } + }, + "ApplicationMethod": { + "filePath": "packages/modules/promotion/src/models/application-method.ts", + "properties": { + "id": "The ID of the application method.", + "value": "The value of the application method", + "currency_code": "The currency code of the application method.\n\n@example usd", + "max_quantity": "The max quantity allowed in the cart for the associated promotion to be applied.", + "apply_to_quantity": "The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a \"Buy 2 shirts get 1 free\", the value of this attribute is `1`.", + "buy_rules_min_quantity": "The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a \"Buy 2 shirts get 1 free\", the value of this attribute is `2`.", + "type": "The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage.", + "target_type": "Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order.", + "allocation": "How is the promotion amount discounted. `each` means the discounted amount is applied on each applicable item; `across` means the discounted amount is split accross the applicable items.", + "promotion": "The associated promotion.\n\n@expandable", + "target_rules": "The associated target rules.\n\n@expandable", + "buy_rules": "The associated buy rules.\n\n@expandable" + } + } +} \ No newline at end of file diff --git a/www/utils/generated/dml-output/stock-location.json b/www/utils/generated/dml-output/stock-location.json new file mode 100644 index 0000000000..e3f37911b5 --- /dev/null +++ b/www/utils/generated/dml-output/stock-location.json @@ -0,0 +1,27 @@ +{ + "StockLocationAddress": { + "filePath": "packages/modules/stock-location/src/models/stock-location-address.ts", + "properties": { + "id": "The ID of the stock location address.", + "address_1": "The first line of the stock location address", + "address_2": "The second line of the stock location address", + "company": "The company of the stock location address", + "city": "The city of the stock location address", + "country_code": "The country code of the stock location address.\n\n@example us", + "phone": "The phone of the stock location address", + "province": "The province of the stock location address", + "postal_code": "The postal code of the stock location address", + "metadata": "Holds custom data in key-value pairs.", + "stock_locations": "The associated stock locations.\n\n@expandable" + } + }, + "StockLocation": { + "filePath": "packages/modules/stock-location/src/models/stock-location.ts", + "properties": { + "id": "The ID of the stock location.", + "name": "The name of the stock location", + "metadata": "Holds custom data in key-value pairs.", + "address": "The associated address.\n\n@expandable" + } + } +} \ No newline at end of file diff --git a/www/utils/generated/dml-output/tax.json b/www/utils/generated/dml-output/tax.json new file mode 100644 index 0000000000..1609589123 --- /dev/null +++ b/www/utils/generated/dml-output/tax.json @@ -0,0 +1,50 @@ +{ + "TaxRateRule": { + "filePath": "packages/modules/tax/src/models/tax-rate-rule.ts", + "properties": { + "id": "The ID of the tax rate rule.", + "metadata": "Holds custom data in key-value pairs.", + "created_by": "The ID of the user that created the tax rate rule", + "tax_rate": "The associated tax rate.\n\n@expandable", + "reference": "The name of the table this rule references.\n\n@example product_type", + "reference_id": "The id of a record in the table that this rule references.\n\n@example ptyp_1" + } + }, + "TaxProvider": { + "filePath": "packages/modules/tax/src/models/tax-provider.ts", + "properties": { + "id": "The ID of the tax provider.", + "is_enabled": "Whether the tax provider is enabled.", + "regions": "The regions that use this provider to calculate taxes.\n\n@expandable" + } + }, + "TaxRegion": { + "filePath": "packages/modules/tax/src/models/tax-region.ts", + "properties": { + "id": "The ID of the tax region.", + "country_code": "The country code of the tax region.\n\n@example us", + "province_code": "The province code of the tax region", + "metadata": "Holds custom data in key-value pairs.", + "created_by": "The ID of the user that created the tax region", + "provider": "The provider that calculates taxes in this region.\n\n@expandable", + "parent": "The tax region's parent.\n\n@expandable", + "children": "The tax region's children..\n\n@expandable", + "tax_rates": "The associated tax rates.\n\n@expandable" + } + }, + "TaxRate": { + "filePath": "packages/modules/tax/src/models/tax-rate.ts", + "properties": { + "id": "The ID of the tax rate.", + "rate": "The rate to charge.\n\n@example 10", + "code": "The code the tax rate is identified by.", + "name": "The name of the tax rate", + "is_default": "Whether this tax rate is the default in the tax region.", + "is_combinable": "Whether the tax rate should be combined with parent rates. Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).", + "tax_region": "The associated tax region.\n\n@expandable", + "rules": "The associated rules.\n\n@expandable", + "metadata": "Holds custom data in key-value pairs.", + "created_by": "The ID of the user that created the tax rate" + } + } +} \ No newline at end of file