@getopenpay/client/models/ProductExternal.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 { PriceExternal } from './PriceExternal';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface ProductExternal
 */
export interface ProductExternal {
    /**
     *
     * @type {string}
     * @memberof ProductExternal
     */
    accountSku: string | null;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof ProductExternal
     */
    createdAt: Date;
    /**
     *
     * @type {object}
     * @memberof ProductExternal
     */
    customFields?: object | null;
    /**
     *
     * @type {string}
     * @memberof ProductExternal
     */
    defaultPrice: string | null;
    /**
     *
     * @type {string}
     * @memberof ProductExternal
     */
    description: string | null;
    /**
     * List of product features.
     * @type {Array<string>}
     * @memberof ProductExternal
     */
    features: Array<string>;
    /**
     * Unique identifier of the product.
     * @type {string}
     * @memberof ProductExternal
     */
    id: string;
    /**
     * Whether the product is currently available for purchase.
     * @type {boolean}
     * @memberof ProductExternal
     */
    isActive: boolean;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof ProductExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {object}
     * @memberof ProductExternal
     */
    metadata?: object | null;
    /**
     * Name of product.
     * @type {string}
     * @memberof ProductExternal
     */
    name: string;
    /**
     *
     * @type {ObjectName}
     * @memberof ProductExternal
     */
    object?: ObjectName;
    /**
     *
     * @type {Array<PriceExternal>}
     * @memberof ProductExternal
     */
    prices: Array<PriceExternal>;
    /**
     *
     * @type {string}
     * @memberof ProductExternal
     */
    unitLabel: string | null;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof ProductExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the ProductExternal interface.
 */
export declare function instanceOfProductExternal(value: object): value is ProductExternal;
export declare function ProductExternalFromJSON(json: any): ProductExternal;
export declare function ProductExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProductExternal;
export declare function ProductExternalToJSON(json: any): ProductExternal;
export declare function ProductExternalToJSONTyped(value?: ProductExternal | null, ignoreDiscriminator?: boolean): any;