docs: generate references manually for 2.4.0 (#11171)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
65d8d6dc0e
commit
4ccb489dbe
444 files changed
+236833
-244966
No files matched your search
+11
@@ -0,0 +1,11 @@
|
||||
---
|
||||
displayed_sidebar: paymentReference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# FilterablePaymentMethodProps
|
||||
|
||||
The filters to apply on the retrieved payment sessions.
|
||||
|
||||
<TypeList types={[{"name":"provider_id","type":"`string`","description":"Filter the payment methods by provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PaymentProviderContext](../payment.PaymentProviderContext/page.mdx)","description":"Filter the payment methods by the context of their associated payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"billing_address","type":"Partial<[AddressDTO](../../types/payment.AddressDTO/page.mdx)>","description":"The payment's billing address.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"email","type":"`string`","description":"The associated customer's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session_id","type":"`string`","description":"The ID of payment session the provider payment is associated with.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"Partial<[CustomerDTO](../payment.CustomerDTO/page.mdx)>","description":"The customer associated with this payment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"A flag indicating if customer has an account or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_billing_address_id","type":"`null` \\| `string`","description":"The associated default billing address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_shipping_address_id","type":"`null` \\| `string`","description":"The associated default shipping address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company_name","type":"`null` \\| `string`","description":"The company name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addresses","type":"[CustomerAddressDTO](../payment.CustomerAddressDTO/page.mdx)[]","description":"The addresses of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},Line truncated
|
||||
+2
@@ -31,9 +31,11 @@ The main service interface for the Payment Module.
|
||||
- [deleteRefundReasons](../../IPaymentModuleService/methods/payment.IPaymentModuleService.deleteRefundReasons/page.mdx)
|
||||
- [getWebhookActionAndData](../../IPaymentModuleService/methods/payment.IPaymentModuleService.getWebhookActionAndData/page.mdx)
|
||||
- [listAndCountPaymentCollections](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentCollections/page.mdx)
|
||||
- [listAndCountPaymentMethods](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentMethods/page.mdx)
|
||||
- [listAndCountPaymentProviders](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentProviders/page.mdx)
|
||||
- [listCaptures](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listCaptures/page.mdx)
|
||||
- [listPaymentCollections](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentCollections/page.mdx)
|
||||
- [listPaymentMethods](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentMethods/page.mdx)
|
||||
- [listPaymentProviders](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentProviders/page.mdx)
|
||||
- [listPayments](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listPayments/page.mdx)
|
||||
- [listPaymentSessions](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentSessions/page.mdx)
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
displayed_sidebar: paymentReference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PaymentMethodDTO
|
||||
|
||||
<TypeList types={[{"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="PaymentMethodDTO"/>
|
||||
Reference in new issue
Block a user