wallee/dist/models/SubscriberUpdate.d.ts

TypeScript/JavaScript client for wallee

import type { AddressCreate } from './AddressCreate';
/**
 * A subscriber represents everyone who is subscribed to a product.
 * @export
 * @interface SubscriberUpdate
 */
export interface SubscriberUpdate {
    /**
     * The merchant's reference used to identify the subscriber.
     * @type {string}
     * @memberof SubscriberUpdate
     */
    reference?: string;
    /**
     * Allow the subscriber to use these payment methods even if subscription products do not accept them.
     * @type {Array<number>}
     * @memberof SubscriberUpdate
     */
    additionalAllowedPaymentMethodConfigurations?: Array<number>;
    /**
     * Allow to store additional information about the object.
     * @type {{ [key: string]: string; }}
     * @memberof SubscriberUpdate
     */
    metaData?: {
        [key: string]: string;
    };
    /**
     * The email address that is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
     * @type {string}
     * @memberof SubscriberUpdate
     */
    emailAddress?: string;
    /**
     * Prevent the subscriber from using these payment methods even if subscription products do accept them.
     * @type {Array<number>}
     * @memberof SubscriberUpdate
     */
    disallowedPaymentMethodConfigurations?: Array<number>;
    /**
     * The description used to identify the subscriber.
     * @type {string}
     * @memberof SubscriberUpdate
     */
    description?: string;
    /**
     *
     * @type {AddressCreate}
     * @memberof SubscriberUpdate
     */
    shippingAddress?: AddressCreate;
    /**
     * The language that is used when communicating with the subscriber via emails and documents.
     * @type {string}
     * @memberof SubscriberUpdate
     */
    language?: string;
    /**
     *
     * @type {AddressCreate}
     * @memberof SubscriberUpdate
     */
    billingAddress?: AddressCreate;
    /**
     * The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     * @type {number}
     * @memberof SubscriberUpdate
     */
    version: number;
}
/**
 * Check if a given object implements the SubscriberUpdate interface.
 */
export declare function instanceOfSubscriberUpdate(value: object): value is SubscriberUpdate;
export declare function SubscriberUpdateFromJSON(json: any): SubscriberUpdate;
export declare function SubscriberUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriberUpdate;
export declare function SubscriberUpdateToJSON(json: any): SubscriberUpdate;
export declare function SubscriberUpdateToJSONTyped(value?: SubscriberUpdate | null, ignoreDiscriminator?: boolean): any;