asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: generated references after collapse types improvement (#11889)

Browse Source
This commit is contained in:
Shahed Nasser
2025-03-18 16:48:43 +02:00
committed by GitHub
parent d0ca0f5ce0
commit ac24749bd3
774 changed files with 1612 additions and 1628 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.authorizePaymentSession/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.cancelPayment/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.capturePayment/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.completePaymentCollections/page.mdx
+2 -2
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.createAccountHolder/page.mdx
+1 -1
View File
@@ -49,4 +49,4 @@ const accountHolder =
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AccountHolderDTO](../../../interfaces/payment.AccountHolderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created account holder's details.","expandable":false,"children":[{"name":"AccountHolderDTO","type":"[AccountHolderDTO](../../../interfaces/payment.AccountHolderDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the account holder.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`string`","description":"The external ID of the account holder in the payment provider system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the account holder.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the account holder, as returned by the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string` \\| `Date`","description":"When the account holder was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string` \\| `Date`","description":"When the account holder was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createAccountHolder"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AccountHolderDTO](../../../interfaces/payment.AccountHolderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created account holder's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the account holder.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`string`","description":"The external ID of the account holder in the payment provider system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the account holder.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the account holder, as returned by the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string` \\| `Date`","description":"When the account holder was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string` \\| `Date`","description":"When the account holder was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createAccountHolder"/>
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.createPaymentCollections/page.mdx
+2 -2
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.createPaymentMethods/page.mdx
+2 -2
View File
@@ -60,7 +60,7 @@ const paymentMethods =
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created payment methods.","expandable":false,"children":[{"name":"PaymentMethodDTO[]","type":"[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PaymentMethodDTO","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPaymentMethods"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created payment methods.","expandable":false,"children":[{"name":"PaymentMethodDTO[]","type":"[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the payment method, as returned by the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPaymentMethods"/>
## createPaymentMethods(data, sharedContext?): Promise&#60;[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)&#62;
@@ -92,4 +92,4 @@ const paymentMethod =
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created payment method.","expandable":false,"children":[{"name":"PaymentMethodDTO","type":"[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the payment method, as returned by the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPaymentMethods"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created payment method.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the payment method, as returned by the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createPaymentMethods"/>
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.createPaymentSession/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.createRefundReasons/page.mdx
+2 -2
View File
@@ -40,7 +40,7 @@ const refundReasons =
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created refund reasons.","expandable":false,"children":[{"name":"RefundReasonDTO[]","type":"[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"RefundReasonDTO","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRefundReasons"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created refund reasons.","expandable":false,"children":[{"name":"RefundReasonDTO[]","type":"[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the refund reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the refund reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRefundReasons"/>
## createRefundReasons(data, sharedContext?): Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)&#62;
@@ -61,4 +61,4 @@ const refundReason =
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created refund reason.","expandable":false,"children":[{"name":"RefundReasonDTO","type":"[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the refund reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the refund reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRefundReasons"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created refund reason.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the refund reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the refund reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRefundReasons"/>
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.getWebhookActionAndData/page.mdx
+1 -1
View File
@@ -41,4 +41,4 @@ const dataAndAction = await paymentModuleService.getWebhookActionAndData({
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[WebhookActionResult](../../../interfaces/payment.WebhookActionResult/page.mdx)&#62;","optional":false,"defaultValue":"","description":"Resolves when the webhook event is handled successfully.","expandable":false,"children":[{"name":"WebhookActionResult","type":"[WebhookActionResult](../../../interfaces/payment.WebhookActionResult/page.mdx)","optional":false,"defaultValue":"","description":"The actions that the payment provider informs the Payment Module to perform.","expandable":false,"children":[{"name":"action","type":"[PaymentActions](../../../types/payment.PaymentActions/page.mdx)","description":"Normalized events from payment provider to internal payment module events.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"[WebhookActionData](../../../interfaces/payment.WebhookActionData/page.mdx)","description":"The webhook action's details.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"session_id","type":"`string`","description":"The associated payment session's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/payment.BigNumberValue/page.mdx)","description":"The amount to be captured or authorized (based on the action's type.)","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getWebhookActionAndData"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[WebhookActionResult](../../../interfaces/payment.WebhookActionResult/page.mdx)&#62;","optional":false,"defaultValue":"","description":"Resolves when the webhook event is handled successfully.","expandable":false,"children":[{"name":"action","type":"[PaymentActions](../../../types/payment.PaymentActions/page.mdx)","description":"Normalized events from payment provider to internal payment module events.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"[WebhookActionData](../../../interfaces/payment.WebhookActionData/page.mdx)","description":"The webhook action's details.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"session_id","type":"`string`","description":"The associated payment session's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"[BigNumberValue](../../../types/payment.BigNumberValue/page.mdx)","description":"The amount to be captured or authorized (based on the action's type.)","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getWebhookActionAndData"/>
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listCaptures/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentCollections/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentMethods/page.mdx
+1 -1
View File
@@ -43,4 +43,4 @@ const paymentMethods =
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of payment methods.","expandable":false,"children":[{"name":"PaymentMethodDTO[]","type":"[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PaymentMethodDTO","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listPaymentMethods"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of payment methods.","expandable":false,"children":[{"name":"PaymentMethodDTO[]","type":"[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the payment method, as returned by the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listPaymentMethods"/>
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentProviders/page.mdx
+1 -1
View File
@@ -50,4 +50,4 @@ const paymentProviders =
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PaymentProviderDTO](../../../interfaces/payment.PaymentProviderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of payment providers.","expandable":false,"children":[{"name":"PaymentProviderDTO[]","type":"[PaymentProviderDTO](../../../interfaces/payment.PaymentProviderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"PaymentProviderDTO","type":"`object`","description":"The payment provider details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listPaymentProviders"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[PaymentProviderDTO](../../../interfaces/payment.PaymentProviderDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of payment providers.","expandable":false,"children":[{"name":"PaymentProviderDTO[]","type":"[PaymentProviderDTO](../../../interfaces/payment.PaymentProviderDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","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":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listPaymentProviders"/>
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentSessions/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listPayments/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listRefundReasons/page.mdx
+1 -1
View File
@@ -62,4 +62,4 @@ const refundReasons =
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of refund reasons.","expandable":false,"children":[{"name":"RefundReasonDTO[]","type":"[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"RefundReasonDTO","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listRefundReasons"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of refund reasons.","expandable":false,"children":[{"name":"RefundReasonDTO[]","type":"[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the refund reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the refund reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listRefundReasons"/>
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.listRefunds/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.refundPayment/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.retrievePaymentCollection/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.retrievePaymentSession/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.updateAccountHolder/page.mdx
+1 -1
View File
@@ -46,4 +46,4 @@ const accountHolder =
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AccountHolderDTO](../../../interfaces/payment.AccountHolderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated account holder's details.","expandable":false,"children":[{"name":"AccountHolderDTO","type":"[AccountHolderDTO](../../../interfaces/payment.AccountHolderDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the account holder.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`string`","description":"The external ID of the account holder in the payment provider system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the account holder.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the account holder, as returned by the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string` \\| `Date`","description":"When the account holder was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string` \\| `Date`","description":"When the account holder was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateAccountHolder"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AccountHolderDTO](../../../interfaces/payment.AccountHolderDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated account holder's details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the account holder.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`string`","description":"The external ID of the account holder in the payment provider system.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`null` \\| `string`","description":"The email of the account holder.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data of the account holder, as returned by the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`null` \\| `string` \\| `Date`","description":"When the account holder was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`null` \\| `string` \\| `Date`","description":"When the account holder was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateAccountHolder"/>
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.updatePayment/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.updatePaymentCollections/page.mdx
+2 -2
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.updatePaymentSession/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.updateRefundReasons/page.mdx
+2 -2
View File
@@ -38,7 +38,7 @@ const refundReason =
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated refund reason.","expandable":false,"children":[{"name":"RefundReasonDTO[]","type":"[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"RefundReasonDTO","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRefundReasons"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated refund reason.","expandable":false,"children":[{"name":"RefundReasonDTO[]","type":"[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the refund reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the refund reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRefundReasons"/>
## updateRefundReasons(data, sharedContext?): Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)&#62;
@@ -48,4 +48,4 @@ const refundReason =
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"RefundReasonDTO","type":"[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the refund reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the refund reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRefundReasons"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the refund reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the refund reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRefundReasons"/>
www/apps/resources/references/payment/IPaymentModuleService/methods/payment.IPaymentModuleService.upsertPaymentCollections/page.mdx
+2 -2
View File
File diff suppressed because one or more lines are too long