PaymentLinks | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- PaymentLinks

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PaymentLinks(options: PaymentLinksOptions, http: Client): PaymentLinks

Overrides ThBaseHandler.constructor
- Defined in src/v0/payment_links.ts:166
Parameters
- options: PaymentLinksOptions
- http: Client
Returns PaymentLinks

Properties

endpoint

endpoint: string

http

http: Client

options

options: PaymentLinksOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/payment-links'

Methods

create

create(paymentLinkData: CreatePaymentLinkRequest): Promise<CreatePaymentLinkResponse>

- Defined in src/v0/payment_links.ts:206
Parameters
- paymentLinkData: CreatePaymentLinkRequest
Returns Promise<CreatePaymentLinkResponse>

getAll

getAll(query?: PaymentLinkQueryHandler): Promise<PaymentLinksResponse>

- Defined in src/v0/payment_links.ts:181
Parameters
- Optional query: PaymentLinkQueryHandler
Returns Promise<PaymentLinksResponse>

getById

getById(id: string): Promise<PaymentLinkDto>

- Defined in src/v0/payment_links.ts:307
Parameters
- id: string
Returns Promise<PaymentLinkDto>

getPaymentPageUrl

getPaymentPageUrl(paymentLinkId: string): Promise<PaymentPageUrlResponse>

- Defined in src/v0/payment_links.ts:271
Parameters
- paymentLinkId: string
Returns Promise<PaymentPageUrlResponse>

getQrCodeSvg

getQrCodeSvg(paymentLinkId: string): Promise<PaymentLinkQrCodeResponse>

- Defined in src/v0/payment_links.ts:289
Parameters
- paymentLinkId: string
Returns Promise<PaymentLinkQrCodeResponse>

meta

meta(query?: PaymentLinkQueryHandler): Promise<PaymentLinksResponse>

- Defined in src/v0/payment_links.ts:223
Parameters
- Optional query: PaymentLinkQueryHandler
Returns Promise<PaymentLinksResponse>

sendEmail

sendEmail(sendPaymentLinkEmailDto: SendPaymentLinkEmailDto): Promise<NotificationResponse>

- Defined in src/v0/payment_links.ts:256
Parameters
- sendPaymentLinkEmailDto: SendPaymentLinkEmailDto
Returns Promise<NotificationResponse>

sendSms

sendSms(sendSmsRequest: SendSmsRequest): Promise<NotificationResponse>

- Defined in src/v0/payment_links.ts:241
Parameters
- sendSmsRequest: SendSmsRequest
Returns Promise<NotificationResponse>

Generated using TypeDoc