@getopenpay/client/models/PromotionCodeExternal.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 { PromoRestrictions } from './PromoRestrictions';
import type { CouponExternal } from './CouponExternal';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface PromotionCodeExternal
 */
export interface PromotionCodeExternal {
    /**
     *
     * @type {string}
     * @memberof PromotionCodeExternal
     */
    code: string;
    /**
     * Coupon object for this promotion code.
     * @type {CouponExternal}
     * @memberof PromotionCodeExternal
     */
    coupon: CouponExternal;
    /**
     *
     * @type {string}
     * @memberof PromotionCodeExternal
     */
    couponId: string;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PromotionCodeExternal
     */
    createdAt: Date;
    /**
     * List of customer ids who can redeem this PromotionCode. If empty all customers can redeem it.
     * @type {Array<string>}
     * @memberof PromotionCodeExternal
     */
    customerIds?: Array<string>;
    /**
     *
     * @type {Date}
     * @memberof PromotionCodeExternal
     */
    expiresAt?: Date | null;
    /**
     *
     * @type {string}
     * @memberof PromotionCodeExternal
     */
    id: string;
    /**
     *
     * @type {boolean}
     * @memberof PromotionCodeExternal
     */
    isActive: boolean;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof PromotionCodeExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {number}
     * @memberof PromotionCodeExternal
     */
    maxRedemptions?: number | null;
    /**
     *
     * @type {number}
     * @memberof PromotionCodeExternal
     */
    maxRedemptionsPerCustomer?: number | null;
    /**
     *
     * @type {object}
     * @memberof PromotionCodeExternal
     */
    metadata?: object | null;
    /**
     *
     * @type {ObjectName}
     * @memberof PromotionCodeExternal
     */
    object?: ObjectName;
    /**
     *
     * @type {PromoRestrictions}
     * @memberof PromotionCodeExternal
     */
    restrictions: PromoRestrictions | null;
    /**
     *
     * @type {number}
     * @memberof PromotionCodeExternal
     */
    timesRedeemed?: number | null;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PromotionCodeExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the PromotionCodeExternal interface.
 */
export declare function instanceOfPromotionCodeExternal(value: object): value is PromotionCodeExternal;
export declare function PromotionCodeExternalFromJSON(json: any): PromotionCodeExternal;
export declare function PromotionCodeExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PromotionCodeExternal;
export declare function PromotionCodeExternalToJSON(json: any): PromotionCodeExternal;
export declare function PromotionCodeExternalToJSONTyped(value?: PromotionCodeExternal | null, ignoreDiscriminator?: boolean): any;