@voucherify/sdk 2.9.2 → 2.9.3

package/dist/types/Customers.d.ts

@@ -1,361 +0,0 @@
-import { DiscountUnit, DiscountAmount, DiscountPercent, DiscountFixed } from './DiscountVoucher';
-export interface SimpleCustomer {
-    id: string;
-    name?: string;
-    email?: string;
-    source_id?: string;
-    metadata?: Record<string, any>;
-    object: 'customer';
-}
-export 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';
-}
-export declare type CustomerUnconfirmed = Pick<CustomerObject, 'summary' | 'email' | 'loyalty'> & {
-    object: 'unconfirmed_customer';
-};
-export 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>;
-}
-export interface CustomersCommonListRequest {
-    limit?: number;
-    page?: number;
-    email?: string;
-    city?: string;
-    name?: string;
-    order?: 'created_at' | '-created_at';
-    starting_after?: Date | string;
-}
-export interface CustomersCommonListResponse {
-    object: 'list';
-    total: number;
-    data_ref: 'customers';
-    customers: CustomerObject[];
-    has_more?: boolean;
-}
-export 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;
-}
-export interface CustomerActivityListResponse {
-    object: 'list';
-    data_ref: 'data';
-    data: Record<string, unknown>[];
-    has_more: boolean;
-    more_starting_after?: string;
-}
-export 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;
-}
-export interface CustomerActivitiesListResponse {
-    object: 'list';
-    total: number;
-    data_ref: 'data';
-    data: Record<string, any>[];
-}
-export interface CustomerRedeemablesListQueryParams {
-    limit?: number;
-    order?: 'created_at' | '-created_at' | 'id' | '-id';
-    starting_after_id?: string;
-    filters?: Record<string, any>;
-}
-export interface CustomerRedeemablesListResponse {
-    object: 'list';
-    total: number;
-    data_ref: 'data';
-    data: CustomerRedeemablesListItemResponse[];
-    has_more: boolean;
-    more_starting_after?: string;
-}
-export 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;
-}
-export 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';
-}
-export interface CustomerRedeemablesListItemContainerResponse {
-    type: 'voucher';
-    voucher?: CustomerRedeemablesListItemContainerVoucherResponse;
-    status: 'ACTIVE' | 'USED' | 'DISABLED' | 'NOT_ACTIVE_YET' | 'EXPIRED' | 'NO_BALANCE';
-}
-export declare type CustomersCreateBody = CustomerRequest;
-export declare type CustomersCreateResponse = CustomerObject | CustomerUnconfirmed;
-export declare type CustomersGetResponse = CustomerObject | CustomerUnconfirmed;
-export declare type CustomersListParams = CustomersCommonListRequest;
-export declare type CustomersListResponse = CustomersCommonListResponse;
-export declare type CustomersScrollParams = CustomersCommonListRequest;
-export declare type CustomersScrollResponse = CustomersCommonListResponse;
-export declare type CustomersScrollYield = CustomerObject;
-declare type IdOrSourceId = {
-    id: string;
-} | {
-    source_id: string;
-};
-export declare type CustomersUpdateParams = CustomerRequest & IdOrSourceId;
-export declare type CustomersUpdateResponse = CustomerObject | CustomerUnconfirmed;
-export declare type CustomersUpdateConsentsBody = Record<string, boolean>;
-declare type CustomerBase = {
-    name?: string | null;
-    description?: string | null;
-    email?: string | null;
-    phone?: string | null;
-    birthdate?: string | null;
-    metadata?: Record<string, unknown> | null;
-};
-declare 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;
-};
-export declare type Referrer = CustomerRequest;
-export declare type Customer = CustomerRequest;
-export declare type ReferrerWithSummaryLoyaltyReferrals = CustomerWithSummaryLoyaltyReferrals;
-export declare type CustomerId = {
-    id: string;
-    object: 'customer';
-};
-export declare type ReferrerId = CustomerId;
-export declare 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';
-};
-export declare type CustomerSummary = {
-    redemptions: CustomerSummaryRedemptions;
-    orders: CustomerSummaryOrders;
-};
-export declare 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;
-    };
-};
-export declare type CustomerSummaryOrders = {
-    total_amount: number;
-    total_count: number;
-    average_amount: number;
-    last_order_amount: number;
-    last_order_date: string;
-};
-export declare type CustomerLoyalty = {
-    points: number;
-    referred_customers: number;
-    campaigns: Record<string, {
-        points: number;
-        loyalty_tier: string;
-        referred_customers: number;
-    }>;
-};
-export declare type CustomerReferrals = {
-    total: number;
-    campaigns: {
-        campaign_id: string;
-        referrer_id: string;
-        related_object_id: string;
-        related_object_type: string;
-        date: string;
-    }[];
-};
-export declare type CustomersUpdateInBulkRequestBody = (CustomerBase & CustomerAddress & {
-    source_id: string | null;
-})[];
-export interface CustomersUpdateMetadataInBulkRequestBody {
-    source_ids: string[];
-    metadata: Record<string, unknown>;
-}
-export 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 {};

package/dist/types/DiscountVoucher.d.ts

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

package/dist/types/Distributions.d.ts

@@ -1,144 +0,0 @@
-import { CustomerRequest, SimpleCustomer } from './Customers';
-import { VoucherType } from './Vouchers';
-declare type OrderType = 'id' | '-id' | 'voucher_code' | '-voucher_code' | 'tracking_id' | '-tracking_id' | 'customer_id' | '-customer_id' | 'created_at' | '-created_at' | 'channel' | '-channel';
-export interface VoucherDiscount {
-    type: 'UNIT' | 'AMOUNT' | 'DISCOUNT';
-    unit_off?: number;
-    unit_off_formula?: string;
-    effect?: string;
-    amount_off?: number;
-    amount_off_formula?: string;
-    percent_off?: number;
-    percent_off_formula?: string;
-    amount_limit?: number;
-}
-interface DistributionsPublicationsVoucher {
-    code?: string;
-    object?: 'voucher';
-    campaign?: string;
-    gift?: {
-        amount: number;
-        balance: number;
-    };
-    loyalty_card?: {
-        amount: number;
-        balance: number;
-    };
-    is_referral_code?: boolean;
-    discount?: VoucherDiscount;
-}
-interface DistributionsPublicationsCreateResponseVoucher {
-    id: string;
-    code: string;
-    campaign?: string;
-    campaign_id?: string;
-    category?: string;
-    type?: VoucherType;
-    discount?: VoucherDiscount;
-    gift?: {
-        amount: number;
-        balance: number;
-    };
-    loyalty_card?: {
-        amount: number;
-        balance: number;
-    };
-    start_date?: string;
-    expiration_date?: string;
-    validity_timeframe?: string;
-    validity_day_of_week?: 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;
-    created_at: string;
-    updated_at?: string;
-    holder_id?: string;
-    object: 'voucher';
-    publish: {
-        object: string;
-        count: number;
-        url: string;
-    };
-    redemption: {
-        object: string;
-        quantity: number;
-        redeemed_quantity: number;
-        url: string;
-    };
-}
-export interface DistributionsPublicationsListParams {
-    limit?: number;
-    page?: number;
-    order?: OrderType;
-    campaign?: string;
-    customer?: string;
-    voucher?: string;
-    result?: 'SUCCESS' | 'FAILURE';
-    voucher_type?: 'GIFT' | 'DISCOUNT' | 'LOYALTY_CARD' | 'LUCKY_DRAW';
-    is_referral_code?: boolean;
-    filters?: {
-        junction?: 'OR' | 'AND';
-        [filter_condition: string]: any;
-    };
-}
-interface PublicationResponse {
-    id: string;
-    source_id?: string;
-    object: 'publication';
-    created_at: string;
-    customer_id?: string;
-    tracking_id?: string;
-    metadata?: Record<string, any>;
-    channel?: string;
-    result: 'SUCCESS' | 'FAILURE';
-    customer?: {
-        object?: string;
-        id: string;
-    };
-    voucher?: DistributionsPublicationsVoucher;
-    vouchers?: string[];
-    failure_code?: string;
-    failure_message?: string;
-}
-export interface DistributionsPublicationsListResponse {
-    object: 'list';
-    total: number;
-    data_ref: 'publications';
-    publications?: PublicationResponse[];
-}
-export interface DistributionsPublicationsCreateParams {
-    join_once?: boolean;
-    source_id?: string;
-    campaign?: {
-        name: string;
-        count?: number;
-    };
-    voucher?: string;
-    channel?: string;
-    customer: CustomerRequest;
-}
-export interface DistributionsPublicationsCreateResponse {
-    id: string;
-    object: 'publication';
-    created_at: string;
-    customer_id: string;
-    tracking_id?: string;
-    metadata?: Record<string, any>;
-    channel?: string;
-    source_id?: string;
-    result: 'SUCCESS' | 'FAILURE';
-    customer?: SimpleCustomer;
-    voucher: DistributionsPublicationsCreateResponseVoucher;
-}
-export {};

package/dist/types/Events.d.ts

@@ -1,17 +0,0 @@
-import { CustomerRequest } from './Customers';
-export interface EventsParams {
-    event: string;
-    customer: CustomerRequest;
-    metadata?: Record<string, any>;
-    referral?: {
-        code: string;
-        referrer_id?: string;
-    };
-    loyalty?: {
-        code: string;
-    };
-}
-export interface EventsResponse {
-    object: 'event';
-    type: string;
-}