@medusajs/types/dist/promotion/mutations.d.ts

Medusa Types definition

import { CampaignBudgetTypeValues } from "./common";
/**
 * The campaign budget to be created.
 */
export interface CreateCampaignBudgetDTO {
    /**
     * The type of the campaign budget.
     */
    type?: CampaignBudgetTypeValues;
    /**
     * The limit of the campaign budget.
     */
    limit?: number | null;
    /**
     * How much is used of the campaign budget.
     */
    used?: number;
    /**
     * The currency of the campaign.
     */
    currency_code?: string | null;
}
/**
 * The attributes to update in the campaign budget.
 */
export interface UpdateCampaignBudgetDTO {
    /**
     * The ID of the campaign budget.
     */
    id: string;
    /**
     * The type of the campaign budget.
     */
    type?: CampaignBudgetTypeValues;
    /**
     * The limit of the campaign budget.
     */
    limit?: number | null;
    /**
     * The limit of the campaign budget.
     */
    currency_code?: string | null;
    /**
     * How much is used of the campaign budget.
     */
    used?: number;
}
/**
 * The campaign to be created.
 */
export interface CreateCampaignDTO {
    /**
     * The name of the campaign.
     */
    name: string;
    /**
     * The description of the campaign.
     */
    description?: string | null;
    /**
     * The campaign identifier of the campaign.
     */
    campaign_identifier: string;
    /**
     * The start date of the campaign.
     */
    starts_at?: Date | null;
    /**
     * The end date of the campaign.
     */
    ends_at?: Date | null;
    /**
     * The associated campaign budget.
     */
    budget?: CreateCampaignBudgetDTO | null;
}
/**
 * The attributes to update in the campaign.
 */
export interface UpdateCampaignDTO {
    /**
     * The ID of the campaign.
     */
    id: string;
    /**
     * The name of the campaign.
     */
    name?: string;
    /**
     * The description of the campaign.
     */
    description?: string | null;
    /**
     * The campaign identifier of the campaign.
     */
    campaign_identifier?: string;
    /**
     * The start date of the campaign.
     */
    starts_at?: Date | null;
    /**
     * The end date of the campaign.
     */
    ends_at?: Date | null;
    /**
     * The budget of the campaign.
     */
    budget?: Omit<UpdateCampaignBudgetDTO, "id">;
}
export interface AddPromotionsToCampaignDTO {
    /**
     * The ID of the campaign.
     */
    id: string;
    /**
     * Ids of promotions to add
     */
    promotion_ids: string[];
}
export interface RemovePromotionsFromCampaignDTO {
    /**
     * The ID of the campaign.
     */
    id: string;
    /**
     * Ids of promotions to add
     */
    promotion_ids: string[];
}
//# sourceMappingURL=mutations.d.ts.map