fix: Add missing typings around creating a payment method (#11209)
This commit is contained in:
@@ -34,6 +34,7 @@ import {
|
|||||||
UpdateRefundReasonDTO,
|
UpdateRefundReasonDTO,
|
||||||
CreateAccountHolderDTO,
|
CreateAccountHolderDTO,
|
||||||
UpsertPaymentCollectionDTO,
|
UpsertPaymentCollectionDTO,
|
||||||
|
CreatePaymentMethodDTO,
|
||||||
} from "./mutations"
|
} from "./mutations"
|
||||||
import { WebhookActionResult } from "./provider"
|
import { WebhookActionResult } from "./provider"
|
||||||
|
|
||||||
@@ -878,6 +879,78 @@ export interface IPaymentModuleService extends IModuleService {
|
|||||||
sharedContext?: Context
|
sharedContext?: Context
|
||||||
): Promise<[PaymentMethodDTO[], number]>
|
): Promise<[PaymentMethodDTO[], number]>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method creates payment methods.
|
||||||
|
*
|
||||||
|
* @param {CreatePaymentMethodDTO[]} data - The payment methods to create.
|
||||||
|
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
||||||
|
* @returns {Promise<PaymentMethodDTO[]>} The created payment methods.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* const paymentMethods =
|
||||||
|
* await paymentModuleService.createPaymentMethods([
|
||||||
|
* {
|
||||||
|
* provider_id: "pp_stripe_stripe",
|
||||||
|
* data: {
|
||||||
|
* customer_id: "cus_123",
|
||||||
|
* },
|
||||||
|
* context: {
|
||||||
|
* accountHolder: {
|
||||||
|
* data: {
|
||||||
|
* id: "acc_holder_123",
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* {
|
||||||
|
* provider_id: "pp_stripe_stripe",
|
||||||
|
* data: {
|
||||||
|
* customer_id: "cus_123",
|
||||||
|
* },
|
||||||
|
* context: {
|
||||||
|
* accountHolder: {
|
||||||
|
* data: {
|
||||||
|
* id: "acc_holder_123",
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* ])
|
||||||
|
*/
|
||||||
|
createPaymentMethods(
|
||||||
|
data: CreatePaymentMethodDTO[],
|
||||||
|
sharedContext?: Context
|
||||||
|
): Promise<PaymentMethodDTO[]>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method creates a payment method.
|
||||||
|
*
|
||||||
|
* @param {CreatePaymentMethodDTO} data - The payment method to create.
|
||||||
|
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
||||||
|
* @returns {Promise<PaymentMethodDTO>} The created payment method.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* const paymentMethod =
|
||||||
|
* await paymentModuleService.createPaymentMethods({
|
||||||
|
* provider_id: "pp_stripe_stripe",
|
||||||
|
* data: {
|
||||||
|
* customer_id: "cus_123",
|
||||||
|
* },
|
||||||
|
* context: {
|
||||||
|
* accountHolder: {
|
||||||
|
* data: {
|
||||||
|
* id: "acc_holder_123",
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* })
|
||||||
|
*/
|
||||||
|
createPaymentMethods(
|
||||||
|
data: CreatePaymentMethodDTO,
|
||||||
|
sharedContext?: Context
|
||||||
|
): Promise<PaymentMethodDTO>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method retrieves a paginated list of captures based on optional filters and configuration.
|
* This method retrieves a paginated list of captures based on optional filters and configuration.
|
||||||
*
|
*
|
||||||
|
|||||||
Reference in New Issue
Block a user