Class PayerInvitesApi

PayerInvitesApi - object-oriented interface export PayerInvitesApi

Hierarchy (view full)

BaseAPI
- PayerInvitesApi

Index

Constructors

Properties

axios basePath configuration

Methods

acceptPayerInvite getPayerInviteById getPayerInviteProfile listPayerInvites sendPayerInvite

Constructors

constructor

new PayerInvitesApi(configuration?, basePath?, axios?): PayerInvitesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PayerInvitesApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

acceptPayerInvite

acceptPayerInvite(paymentInviteAcceptCreateDeets?, options?): Promise<AxiosResponse<PayerInviteResponse, any>>
summary Accept payer invite
Parameters
- OptionalpaymentInviteAcceptCreateDeets: PaymentInviteAcceptCreateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PayerInviteResponse, any>>
Throws
memberof PayerInvitesApi
- Defined in src/api/api.ts:19278

getPayerInviteById

getPayerInviteById(id, options?): Promise<AxiosResponse<PayerInviteResponse, any>>
summary Get payer invite details by id
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PayerInviteResponse, any>>
Throws
memberof PayerInvitesApi
- Defined in src/api/api.ts:19290

getPayerInviteProfile

getPayerInviteProfile(options?): Promise<AxiosResponse<PayerInviteProfileResponse, any>>
summary Get the current user payer profile
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PayerInviteProfileResponse, any>>
Throws
memberof PayerInvitesApi
- Defined in src/api/api.ts:19301

listPayerInvites

listPayerInvites(emailAddress?, inviteStatus?, limit?, page?, userId?, options?): Promise<AxiosResponse<PayerInviteResponseListResponse, any>>
summary Retrieve a list of sent payer invites
Parameters
- OptionalemailAddress: string
- OptionalinviteStatus: PayerInviteStatus
  sent accepted expired
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PayerInviteResponseListResponse, any>>
Throws
memberof PayerInvitesApi
- Defined in src/api/api.ts:19317

sendPayerInvite

sendPayerInvite(paymentInviteCreateDeets?, options?): Promise<AxiosResponse<PayerInviteResponse, any>>
summary Send payer invite request.
Parameters
- OptionalpaymentInviteCreateDeets: PaymentInviteCreateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PayerInviteResponse, any>>
Throws
memberof PayerInvitesApi
- Defined in src/api/api.ts:19329