@getopenpay/client/models/DiscountExternal.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 { PromotionCodeExternal } from './PromotionCodeExternal';
import type { CouponExternal } from './CouponExternal';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface DiscountExternal
 */
export interface DiscountExternal {
    /**
     *
     * @type {CouponExternal}
     * @memberof DiscountExternal
     */
    coupon: CouponExternal;
    /**
     *
     * @type {string}
     * @memberof DiscountExternal
     */
    couponId: string;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof DiscountExternal
     */
    createdAt: Date;
    /**
     *
     * @type {string}
     * @memberof DiscountExternal
     */
    customerId: string | null;
    /**
     *
     * @type {Date}
     * @memberof DiscountExternal
     */
    endDate: Date | null;
    /**
     *
     * @type {string}
     * @memberof DiscountExternal
     */
    id: string;
    /**
     *
     * @type {string}
     * @memberof DiscountExternal
     */
    invoiceId: string | null;
    /**
     *
     * @type {string}
     * @memberof DiscountExternal
     */
    invoiceItemId: string | null;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof DiscountExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {ObjectName}
     * @memberof DiscountExternal
     */
    object?: ObjectName;
    /**
     *
     * @type {PromotionCodeExternal}
     * @memberof DiscountExternal
     */
    promotionCode: PromotionCodeExternal | null;
    /**
     *
     * @type {string}
     * @memberof DiscountExternal
     */
    promotionCodeId: string | null;
    /**
     *
     * @type {Date}
     * @memberof DiscountExternal
     */
    startDate: Date;
    /**
     *
     * @type {string}
     * @memberof DiscountExternal
     */
    subscriptionId: string | null;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof DiscountExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the DiscountExternal interface.
 */
export declare function instanceOfDiscountExternal(value: object): value is DiscountExternal;
export declare function DiscountExternalFromJSON(json: any): DiscountExternal;
export declare function DiscountExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): DiscountExternal;
export declare function DiscountExternalToJSON(json: any): DiscountExternal;
export declare function DiscountExternalToJSONTyped(value?: DiscountExternal | null, ignoreDiscriminator?: boolean): any;