@voucherify/sdk 1.2.0

package/dist/types/Loyalties.d.ts

@@ -0,0 +1,462 @@
+import { OrdersCreateResponse, OrdersItem } from './Orders';
+import { ProductsCreateResponse, ProductsCreateSkuResponse } from './Products';
+import { SimpleCustomer } from './Customers';
+import { ValidationRulesCreateAssignmentResponse } from './ValidationRules';
+import { VouchersResponse } from './Vouchers';
+interface LoyaltiesVoucher {
+    code_config?: {
+        length?: number;
+        charset?: string;
+        pattern?: string;
+        prefix?: string;
+        suffix?: string;
+    };
+    type?: string;
+    is_referral_code?: boolean;
+    loyalty_card?: {
+        points: number;
+        balance: number;
+    };
+    redemption?: {
+        quantity?: number;
+    };
+}
+export interface LoyaltiesListParams {
+    limit?: number;
+    page?: number;
+}
+export interface LoyaltiesListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'campaigns';
+    campaigns?: LoyaltiesCreateCampaignResponse[];
+}
+export interface LoyaltiesCreateCampaign {
+    name: string;
+    start_date?: string;
+    expiration_date?: string;
+    type?: 'AUTO_UPDATE' | 'STATIC';
+    vouchers_count?: number;
+    voucher: {
+        type: 'LOYALTY_CARD';
+        redemption?: {
+            quantity: number;
+        };
+        loyalty_card: {
+            points: number;
+            balance?: number;
+        };
+        code_config?: {
+            length?: number;
+            charset?: string;
+            pattern?: string;
+            prefix?: string;
+            suffix?: string;
+        };
+    };
+    metadata?: Record<string, any>;
+}
+export interface LoyaltiesCreateCampaignResponse {
+    id: string;
+    name: string;
+    campaign_type?: 'LOYALTY_PROGRAM';
+    type: 'AUTO_UPDATE' | 'STATIC';
+    category?: string;
+    auto_join?: boolean;
+    join_once?: boolean;
+    description?: string;
+    start_date?: string;
+    validation_rules_assignments?: {
+        data?: ValidationRulesCreateAssignmentResponse[];
+        object: 'list';
+        total: number;
+        data_ref: 'data';
+    };
+    expiration_date?: string;
+    activity_duration_after_publishing?: string;
+    validity_timeframe?: {
+        interval?: string;
+        duration?: string;
+    };
+    validity_day_of_week?: number[];
+    metadata?: Record<string, any>;
+    created_at: string;
+    vouchers_generation_status: 'IN_PROGRESS' | 'DONE' | 'FAILED' | 'DRAFT';
+    active: boolean;
+    voucher?: LoyaltiesVoucher;
+    referral_program?: boolean;
+    use_voucher_metadata_schema?: boolean;
+    protected?: boolean;
+    vouchers_count?: number;
+    object: 'campaign';
+}
+export declare type LoyaltiesGetCampaignResponse = LoyaltiesCreateCampaignResponse;
+export interface LoyaltiesUpdateCampaign {
+    id: string;
+    start_date?: string;
+    expiration_date?: string;
+    metadata?: Record<string, any>;
+    description?: string;
+    type?: 'AUTO_UPDATE' | 'STATIC';
+}
+export declare type LoyaltiesUpdateCampaignResponse = LoyaltiesCreateCampaignResponse;
+export interface LoyaltiesDeleteCampaignParams {
+    force?: boolean;
+}
+export interface LoyaltiesListRewardAssignmentsParams {
+    limit?: number;
+    page?: number;
+}
+export interface LoyaltiesListRewardAssignmentsResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'data';
+    data: LoyaltiesCreateRewardAssignmentResponse[];
+}
+export interface LoyaltiesCreateRewardAssignments {
+    reward: string;
+    parameters: {
+        loyalty: {
+            points: number;
+        };
+    };
+}
+export interface LoyaltiesCreateRewardAssignmentResponse {
+    id: string;
+    reward_id: string;
+    related_object_id?: string;
+    related_object_type?: string;
+    parameters?: {
+        loyalty: {
+            points: number;
+        };
+    };
+    created_at: string;
+    updated_at?: string;
+    object: 'reward_assignment';
+}
+export interface LoyaltiesUpdateRewardAssignment {
+    id: string;
+    parameters: {
+        loyalty: {
+            points: number;
+        };
+    };
+}
+export declare type LoyaltiesUpdateRewardAssignmentResponse = LoyaltiesCreateRewardAssignmentResponse;
+export interface LoyaltiesListEarningRulesParams {
+    limit?: number;
+    page?: number;
+}
+export interface LoyaltyFixed {
+    type: 'FIXED';
+    points: number;
+}
+export interface LoyaltyProportional {
+    type: 'PROPORTIONAL';
+    order?: {
+        amount: {
+            every: number;
+            points: number;
+        };
+    };
+}
+export interface LoyaltiesEarningRulesResponse {
+    id: string;
+    created_at: string;
+    updated_at?: string;
+    validation_rule_id?: string;
+    loyalty: LoyaltyFixed | LoyaltyProportional;
+    segment?: {
+        id: string;
+    };
+    event: 'customer.segment.entered' | 'order.paid' | string;
+    source?: {
+        banner?: string;
+        object_id?: string;
+        object_type?: string;
+    };
+    object: 'earning_rule';
+    automation_id: string;
+}
+export interface LoyaltiesListEarningRulesResponse {
+    object: 'list';
+    total: number;
+    data_ref: string;
+    data: LoyaltiesEarningRulesResponse[];
+}
+export interface LoyaltiesCreateEarningRule {
+    event: 'order.paid' | 'customer.segment.entered' | string;
+    validation_rule_id?: string;
+    loyalty: LoyaltyProportional | LoyaltyFixed;
+    source?: {
+        banner?: string;
+    };
+    custom_event?: {
+        schema_id?: string;
+    };
+    segment?: {
+        id?: string;
+    };
+}
+export declare type LoyaltiesCreateEarningRuleResponse = LoyaltiesEarningRulesResponse;
+export interface LoyaltiesUpdateEarningRule {
+    id: string;
+    validation_rule_id?: string;
+    source?: {
+        banner: string;
+    };
+    loyalty?: {
+        points: number;
+    };
+}
+export declare type LoyaltiesUpdateEarningRuleResponse = LoyaltiesEarningRulesResponse;
+export interface LoyaltiesListMembersParams {
+    limit?: number;
+    page?: number;
+    created_at?: {
+        before?: string;
+        after?: string;
+    };
+    updated_at?: {
+        before?: string;
+        after?: string;
+    };
+}
+export interface LoyaltiesVoucherResponse {
+    id: string;
+    code: string;
+    campaign: string;
+    campaign_id: string;
+    category?: string;
+    type: 'LOYALTY_CARD';
+    loyalty_card: {
+        points: number;
+        balance: number;
+    };
+    start_date?: string;
+    expiration_date?: string;
+    validity_timeframe?: {
+        interval?: string;
+        duration?: string;
+    };
+    validity_day_of_week?: number[];
+    publish?: {
+        count?: number;
+        entries?: string[];
+    };
+    redemption?: {
+        quantity?: number;
+        redeemed_points?: number;
+        redeemed_quantity?: number;
+        redemption_entries?: string[];
+    };
+    active?: boolean;
+    additional_info?: string;
+    metadata?: Record<string, any>;
+    is_referral_code?: boolean;
+    holder_id?: string;
+    updated_at?: string;
+}
+export interface LoyaltiesListMembersResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'vouchers';
+    vouchers: LoyaltiesVoucherResponse[];
+}
+export interface LoyaltiesCreateMember {
+    voucher?: string;
+    channel?: string;
+    customer: {
+        id?: string;
+        name?: string;
+        email?: string;
+        metadata?: Record<string, any>;
+        description?: string;
+        source_id?: string;
+    };
+    metadata?: Record<string, any>;
+}
+export declare type LoyaltiesCreateMemberResponse = LoyaltiesVoucherResponse;
+export declare type LoyaltiesGetMemberResponse = LoyaltiesCreateMemberResponse;
+export interface LoyaltiesGetMemberActivitiesResponse {
+    object: 'list';
+    data_ref: 'activities';
+    total: number;
+    activities: {
+        id: string;
+        type: string;
+        object: string;
+        created_at: string;
+        data: any;
+    }[];
+}
+export interface LoyaltiesAddPoints {
+    points: number;
+}
+export interface LoyaltiesAddPointsResponse {
+    points: number;
+    total: number;
+    balance: number;
+    type: string;
+    object: 'balance';
+    related_object?: {
+        type?: string;
+        id?: string;
+    };
+}
+export interface LoyaltiesRedeemRewardParams {
+    reward: {
+        id: string;
+    };
+    order?: {
+        id?: string;
+        source_id?: string;
+        amount: number;
+        items?: OrdersItem[];
+        metadata?: Record<string, any>;
+    };
+    metadata?: Record<string, any>;
+}
+interface CoinReward {
+    assignment_id: string;
+    loyalty_tier_id: string;
+    id: string;
+    name: string;
+    created_at: string;
+    updated_at?: string;
+    parameters: {
+        automation_id?: string;
+        coin: {
+            exchange_ratio: number;
+            points_ratio: number;
+        };
+    };
+    type: 'COIN';
+    object: 'reward';
+}
+interface MaterialReward {
+    assignment_id: string;
+    loyalty_tier_id: string;
+    product: ProductsCreateResponse & ProductsCreateSkuResponse;
+    id: string;
+    name: string;
+    created_at: string;
+    updated_at?: string;
+    parameters: {
+        automation_id?: string;
+        product?: {
+            id: string;
+        };
+    };
+    type: 'MATERIAL';
+    object: 'reward';
+}
+interface CampaignReward {
+    assignment_id: string;
+    loyalty_tier_id: string;
+    voucher: VouchersResponse;
+    id: string;
+    name: string;
+    created_at: string;
+    updated_at?: string;
+    parameters: {
+        automation_id?: string;
+        campaign?: {
+            id: string;
+        };
+    };
+    type: 'CAMPAIGN';
+    object: 'reward';
+}
+export interface LoyaltiesRedeemRewardResponse {
+    id: string;
+    object: 'redemption';
+    date: string;
+    customer_id: string;
+    amount: number;
+    order?: Omit<OrdersCreateResponse, 'customer'> & {
+        total_discount_amount: number;
+        total_amount: number;
+        customer: {
+            id: string;
+            object: 'customer';
+            referrals: {
+                campaigns: any[];
+                total: number;
+            };
+        };
+    };
+    customer: SimpleCustomer;
+    reward: MaterialReward | CampaignReward | CoinReward;
+    result: 'SUCCESS' | 'FAILURE';
+    tracking_id?: string;
+    voucher: {
+        id: string;
+        code?: string;
+        campaign?: string;
+        campaign_id?: string;
+        category?: string;
+        type: 'LOYALTY_CARD';
+        loyalty_card?: {
+            points: number;
+            balance: 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: true;
+        additional_info?: string;
+        assets?: {
+            qr?: {
+                id: string;
+                url: string;
+            };
+            barcode?: {
+                id: string;
+                url: string;
+            };
+        };
+        is_referral_code: boolean;
+        referrer_id: string;
+        holder_id: string;
+        updated_at: string;
+        holder: {
+            id: string;
+            source_id: string;
+            metadata?: Record<string, any>;
+            object: 'customer';
+        };
+        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 {};

package/dist/types/Orders.d.ts

@@ -0,0 +1,61 @@
+import { CustomerRequest } from './Customers';
+export interface OrdersItem {
+    sku_id?: string;
+    product_id?: string;
+    related_object?: 'product' | 'sku';
+    source_id?: string;
+    quantity?: number;
+    price?: number;
+    amount?: number;
+    product?: {
+        override?: boolean;
+        name?: string;
+        metadata?: Record<string, any>;
+    };
+    sku?: {
+        override?: boolean;
+        sku?: string;
+    };
+}
+export interface OrdersCreate {
+    customer?: CustomerRequest;
+    amount?: number;
+    items?: OrdersItem[];
+    metadata?: Record<string, any>;
+}
+export interface OrdersCreateResponse {
+    id: string;
+    source_id?: string;
+    created_at: string;
+    updated_at?: string;
+    status?: 'CREATED' | 'PAID' | 'PROCESSING' | 'CANCELED' | 'FULFILLED';
+    amount?: number;
+    discount_amount?: number;
+    items?: OrdersItem[];
+    metadata?: Record<string, any>;
+    customer?: CustomerRequest;
+    object: 'order';
+}
+export declare type OrdersGetResponse = OrdersCreateResponse;
+export interface OrdersUpdate {
+    id: string;
+    source_id?: string;
+    status?: 'CREATED' | 'PAID' | 'CANCELLED' | 'FULFILLED';
+    items?: OrdersItem[];
+    amount?: number;
+    metadata?: Record<string, any>;
+    customer?: {
+        id: string;
+    };
+}
+export declare type OrdersUpdateResponse = OrdersGetResponse;
+export interface OrdersListParams {
+    limit?: number;
+    page?: number;
+}
+export interface OrdersListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'orders';
+    orders: OrdersGetResponse[];
+}

package/dist/types/Products.d.ts

@@ -0,0 +1,97 @@
+export interface ProductsCreate {
+    name?: string;
+    source_id?: string;
+    price?: number;
+    attributes?: string[];
+    metadata?: Record<string, any>;
+    image_url?: string;
+}
+export interface ProductsGetResponseSkus {
+    skus?: {
+        object: 'list';
+        total: number;
+        data?: ProductsGetSkuResponse[];
+    };
+}
+export interface ProductsCreateResponse {
+    id: string;
+    source_id?: string;
+    object: 'product';
+    name?: string;
+    price?: number;
+    attributes?: string[];
+    created_at: string;
+    image_url?: string;
+}
+export declare type ProductsGetResponse = ProductsCreateResponse & ProductsGetResponseSkus;
+export declare type ProductsUpdate = {
+    name?: string;
+    id?: string;
+    source_id?: string;
+    attributes?: string[];
+    price?: number;
+    image_url?: string;
+    metadata?: Record<string, any>;
+};
+export declare type ProductsUpdateResponse = ProductsCreateResponse;
+export interface ProductsBulkMetadataUpdate {
+    source_ids: string[];
+    metadata: Record<string, any>;
+}
+export declare type ProductsBulkUpdate = ProductsCreate[];
+interface BulkUpdateResponse {
+    source_id?: string;
+    found: boolean;
+    updated: boolean;
+}
+export declare type ProductsBulkUpdateResponse = BulkUpdateResponse[];
+export declare type ProductsBulkMetadataUpdateResponse = BulkUpdateResponse[];
+export interface ProductsDeleteParams {
+    force?: boolean;
+}
+export interface ProductsListParams {
+    page?: number;
+    limit?: number;
+}
+export interface ProductsListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'products';
+    products: ProductsGetResponse[];
+}
+export interface ProductsCreateSku {
+    sku: string;
+    source_id?: string;
+    attributes?: Record<string, string>;
+    metadata?: Record<string, any>;
+    price?: number;
+    image_url?: string;
+    currency?: string;
+}
+export interface ProductsCreateSkuResponse {
+    id: string;
+    source_id?: string;
+    sku?: string;
+    price?: number;
+    attributes?: Record<string, string>;
+    metadata?: Record<string, any>;
+    updated_at?: string;
+    currency?: string;
+    created_at: string;
+    object: 'sku';
+}
+export declare type ProductsGetSkuResponse = ProductsCreateSkuResponse;
+export declare type ProductsUpdateSku = ProductsCreateSku & {
+    id?: string;
+    source_id?: string;
+};
+export declare type ProductsUpdateSkuResponse = ProductsGetSkuResponse;
+export interface ProductsDeleteSkuParams {
+    force?: boolean;
+}
+export interface ProductsListSkus {
+    object: 'list';
+    total: number;
+    skus: ProductsGetSkuResponse[];
+}
+export {};

package/dist/types/PromotionTiers.d.ts

@@ -0,0 +1,107 @@
+import { DiscountAmount, DiscountPercent, DiscountUnit } from './Vouchers';
+import { OrdersCreateResponse, OrdersItem } from './Orders';
+import { SimpleCustomer } from './Customers';
+import { ValidationRulesListAssignmentsResponse } from './ValidationRules';
+export interface SimplePromotionTier {
+    tracking_id: string;
+    metadata?: Record<string, any>;
+    valid: boolean;
+    id: string;
+    name: string;
+    banner?: string;
+    discount: DiscountUnit | DiscountPercent | DiscountAmount;
+    hierarchy: number;
+    object: 'promotion_tier';
+}
+export interface PromotionTier {
+    id: string;
+    object: 'promotion_tier';
+    name: string;
+    banner?: string;
+    campaign: {
+        id: string;
+        object: 'campaign';
+        start_date?: string;
+        expiration_date?: string;
+        active: boolean;
+    };
+    validation_rule_assignments: ValidationRulesListAssignmentsResponse;
+    action: {
+        discount: DiscountUnit | DiscountPercent | DiscountAmount;
+    };
+    hierarchy: number;
+    metadata?: Record<string, any>;
+}
+export interface PromotionTiersListAllParams {
+    is_available?: boolean;
+    limit?: number;
+    page?: number;
+}
+export interface PromotionTiersListAllResponse {
+    object: 'list';
+    data_ref: 'tiers';
+    tiers: PromotionTier[];
+    has_more: boolean;
+}
+export declare type PromotionTiersListResponse = PromotionTiersListAllResponse;
+export interface PromotionTiersCreateParams {
+    name?: string;
+    banner?: string;
+    action?: {
+        discount?: DiscountUnit | DiscountPercent | DiscountAmount;
+    };
+    metadata?: Record<string, any>;
+}
+export declare type PromotionTiersCreateResponse = PromotionTier;
+export interface PromotionTiersRedeemParams {
+    customer?: Omit<SimpleCustomer, 'object'> & {
+        description?: string;
+    };
+    order?: {
+        id?: string;
+        source_id?: string;
+        amount?: number;
+        items?: OrdersItem[];
+        status?: 'CREATED' | 'PAID' | 'CANCELLED' | 'FULFILLED';
+        metadata?: Record<string, any>;
+    };
+    metadata?: Record<string, any>;
+    session?: {
+        key: string;
+    };
+}
+export interface PromotionTiersRedeemResponse {
+    id: string;
+    object: 'redemption';
+    date: string;
+    customer_id?: string;
+    tracking_id?: string;
+    order: Omit<OrdersCreateResponse, 'object' | 'customer'> & {
+        customer: {
+            id: string;
+            object: 'customer';
+            referrals: {
+                campaigns: any[];
+                total: number;
+            };
+        };
+        total_discount_amount?: number;
+        total_amount?: number;
+    };
+    result?: string;
+    promotion_tier: PromotionTier & {
+        summary: {
+            redemptions: {
+                total_redeemed: number;
+            };
+            orders: {
+                total_amount: number;
+                total_discount_amount: number;
+            };
+        };
+    };
+}
+export declare type PromotionTiersUpdateParams = PromotionTiersCreateParams & {
+    id: string;
+};
+export declare type PromotionTiersUpdateResponse = PromotionTier;