Function ApplePayDomainsApiFp

Returns {
    createApplePayDomain(tilled_account, ApplePayDomainCreateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<ApplePayDomain>)>;
    deleteApplePayDomain(id, tilled_account, options?) => Promise<((axios?, basePath?) => AxiosPromise<object>)>;
    getApplePayDomain(id, tilled_account, options?) => Promise<((axios?, basePath?) => AxiosPromise<ApplePayDomain>)>;
    listApplePayDomains(tilled_account, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListApplePayDomains200Response>)>;
}

• createApplePayDomain:function

  • createApplePayDomain(tilled_account, ApplePayDomainCreateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<ApplePayDomain>)>

  • 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<((axios?, basePath?) => AxiosPromise<ApplePayDomain>)>

• deleteApplePayDomain:function

  • deleteApplePayDomain(id, tilled_account, options?): Promise<((axios?, basePath?) => AxiosPromise<object>)>

  • 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<((axios?, basePath?) => AxiosPromise<object>)>

• getApplePayDomain:function

  • getApplePayDomain(id, tilled_account, options?): Promise<((axios?, basePath?) => AxiosPromise<ApplePayDomain>)>

  • 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<((axios?, basePath?) => AxiosPromise<ApplePayDomain>)>

• listApplePayDomains:function

  • listApplePayDomains(tilled_account, offset?, limit?, options?): Promise<((axios?, basePath?) => AxiosPromise<ListApplePayDomains200Response>)>

  • 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<((axios?, basePath?) => AxiosPromise<ListApplePayDomains200Response>)>