@voucherify/sdk 2.9.2 → 2.9.3

package/dist/types/PromotionsStacks.d.ts

@@ -1,71 +0,0 @@
-import { Category } from './Categories';
-export interface PromotionsStacksListInCampaignResponseBody {
-    object: 'list';
-    data_ref: 'data';
-    data: PromotionStack[];
-    total: number;
-}
-export interface PromotionsStacksListResponseBody {
-    object: 'list';
-    data_ref: 'data';
-    data: PromotionStack[];
-    total: number;
-}
-export interface PromotionsStacksListRequestQuery {
-    limit?: number;
-    page?: number;
-    order?: 'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'name' | '-name';
-    created_at?: {
-        before?: string;
-        after?: string;
-    };
-    updated_at?: {
-        before?: string;
-        after?: string;
-    };
-}
-export declare type PromotionsStacksGetResponseBody = PromotionStack;
-export declare type PromotionsStacksUpdateRequestBody = {
-    name: string;
-    tiers?: {
-        ids?: string[];
-        hierarchy_mode?: 'MANUAL';
-    };
-    category_id?: string;
-};
-export declare type PromotionsStacksUpdateResponseBody = PromotionStackBase & {
-    id: string;
-    created_at: string;
-    updated_at: string;
-    campaign_id: string;
-    object: 'promotion_stack';
-    category_id: string | null;
-    categories: Category[];
-};
-export declare type PromotionsStacksCreateInCampaignRequestBody = PromotionStackBase & {
-    category_id?: string;
-};
-export declare type PromotionsStacksCreateInCampaignResponseBody = PromotionStackBase & {
-    id: string;
-    created_at: string;
-    campaign_id: string;
-    object: 'promotion_stack';
-    category_id: string | null;
-    categories: Category[];
-};
-export interface PromotionStackBase {
-    name: string;
-    tiers: {
-        ids: string[];
-        hierarchy_mode?: 'MANUAL';
-    };
-}
-export declare type PromotionStack = PromotionStackBase & {
-    id: string;
-    created_at: string;
-    updated_at?: string;
-    campaign_id: string;
-    object: 'promotion_stack';
-    category_id: string | null;
-    categories: Category[];
-};

package/dist/types/Qualifications.d.ts

@@ -1,86 +0,0 @@
-import { CustomerRequest } from './Customers';
-import { Junction } from './Exports';
-import { Order, OrderCalculated } from './Orders';
-import { ApplicableToResultList, InapplicableToResultList } from './ApplicableTo';
-import { Category } from './Categories';
-import { Discount } from './DiscountVoucher';
-import { LoyaltiesTransferPoints } from './Loyalties';
-import { ValidationRulesAssignmentsList } from './ValidationRules';
-export declare type QualificationsCheckEligibilityRequestBody = {
-    customer?: CustomerRequest;
-    order?: Order;
-    mode?: 'BASIC' | 'ADVANCED';
-    tracking_id?: string;
-    scenario?: 'ALL' | 'CUSTOMER_WALLET' | 'AUDIENCE_ONLY' | 'PRODUCTS' | 'PRODUCTS_DISCOUNT' | 'PROMOTION_STACKS' | 'PRODUCTS_BY_CUSTOMER' | 'PRODUCTS_DISCOUNT_BY_CUSTOMER';
-    options?: {
-        limit?: number;
-        starting_after?: string;
-        filters?: {
-            junction?: Junction;
-        } & Partial<Record<QualificationsFiltersFields, QualificationsFieldConditions>>;
-        expand?: ('redeemable' | 'category' | 'validation_rules')[];
-        sorting_rule?: 'BEST_DEAL' | 'LEAST_DEAL' | 'DEFAULT';
-    };
-    metadata?: Record<string, any>;
-};
-export declare type QualificationsCheckEligibilityResponseBody = {
-    redeemables: QualificationsRedeemableList;
-    tracking_id?: string;
-    order?: OrderCalculated;
-    stacking_rules: QualificationsStackingRules;
-};
-export declare type QualificationsFiltersFields = 'category_id' | 'campaign_id' | 'resource_id' | 'resource_type' | 'voucher_type' | 'code';
-export declare type QualificationsFiltersCondition = '$in' | '$not_in' | '$is' | '$is_not' | '$has_value' | '$is_unknown';
-export declare type QualificationsFieldConditions = {
-    conditions?: Partial<Record<QualificationsFiltersCondition, any>>;
-};
-export declare type QualificationsRedeemableList = {
-    object: 'list';
-    data_ref: 'data';
-    data: QualificationsRedeemable[];
-    total: number;
-    has_more: boolean;
-    more_starting_after?: string;
-};
-export declare type QualificationsStackingRules = {
-    redeemables_limit: number;
-    applicable_redeemables_limit: number;
-    applicable_exclusive_redeemables_limit: number;
-    exclusive_categories: string[];
-    joint_categories: string[];
-};
-export declare type QualificationsRedeemable = QualificationsRedeemableBase & {
-    redeemables?: QualificationsRedeemableBase[];
-};
-export declare type QualificationsRedeemableBase = {
-    id: string;
-    object: 'campaign' | 'promotion_tier' | 'promotion_stack' | 'voucher';
-    created_at: string;
-    result: RedeemableResult;
-    order?: OrderCalculated;
-    validation_rule_id?: string;
-    applicable_to: ApplicableToResultList;
-    inapplicable_to: InapplicableToResultList;
-    metadata: Record<string, unknown> | null;
-    categories: Category[];
-    banner?: string;
-    name?: string;
-    campaign_name?: string;
-    campaign_id?: string;
-    validation_rules_assignments?: ValidationRulesAssignmentsList;
-};
-export declare type RedeemableResult = {
-    discount?: Discount;
-    gift?: {
-        balance: number;
-        credits: number;
-    };
-    loyalty_card?: {
-        points?: number;
-        balance?: number;
-        exchange_ratio?: number;
-        points_ratio?: number;
-        transfers?: LoyaltiesTransferPoints[];
-    };
-    error?: Error;
-};

package/dist/types/Redemptions.d.ts

@@ -1,205 +0,0 @@
-import { OrdersCreateResponse, OrdersCreate } from './Orders';
-import { RewardsCreateResponse, RewardRedemptionParams } from './Rewards';
-import { CustomersCreateBody, SimpleCustomer } from './Customers';
-import { VouchersResponse } from './Vouchers';
-import { GiftRedemptionParams } from './Gift';
-import { ValidationSessionParams, ValidationSessionReleaseParams } from './ValidateSession';
-import { StackableOptions, StackableRedeemableInapplicableResponse, StackableRedeemableParams, StackableRedeemableSkippedResponse } from './Stackable';
-import { PromotionTierRedeemDetailsSimple, PromotionTierRedeemDetails } from './PromotionTiers';
-export interface RedemptionsRedeemBody {
-    tracking_id?: string;
-    customer?: Omit<SimpleCustomer, 'id'> & {
-        description?: string;
-        id?: string;
-    };
-    order?: Pick<Partial<OrdersCreateResponse>, 'id' | 'source_id' | 'amount' | 'items' | 'status' | 'metadata'>;
-    metadata?: Record<string, any>;
-    reward?: RewardRedemptionParams;
-    gift?: GiftRedemptionParams;
-    session?: ValidationSessionReleaseParams;
-}
-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;
-    };
-    promotion_tier?: PromotionTierRedeemDetailsSimple | PromotionTierRedeemDetails;
-    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;
-    };
-};
-export interface RedemptionsRedeemStackableParams {
-    options?: StackableOptions;
-    redeemables: StackableRedeemableParams[];
-    session?: ValidationSessionParams;
-    order?: OrdersCreate;
-    customer?: CustomersCreateBody;
-    metadata?: Record<string, any>;
-}
-export declare type RedemptionsRedeemStackableRedemptionResult = RedemptionsRedeemResponse & {
-    redemption: string;
-};
-export declare type RedemptionsRedeemStackableOrderResponse = OrdersCreateResponse & {
-    redemptions?: Record<string, {
-        date: string;
-        rollback_id?: string;
-        rollback_date?: string;
-        related_object_type: 'redemption';
-        related_object_id: string;
-        stacked: string[];
-        rollback_stacked?: string[];
-    }>;
-};
-export interface RedemptionsRedeemStackableResponse {
-    redemptions: RedemptionsRedeemStackableRedemptionResult[];
-    parent_redemption: {
-        id: string;
-        object: 'redemption';
-        date: string;
-        customer_id?: string;
-        tracking_id?: string;
-        metadata?: Record<string, any>;
-        result: 'SUCCESS' | 'FAILURE';
-        order?: RedemptionsRedeemStackableOrderResponse;
-        customer?: SimpleCustomer;
-        related_object_type: 'redemption';
-        related_object_id: string;
-    };
-    order?: RedemptionsRedeemStackableOrderResponse;
-    skipped_redeemables?: StackableRedeemableSkippedResponse;
-    inapplicable_redeemables?: StackableRedeemableInapplicableResponse;
-}
-export interface RedemptionsRollbackStackableResponse {
-    rollbacks: RedemptionsRedeemStackableRedemptionResult[];
-    parent_rollback: {
-        id: string;
-        date: string;
-        customer_id?: string;
-        tracking_id?: string;
-        metadata?: Record<string, any>;
-        result: 'SUCCESS' | 'FAILURE';
-        order?: OrdersCreateResponse;
-        customer?: SimpleCustomer;
-        redemption: string;
-    };
-    order?: RedemptionsRedeemStackableOrderResponse;
-}

package/dist/types/Rewards.d.ts

@@ -1,219 +0,0 @@
-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 declare type RewardsGetResponse = 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 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 interface RewardRedemptionParams {
-    points?: number;
-    assignment_id?: string;
-    id?: string;
-}
-export declare type Reward = {
-    id: string;
-    name?: string;
-    stock?: string;
-    redeemed?: string;
-    attributes?: {
-        image_url?: string;
-        description?: string;
-    };
-    created_at: string;
-    updated_at?: string;
-    object: 'reward';
-} & RewardType;
-export interface RewardTypeCampaign {
-    type: 'CAMPAIGN';
-    parameters: {
-        campaign: {
-            id: string;
-            balance?: number;
-            type: 'DISCOUNT_COUPONS' | 'PROMOTION' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
-        };
-    };
-}
-export interface RewardTypeCoin {
-    type: 'COIN';
-    parameters: {
-        coin: {
-            exchange_ratio: number;
-            points_ratio?: number;
-        };
-    };
-}
-export interface RewardTypeMaterial {
-    type: 'MATERIAL';
-    parameters: {
-        product: {
-            id: string;
-            sku: string | null;
-        };
-    };
-}
-export declare type RewardType = RewardTypeCampaign | RewardTypeCoin | RewardTypeMaterial;
-export declare type RewardAssignment = RewardsAssignmentCoinReward | RewardsAssignmentCampaignOrMaterialReward;
-export interface RewardsAssignmentCoinReward {
-    id: string;
-    reward_id: string;
-    related_object_id: string;
-    related_object_type: 'campaign';
-    created_at: string;
-    updated_at: string | null;
-    object: 'reward-assignment';
-}
-export interface RewardsAssignmentCampaignOrMaterialReward {
-    id: string;
-    reward_id: string;
-    related_object_id: string;
-    related_object_type: 'campaign';
-    created_at: string;
-    updated_at: string | null;
-    object: 'reward-assignment';
-    parameters: {
-        loyalty: {
-            points?: number;
-        };
-    };
-}
-export declare type RewardsGetAssignmentResponseBody = RewardAssignment;
-export interface RewardsListAssignmentsRequestQuery {
-    limit?: number;
-    page?: number;
-}
-export interface RewardsListAssignmentsResponseBody {
-    object: 'list';
-    data_ref: 'data';
-    data: RewardAssignment[];
-    total: number;
-}
-export declare type RewardsCreateAssignmentRequestBody = RewardsCreateAssignmentCoinRewardRequestBody | RewardsCreateAssignmentCampaignOrMaterialRewardRequestBody;
-export interface RewardsCreateAssignmentCoinRewardRequestBody {
-    campaign: string;
-    validation_rules?: string[];
-}
-export interface RewardsCreateAssignmentCampaignOrMaterialRewardRequestBody {
-    campaign: string;
-    parameters: {
-        loyalty: {
-            points?: number;
-        };
-    };
-}
-export declare type RewardsCreateAssignmentResponseBody = RewardAssignment;
-export interface RewardsUpdateAssignmentRequestBody {
-    parameters?: {
-        loyalty?: {
-            points?: number;
-        };
-    };
-    id: string;
-}
-export declare type RewardsUpdateAssignmentResponseBody = RewardAssignment;
-export {};

package/dist/types/Segments.d.ts

@@ -1,32 +0,0 @@
-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';
-    }[];
-}