@voucherify/sdk 2.9.3 → 2.9.4

package/dist/types/ClientSide.d.ts

@@ -0,0 +1,145 @@
+import { CustomerRequest, CustomersCreateBody, CustomersUpdateConsentsBody, CustomersCreateResponse } from './Customers.js';
+import { VouchersResponse, VouchersListParams } from './Vouchers.js';
+import { DiscountUnit, DiscountAmount, DiscountPercent, DiscountFixed } from './DiscountVoucher.js';
+import { OrdersItem, OrdersCreateResponse } from './Orders.js';
+import { ConsentsListResponse } from './Consents.js';
+import { DistributionsPublicationsCreateResponse } from './Distributions.js';
+import { SimplePromotionTier } from './PromotionTiers.js';
+import { ValidationSessionReleaseParams } from './ValidateSession.js';
+import { ApplicableToResultList } from './ApplicableTo.js';
+import { ValidationsValidateStackableParams, ValidationValidateStackableResponse } from './Validations.js';
+import { RedemptionsRedeemStackableParams, RedemptionsRedeemStackableResponse } from './Redemptions.js';
+import './ValidationRules.js';
+import './Stackable.js';
+import './Rewards.js';
+import './Gift.js';
+import './Products.js';
+import './Loyalties.js';
+import './Categories.js';
+import './ValidationError.js';
+import './Promotions.js';
+
+type ClientSideItem = Pick<OrdersItem, 'source_id' | 'sku_id' | 'product_id' | 'sku' | 'quantity' | 'related_object' | 'amount'>;
+type ClientSideCustomersUpdateConsentsBody = CustomersUpdateConsentsBody;
+type ClientSideCustomersCreateParams = CustomersCreateBody;
+type ClientSideCustomersCreateResponse = CustomersCreateResponse;
+interface ClientSideValidateParams {
+    code?: string;
+    tracking_id?: string;
+    amount?: number;
+    items?: ClientSideItem[];
+    orderMetadata?: Record<string, any>;
+    customer?: Pick<CustomerRequest, 'source_id' | 'metadata'>;
+    reward?: {
+        id: string;
+    };
+    metadata?: Record<string, any>;
+    session_type?: 'LOCK';
+    session_key?: string;
+    session_ttl?: number;
+    session_ttl_unit?: 'MILLISECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS';
+}
+type ClientSideListVouchersParams = VouchersListParams;
+type ClientSideVoucherListing = Pick<VouchersResponse, 'active' | 'code' | 'metadata' | 'assets' | 'object' | 'expiration_date' | 'start_date' | 'created_at'>;
+interface ClientSideListVouchersResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'vouchers';
+    vouchers: ClientSideVoucherListing[];
+}
+interface ClientSideValidateResponse {
+    code?: string;
+    valid: boolean;
+    discount?: DiscountUnit | DiscountAmount | DiscountPercent | DiscountFixed;
+    applicable_to?: ApplicableToResultList;
+    order?: {
+        amount: number;
+        discount_amount: number;
+        total_discount_amount: number;
+        total_amount: number;
+        items?: ClientSideItem[];
+    };
+    tracking_id?: string;
+    campaign_id?: string;
+    loyalty?: {
+        points_cost: number;
+    };
+    gift?: {
+        amount: number;
+        balance: number;
+    };
+    promotions?: SimplePromotionTier[];
+}
+interface ClientSideRedeemPayload {
+    tracking_id?: string;
+    customer?: CustomerRequest;
+    order?: ClientSideRedeemOrder;
+    metadata?: Record<string, any>;
+    reward?: {
+        id: string;
+    };
+    session?: ValidationSessionReleaseParams;
+}
+interface ClientSideRedeemResponse {
+    id: string;
+    object: 'redemption';
+    date?: string;
+    customer_id?: string;
+    tracking_id?: string;
+    order?: OrdersCreateResponse;
+    metadata?: Record<string, any>;
+    result: 'SUCCESS' | 'FAILURE';
+    voucher?: VouchersResponse;
+}
+interface ClientSidePublishPayload {
+    source_id?: string;
+    channel?: 'Voucherify.js' | string;
+    customer?: CustomerRequest;
+    voucher?: string;
+    metadata?: Record<string, any>;
+}
+type ClientSidePublishPreparedPayload = ClientSidePublishPayload;
+interface ClientSidePublishQueryParams {
+    join_once?: boolean;
+    campaign?: string;
+}
+interface ClientSidePublishCampaign {
+    name: string;
+    count?: number;
+}
+type ClientSidePublishResponse = DistributionsPublicationsCreateResponse & {
+    vouchers_id?: string[];
+};
+interface ClientSideTrackLoyalty {
+    code?: string;
+}
+interface ClientSideTrackReferral {
+    code?: string;
+}
+interface ClientSideTrackPayload {
+    event: string;
+    metadata?: Record<string, any>;
+    customer: CustomerRequest;
+    loyalty?: ClientSideTrackLoyalty;
+    referral?: ClientSideTrackReferral;
+}
+interface ClientSideTrackResponse {
+    object: 'event';
+    type: string;
+}
+type ClientSideRedeemOrder = Partial<Pick<OrdersCreateResponse, 'id' | 'source_id' | 'metadata' | 'amount'>> & {
+    items?: ClientSideItem[];
+};
+interface ClientSideRedeemWidgetPayload {
+    order?: {
+        amount?: number;
+    };
+}
+type ClientSideTrackCustomer = CustomerRequest;
+type ClientSideConsentsListResponse = ConsentsListResponse;
+type ClientSideValidationsValidateStackableParams = ValidationsValidateStackableParams;
+type ClientSideValidationValidateStackableResponse = ValidationValidateStackableResponse;
+type ClientSideRedemptionsRedeemStackableParams = RedemptionsRedeemStackableParams;
+type ClientSideRedemptionsRedeemStackableResponse = RedemptionsRedeemStackableResponse;
+
+export type { ClientSideConsentsListResponse, ClientSideCustomersCreateParams, ClientSideCustomersCreateResponse, ClientSideCustomersUpdateConsentsBody, ClientSideListVouchersParams, ClientSideListVouchersResponse, ClientSidePublishCampaign, ClientSidePublishPayload, ClientSidePublishPreparedPayload, ClientSidePublishQueryParams, ClientSidePublishResponse, ClientSideRedeemOrder, ClientSideRedeemPayload, ClientSideRedeemResponse, ClientSideRedeemWidgetPayload, ClientSideRedemptionsRedeemStackableParams, ClientSideRedemptionsRedeemStackableResponse, ClientSideTrackCustomer, ClientSideTrackLoyalty, ClientSideTrackPayload, ClientSideTrackReferral, ClientSideTrackResponse, ClientSideValidateParams, ClientSideValidateResponse, ClientSideValidationValidateStackableResponse, ClientSideValidationsValidateStackableParams, ClientSideVoucherListing };

package/dist/types/Consents.d.ts

@@ -0,0 +1,34 @@
+interface ConsentGroup {
+    id: string;
+    name: string;
+    description: string;
+    consents: string[];
+    created_at: string;
+    updated_at?: string;
+    object: 'consent_group';
+}
+interface Consent {
+    id: string;
+    name: string;
+    description: string;
+    category: string;
+    created_at: string;
+    updated_at?: string;
+    object: 'consent';
+}
+interface ConsentsListResponse {
+    groups: {
+        object: 'list';
+        total: number;
+        data_ref: 'data';
+        data: ConsentGroup[];
+    };
+    consents: {
+        object: 'list';
+        total: number;
+        data_ref: 'data';
+        data: Consent[];
+    };
+}
+
+export type { Consent, ConsentsListResponse };

package/dist/types/Customers.d.ts

@@ -0,0 +1,363 @@
+import { DiscountAmount, DiscountPercent, DiscountUnit, DiscountFixed } from './DiscountVoucher.js';
+
+interface SimpleCustomer {
+    id: string;
+    name?: string;
+    email?: string;
+    source_id?: string;
+    metadata?: Record<string, any>;
+    object: 'customer';
+}
+interface CustomerObject {
+    id: string;
+    source_id?: string;
+    name?: string;
+    email?: string;
+    phone?: string;
+    description?: string;
+    address: {
+        city?: string;
+        state?: string;
+        line_1?: string;
+        line_2?: string;
+        country?: string;
+        postal_code?: string;
+    };
+    summary: {
+        redemptions: {
+            total_redeemed: number;
+            total_failed: number;
+            total_succeeded: number;
+            total_rolled_back: number;
+            total_rollback_failed: number;
+            total_rollback_succeeded: number;
+            gift?: {
+                redeemed_amount: number;
+                amount_to_go: number;
+            };
+            loyalty?: {
+                redeemed_points: number;
+                points_to_go: number;
+            };
+        };
+        orders: {
+            total_amount: number;
+            total_count: number;
+            average_amount: number;
+            last_order_amount: number;
+            last_order_date?: string;
+        };
+    };
+    loyalty: {
+        points: number;
+        referred_customers: number;
+        campaigns?: Record<string, {
+            points: number;
+            referred_customers: number;
+        }>;
+    };
+    metadata: Record<string, any>;
+    created_at: string;
+    object: 'customer';
+}
+type CustomerUnconfirmed = Pick<CustomerObject, 'summary' | 'email' | 'loyalty'> & {
+    object: 'unconfirmed_customer';
+};
+interface CustomerRequest {
+    id?: string;
+    source_id?: string;
+    name?: string;
+    description?: string;
+    email?: string;
+    phone?: string;
+    birthday?: string;
+    birthdate?: string;
+    address?: {
+        city?: string;
+        state?: string;
+        line_1?: string;
+        line_2?: string;
+        country?: string;
+        postal_code?: string;
+    };
+    metadata?: Record<string, any>;
+}
+interface CustomersCommonListRequest {
+    limit?: number;
+    page?: number;
+    email?: string;
+    city?: string;
+    name?: string;
+    order?: 'created_at' | '-created_at';
+    starting_after?: Date | string;
+}
+interface CustomersCommonListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'customers';
+    customers: CustomerObject[];
+    has_more?: boolean;
+}
+interface CustomerActivityListQueryParams {
+    limit?: number;
+    order?: 'created_at' | '-created_at';
+    starting_after_id?: string;
+    campaign_type?: 'LOYALTY_PROGRAM' | 'PROMOTION' | 'DISCOUNT_COUPONS' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
+    campaign_id?: string;
+    category?: 'ACTION' | 'EFFECT';
+    type?: string;
+    start_date?: string;
+    end_date?: string;
+}
+interface CustomerActivityListResponse {
+    object: 'list';
+    data_ref: 'data';
+    data: Record<string, unknown>[];
+    has_more: boolean;
+    more_starting_after?: string;
+}
+interface CustomerActivitiesListQueryParams {
+    limit?: number;
+    order?: 'created_at' | '-created_at';
+    starting_after?: string;
+    starting_after_id?: string;
+    campaign_type?: 'LOYALTY_PROGRAM' | 'PROMOTION' | 'DISCOUNT_COUPONS' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
+    campaign_id?: string;
+}
+interface CustomerActivitiesListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'data';
+    data: Record<string, any>[];
+}
+interface CustomerRedeemablesListQueryParams {
+    limit?: number;
+    order?: 'created_at' | '-created_at' | 'id' | '-id';
+    starting_after_id?: string;
+    filters?: Record<string, any>;
+}
+interface CustomerRedeemablesListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'data';
+    data: CustomerRedeemablesListItemResponse[];
+    has_more: boolean;
+    more_starting_after?: string;
+}
+interface CustomerRedeemablesListItemResponse {
+    id: string;
+    created_at: string;
+    redeemable_id: string;
+    redeemable_object: string;
+    customer_id: string;
+    holder_role: 'OWNER' | 'REFERRER' | 'REFEREE';
+    campaign_id: string;
+    campaign_type: 'LOYALTY_PROGRAM' | 'PROMOTION' | 'DISCOUNT_COUPONS' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
+    voucher_type: 'GIFT_VOUCHER' | 'DISCOUNT_VOUCHER' | 'LOYALTY_CARD';
+    redeemable: CustomerRedeemablesListItemContainerResponse;
+}
+interface CustomerRedeemablesListItemContainerVoucherResponse {
+    id: string;
+    code: string;
+    campaign?: string;
+    camapign_id?: string;
+    category_id?: string;
+    type: 'GIFT_VOUCHER' | 'DISCOUNT_VOUCHER' | 'LOYALTY_CARD';
+    discount?: DiscountAmount | DiscountPercent | DiscountUnit | DiscountFixed;
+    gift?: {
+        amount: number;
+        balance: number;
+        effect: string;
+    };
+    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;
+        url: string;
+    };
+    redemption?: {
+        object: 'list';
+        quantity?: number;
+        redeemed_quantity: number;
+        url: string;
+        redeemed_points?: number;
+    };
+    active?: boolean;
+    additional_info?: string;
+    metadata?: Record<string, any>;
+    assets: {
+        qr: {
+            id: string;
+            url: string;
+        };
+        barcode: {
+            id: string;
+            url: string;
+        };
+    };
+    is_referral_code: boolean;
+    holder_id?: string;
+    updated_at?: string;
+    created_at: string;
+    object: 'voucher';
+}
+interface CustomerRedeemablesListItemContainerResponse {
+    type: 'voucher';
+    voucher?: CustomerRedeemablesListItemContainerVoucherResponse;
+    status: 'ACTIVE' | 'USED' | 'DISABLED' | 'NOT_ACTIVE_YET' | 'EXPIRED' | 'NO_BALANCE';
+}
+type CustomersCreateBody = CustomerRequest;
+type CustomersCreateResponse = CustomerObject | CustomerUnconfirmed;
+type CustomersGetResponse = CustomerObject | CustomerUnconfirmed;
+type CustomersListParams = CustomersCommonListRequest;
+type CustomersListResponse = CustomersCommonListResponse;
+type CustomersScrollParams = CustomersCommonListRequest;
+type CustomersScrollResponse = CustomersCommonListResponse;
+type CustomersScrollYield = CustomerObject;
+type IdOrSourceId = {
+    id: string;
+} | {
+    source_id: string;
+};
+type CustomersUpdateParams = CustomerRequest & IdOrSourceId;
+type CustomersUpdateResponse = CustomerObject | CustomerUnconfirmed;
+type CustomersUpdateConsentsBody = Record<string, boolean>;
+type CustomerBase = {
+    name?: string | null;
+    description?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    birthdate?: string | null;
+    metadata?: Record<string, unknown> | null;
+};
+type CustomerAddress = {
+    address?: {
+        city?: string | null;
+        state?: string | null;
+        line_1?: string | null;
+        line_2?: string | null;
+        country?: string | null;
+        postal_code?: string | null;
+    } | null;
+};
+type Referrer = CustomerRequest;
+type Customer = CustomerRequest;
+type ReferrerWithSummaryLoyaltyReferrals = CustomerWithSummaryLoyaltyReferrals;
+type CustomerId = {
+    id: string;
+    object: 'customer';
+};
+type ReferrerId = CustomerId;
+type CustomerWithSummaryLoyaltyReferrals = {
+    id?: string;
+    source_id?: string;
+    name?: string;
+    description?: string;
+    email?: string;
+    phone?: string;
+    birthday?: string;
+    birthdate?: string;
+    address: {
+        city?: string;
+        state?: string;
+        line_1?: string;
+        line_2?: string;
+        country?: string;
+        postal_code?: string;
+    } | null;
+    metadata?: Record<string, any>;
+    summary: CustomerSummary;
+    loyalty: CustomerLoyalty;
+    referrals: CustomerReferrals;
+    system_metadata: Record<string, unknown>;
+    created_at: string;
+    updated_at?: string;
+    assets?: {
+        cockpit_url?: string;
+    };
+    object: 'customer';
+};
+type CustomerSummary = {
+    redemptions: CustomerSummaryRedemptions;
+    orders: CustomerSummaryOrders;
+};
+type CustomerSummaryRedemptions = {
+    total_redeemed: number;
+    total_failed: number;
+    total_succeeded: number;
+    total_rolled_back: number;
+    total_rollback_failed: number;
+    total_rollback_succeeded: number;
+    gift: {
+        redeemed_amount: number;
+        amount_to_go: number;
+    };
+    loyalty_card: {
+        redeemed_points: number;
+        points_to_go: number;
+    };
+};
+type CustomerSummaryOrders = {
+    total_amount: number;
+    total_count: number;
+    average_amount: number;
+    last_order_amount: number;
+    last_order_date: string;
+};
+type CustomerLoyalty = {
+    points: number;
+    referred_customers: number;
+    campaigns: Record<string, {
+        points: number;
+        loyalty_tier: string;
+        referred_customers: number;
+    }>;
+};
+type CustomerReferrals = {
+    total: number;
+    campaigns: {
+        campaign_id: string;
+        referrer_id: string;
+        related_object_id: string;
+        related_object_type: string;
+        date: string;
+    }[];
+};
+type CustomersUpdateInBulkRequestBody = (CustomerBase & CustomerAddress & {
+    source_id: string | null;
+})[];
+interface CustomersUpdateMetadataInBulkRequestBody {
+    source_ids: string[];
+    metadata: Record<string, unknown>;
+}
+interface CustomersDeletePermanentlyResponseBody {
+    id: string;
+    created_at: string;
+    related_object_id: string;
+    related_object: 'customer';
+    status: 'DONE';
+    data_json: {
+        events: number;
+        customer_events: number;
+        daily_events: number;
+        segments: number;
+        orders: number;
+        order_events: number;
+        customer: 1;
+    };
+    object: 'pernament_deletion';
+}
+
+export type { Customer, CustomerActivitiesListQueryParams, CustomerActivitiesListResponse, CustomerActivityListQueryParams, CustomerActivityListResponse, CustomerId, CustomerLoyalty, CustomerObject, CustomerRedeemablesListItemContainerResponse, CustomerRedeemablesListItemContainerVoucherResponse, CustomerRedeemablesListItemResponse, CustomerRedeemablesListQueryParams, CustomerRedeemablesListResponse, CustomerReferrals, CustomerRequest, CustomerSummary, CustomerSummaryOrders, CustomerSummaryRedemptions, CustomerUnconfirmed, CustomerWithSummaryLoyaltyReferrals, CustomersCommonListRequest, CustomersCommonListResponse, CustomersCreateBody, CustomersCreateResponse, CustomersDeletePermanentlyResponseBody, CustomersGetResponse, CustomersListParams, CustomersListResponse, CustomersScrollParams, CustomersScrollResponse, CustomersScrollYield, CustomersUpdateConsentsBody, CustomersUpdateInBulkRequestBody, CustomersUpdateMetadataInBulkRequestBody, CustomersUpdateParams, CustomersUpdateResponse, Referrer, ReferrerId, ReferrerWithSummaryLoyaltyReferrals, SimpleCustomer };

package/dist/types/DiscountVoucher.d.ts

@@ -0,0 +1,94 @@
+type DiscountVouchersTypes = 'AMOUNT' | 'PERCENT' | 'UNIT' | 'FIXED';
+declare enum DiscountVouchersTypesEnum {
+    AMOUNT = "AMOUNT",
+    PERCENT = "PERCENT",
+    UNIT = "UNIT",
+    FIXED = "FIXED"
+}
+type DiscountVouchersEffectTypes = 'ADD_MISSING_ITEMS' | 'ADD_NEW_ITEMS' | 'ADD_MANY_ITEMS' | 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS' | 'APPLY_TO_ITEMS_PROPORTIONALLY' | 'APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY' | 'APPLY_TO_ITEMS_BY_QUANTITY';
+type DiscountUnitVouchersEffectTypes = 'ADD_MISSING_ITEMS' | 'ADD_NEW_ITEMS' | 'ADD_MANY_ITEMS';
+type DiscountAmountVouchersEffectTypes = 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS' | 'APPLY_TO_ITEMS_PROPORTIONALLY' | 'APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY' | 'APPLY_TO_ITEMS_BY_QUANTITY';
+type DiscountPercentVouchersEffectTypes = 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS';
+type DiscountFixedVouchersEffectTypes = 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS';
+interface SimpleSkuDiscountUnit {
+    id: string;
+    source_id?: string;
+    sku: string;
+}
+interface SimpleProductDiscountUnit {
+    id: string;
+    source_id?: string;
+    name: string;
+}
+interface DiscountUnit {
+    type?: DiscountVouchersTypesEnum.UNIT;
+    unit_off?: number;
+    unit_off_formula?: string;
+    effect?: DiscountUnitVouchersEffectTypes;
+    unit_type?: string;
+    product?: SimpleProductDiscountUnit;
+    sku?: SimpleSkuDiscountUnit;
+}
+interface DiscountAmount {
+    type?: DiscountVouchersTypesEnum.AMOUNT;
+    amount_off?: number;
+    amount_off_formula?: string;
+    effect?: DiscountAmountVouchersEffectTypes;
+}
+interface DiscountPercent {
+    type?: DiscountVouchersTypesEnum.PERCENT;
+    percent_off?: number;
+    percent_off_formula?: string;
+    amount_limit?: number;
+    effect?: DiscountPercentVouchersEffectTypes;
+}
+interface DiscountFixed {
+    type?: DiscountVouchersTypesEnum.FIXED;
+    fixed_amount?: number;
+    fixed_amount_formula?: string;
+    effect?: DiscountFixedVouchersEffectTypes;
+}
+type Discount = DiscountAmount_ | DiscountUnit_ | DiscountUnitMultiple_ | DiscountPercent_ | DiscountFixed_;
+type DiscountAmount_ = {
+    type: 'AMOUNT';
+    amount_off?: number;
+    amount_off_formula?: string;
+    aggregated_amount_limit?: number;
+    effect?: DiscountAmountVouchersEffectTypes;
+    is_dynamic?: boolean;
+};
+type DiscountUnit_ = {
+    type: 'UNIT';
+} & DiscountUnitBase_;
+type DiscountUnitBase_ = {
+    unit_off?: number;
+    unit_off_formula?: string;
+    unit_type: string;
+    product?: SimpleProductDiscountUnit;
+    sku?: SimpleSkuDiscountUnit;
+    effect?: 'ADD_MISSING_ITEMS' | 'ADD_NEW_ITEMS';
+    is_dynamic?: boolean;
+};
+type DiscountUnitMultiple_ = {
+    type: 'UNIT';
+    effect: 'ADD_MANY_ITEMS';
+    units: DiscountUnitBase_[];
+};
+type DiscountPercent_ = {
+    type: 'PERCENT';
+    percent_off?: number;
+    percent_off_formula?: string;
+    amount_limit?: number;
+    aggregated_amount_limit?: number;
+    effect?: DiscountPercentVouchersEffectTypes;
+    is_dynamic?: boolean;
+};
+type DiscountFixed_ = {
+    type: 'FIXED';
+    fixed_amount?: number;
+    fixed_amount_formula?: string;
+    effect?: DiscountFixedVouchersEffectTypes;
+    is_dynamic?: boolean;
+};
+
+export { type Discount, type DiscountAmount, type DiscountAmountVouchersEffectTypes, type DiscountAmount_, type DiscountFixed, type DiscountFixedVouchersEffectTypes, type DiscountFixed_, type DiscountPercent, type DiscountPercentVouchersEffectTypes, type DiscountPercent_, type DiscountUnit, type DiscountUnitBase_, type DiscountUnitMultiple_, type DiscountUnitVouchersEffectTypes, type DiscountUnit_, type DiscountVouchersEffectTypes, type DiscountVouchersTypes, DiscountVouchersTypesEnum };