chore: generate types docs reference manually for 2.3.0 (#11034)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-01-17 18:39:29 +02:00
1 parent 24441e48df
commit 2f7ec55f2e
452 files changed
+67793 -60853

No files matched your search

@@ -22,4 +22,4 @@ sdk.admin.payment.capture("paycol_123", {})
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The payment's details.","expandable":false,"children":[{"name":"AdminPaymentResponse","type":"[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"payment","type":"[AdminPayment](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPayment/page.mdx)","description":"The payment's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The payment's total amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment.","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":"refunds","type":"[AdminRefund](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminRefund/page.mdx)[]","description":"The associated refunds.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_collection","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)","description":"The payment collection this payment belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"[AdminPaymentSession](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentSession/page.mdx)","description":"The associated payment session.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`number`","description":"The authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit_id","type":"`string`","description":"The ID of the associated order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data relevant for the payment provider to process the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"When the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`number`","description":"The sum of the associated captures' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`number`","description":"The sum of the associated refunds' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captures","type":"[BaseCapture](../../../../../types/interfaces/types.BaseCapture/page.mdx)[]","description":"The associated captures.","optional":true,"defaultValue":"","expandable":true,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="capture"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The payment's details.","expandable":false,"children":[{"name":"AdminPaymentResponse","type":"[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"payment","type":"[AdminPayment](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPayment/page.mdx)","description":"The payment's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The payment's total amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment.","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":"refunds","type":"[AdminRefund](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminRefund/page.mdx)[]","description":"The associated refunds.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_collection","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)","description":"The payment collection this payment belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"[AdminPaymentSession](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentSession/page.mdx)","description":"The associated payment session.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`number`","description":"The authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data relevant for the payment provider to process the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"When the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`number`","description":"The sum of the associated captures' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`number`","description":"The sum of the associated refunds' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captures","type":"[BaseCapture](../../../../../types/interfaces/types.BaseCapture/page.mdx)[]","description":"The associated captures.","optional":true,"defaultValue":"","expandable":true,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="capture"/>
@@ -22,4 +22,4 @@ sdk.admin.payment.refund("paycol_123", {})
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The payment's details.","expandable":false,"children":[{"name":"AdminPaymentResponse","type":"[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"payment","type":"[AdminPayment](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPayment/page.mdx)","description":"The payment's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The payment's total amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment.","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":"refunds","type":"[AdminRefund](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminRefund/page.mdx)[]","description":"The associated refunds.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_collection","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)","description":"The payment collection this payment belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"[AdminPaymentSession](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentSession/page.mdx)","description":"The associated payment session.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`number`","description":"The authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit_id","type":"`string`","description":"The ID of the associated order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data relevant for the payment provider to process the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"When the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`number`","description":"The sum of the associated captures' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`number`","description":"The sum of the associated refunds' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captures","type":"[BaseCapture](../../../../../types/interfaces/types.BaseCapture/page.mdx)[]","description":"The associated captures.","optional":true,"defaultValue":"","expandable":true,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="refund"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The payment's details.","expandable":false,"children":[{"name":"AdminPaymentResponse","type":"[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"payment","type":"[AdminPayment](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPayment/page.mdx)","description":"The payment's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The payment's total amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment.","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":"refunds","type":"[AdminRefund](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminRefund/page.mdx)[]","description":"The associated refunds.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_collection","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)","description":"The payment collection this payment belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"[AdminPaymentSession](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentSession/page.mdx)","description":"The associated payment session.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`number`","description":"The authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data relevant for the payment provider to process the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"When the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`number`","description":"The sum of the associated captures' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`number`","description":"The sum of the associated refunds' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captures","type":"[BaseCapture](../../../../../types/interfaces/types.BaseCapture/page.mdx)[]","description":"The associated captures.","optional":true,"defaultValue":"","expandable":true,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="refund"/>
@@ -36,4 +36,4 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
## Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The payment's details.","expandable":false,"children":[{"name":"AdminPaymentResponse","type":"[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"payment","type":"[AdminPayment](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPayment/page.mdx)","description":"The payment's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The payment's total amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment.","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":"refunds","type":"[AdminRefund](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminRefund/page.mdx)[]","description":"The associated refunds.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_collection","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)","description":"The payment collection this payment belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"[AdminPaymentSession](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentSession/page.mdx)","description":"The associated payment session.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`number`","description":"The authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the associated cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit_id","type":"`string`","description":"The ID of the associated order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data relevant for the payment provider to process the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"When the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`number`","description":"The sum of the associated captures' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`number`","description":"The sum of the associated refunds' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captures","type":"[BaseCapture](../../../../../types/interfaces/types.BaseCapture/page.mdx)[]","description":"The associated captures.","optional":true,"defaultValue":"","expandable":true,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The payment's details.","expandable":false,"children":[{"name":"AdminPaymentResponse","type":"[AdminPaymentResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"payment","type":"[AdminPayment](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPayment/page.mdx)","description":"The payment's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The payment's total amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The ISO 3 character currency code of the payment.","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":"refunds","type":"[AdminRefund](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminRefund/page.mdx)[]","description":"The associated refunds.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_collection","type":"[AdminPaymentCollection](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentCollection/page.mdx)","description":"The payment collection this payment belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"[AdminPaymentSession](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminPaymentSession/page.mdx)","description":"The associated payment session.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`number`","description":"The authorized amount of the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data relevant for the payment provider to process the payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the payment was created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the payment was updated.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"When the payment was captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"When the payment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_amount","type":"`number`","description":"The sum of the associated captures' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_amount","type":"`number`","description":"The sum of the associated refunds' amounts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"captures","type":"[BaseCapture](../../../../../types/interfaces/types.BaseCapture/page.mdx)[]","description":"The associated captures.","optional":true,"defaultValue":"","expandable":true,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieve"/>