Class PaymentsClient

Hierarchy

GhlClient
- PaymentsClient

Index

Constructors

Methods

createWhiteLabelIntegrationProvider findWhiteLabelIntegrationProviders findOrders findOrderById createOrderFullfillment findOrderFullfillments findTransactions findTransactionById findSubscriptions findSubscriptionById createCustomIntegrationProvider removeCustomIntegrationProvider findCustomIntegrationConnection connectCustomIntegration disconnectCustomIntegration

Constructors

constructor

new PaymentsClient(accessToken: string): PaymentsClient
Parameters
- accessToken: string
Returns PaymentsClient
Overrides GhlClient.constructor
- Defined in payments/payments.client.ts:26

Methods

createWhiteLabelIntegrationProvider

createWhiteLabelIntegrationProvider(
dto: CreateWhiteLabelIntegrationProviderDto,
): Promise<PaymentIntegrationProvider>
Parameters
- dto: CreateWhiteLabelIntegrationProviderDto
Returns Promise<PaymentIntegrationProvider>
- Defined in payments/payments.client.ts:30

findWhiteLabelIntegrationProviders

findWhiteLabelIntegrationProviders(
params: IntegrationProviderSearchParams,
): Promise<ListIntegrationProvidersResponse>
Parameters
- params: IntegrationProviderSearchParams
Returns Promise<ListIntegrationProvidersResponse>
- Defined in payments/payments.client.ts:39

findOrders

findOrders(params: OrderSearchParams): Promise<ListOrdersResponse>
Parameters
- params: OrderSearchParams
Returns Promise<ListOrdersResponse>
- Defined in payments/payments.client.ts:48

findOrderById

findOrderById(orderId: string, locationId: string): Promise<Order>
Parameters
- orderId: string
- locationId: string
Returns Promise<Order>
- Defined in payments/payments.client.ts:54

createOrderFullfillment

createOrderFullfillment(
orderId: string,
dto: CreateOrderFulfillmentDto,
): Promise<OrderFulfillmentResponse>
Parameters
- orderId: string
- dto: CreateOrderFulfillmentDto
Returns Promise<OrderFulfillmentResponse>
- Defined in payments/payments.client.ts:63

findOrderFullfillments

findOrderFullfillments(
orderId: string,
locationId: string,
): Promise<OrderFulfillmentResponse>
Parameters
- orderId: string
- locationId: string
Returns Promise<OrderFulfillmentResponse>
- Defined in payments/payments.client.ts:73

findTransactions

findTransactions(
params: TransactionSearchParams,
): Promise<ListTransactionsResponse>
Parameters
- params: TransactionSearchParams
Returns Promise<ListTransactionsResponse>
- Defined in payments/payments.client.ts:83

findTransactionById

findTransactionById(
transactionId: string,
locationId: string,
): Promise<TransactionDetailsResponse>
Parameters
- transactionId: string
- locationId: string
Returns Promise<TransactionDetailsResponse>
- Defined in payments/payments.client.ts:91

findSubscriptions

findSubscriptions(
params: SubscriptionSearchParams,
): Promise<ListSubscriptionsResponse>
Parameters
- params: SubscriptionSearchParams
Returns Promise<ListSubscriptionsResponse>
- Defined in payments/payments.client.ts:101

findSubscriptionById

findSubscriptionById(
subscriptionId: string,
locationId: string,
): Promise<SubscriptionDetailsReponse>
Parameters
- subscriptionId: string
- locationId: string
Returns Promise<SubscriptionDetailsReponse>
- Defined in payments/payments.client.ts:109

createCustomIntegrationProvider

createCustomIntegrationProvider(
locationId: string,
dto: CreateCustomIntegrationProviderDto,
): Promise<CustomIntegrationProviderResponse>
Parameters
- locationId: string
- dto: CreateCustomIntegrationProviderDto
Returns Promise<CustomIntegrationProviderResponse>
- Defined in payments/payments.client.ts:119

removeCustomIntegrationProvider

removeCustomIntegrationProvider(
locationId: string,
): Promise<SuccessDeleteResponse>
Parameters
- locationId: string
Returns Promise<SuccessDeleteResponse>
- Defined in payments/payments.client.ts:130

findCustomIntegrationConnection

findCustomIntegrationConnection(
locationId: string,
): Promise<CustomIntegrationProviderResponse>
Parameters
- locationId: string
Returns Promise<CustomIntegrationProviderResponse>
- Defined in payments/payments.client.ts:139

connectCustomIntegration

connectCustomIntegration(
locationId: string,
dto: CustomIntegrationProviderConnectDetails,
): Promise<CustomIntegrationProviderResponse>
Parameters
- locationId: string
- dto: CustomIntegrationProviderConnectDetails
Returns Promise<CustomIntegrationProviderResponse>
- Defined in payments/payments.client.ts:148

disconnectCustomIntegration

disconnectCustomIntegration(
locationId: string,
liveMode: boolean,
): Promise<DisconnectCustomIntegrationProviderResponse>
Parameters
- locationId: string
- liveMode: boolean
Returns Promise<DisconnectCustomIntegrationProviderResponse>
- Defined in payments/payments.client.ts:159