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>
2024-10-24 09:41:14 +00:00
1 parent e196ad7659
commit 5deeae060a
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `authorizePaymentSession` method. This belongs to the Payment 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 authorizes a payment session using its associated payment provider. This creates a payment that can later be captured.

 Learn more about the payment flow in [this guide](https://docs.medusajs.com/experimental/payment/payment-flow/)
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `cancelPayment` method. This belongs to the Payment 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 cancels a payment.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `capturePayment` method. This belongs to the Payment 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 captures a payment using its associated payment provider.

 Learn more about the payment flow in [this guide](https://docs.medusajs.com/experimental/payment/payment-flow/)
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `completePaymentCollections` method. This belongs to the Payment Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## completePaymentCollections(paymentCollectionId, sharedContext?): Promise&#60;[PaymentCollectionDTO](../../../interfaces/payment.PaymentCollectionDTO/page.mdx)&#62;

 This method marks a payment collection as completed by settings its `completed_at` field to the current date and time.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `createPaymentCollections` method. This belongs to the Payment Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## createPaymentCollections(data, sharedContext?): Promise&#60;[PaymentCollectionDTO](../../../interfaces/payment.PaymentCollectionDTO/page.mdx)[]&#62;

 This method creates payment collections.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `createPaymentSession` method. This belongs to the Payment 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 creates a payment session in a payment collection.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `createRefundReasons` method. This belongs to the Payment Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## createRefundReasons(data, sharedContext?): Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]&#62;

 This method creates refund reasons.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deletePaymentCollections` method. This belongs to the Payment Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deletePaymentCollections(paymentCollectionId, sharedContext?): Promise&#60;void&#62;

 This method deletes a payment collection by its ID.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deletePaymentSession` method. This belongs to the Payment 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 deletes a payment session.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `deleteRefundReasons` method. This belongs to the Payment Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## deleteRefundReasons(refundReasonId, sharedContext?): Promise&#60;void&#62;

 This method deletes a refund reason by its ID.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `getWebhookActionAndData` method. This belongs to the Payment 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 webhook event data with the associated payment provider.

 Learn more about handling webhook events in [this guide](https://docs.medusajs.com/experimental/payment/webhook-events/)
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listAndCountPaymentCollections` method. This belongs to the Payment 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 payment collections along with the total count of available payment collections satisfying the provided filters.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listAndCountPaymentProviders` method. This belongs to the Payment Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## Parameters

 <TypeList types={[{"name":"filters","type":"[FilterablePaymentProviderProps](../../../interfaces/payment.FilterablePaymentProviderProps/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([PaymentProviderDTO](../../../interfaces/payment.PaymentProviderDTO/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[PaymentProviderDTO](../../../interfaces/payment.PaymentProviderDTO/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([PaymentProviderDTO](../../../interfaces/payment.PaymentProviderDTO/page.mdx) \\| [BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;[PaymentProviderDTO](../../../interfaces/payment.PaymentProviderDTO/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/payment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/payment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the payment provider by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../types/payment.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../types/payment.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../types/payment.ExpandScalar/page.mdx)&#60;T&#62; \\| [ExpandScalar](../../../types/payment.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../types/payment.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../types/payment.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../types/payment.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../types/payment.Query/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../types/payment.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../types/payment.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../types/payment.ExLine truncated
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listCaptures` method. This belongs to the Payment 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 captures based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listPaymentCollections` method. This belongs to the Payment 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 payment collections based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listPaymentProviders` method. This belongs to the Payment 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 payment providers based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listPaymentSessions` method. This belongs to the Payment 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 payment sessions based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listPayments` method. This belongs to the Payment 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 payments based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listRefundReasons` method. This belongs to the Payment 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 refund reasons based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `listRefunds` method. This belongs to the Payment 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 refunds based on optional filters and configuration.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `refundPayment` method. This belongs to the Payment 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 refunds a payment using its associated payment provider. An amount can only be refunded if it has been captured first.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `restorePaymentCollections` method. This belongs to the Payment 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 payment collection by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `restoreRefundReasons` method. This belongs to the Payment 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 refund reason by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `retrievePaymentCollection` method. This belongs to the Payment 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 payment collection by its ID.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `retrievePaymentSession` method. This belongs to the Payment Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## Parameters

 <TypeList types={[{"name":"paymentSessionId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/payment.FindConfig/page.mdx)&#60;[PaymentSessionDTO](../../../interfaces/payment.PaymentSessionDTO/page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"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":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/payment.Context/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","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":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/payment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrievePaymentSession"/>
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `softDeletePaymentCollections` method. This belongs to the Payment 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 payment collections by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `softDeleteRefundReasons` method. This belongs to the Payment 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 refund reasons by their IDs.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updatePayment` method. This belongs to the Payment 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 updates an existing payment.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updatePaymentCollections` method. This belongs to the Payment Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## updatePaymentCollections(paymentCollectionId, data, sharedContext?): Promise&#60;[PaymentCollectionDTO](../../../interfaces/payment.PaymentCollectionDTO/page.mdx)&#62;

 This method updates an existing payment collection.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updatePaymentSession` method. This belongs to the Payment 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 updates a payment session.

 ## Example
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `updateRefundReasons` method. This belongs to the Payment Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## updateRefundReasons(data, sharedContext?): Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]&#62;

 This method updates an existing refund reason.
@@ -10,6 +10,12 @@ import { TypeList } from "docs-ui"

 This documentation provides a reference to the `upsertPaymentCollections` method. This belongs to the Payment Module.

+<Note>
+
+You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
+
+</Note>
+
 ## upsertPaymentCollections(data, sharedContext?): Promise&#60;[PaymentCollectionDTO](../../../interfaces/payment.PaymentCollectionDTO/page.mdx)[]&#62;

 This method updates or creates payment collections if they don't exist.
@@ -9,6 +9,12 @@ import { TypeList } from "docs-ui"

 This section of the documentation provides a reference to the `IPaymentModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Payment 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 Payment Module.

 ## Methods
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"

 **AddressDTO**: `Object`

-## Properties
-
 <TypeList types={[{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AddressDTO"/>
@@ -8,6 +8,4 @@ import { TypeList } from "docs-ui"

 **BigNumberRawValue**: `Object`

-## Properties
-
 <TypeList types={[{"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="BigNumberRawValue"/>
@@ -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](../payment.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](../payment.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../payment.Query/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../payment.ExpandScalar/page.mdx)&#60;T&#62; \\| [ExpandScalar](../payment.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../payment.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../payment.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../payment.ExpandScalar/page.mdx)&#60;T&#62;[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../payment.Query/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../payment.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../payment.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../payment.ExpandScalar/page.mdx)&#60;T&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../payment.ExpandScalar/page.mdx)&#60;T&#62;","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&#60;[Context](../../interfaces/payment.Context/page.mdx), \"eventGroupId\"&#62;","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"/>