expresspayments/types/ApplePayDomainsResource.d.ts

ExpressPayments API wrapper

// File generated from our OpenAPI spec

declare module 'expresspayments' {
    namespace ExpressPayments {
        interface ApplePayDomainCreateParams {
            domain_name: string;

            /**
             * Specifies which fields in the response should be expanded.
             */
            expand?: Array<string>;
        }

        interface ApplePayDomainRetrieveParams {
            /**
             * Specifies which fields in the response should be expanded.
             */
            expand?: Array<string>;
        }

        interface ApplePayDomainListParams extends PaginationParams {
            domain_name?: string;

            /**
             * Specifies which fields in the response should be expanded.
             */
            expand?: Array<string>;
        }

        interface ApplePayDomainDeleteParams {}

        class ApplePayDomainsResource {
            /**
             * Create an apple pay domain.
             */
            create(
                params: ApplePayDomainCreateParams,
                options?: RequestOptions
            ): Promise<ExpressPayments.Response<ExpressPayments.ApplePayDomain>>;

            /**
             * Retrieve an apple pay domain.
             */
            retrieve(
                id: string,
                params?: ApplePayDomainRetrieveParams,
                options?: RequestOptions
            ): Promise<ExpressPayments.Response<ExpressPayments.ApplePayDomain>>;
            retrieve(
                id: string,
                options?: RequestOptions
            ): Promise<ExpressPayments.Response<ExpressPayments.ApplePayDomain>>;

            /**
             * List apple pay domains.
             */
            list(
                params?: ApplePayDomainListParams,
                options?: RequestOptions
            ): ApiListPromise<ExpressPayments.ApplePayDomain>;
            list(
                options?: RequestOptions
            ): ApiListPromise<ExpressPayments.ApplePayDomain>;

            /**
             * Delete an apple pay domain.
             */
            del(
                id: string,
                params?: ApplePayDomainDeleteParams,
                options?: RequestOptions
            ): Promise<
                ExpressPayments.Response<ExpressPayments.DeletedApplePayDomain>
            >;
            del(
                id: string,
                options?: RequestOptions
            ): Promise<
                ExpressPayments.Response<ExpressPayments.DeletedApplePayDomain>
            >;
        }
    }
}