Function PayerInvitesApiAxiosParamCreator

PayerInvitesApi - axios parameter creator export

  • PayerInvitesApiAxiosParamCreator(configuration?): {
        acceptPayerInvite: ((paymentInviteAcceptCreateDeets?: PaymentInviteAcceptCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPayerInviteById: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPayerInviteProfile: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        listPayerInvites: ((emailAddress?: string, inviteStatus?: PayerInviteStatus, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        sendPayerInvite: ((paymentInviteCreateDeets?: PaymentInviteCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        acceptPayerInvite: ((paymentInviteAcceptCreateDeets?: PaymentInviteAcceptCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPayerInviteById: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPayerInviteProfile: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        listPayerInvites: ((emailAddress?: string, inviteStatus?: PayerInviteStatus, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        sendPayerInvite: ((paymentInviteCreateDeets?: PaymentInviteCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • acceptPayerInvite: ((paymentInviteAcceptCreateDeets?: PaymentInviteAcceptCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Accept payer invite

      Throws

    • getPayerInviteById: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Get payer invite details by id

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPayerInviteProfile: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Get the current user payer profile

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • listPayerInvites: ((emailAddress?: string, inviteStatus?: PayerInviteStatus, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retrieve a list of sent payer invites

      Throws

        • (emailAddress?, inviteStatus?, limit?, page?, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • sendPayerInvite: ((paymentInviteCreateDeets?: PaymentInviteCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Send payer invite request.

      Throws

Settings

Member Visibility