Function ApplePayDomainsApiAxiosParamCreator

  • ApplePayDomainsApi - axios parameter creator

    Export

    Parameters

    Returns {
        createApplePayDomain: ((tilled_account, ApplePayDomainCreateParams, options?) => Promise<RequestArgs>);
        deleteApplePayDomain: ((id, tilled_account, options?) => Promise<RequestArgs>);
        getApplePayDomain: ((id, tilled_account, options?) => Promise<RequestArgs>);
        listApplePayDomains: ((tilled_account, offset?, limit?, options?) => Promise<RequestArgs>);
    }

    • createApplePayDomain: ((tilled_account, ApplePayDomainCreateParams, options?) => Promise<RequestArgs>)
        • (tilled_account, ApplePayDomainCreateParams, options?): Promise<RequestArgs>
        • Creates an Apple Pay Domain.

          Summary

          Create an Apple Pay Domain

          Throws

          Parameters

          • tilled_account: string

            The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

          • ApplePayDomainCreateParams: ApplePayDomainCreateParams
          • Optional options: RawAxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • deleteApplePayDomain: ((id, tilled_account, options?) => Promise<RequestArgs>)
        • (id, tilled_account, options?): Promise<RequestArgs>
        • Deletes an Apple Pay Domain. This cannot be undone.

          Summary

          Delete an Apple Pay Domain

          Throws

          Parameters

          • id: string
          • tilled_account: string

            The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

          • Optional options: RawAxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getApplePayDomain: ((id, tilled_account, options?) => Promise<RequestArgs>)
        • (id, tilled_account, options?): Promise<RequestArgs>
        • Retrieves the details of an existing Apple Pay Domain.

          Summary

          Get an Apple Pay Domain

          Throws

          Parameters

          • id: string
          • tilled_account: string

            The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

          • Optional options: RawAxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • listApplePayDomains: ((tilled_account, offset?, limit?, options?) => Promise<RequestArgs>)
        • (tilled_account, offset?, limit?, options?): Promise<RequestArgs>
        • Returns a list of registered Apple Pay Domains. The Apple Pay Domains are sorted with the most recently created appearing first.

          Summary

          List all Apple Pay Domains

          Throws

          Parameters

          • tilled_account: string

            The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

          • Optional offset: number

            The (zero-based) offset of the first item in the collection to return.

          • Optional limit: number

            The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

          • Optional options: RawAxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

Generated using TypeDoc