docs: generated references after collapse types improvement (#11889)
This commit is contained in:
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -49,4 +49,4 @@ const accountHolder =
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AccountHolderDTO](../../../interfaces/payment.AccountHolderDTO/page.mdx)>","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<[AccountHolderDTO](../../../interfaces/payment.AccountHolderDTO/page.mdx)>","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"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -60,7 +60,7 @@ const paymentMethods =
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]>","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<[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]>","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<[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)>
|
||||
|
||||
@@ -92,4 +92,4 @@ const paymentMethod =
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)>","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<[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)>","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"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -40,7 +40,7 @@ const refundReasons =
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]>","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<[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]>","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<[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)>
|
||||
|
||||
@@ -61,4 +61,4 @@ const refundReason =
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)>","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<[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)>","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"/>
|
||||
|
||||
@@ -41,4 +41,4 @@ const dataAndAction = await paymentModuleService.getWebhookActionAndData({
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[WebhookActionResult](../../../interfaces/payment.WebhookActionResult/page.mdx)>","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<[WebhookActionResult](../../../interfaces/payment.WebhookActionResult/page.mdx)>","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"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -43,4 +43,4 @@ const paymentMethods =
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]>","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<[PaymentMethodDTO](../../../interfaces/payment.PaymentMethodDTO/page.mdx)[]>","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"/>
|
||||
|
||||
@@ -50,4 +50,4 @@ const paymentProviders =
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[PaymentProviderDTO](../../../interfaces/payment.PaymentProviderDTO/page.mdx)[]>","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<[PaymentProviderDTO](../../../interfaces/payment.PaymentProviderDTO/page.mdx)[]>","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"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -62,4 +62,4 @@ const refundReasons =
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]>","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<[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]>","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"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -46,4 +46,4 @@ const accountHolder =
|
||||
|
||||
## Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[AccountHolderDTO](../../../interfaces/payment.AccountHolderDTO/page.mdx)>","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<[AccountHolderDTO](../../../interfaces/payment.AccountHolderDTO/page.mdx)>","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"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -38,7 +38,7 @@ const refundReason =
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]>","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<[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)[]>","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<[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)>
|
||||
|
||||
@@ -48,4 +48,4 @@ const refundReason =
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[RefundReasonDTO](../../../interfaces/payment.RefundReasonDTO/page.mdx)>","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<[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"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user