@voucherify/sdk 2.9.2 → 2.9.4

package/dist/types/Qualifications.d.ts

@@ -1,86 +1,92 @@
-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;
-};
+import { CustomerRequest } from './Customers.js';
+import { Junction } from './Exports.js';
+import { Order, OrderCalculated } from './Orders.js';
+import { ApplicableToResultList, InapplicableToResultList } from './ApplicableTo.js';
+import { Category } from './Categories.js';
+import { Discount } from './DiscountVoucher.js';
+import { LoyaltiesTransferPoints } from './Loyalties.js';
+import { ValidationRulesAssignmentsList } from './ValidationRules.js';
+import './Products.js';
+import './Vouchers.js';
+import './Rewards.js';
+
+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>;
+};
+type QualificationsCheckEligibilityResponseBody = {
+    redeemables: QualificationsRedeemableList;
+    tracking_id?: string;
+    order?: OrderCalculated;
+    stacking_rules: QualificationsStackingRules;
+};
+type QualificationsFiltersFields = 'category_id' | 'campaign_id' | 'resource_id' | 'resource_type' | 'voucher_type' | 'code';
+type QualificationsFiltersCondition = '$in' | '$not_in' | '$is' | '$is_not' | '$has_value' | '$is_unknown';
+type QualificationsFieldConditions = {
+    conditions?: Partial<Record<QualificationsFiltersCondition, any>>;
+};
+type QualificationsRedeemableList = {
+    object: 'list';
+    data_ref: 'data';
+    data: QualificationsRedeemable[];
+    total: number;
+    has_more: boolean;
+    more_starting_after?: string;
+};
+type QualificationsStackingRules = {
+    redeemables_limit: number;
+    applicable_redeemables_limit: number;
+    applicable_exclusive_redeemables_limit: number;
+    exclusive_categories: string[];
+    joint_categories: string[];
+};
+type QualificationsRedeemable = QualificationsRedeemableBase & {
+    redeemables?: QualificationsRedeemableBase[];
+};
+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;
+};
+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;
+};
+
+export type { QualificationsCheckEligibilityRequestBody, QualificationsCheckEligibilityResponseBody, QualificationsFieldConditions, QualificationsFiltersCondition, QualificationsFiltersFields, QualificationsRedeemable, QualificationsRedeemableBase, QualificationsRedeemableList, QualificationsStackingRules, RedeemableResult };

package/dist/types/Redemptions.d.ts

@@ -1,205 +1,215 @@
-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;
-}
+import { OrdersCreate, OrdersCreateResponse } from './Orders.js';
+import { RewardsCreateResponse, RewardRedemptionParams } from './Rewards.js';
+import { CustomersCreateBody, SimpleCustomer } from './Customers.js';
+import { VouchersResponse } from './Vouchers.js';
+import { GiftRedemptionParams } from './Gift.js';
+import { ValidationSessionParams, ValidationSessionReleaseParams } from './ValidateSession.js';
+import { StackableOptions, StackableRedeemableParams, StackableRedeemableSkippedResponse, StackableRedeemableInapplicableResponse } from './Stackable.js';
+import { PromotionTierRedeemDetailsSimple, PromotionTierRedeemDetails } from './PromotionTiers.js';
+import './DiscountVoucher.js';
+import './ApplicableTo.js';
+import './Products.js';
+import './Loyalties.js';
+import './ValidationRules.js';
+import './Categories.js';
+import './ValidationError.js';
+
+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;
+}
+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;
+}
+interface RedemptionsListParams {
+    limit?: number;
+    page?: number;
+    result?: 'SUCCESS' | 'FAILURE';
+    campaign?: string;
+    customer?: string;
+    created_at?: {
+        before?: string;
+        after?: string;
+    };
+}
+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;
+    };
+}
+interface RedemptionsListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'redemptions';
+    redemptions: (Redemption | SimpleRollback)[];
+}
+interface RedemptionsGetForVoucherResponse {
+    object: 'list';
+    total: number;
+    data_ref: string;
+    quantity: number;
+    redeemed_quantity?: number;
+    redeemed_amount?: number;
+    redemption_entries?: (Redemption | SimpleRollback)[];
+}
+interface RedemptionsRollbackParams {
+    reason?: string;
+    tracking_id?: string;
+    customer?: SimpleCustomer & {
+        description?: string;
+    };
+}
+interface RedemptionsRollbackQueryParams {
+    reason?: string;
+    tracking_id?: string;
+}
+interface RedemptionsRollbackPayload {
+    customer?: SimpleCustomer & {
+        description?: string;
+    };
+}
+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';
+    };
+}
+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;
+    };
+};
+interface RedemptionsRedeemStackableParams {
+    options?: StackableOptions;
+    redeemables: StackableRedeemableParams[];
+    session?: ValidationSessionParams;
+    order?: OrdersCreate;
+    customer?: CustomersCreateBody;
+    metadata?: Record<string, any>;
+}
+type RedemptionsRedeemStackableRedemptionResult = RedemptionsRedeemResponse & {
+    redemption: string;
+};
+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[];
+    }>;
+};
+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;
+}
+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;
+}
+
+export type { Redemption, RedemptionsGetForVoucherResponse, RedemptionsListParams, RedemptionsListResponse, RedemptionsRedeemBody, RedemptionsRedeemResponse, RedemptionsRedeemStackableOrderResponse, RedemptionsRedeemStackableParams, RedemptionsRedeemStackableRedemptionResult, RedemptionsRedeemStackableResponse, RedemptionsRollbackParams, RedemptionsRollbackPayload, RedemptionsRollbackQueryParams, RedemptionsRollbackResponse, RedemptionsRollbackStackableResponse, SimpleRollback };