sc-cobre-facil/dist/interfaces/CreatePlanParams.d.ts

Biblioteca TypeScript para consumir a API da Cobre Fácil

import { PlanItem } from "./PlanItem";
/**
 * Represents the parameters required to create a plan.
 *
 * @interface CreatePlanParams
 *
 * @property {string} description - Description of the plan.
 * @property {number} [discount] - Discount percentage (optional).
 * @property {number} [goal] - Goal for the number of plans to be sold (optional).
 * @property {Omit<PlanItem, "id" | "price" | "created_at" | "updated_at">[]} items - Array of plan item objects, excluding specific fields.
 * @property {string} name - Name of the plan.
 * @property {string | null} [notify_reactivation_at] - Date for system and email notifications to reactivate the plan (optional).
 * @property {"actived" | "paused" | "canceled"} [status] - Status of the plan, default is "actived" (optional).
 */
export interface CreatePlanParams {
    description: string;
    discount?: number;
    goal?: number;
    items: Omit<PlanItem, "id" | "price" | "created_at" | "updated_at">[];
    name: string;
    notify_reactivation_at?: string | null;
    status?: "actived" | "paused" | "canceled";
}
//# sourceMappingURL=CreatePlanParams.d.ts.map