chore(docs): Generated References (automated) (#9727)
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` - `notification` - `order` - `order_models` - `payment` - `pricing` - `product` - `promotion` - `region` - `sales_channel` - `stock_location_next` - `store` - `tax` - `tax_provider` - `types` - `user` - `utils` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
2313 files changed
+533036
-383477
No files matched your search
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `addCustomerToGroup` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## addCustomerToGroup(groupCustomerPair, sharedContext?): Promise<{ id: string }>
|
||||
|
||||
This method adds a customer to a group.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createCustomerAddresses` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## createCustomerAddresses(addresses, sharedContext?): Promise<[CustomerAddressDTO](../../../interfaces/customer.CustomerAddressDTO/page.mdx)[]>
|
||||
|
||||
This method adds addresses to customers.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createCustomerGroups` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## createCustomerGroups(data, sharedContext?): Promise<[CustomerGroupDTO](../../../interfaces/customer.CustomerGroupDTO/page.mdx)[]>
|
||||
|
||||
This method creates customer groups.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createCustomers` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## createCustomers(data, sharedContext?): Promise<[CustomerDTO](../../../interfaces/customer.CustomerDTO/page.mdx)[]>
|
||||
|
||||
This method creates customers.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `deleteCustomerAddresses` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## deleteCustomerAddresses(addressId, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes an address by its ID.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `deleteCustomerGroups` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## deleteCustomerGroups(groupId, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes a customer group by its ID.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `deleteCustomers` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## deleteCustomers(customerId, sharedContext?): Promise<void>
|
||||
|
||||
This method deletes a customer by its ID.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listAndCountCustomerAddresses` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of addresses along with the total count of available addresses satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listAndCountCustomerGroups` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of customer groups along with the total count of available customer groups satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listAndCountCustomers` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of customers along with the total count of available customers satisfying the provided filters.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listCustomerAddresses` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of addresses based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listCustomerGroupCustomers` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of relations between customer and groups based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listCustomerGroups` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of customer groups based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `listCustomers` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a paginated list of customers based on optional filters and configuration.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `removeCustomerFromGroup` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## removeCustomerFromGroup(groupCustomerPair, sharedContext?): Promise<void>
|
||||
|
||||
This method removes a customer from a group.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `restoreCustomerGroups` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method restores a soft deleted customer group by its IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `restoreCustomers` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method restores soft deleted customer by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `retrieveCustomer` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a customer by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `retrieveCustomerGroup` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method retrieves a customer group by its ID.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `softDeleteCustomerGroups` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method soft deletes customer groups by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `softDeleteCustomers` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
This method soft deletes customers by their IDs.
|
||||
|
||||
## Example
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateCustomerAddresses` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## updateCustomerAddresses(addressId, data, sharedContext?): Promise<[CustomerAddressDTO](../../../interfaces/customer.CustomerAddressDTO/page.mdx)>
|
||||
|
||||
This method updates an address.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateCustomerGroups` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## updateCustomerGroups(groupId, data, sharedContext?): Promise<[CustomerGroupDTO](../../../interfaces/customer.CustomerGroupDTO/page.mdx)>
|
||||
|
||||
This method updates an existing customer group.
|
||||
|
||||
+6
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateCustomers` method. This belongs to the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
## updateCustomers(customerId, data, sharedContext?): Promise<[CustomerDTO](../../../interfaces/customer.CustomerDTO/page.mdx)>
|
||||
|
||||
This method updates an existing customer.
|
||||
|
||||
+6
@@ -9,6 +9,12 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This section of the documentation provides a reference to the `ICustomerModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Customer Module.
|
||||
|
||||
<Note>
|
||||
|
||||
You should only use the methods in this reference when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||||
|
||||
</Note>
|
||||
|
||||
The main service interface for the Customer Module.
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
**Event**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../customer.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Event"/>
|
||||
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
**JoinerRelationship**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="JoinerRelationship"/>
|
||||
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
**OperatorMap**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"$and","type":"[Query](../customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OperatorMap"/>
|
||||
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
**RawMessageFormat**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"eventName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"source","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Pick<[Context](../../interfaces/customer.Context/page.mdx), \"eventGroupId\">","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="RawMessageFormat"/>
|
||||
Reference in new issue
Block a user