@getopenpay/client/models/CouponExternal.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 { CouponDuration } from './CouponDuration';
import type { CurrencyEnum } from './CurrencyEnum';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface CouponExternal
 */
export interface CouponExternal {
    /**
     *
     * @type {number}
     * @memberof CouponExternal
     */
    amountAtomOff: number | null;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof CouponExternal
     */
    createdAt: Date;
    /**
     *
     * @type {CurrencyEnum}
     * @memberof CouponExternal
     */
    currency?: CurrencyEnum | null;
    /**
     *
     * @type {CouponDuration}
     * @memberof CouponExternal
     */
    duration: CouponDuration;
    /**
     *
     * @type {number}
     * @memberof CouponExternal
     */
    durationInMonths: number | null;
    /**
     *
     * @type {string}
     * @memberof CouponExternal
     */
    id: string;
    /**
     *
     * @type {boolean}
     * @memberof CouponExternal
     */
    isActive: boolean;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof CouponExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {number}
     * @memberof CouponExternal
     */
    maxRedemptions: number | null;
    /**
     *
     * @type {object}
     * @memberof CouponExternal
     */
    metadata?: object | null;
    /**
     *
     * @type {string}
     * @memberof CouponExternal
     */
    name: string;
    /**
     *
     * @type {ObjectName}
     * @memberof CouponExternal
     */
    object?: ObjectName;
    /**
     *
     * @type {number}
     * @memberof CouponExternal
     */
    percentOff: number | null;
    /**
     *
     * @type {Array<string>}
     * @memberof CouponExternal
     */
    productFamilies?: Array<string>;
    /**
     *
     * @type {Array<string>}
     * @memberof CouponExternal
     */
    products?: Array<string>;
    /**
     *
     * @type {Array<string>}
     * @memberof CouponExternal
     */
    promotionCodes?: Array<string>;
    /**
     *
     * @type {Date}
     * @memberof CouponExternal
     */
    redeemBy: Date | null;
    /**
     *
     * @type {number}
     * @memberof CouponExternal
     */
    timesRedeemed: number | null;
    /**
     *
     * @type {number}
     * @memberof CouponExternal
     */
    trialDaysOff?: number | null;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof CouponExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the CouponExternal interface.
 */
export declare function instanceOfCouponExternal(value: object): value is CouponExternal;
export declare function CouponExternalFromJSON(json: any): CouponExternal;
export declare function CouponExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): CouponExternal;
export declare function CouponExternalToJSON(json: any): CouponExternal;
export declare function CouponExternalToJSONTyped(value?: CouponExternal | null, ignoreDiscriminator?: boolean): any;