@voucherify/sdk 1.2.0

package/dist/types/Promotions.d.ts

@@ -0,0 +1,90 @@
+import { DiscountAmount, DiscountPercent, DiscountUnit } from './Vouchers';
+import { OrdersItem } from './Orders';
+import { PromotionTier } from './PromotionTiers';
+import { SimpleCustomer } from './Customers';
+import { ValidationRulesCreateAssignmentResponse } from './ValidationRules';
+export interface PromotionsCreateResponse {
+    id: string;
+    name: string;
+    campaign_type?: 'PROMOTION';
+    type: 'STATIC';
+    description?: string;
+    start_date?: string;
+    expiration_date?: string;
+    promotion: {
+        object: 'list';
+        data_ref: 'tiers';
+        tiers?: PromotionTier[];
+        has_more: boolean;
+    };
+    category?: string;
+    auto_join: boolean;
+    join_once: boolean;
+    validation_rules_assignments: {
+        data?: ValidationRulesCreateAssignmentResponse[];
+        object: 'list';
+        total: number;
+        data_ref: 'data';
+    };
+    activity_duration_after_publishing?: string;
+    validity_timeframe?: {
+        interval?: string;
+        duration?: string;
+    };
+    validity_day_of_week?: number[];
+    metadata?: Record<string, string>;
+    created_at: string;
+    vouchers_generation_status: 'DONE';
+    active: boolean;
+    use_voucher_metadata_schema: boolean;
+    protected: boolean;
+    object: 'campaign';
+}
+export interface PromotionsCreate {
+    name: string;
+    campaign_type: 'PROMOTION';
+    start_date?: string;
+    expiration_date?: string;
+    promotion?: {
+        tiers: {
+            name: string;
+            banner: string;
+            action: {
+                discount: DiscountUnit | DiscountAmount | DiscountPercent;
+            };
+            metadata?: Record<string, any>;
+        }[];
+    };
+}
+export interface PromotionsValidateParams {
+    customer?: Omit<SimpleCustomer, 'object'> & {
+        description?: string;
+    };
+    order?: {
+        id?: string;
+        source_id?: string;
+        items?: OrdersItem[];
+        amount?: number;
+        metadata?: Record<string, any>;
+    };
+    metadata?: Record<string, any>;
+}
+export interface PromotionsValidateResponse {
+    valid: boolean;
+    promotions?: {
+        id: string;
+        object: 'promotion_tier';
+        banner?: string;
+        discount?: DiscountUnit | DiscountAmount | DiscountPercent;
+        discount_amount?: number;
+        metadata?: Record<string, any>;
+        order?: {
+            id?: string;
+            source_id?: string;
+            amount: number;
+            items?: OrdersItem[];
+            metadata?: Record<string, any>;
+        };
+    }[];
+    tracking_id?: string;
+}

package/dist/types/Redemptions.d.ts

@@ -0,0 +1,150 @@
+import { OrdersCreateResponse } from './Orders';
+import { RewardsCreateResponse } from './Rewards';
+import { SimpleCustomer } from './Customers';
+import { VouchersResponse } from './Vouchers';
+export interface RedemptionsRedeemBody {
+    tracking_id?: string;
+    customer?: SimpleCustomer & {
+        description?: string;
+    };
+    order?: Pick<Partial<OrdersCreateResponse>, 'id' | 'source_id' | 'amount' | 'items' | 'status' | 'metadata'>;
+    metadata?: Record<string, any>;
+    reward?: {
+        id?: string;
+        points?: number;
+    };
+    gift?: {
+        credits: number;
+    };
+    session?: {
+        key: string;
+    };
+}
+export interface RedemptionsRedeemResponse {
+    id: string;
+    object: 'redemption';
+    date?: string;
+    customer_id?: string;
+    tracking_id?: string;
+    order?: OrdersCreateResponse;
+    metadata?: Record<string, any>;
+    result: 'SUCCESS' | 'FAILURE';
+    voucher: VouchersResponse;
+    customer?: SimpleCustomer;
+    reward?: RewardsCreateResponse;
+    related_object_type: 'voucher';
+    gift?: {
+        amount: number;
+    };
+    loyalty_card?: {
+        points: number;
+    };
+    failure_code?: string;
+    failure_message?: string;
+}
+export interface RedemptionsListParams {
+    limit?: number;
+    page?: number;
+    result?: 'SUCCESS' | 'FAILURE';
+    campaign?: string;
+    customer?: string;
+    created_at?: {
+        before?: string;
+        after?: string;
+    };
+}
+export interface Redemption {
+    id: string;
+    object: 'redemption';
+    date?: string;
+    customer_id?: string;
+    tracking_id?: string;
+    order?: Omit<OrdersCreateResponse, 'object'> & {
+        related_object_id: string;
+        related_object_type: 'redemption';
+        referrer?: string;
+    };
+    metadata?: Record<string, any>;
+    result: 'SUCCESS' | 'FAILURE';
+    failure_code?: string;
+    failure_message?: string;
+    customer?: SimpleCustomer;
+    related_object_type?: 'string';
+    voucher?: {
+        code: string;
+        campaign?: string;
+        id: string;
+        object: 'voucher';
+        campaign_id?: string;
+    };
+    gift?: {
+        amount: number;
+    };
+    loyalty_card?: {
+        points: number;
+    };
+}
+export interface RedemptionsListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'redemptions';
+    redemptions: (Redemption | SimpleRollback)[];
+}
+export interface RedemptionsGetForVoucherResponse {
+    object: 'list';
+    total: number;
+    data_ref: string;
+    quantity: number;
+    redeemed_quantity?: number;
+    redeemed_amount?: number;
+    redemption_entries?: (Redemption | SimpleRollback)[];
+}
+export interface RedemptionsRollbackParams {
+    reason?: string;
+    tracking_id?: string;
+    customer?: SimpleCustomer & {
+        description?: string;
+    };
+}
+export interface RedemptionsRollbackQueryParams {
+    reason?: string;
+    tracking_id?: string;
+}
+export interface RedemptionsRollbackPayload {
+    customer?: SimpleCustomer & {
+        description?: string;
+    };
+}
+export interface RedemptionsRollbackResponse {
+    id: string;
+    object: 'redemption_rollback';
+    date?: string;
+    customer_id?: string;
+    tracking_id?: string;
+    redemption?: string;
+    amount?: number;
+    reason?: string;
+    result: 'SUCCESS' | 'FAILURE';
+    voucher?: VouchersResponse;
+    customer?: SimpleCustomer;
+    reward?: {
+        assignment_id: string;
+        object: 'reward';
+    };
+}
+export declare type SimpleRollback = Pick<RedemptionsRollbackResponse, 'id' | 'object' | 'date' | 'customer_id' | 'tracking_id' | 'redemption' | 'result' | 'customer'> & {
+    related_object_type: 'voucher';
+    voucher: {
+        id: string;
+        object: 'voucher';
+        code: string;
+        campaign?: string;
+        campaign_id?: string;
+    };
+    gift?: {
+        amount: number;
+    };
+    loyalty_card?: {
+        points: number;
+    };
+};

package/dist/types/Rewards.d.ts

@@ -0,0 +1,114 @@
+export interface RewardsListParams {
+    page?: number;
+    limit?: number;
+}
+export interface RewardsResponse {
+    id: string;
+    name?: string;
+    stock?: number;
+    redeemed?: number;
+    attributes?: {
+        image_url?: string;
+        description?: string;
+    };
+    created_at: string;
+    updated_at?: string;
+    object: 'reward';
+}
+export declare type RewardsCreateResponse = RewardsResponse & RewardsTypeResponse;
+export interface RewardsListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'data';
+    data: RewardsCreateResponse[];
+}
+export interface Rewards {
+    name: string;
+    stock?: number;
+    attributes?: {
+        image_url?: string;
+        description?: string;
+    };
+}
+interface RewardsTypeMaterial {
+    type?: 'MATERIAL';
+    parameters: {
+        product?: {
+            id?: string;
+            sku?: string;
+        };
+    };
+}
+interface RewardsTypeCampaign {
+    type?: 'CAMPAIGN';
+    parameters: {
+        campaign?: {
+            id: string;
+            balance?: number;
+        };
+    };
+}
+interface RewardsTypeCampaignResponse {
+    type?: 'CAMPAIGN';
+    parameters: {
+        campaign?: {
+            id: string;
+            balance?: number;
+            type?: 'DISCOUNT_COUPONS' | 'PROMOTION' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
+        };
+    };
+}
+interface RewardsTypeCoin {
+    type?: 'COIN';
+    parameters: {
+        coin?: {
+            exchange_ratio?: number;
+        };
+    };
+}
+export declare type RewardsType = RewardsTypeCampaign | RewardsTypeCoin | RewardsTypeMaterial;
+export declare type RewardsTypeResponse = Required<RewardsTypeCampaignResponse> | Required<RewardsTypeCoin> | Required<RewardsTypeMaterial>;
+export declare type RewardsCreate = Rewards & RewardsType;
+export declare type RewardsGetResponse = RewardsCreateResponse;
+export declare type RewardsUpdate = Omit<RewardsCreate, 'type'> & {
+    id: string;
+};
+export declare type RewardsUpdateResponse = RewardsCreateResponse;
+export interface RewardsAssignmentObject {
+    id: string;
+    reward_id: string;
+    related_object_id?: string;
+    related_object_type?: string;
+    parameters?: {
+        loyalty?: {
+            points: number;
+        };
+    };
+    created_at: string;
+    updated_at?: string;
+    object: 'reward_assignment';
+}
+export interface RewardsListAssignmentsParams {
+    limit?: number;
+    page?: number;
+}
+export interface RewardsListAssignmentsResponse {
+    total: number;
+    data: RewardsAssignmentObject[];
+    object: 'list';
+    data_ref: 'data';
+}
+export interface RewardsCreateAssignment {
+    campaign?: string;
+    parameters?: {
+        loyalty?: {
+            points: number;
+        };
+    };
+}
+export declare type RewardsCreateAssignmentResponse = RewardsAssignmentObject;
+export declare type RewardsUpdateAssignment = RewardsCreateAssignment & {
+    id: string;
+};
+export declare type RewardsUpdateAssignmentResponse = RewardsAssignmentObject;
+export {};

package/dist/types/Segments.d.ts

@@ -0,0 +1,32 @@
+export interface SegmentsCreate {
+    name: string;
+    type: 'static' | 'auto-update';
+    filter?: {
+        junction?: 'AND' | 'OR';
+        [filter_conditions: string]: any;
+    };
+    customers?: string[];
+}
+export interface SegmentsCreateResponse {
+    id: string;
+    name: string;
+    created_at: string;
+    metadata?: Record<string, any>;
+    filter?: {
+        junction?: 'AND' | 'OR';
+        [filter_conditions: string]: any;
+    };
+    type?: string;
+    object: 'segment';
+}
+export declare type SegmentsGetResponse = SegmentsCreateResponse;
+export interface SegmentsListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'data';
+    data: {
+        id: string;
+        name: string;
+        object: 'segment';
+    }[];
+}

package/dist/types/ValidationRules.d.ts

@@ -0,0 +1,74 @@
+export interface ValidationRulesCreate {
+    name: string;
+    error?: {
+        message?: string;
+    };
+    rules?: {
+        logic?: string;
+        [rule: string]: any;
+    };
+}
+export interface ValidationRulesCreateResponse {
+    id: string;
+    name: string;
+    error?: {
+        message?: string;
+    };
+    rules?: {
+        logic?: string;
+        [rule: string]: any;
+    };
+    created_at: string;
+    updated_at?: string;
+    object: 'validation_rules';
+}
+export interface ValidationRulesValidateResponse {
+    valid: boolean;
+    rule_id: string;
+    applicable_to: {
+        data: any[];
+        object: 'list';
+        total: number;
+    };
+}
+export declare type ValidationRulesGetResponse = ValidationRulesCreateResponse & {
+    assignments_count?: string;
+};
+export declare type ValidationRulesUpdate = Partial<ValidationRulesCreate> & {
+    id: string;
+};
+export declare type ValidationRulesUpdateResponse = ValidationRulesCreateResponse;
+export interface ValidationRulesCreateAssignment {
+    voucher?: string;
+    campaign?: string;
+    promotion_tier?: string;
+}
+export interface ValidationRulesCreateAssignmentResponse {
+    id: string;
+    rule_id: string;
+    related_object_id?: string;
+    related_object_type?: string;
+    created_at?: string;
+    updated_at: string;
+    object: 'validation_rules_assignment';
+}
+export interface ValidationRulesListParams {
+    limit?: number;
+    page?: number;
+}
+export interface ValidationRulesListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'data';
+    data: ValidationRulesGetResponse[];
+}
+export interface ValidationRulesListAssignmentsParams {
+    limit?: number;
+    page?: number;
+}
+export interface ValidationRulesListAssignmentsResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'data';
+    data: ValidationRulesCreateAssignmentResponse[];
+}

package/dist/types/Validations.d.ts

@@ -0,0 +1,66 @@
+import { DiscountAmount, DiscountPercent, DiscountUnit } from './Vouchers';
+import { OrdersItem } from './Orders';
+import { PromotionsValidateParams } from './Promotions';
+export interface ValidationsValidateVoucherParams {
+    customer?: {
+        id?: string;
+        source_id?: string;
+        name?: string;
+        email?: string;
+        description?: string;
+        metadata?: Record<string, any>;
+    };
+    order?: {
+        id?: string;
+        source_id?: string;
+        amount?: number;
+        items?: OrdersItem[];
+        metadata?: Record<string, any>;
+    };
+    gift?: {
+        credits: number;
+    };
+    reward?: {
+        id: string;
+    };
+    session?: {
+        type: 'LOCK';
+        key?: string;
+        ttl?: number;
+        ttl_unit?: 'MILLISECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS';
+    };
+}
+export interface ValidationsValidateVoucherResponse {
+    applicable_to?: {
+        object: 'list';
+        total: number;
+        data?: {
+            id: string;
+            object: 'product';
+            source_id?: string;
+        }[];
+    };
+    campaign?: string;
+    campaign_id?: string;
+    metadata?: Record<string, any>;
+    code?: string;
+    valid?: boolean;
+    discount?: DiscountAmount | DiscountUnit | DiscountPercent;
+    gift?: {
+        amount: number;
+        balance: number;
+    };
+    loyalty?: {
+        points_cost: number;
+    };
+    order?: {
+        amount: number;
+        discount_amount: number;
+        total_discount_amount: number;
+        total_amount: number;
+        items?: OrdersItem[];
+    };
+    tracking_id: string;
+}
+export declare type ValidationsValidateCode = PromotionsValidateParams;
+export declare type ValidationsValidateContext = ValidationsValidateVoucherParams;