@voucherify/sdk 2.9.1 → 2.9.3

package/dist/types/Stackable.d.ts

@@ -1,101 +0,0 @@
-import { RewardRedemptionParams } from './Rewards';
-import { GiftRedemptionParams } from './Gift';
-import { OrdersCreateResponse } from './Orders';
-import { ApplicableToResultList } from './ApplicableTo';
-import { DiscountVouchersTypes, DiscountVouchersEffectTypes, DiscountUnitVouchersEffectTypes } from './DiscountVoucher';
-import { SimpleProduct, SimpleSku } from './Products';
-import { LoyaltyPointsTransfer } from './Loyalties';
-import { ValidationError } from './ValidationError';
-import { Category } from './Categories';
-declare type ExpandOption = 'order' | 'redeemable' | 'redemption';
-export interface StackableOptions {
-    expand: ExpandOption[];
-}
-export declare type StackableRedeemableObject = 'promotion_stack' | 'promotion_tier' | 'voucher';
-export interface StackableRedeemableParams {
-    object: StackableRedeemableObject;
-    id: string;
-    reward?: RewardRedemptionParams;
-    gift?: GiftRedemptionParams;
-}
-export declare type StackableRedeemableResponseStatus = 'APPLICABLE' | 'INAPPLICABLE' | 'SKIPPED';
-export interface StackableRedeemableResultDiscountUnit {
-    effect: DiscountUnitVouchersEffectTypes;
-    unit_off: number;
-    unit_type: string;
-    sku?: SimpleSku;
-    product?: SimpleProduct;
-}
-export interface StackableRedeemableResultDiscount {
-    type: DiscountVouchersTypes;
-    effect: DiscountVouchersEffectTypes;
-    amount_off?: number;
-    amount_off_formula?: string;
-    percent_off?: number;
-    percent_off_formula?: string;
-    amount_limit?: number;
-    fixed_amount?: number;
-    fixed_amount_formula?: string;
-    unit_off?: number;
-    unit_off_formula?: string;
-    unit_type?: string;
-    sku?: SimpleSku;
-    product?: SimpleProduct;
-    units?: StackableRedeemableResultDiscountUnit[];
-}
-export interface StackableRedeemableResultGift {
-    credits?: number;
-}
-export interface StackableRedeemableResultLoyaltyCard {
-    points?: number;
-    transfers?: LoyaltyPointsTransfer[];
-}
-export interface StackableRedeemableResultResponse {
-    discount?: StackableRedeemableResultDiscount;
-    gift?: StackableRedeemableResultGift;
-    loyalty_card?: StackableRedeemableResultLoyaltyCard;
-    error?: ValidationError;
-    details?: {
-        key?: string;
-        message?: string;
-    };
-}
-export interface StackableRedeemableResponse {
-    status: StackableRedeemableResponseStatus;
-    id: string;
-    object: StackableRedeemableObject;
-    order?: OrdersCreateResponse;
-    applicable_to?: ApplicableToResultList;
-    inapplicable_to?: ApplicableToResultList;
-    result?: StackableRedeemableResultResponse;
-    metadata?: Record<string, any>;
-    categories?: Category[];
-}
-export declare type StackableRedeemableInapplicableResponse = {
-    status: 'INAPPLICABLE';
-    id: string;
-    object: 'voucher' | 'promotion_tier';
-    result: {
-        error?: ValidationError;
-        details?: {
-            key?: string;
-            message?: string;
-        };
-    };
-    metadata?: Record<string, unknown>;
-    categories?: Category[];
-};
-export declare type StackableRedeemableSkippedResponse = {
-    status: 'SKIPPED';
-    id: string;
-    object: 'voucher' | 'promotion_tier';
-    result: {
-        details?: {
-            key?: string;
-            message?: string;
-        };
-    };
-    metadata?: Record<string, unknown>;
-    categories?: Category[];
-};
-export {};

package/dist/types/UtilityTypes.d.ts

@@ -1,3 +0,0 @@
-export declare type WithRequiredProperty<Type, Key extends keyof Type> = Type & {
-    [Property in Key]-?: Type[Property];
-};

package/dist/types/ValidateSession.d.ts

@@ -1,17 +0,0 @@
-export declare type ValidationSessionType = 'LOCK';
-export declare type ValidationSessionTTLUnit = 'DAYS' | 'HOURS' | 'MICROSECONDS' | 'MILLISECONDS' | 'MINUTES' | 'NANOSECONDS' | 'SECONDS';
-export interface ValidationSessionParams {
-    key?: string;
-    type?: ValidationSessionType;
-    ttl?: number;
-    ttl_unit?: ValidationSessionTTLUnit;
-}
-export interface ValidationSessionResponse {
-    key: string;
-    type: ValidationSessionType;
-    ttl: number;
-    ttl_unit: ValidationSessionTTLUnit;
-}
-export interface ValidationSessionReleaseParams {
-    key: string;
-}

package/dist/types/ValidationError.d.ts

@@ -1,7 +0,0 @@
-export interface ValidationError {
-    code?: number;
-    key?: string;
-    message: string;
-    details?: string;
-    request_id?: string;
-}

package/dist/types/ValidationRules.d.ts

@@ -1,93 +0,0 @@
-import { ApplicableToResultList } from './ApplicableTo';
-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: ApplicableToResultList;
-}
-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[];
-}
-export declare type ValidationRulesAssignmentsList = ValidationRulesListResponse;
-export interface ValidationRulesAssignment {
-    id: string;
-    rule_id: string;
-    related_object_id: string;
-    related_object_type: string;
-    created_at: string;
-    object: 'validation_rules_assignment';
-}
-export interface ValidationRulesListRulesAssignmentsRequestQuery {
-    related_object_id?: string;
-    rule?: string;
-    page?: number;
-    limit?: number;
-    order?: 'created_at' | '-created_at';
-}
-export interface ValidationRulesListRulesAssignmentsResponseBody {
-    object: 'list';
-    data_ref: 'data';
-    total: number;
-    data: ValidationRulesAssignment[];
-}

package/dist/types/Validations.d.ts

@@ -1,98 +0,0 @@
-import { DiscountAmount, DiscountPercent, DiscountUnit, DiscountFixed } from './DiscountVoucher';
-import { CustomersCreateBody } from './Customers';
-import { StackableOptions, StackableRedeemableInapplicableResponse, StackableRedeemableParams, StackableRedeemableResponse, StackableRedeemableSkippedResponse } from './Stackable';
-import { ValidationSessionParams, ValidationSessionResponse } from './ValidateSession';
-import { ApplicableToResultList } from './ApplicableTo';
-import { ValidationError } from './ValidationError';
-import { OrdersItem, OrdersCreate, OrdersCreateResponse } 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?: ValidationSessionParams;
-}
-export interface ValidationsValidateVoucherResponse {
-    applicable_to?: ApplicableToResultList;
-    inapplicable_to?: ApplicableToResultList;
-    campaign?: string;
-    campaign_id?: string;
-    metadata?: Record<string, any>;
-    code?: string;
-    valid?: boolean;
-    discount?: DiscountAmount | DiscountUnit | DiscountPercent | DiscountFixed;
-    gift?: {
-        amount: number;
-        balance: number;
-    };
-    loyalty?: {
-        points_cost: number;
-    };
-    order?: {
-        amount: number;
-        discount_amount: number;
-        total_discount_amount: number;
-        total_amount: number;
-        applied_discount_amount?: number;
-        total_applied_discount_amount?: number;
-        items?: OrdersItem[];
-        initial_amount?: number;
-        items_discount_amount?: number;
-        items_applied_discount_amount?: number;
-        metadata?: Record<string, any>;
-    };
-    session?: ValidationSessionParams;
-    start_date?: string;
-    expiration_date?: string;
-    tracking_id: string;
-    error?: ValidationError;
-}
-export interface ValidationsValidateStackableParams {
-    options?: StackableOptions;
-    redeemables: StackableRedeemableParams[];
-    session?: ValidationSessionParams;
-    order?: OrdersCreate;
-    customer?: CustomersCreateBody;
-    metadata?: Record<string, any>;
-}
-export interface ValidationValidateStackableResponse {
-    valid: boolean;
-    tracking_id?: string;
-    session?: ValidationSessionResponse;
-    order?: OrdersCreateResponse;
-    redeemables?: StackableRedeemableResponse[];
-    skipped_redeemables?: StackableRedeemableSkippedResponse[];
-    inapplicable_redeemables?: StackableRedeemableInapplicableResponse[];
-    stacking_rules: ValidationsStackingRules;
-}
-export declare type ValidationsStackingRules = {
-    redeemables_limit: number;
-    applicable_redeemables_limit: number;
-    applicable_redeemables_per_category_limit?: number;
-    applicable_exclusive_redeemables_limit: number;
-    applicable_exclusive_redeemables_per_category_limit?: number;
-    exclusive_categories: string[];
-    joint_categories: string[];
-    redeemables_application_mode: 'ALL' | 'PARTIAL';
-    redeemables_sorting_rule: 'CATEGORY_HIERARCHY' | 'REQUESTED_ORDER';
-};
-export declare type ValidationsValidateCode = PromotionsValidateParams;
-export declare type ValidationsValidateContext = ValidationsValidateVoucherParams;

package/dist/types/Vouchers.d.ts

@@ -1,364 +0,0 @@
-import { OrdersGetResponse } from './Orders';
-import { SimpleCustomer } from './Customers';
-import { DiscountUnit, DiscountAmount, DiscountPercent, DiscountFixed } from './DiscountVoucher';
-import { LoyaltyCardTransaction } from './Loyalties';
-export declare type VoucherType = 'GIFT_VOUCHER' | 'DISCOUNT_VOUCHER' | 'LOYALTY_CARD' | 'LUCKY_DRAW';
-export interface SimpleVoucher {
-    code_config?: {
-        length?: number;
-        charset?: string;
-        pattern?: string;
-        prefix?: string;
-        suffix?: string;
-    };
-    type: VoucherType;
-    is_referral_code?: boolean;
-    discount?: DiscountUnit | DiscountAmount | DiscountPercent | DiscountFixed;
-    loyalty_card?: {
-        points: number;
-        balance: number;
-    };
-    redemption?: {
-        quantity: number;
-    };
-}
-export interface VouchersResponse {
-    id: string;
-    code: string;
-    campaign?: string;
-    category?: string;
-    type?: 'DISCOUNT_VOUCHER' | 'GIFT_VOUCHER';
-    discount?: DiscountAmount | DiscountPercent | DiscountUnit | DiscountFixed;
-    gift?: {
-        amount: number;
-        balance: number;
-    };
-    loyalty_card?: {
-        points: number;
-        balance: number;
-        next_expiration_date?: string;
-        next_expiration_points?: number;
-    };
-    start_date?: string;
-    expiration_date?: string;
-    validity_timeframe?: {
-        interval: string;
-        duration: string;
-    };
-    validity_day_of_week?: number[];
-    publish?: {
-        object: 'list';
-        count: number;
-        data_ref: 'entries';
-        entries: string[];
-        total: number;
-        url: string;
-    };
-    redemption?: {
-        object: 'list';
-        quantity?: number;
-        redeemed_quantity: number;
-        data_ref: 'redemption_entries';
-        redemption_entries: string[];
-        total: number;
-        url: string;
-    };
-    active: boolean;
-    additional_info?: string;
-    metadata?: Record<string, any>;
-    assets?: {
-        qr?: {
-            id: string;
-            url: string;
-        };
-        barcode?: {
-            id: string;
-            url: string;
-        };
-    };
-    is_referral_code: boolean;
-    referrer_id?: string;
-    holder_id?: string;
-    updated_at?: string;
-    created_at: string;
-    object: 'voucher';
-    validation_rules_assignments: {
-        object: 'list';
-        total: number;
-        data_ref: 'data';
-        data?: {
-            id: string;
-            rule_id?: string;
-            related_object_id?: string;
-            related_object_type?: string;
-            created_at: string;
-            object: 'validation_rules_assignment';
-        }[];
-    };
-}
-export interface VouchersQualificationExamineBody {
-    customer?: Omit<SimpleCustomer, 'object'> & {
-        description: string;
-    };
-    order?: Pick<OrdersGetResponse, 'id' | 'source_id' | 'amount' | 'items' | 'metadata'>;
-    reward?: {
-        id: string;
-        assignment_id?: string;
-    };
-    metadata?: Record<string, any>;
-}
-export interface VouchersQualificationExamineParams {
-    audienceRulesOnly?: boolean;
-    order?: 'created_at' | '-created_at' | 'updated_at' | '-updated_at';
-    limit?: number;
-}
-export interface VouchersQualificationExamineResponse {
-    object: 'list';
-    total: number;
-    data_ref: 'data';
-    data?: VouchersResponse[];
-}
-export interface VouchersCreateParameters {
-    active?: boolean;
-    code?: string;
-    code_config?: {
-        length?: number;
-        charset?: string;
-        pattern?: string;
-        prefix?: string;
-        suffix?: string;
-    };
-    redemption?: {
-        quantity: number;
-    };
-    validation_rules?: string[];
-}
-export declare type VouchersCreate = VouchersCreateParameters & Pick<VouchersResponse, 'type' | 'discount' | 'gift' | 'category' | 'additional_info' | 'start_date' | 'expiration_date' | 'metadata'>;
-export declare type VouchersCreateResponse = Omit<VouchersResponse, 'validation_rules_assignments'>;
-export declare type VouchersGetResponse = VouchersResponse;
-export interface VouchersUpdate {
-    code: string;
-    category?: string;
-    start_date?: string;
-    expiration_date?: string;
-    active?: boolean;
-    additional_info?: string;
-    metadata?: Record<string, any>;
-    gift?: {
-        amount: number;
-    };
-}
-export declare type VouchersUpdateResponse = VouchersResponse;
-export interface VouchersDeleteParams {
-    force?: boolean;
-}
-export interface VouchersListParams {
-    limit?: number;
-    page?: number;
-    category?: string;
-    campaign?: string;
-    customer?: string;
-    created_at?: {
-        after?: string;
-        before?: string;
-    };
-    updated_at?: {
-        after?: string;
-        before?: string;
-    };
-    order?: '-created_at' | 'created_at' | '-updated_at' | 'updated_at' | '-type' | 'type' | '-code' | 'code' | '-campaign' | 'campaign' | '-category' | 'category';
-    filters?: {
-        junction?: string;
-        [filter_condition: string]: any;
-    };
-}
-export interface VouchersListResponse {
-    object: 'list';
-    total: number;
-    data_ref: 'vouchers';
-    vouchers: VouchersResponse[];
-}
-export declare type VouchersEnableResponse = VouchersResponse;
-export declare type VouchersDisableResponse = VouchersResponse;
-export interface VouchersImport {
-    code: string;
-    category?: string;
-    type?: 'DISCOUNT_VOUCHER' | 'GIFT_VOUCHER';
-    discount: DiscountAmount | DiscountPercent | DiscountUnit | DiscountFixed;
-    additional_info?: string;
-    start_date?: string;
-    expiration_date?: string;
-    active?: boolean;
-    metadata?: Record<string, any>;
-    redemption?: {
-        quantity: number;
-    };
-    code_config?: {
-        length?: number;
-        charset?: string;
-        pattern?: string;
-        prefix?: string;
-        suffix?: string;
-    };
-}
-export interface VouchersBulkUpdateObject {
-    code: string;
-    metadata: Record<string, any>;
-}
-export declare type VouchersBulkUpdate = VouchersBulkUpdateObject[];
-export interface VouchersBulkUpdateMetadata {
-    codes: string[];
-    metadata: Record<string, any>;
-}
-export declare type VouchersImportResponse = {
-    async_action_id: string;
-};
-export declare type VouchersBulkUpdateMetadataResponse = {
-    async_action_id: string;
-};
-export declare type VouchersBulkUpdateResponse = {
-    async_action_id: string;
-};
-export declare type GiftCardTransaction = GiftCardTransactionBase & GiftCardTransactionDetails;
-export interface GiftCardTransactionBase {
-    id: string;
-    source_id: string | null;
-    voucher_id: string;
-    campaign_id: string | null;
-    related_transaction_id: string | null;
-    reason: string | null;
-    created_at: string;
-}
-export declare type GiftCardTransactionDetails = GiftCardTransactionRedemptionDetails | GiftCardTransactionRefundDetails | GiftCardTransactionAdditionDetails | GiftCardTransactionRemovalDetails;
-export interface GiftCardTransactionRedemptionDetails {
-    source: null;
-    type: 'CREDITS_REDEMPTION';
-    details: {
-        balance: {
-            type: 'gift_voucher';
-            total: number;
-            amount: number;
-            object: 'balance';
-            balance: number;
-            related_object: {
-                id: string;
-                type: 'voucher';
-            };
-        };
-        order: {
-            id: string;
-            source_id: string | null;
-        };
-        redemption: {
-            id: string;
-        };
-    };
-}
-export interface GiftCardTransactionRefundDetails {
-    source: null;
-    type: 'CREDITS_REFUND';
-    details: {
-        balance: {
-            type: 'gift_voucher';
-            total: number;
-            amount: number;
-            object: 'balance';
-            balance: number;
-            related_object: {
-                id: string;
-                type: 'voucher';
-            };
-        };
-        order: {
-            id: string;
-            source_id: string | null;
-        };
-        redemption: {
-            id: string;
-        };
-        rollback: {
-            id: string;
-        };
-    };
-}
-export interface GiftCardTransactionAdditionDetails {
-    source: 'voucherify-web-ui' | 'API';
-    type: 'CREDITS_ADDITION';
-    details: {
-        balance: {
-            type: 'gift_voucher';
-            total: number;
-            amount: number;
-            object: 'balance';
-            balance: number;
-            operation_type: 'MANUAL' | 'AUTOMATIC';
-            related_object: {
-                id: string;
-                type: 'voucher';
-            };
-        };
-    };
-}
-export interface GiftCardTransactionRemovalDetails {
-    source: 'voucherify-web-ui' | 'API';
-    type: 'CREDITS_REMOVAL';
-    details: {
-        balance: {
-            type: 'gift_voucher';
-            total: number;
-            amount: number;
-            object: 'balance';
-            balance: number;
-            operation_type: 'MANUAL' | 'AUTOMATIC';
-            related_object: {
-                id: string;
-                type: 'voucher';
-            };
-        };
-    };
-}
-export declare type VoucherTransaction = GiftCardTransaction | LoyaltyCardTransaction;
-export declare type VoucherTransactionsExportFields = 'id' | 'campaign_id' | 'voucher_id' | 'type' | 'source_id' | 'reason' | 'source' | 'balance' | 'amount' | 'related_transaction_id' | 'created_at' | 'details';
-export interface VouchersListTransactionsRequestQuery {
-    limit?: number;
-    starting_after_id?: string;
-    order?: 'id' | '-id';
-    /**
-     * @deprecated Use starting_after_id
-     */
-    page?: number;
-}
-export interface VouchersListTransactionsResponseBody {
-    object: 'list';
-    data_ref: 'data';
-    data: VoucherTransaction[];
-    has_more: boolean;
-    more_starting_after?: string;
-}
-export interface VouchersExportTransactionsRequestBody {
-    parameters?: {
-        order?: '-created_at' | 'created_at';
-        fields?: VoucherTransactionsExportFields[];
-    };
-}
-export interface VouchersExportTransactionsResponseBody {
-    id: string;
-    status: 'SCHEDULED';
-    channel: string;
-    parameters: {
-        order?: string;
-        fields?: VoucherTransactionsExportFields[];
-        filters: {
-            voucher_id: {
-                conditions: {
-                    $in: [string];
-                };
-            };
-        };
-    };
-    result: null;
-    user_id: string | null;
-    exported_object: 'voucher_transactions';
-    object: 'export';
-    created_at: string;
-}