@voucherify/sdk 2.9.2 → 2.9.4

package/dist/types/Vouchers.d.ts

@@ -1,364 +1,452 @@
-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;
-}
+import { OrdersGetResponse } from './Orders.js';
+import { SimpleCustomer } from './Customers.js';
+import { DiscountUnit, DiscountAmount, DiscountPercent, DiscountFixed } from './DiscountVoucher.js';
+
+interface LoyaltyCardTransaction {
+    id: string;
+    source_id: string | null;
+    voucher_id: string;
+    campaign_id: string;
+    source: string | null;
+    reason: string | null;
+    type: LoyaltyCardTransactionsType;
+    details: {
+        balance: {
+            type: 'loyalty_card';
+            total: number;
+            object: 'balance';
+            operation_type: 'MANUAL' | 'AUTOMATIC';
+            points: number;
+            balance: number;
+            related_object: {
+                id: string;
+                type: 'voucher';
+            };
+        };
+        order?: {
+            id: string;
+            source_id: string;
+        };
+        event?: {
+            id: string;
+            type: string;
+        };
+        earning_rule?: {
+            id: string;
+            source: {
+                banner: string;
+            };
+        };
+        segment?: {
+            id: string;
+            name: string;
+        };
+        loyalty_tier?: {
+            id: string;
+            name: string;
+        };
+        redemption?: {
+            id: string;
+        };
+        rollback?: {
+            id: string;
+        };
+        reward?: {
+            id: string;
+            name: string;
+        };
+        custom_event?: {
+            id: string;
+            type: string;
+        };
+        event_schema?: {
+            id: string;
+            name: string;
+        };
+        source_voucher?: SimpleLoyaltyVoucher;
+        destination_voucher?: SimpleLoyaltyVoucher;
+    };
+    related_transaction_id: string | null;
+    created_at: string;
+}
+type LoyaltyCardTransactionsType = 'POINTS_ACCRUAL' | 'POINTS_CANCELLATION' | 'POINTS_REDEMPTION' | 'POINTS_REFUND' | 'POINTS_ADDITION' | 'POINTS_REMOVAL' | 'POINTS_EXPIRATION' | 'POINTS_TRANSFER_IN' | 'POINTS_TRANSFER_OUT';
+interface SimpleLoyaltyVoucher {
+    id: string;
+    code: string;
+    loyalty_card: {
+        points: number;
+        balance: number;
+        next_expiration_date?: string;
+        next_expiration_points?: string;
+    };
+    type: 'LOYALTY_CARD';
+    campaign: string;
+    campaign_id: string;
+    is_referral_code?: boolean;
+    holder_id?: string;
+    referrer_id?: string;
+    created_at?: string;
+    object: 'voucher';
+}
+type VoucherType = 'GIFT_VOUCHER' | 'DISCOUNT_VOUCHER' | 'LOYALTY_CARD' | 'LUCKY_DRAW';
+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;
+    };
+}
+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';
+        }[];
+    };
+}
+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>;
+}
+interface VouchersQualificationExamineParams {
+    audienceRulesOnly?: boolean;
+    order?: 'created_at' | '-created_at' | 'updated_at' | '-updated_at';
+    limit?: number;
+}
+interface VouchersQualificationExamineResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'data';
+    data?: VouchersResponse[];
+}
+interface VouchersCreateParameters {
+    active?: boolean;
+    code?: string;
+    code_config?: {
+        length?: number;
+        charset?: string;
+        pattern?: string;
+        prefix?: string;
+        suffix?: string;
+    };
+    redemption?: {
+        quantity: number;
+    };
+    validation_rules?: string[];
+}
+type VouchersCreate = VouchersCreateParameters & Pick<VouchersResponse, 'type' | 'discount' | 'gift' | 'category' | 'additional_info' | 'start_date' | 'expiration_date' | 'metadata'>;
+type VouchersCreateResponse = Omit<VouchersResponse, 'validation_rules_assignments'>;
+type VouchersGetResponse = VouchersResponse;
+interface VouchersUpdate {
+    code: string;
+    category?: string;
+    start_date?: string;
+    expiration_date?: string;
+    active?: boolean;
+    additional_info?: string;
+    metadata?: Record<string, any>;
+    gift?: {
+        amount: number;
+    };
+}
+type VouchersUpdateResponse = VouchersResponse;
+interface VouchersDeleteParams {
+    force?: boolean;
+}
+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;
+    };
+}
+interface VouchersListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'vouchers';
+    vouchers: VouchersResponse[];
+}
+type VouchersEnableResponse = VouchersResponse;
+type VouchersDisableResponse = VouchersResponse;
+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;
+    };
+}
+interface VouchersBulkUpdateObject {
+    code: string;
+    metadata: Record<string, any>;
+}
+type VouchersBulkUpdate = VouchersBulkUpdateObject[];
+interface VouchersBulkUpdateMetadata {
+    codes: string[];
+    metadata: Record<string, any>;
+}
+type VouchersImportResponse = {
+    async_action_id: string;
+};
+type VouchersBulkUpdateMetadataResponse = {
+    async_action_id: string;
+};
+type VouchersBulkUpdateResponse = {
+    async_action_id: string;
+};
+type GiftCardTransaction = GiftCardTransactionBase & GiftCardTransactionDetails;
+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;
+}
+type GiftCardTransactionDetails = GiftCardTransactionRedemptionDetails | GiftCardTransactionRefundDetails | GiftCardTransactionAdditionDetails | GiftCardTransactionRemovalDetails;
+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;
+        };
+    };
+}
+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;
+        };
+    };
+}
+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';
+            };
+        };
+    };
+}
+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';
+            };
+        };
+    };
+}
+type VoucherTransaction = GiftCardTransaction | LoyaltyCardTransaction;
+type VoucherTransactionsExportFields = 'id' | 'campaign_id' | 'voucher_id' | 'type' | 'source_id' | 'reason' | 'source' | 'balance' | 'amount' | 'related_transaction_id' | 'created_at' | 'details';
+interface VouchersListTransactionsRequestQuery {
+    limit?: number;
+    starting_after_id?: string;
+    order?: 'id' | '-id';
+    /**
+     * @deprecated Use starting_after_id
+     */
+    page?: number;
+}
+interface VouchersListTransactionsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: VoucherTransaction[];
+    has_more: boolean;
+    more_starting_after?: string;
+}
+interface VouchersExportTransactionsRequestBody {
+    parameters?: {
+        order?: '-created_at' | 'created_at';
+        fields?: VoucherTransactionsExportFields[];
+    };
+}
+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;
+}
+
+export type { GiftCardTransaction, GiftCardTransactionAdditionDetails, GiftCardTransactionBase, GiftCardTransactionDetails, GiftCardTransactionRedemptionDetails, GiftCardTransactionRefundDetails, GiftCardTransactionRemovalDetails, SimpleVoucher, VoucherTransaction, VoucherTransactionsExportFields, VoucherType, VouchersBulkUpdate, VouchersBulkUpdateMetadata, VouchersBulkUpdateMetadataResponse, VouchersBulkUpdateObject, VouchersBulkUpdateResponse, VouchersCreate, VouchersCreateParameters, VouchersCreateResponse, VouchersDeleteParams, VouchersDisableResponse, VouchersEnableResponse, VouchersExportTransactionsRequestBody, VouchersExportTransactionsResponseBody, VouchersGetResponse, VouchersImport, VouchersImportResponse, VouchersListParams, VouchersListResponse, VouchersListTransactionsRequestQuery, VouchersListTransactionsResponseBody, VouchersQualificationExamineBody, VouchersQualificationExamineParams, VouchersQualificationExamineResponse, VouchersResponse, VouchersUpdate, VouchersUpdateResponse };