@getopenpay/client/models/CreateCustomerRequest.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { CustomerInvoiceSettings } from './CustomerInvoiceSettings';
import type { CompleteAddress } from './CompleteAddress';
import type { CustomerLanguage } from './CustomerLanguage';
/**
 *
 * @export
 * @interface CreateCustomerRequest
 */
export interface CreateCustomerRequest {
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    billingEmail?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    businessName?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    city?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    country?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    couponId?: string | null;
    /**
     *
     * @type {object}
     * @memberof CreateCustomerRequest
     */
    customFields?: object | null;
    /**
     *
     * @type {CompleteAddress}
     * @memberof CreateCustomerRequest
     */
    customerBillingAddress?: CompleteAddress | null;
    /**
     * The customer’s email address.
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    email: string;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    firstName?: string | null;
    /**
     *
     * @type {CustomerInvoiceSettings}
     * @memberof CreateCustomerRequest
     */
    invoiceSettings?: CustomerInvoiceSettings | null;
    /**
     *
     * @type {CustomerLanguage}
     * @memberof CreateCustomerRequest
     */
    language?: CustomerLanguage | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    lastName?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    line1?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    line2?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    line3?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    notes?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    phoneNumber?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    promotionCodeId?: string | null;
    /**
     * List of the customer’s shipping addresses.
     * @type {Array<CompleteAddress>}
     * @memberof CreateCustomerRequest
     */
    shippingAddresses?: Array<CompleteAddress>;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    state?: string | null;
    /**
     *
     * @type {string}
     * @memberof CreateCustomerRequest
     */
    zipCode?: string | null;
}
/**
 * Check if a given object implements the CreateCustomerRequest interface.
 */
export declare function instanceOfCreateCustomerRequest(value: object): value is CreateCustomerRequest;
export declare function CreateCustomerRequestFromJSON(json: any): CreateCustomerRequest;
export declare function CreateCustomerRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCustomerRequest;
export declare function CreateCustomerRequestToJSON(json: any): CreateCustomerRequest;
export declare function CreateCustomerRequestToJSONTyped(value?: CreateCustomerRequest | null, ignoreDiscriminator?: boolean): any;