chore(docs): Generated References (automated) (#10276)
Generated the following references: - `api_key` - `auth` - `cart` - `core_flows` - `currency` - `customer` - `dml` - `fulfillment` - `helper_steps` - `inventory_next` - `js_sdk` - `medusa` - `medusa_config` - `modules` - `modules_sdk` - `order` - `payment` - `payment_provider` - `pricing` - `product` - `product_models` - `promotion` - `region` - `sales_channel` - `search` - `stock_location_next` - `store` - `tax` - `tax_provider` - `types` - `user` - `utils` - `workflows` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and 
GitHub committed
1 parent
67e2e718e9
commit
d5ee0070b4
928 files changed
+182409
-172163
No files matched your search
@@ -13,4 +13,4 @@ which provides correct typing of field names in its properties.
|
||||
|
||||
<TypeList types={[{"name":"Entity","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
|
||||
|
||||
<TypeList types={[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
|
||||
<TypeList types={[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../types/tax.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
|
||||
@@ -6,15 +6,17 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# IBigNumber
|
||||
|
||||
## Properties
|
||||
|
||||
- [numeric](page.mdx#numeric)
|
||||
- [raw](page.mdx#raw)
|
||||
- [bigNumber](page.mdx#bignumber)
|
||||
|
||||
## Methods
|
||||
|
||||
- [toJSON](../../IBigNumber/methods/tax.IBigNumber.toJSON/page.mdx)
|
||||
- [valueOf](../../IBigNumber/methods/tax.IBigNumber.valueOf/page.mdx)
|
||||
|
||||
<TypeList types={[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/tax.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IBigNumber"/>
|
||||
## Properties
|
||||
|
||||
- [bigNumber](page.mdx#bignumber)
|
||||
- [numeric](page.mdx#numeric)
|
||||
- [raw](page.mdx#raw)
|
||||
|
||||
___
|
||||
|
||||
<TypeList types={[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/tax.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IBigNumber"/>
|
||||
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Methods
|
||||
|
||||
- [save](../../IMessageAggregator/methods/tax.IMessageAggregator.save/page.mdx)
|
||||
- [getMessages](../../IMessageAggregator/methods/tax.IMessageAggregator.getMessages/page.mdx)
|
||||
- [clearMessages](../../IMessageAggregator/methods/tax.IMessageAggregator.clearMessages/page.mdx)
|
||||
- [getMessages](../../IMessageAggregator/methods/tax.IMessageAggregator.getMessages/page.mdx)
|
||||
- [save](../../IMessageAggregator/methods/tax.IMessageAggregator.save/page.mdx)
|
||||
- [saveRawMessageData](../../IMessageAggregator/methods/tax.IMessageAggregator.saveRawMessageData/page.mdx)
|
||||
@@ -6,12 +6,14 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# IModuleService
|
||||
|
||||
## Properties
|
||||
|
||||
- [\_\_hooks](page.mdx#__hooks)
|
||||
|
||||
## Methods
|
||||
|
||||
- [\_\_joinerConfig](../../IModuleService/methods/tax.IModuleService.__joinerConfig/page.mdx)
|
||||
|
||||
## Properties
|
||||
|
||||
- [\_\_hooks](page.mdx#__hooks)
|
||||
|
||||
___
|
||||
|
||||
<TypeList types={[{"name":"__hooks","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"onApplicationStart","type":"() => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IModuleService"/>
|
||||
@@ -19,24 +19,24 @@ The main service interface for the Tax Module.
|
||||
|
||||
## Methods
|
||||
|
||||
- [retrieveTaxRate](../../ITaxModuleService/methods/tax.ITaxModuleService.retrieveTaxRate/page.mdx)
|
||||
- [listTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.listTaxRates/page.mdx)
|
||||
- [listAndCountTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.listAndCountTaxRates/page.mdx)
|
||||
- [createTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.createTaxRates/page.mdx)
|
||||
- [updateTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRates/page.mdx)
|
||||
- [upsertTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.upsertTaxRates/page.mdx)
|
||||
- [deleteTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.deleteTaxRates/page.mdx)
|
||||
- [restoreTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.restoreTaxRates/page.mdx)
|
||||
- [createTaxRegions](../../ITaxModuleService/methods/tax.ITaxModuleService.createTaxRegions/page.mdx)
|
||||
- [updateTaxRegions](../../ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRegions/page.mdx)
|
||||
- [deleteTaxRegions](../../ITaxModuleService/methods/tax.ITaxModuleService.deleteTaxRegions/page.mdx)
|
||||
- [listTaxRegions](../../ITaxModuleService/methods/tax.ITaxModuleService.listTaxRegions/page.mdx)
|
||||
- [createTaxRateRules](../../ITaxModuleService/methods/tax.ITaxModuleService.createTaxRateRules/page.mdx)
|
||||
- [createTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.createTaxRates/page.mdx)
|
||||
- [createTaxRegions](../../ITaxModuleService/methods/tax.ITaxModuleService.createTaxRegions/page.mdx)
|
||||
- [deleteTaxRateRules](../../ITaxModuleService/methods/tax.ITaxModuleService.deleteTaxRateRules/page.mdx)
|
||||
- [listTaxRateRules](../../ITaxModuleService/methods/tax.ITaxModuleService.listTaxRateRules/page.mdx)
|
||||
- [deleteTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.deleteTaxRates/page.mdx)
|
||||
- [deleteTaxRegions](../../ITaxModuleService/methods/tax.ITaxModuleService.deleteTaxRegions/page.mdx)
|
||||
- [getTaxLines](../../ITaxModuleService/methods/tax.ITaxModuleService.getTaxLines/page.mdx)
|
||||
- [listAndCountTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.listAndCountTaxRates/page.mdx)
|
||||
- [listTaxRateRules](../../ITaxModuleService/methods/tax.ITaxModuleService.listTaxRateRules/page.mdx)
|
||||
- [listTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.listTaxRates/page.mdx)
|
||||
- [listTaxRegions](../../ITaxModuleService/methods/tax.ITaxModuleService.listTaxRegions/page.mdx)
|
||||
- [restoreTaxRateRules](../../ITaxModuleService/methods/tax.ITaxModuleService.restoreTaxRateRules/page.mdx)
|
||||
- [restoreTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.restoreTaxRates/page.mdx)
|
||||
- [restoreTaxRegions](../../ITaxModuleService/methods/tax.ITaxModuleService.restoreTaxRegions/page.mdx)
|
||||
- [retrieveTaxRate](../../ITaxModuleService/methods/tax.ITaxModuleService.retrieveTaxRate/page.mdx)
|
||||
- [softDeleteTaxRateRules](../../ITaxModuleService/methods/tax.ITaxModuleService.softDeleteTaxRateRules/page.mdx)
|
||||
- [softDeleteTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.softDeleteTaxRates/page.mdx)
|
||||
- [softDeleteTaxRegions](../../ITaxModuleService/methods/tax.ITaxModuleService.softDeleteTaxRegions/page.mdx)
|
||||
- [restoreTaxRegions](../../ITaxModuleService/methods/tax.ITaxModuleService.restoreTaxRegions/page.mdx)
|
||||
- [softDeleteTaxRateRules](../../ITaxModuleService/methods/tax.ITaxModuleService.softDeleteTaxRateRules/page.mdx)
|
||||
- [restoreTaxRateRules](../../ITaxModuleService/methods/tax.ITaxModuleService.restoreTaxRateRules/page.mdx)
|
||||
- [updateTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRates/page.mdx)
|
||||
- [updateTaxRegions](../../ITaxModuleService/methods/tax.ITaxModuleService.updateTaxRegions/page.mdx)
|
||||
- [upsertTaxRates](../../ITaxModuleService/methods/tax.ITaxModuleService.upsertTaxRates/page.mdx)
|
||||
@@ -9,4 +9,4 @@ import { TypeList } from "docs-ui"
|
||||
The context provided when tax lines are calculated and retrieved. This
|
||||
context is later passed to the underlying tax provider.
|
||||
|
||||
<TypeList types={[{"name":"address","type":"`object`","description":"The customer's address","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"country_code","type":"`string`","description":"The ISO 2 character currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The second line of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer","type":"`object`","description":"The customer's details.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"`string`[]","description":"The groups that the customer belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_return","type":"`boolean`","description":"Whether the tax lines are calculated for an order return.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="TaxCalculationContext"/>
|
||||
<TypeList types={[{"name":"address","type":"`object`","description":"The customer's address","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"country_code","type":"`string`","description":"The ISO 2 character currency code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"The province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"The first line of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The second line of the address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Address metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer","type":"`object`","description":"The customer's details.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"`string`[]","description":"The groups that the customer belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Customer metadata.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_return","type":"`boolean`","description":"Whether the tax lines are calculated for an order return.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="TaxCalculationContext"/>
|
||||
Reference in new issue
Block a user