@voucherify/sdk 2.4.0 → 2.5.0

package/dist/types/Loyalties.d.ts

@@ -3,6 +3,8 @@ import { ProductsCreateResponse, ProductsCreateSkuResponse } from './Products';
 import { SimpleCustomer } from './Customers';
 import { ValidationRulesCreateAssignmentResponse } from './ValidationRules';
 import { VouchersResponse } from './Vouchers';
+import { Reward, RewardAssignment } from './Rewards';
+import { Category } from './Categories';
 interface LoyaltiesVoucher {
     code_config?: {
         length?: number;
@@ -465,11 +467,264 @@ export interface LoyaltyPointsTransfer {
     code: string;
     points: number;
 }
-export declare type LoyaltiesGetEarningRuleResponseBody = EarningRuleBase & {
-    validation_rule_id: string | null;
-    updated_at: string | null;
+export declare type LoyaltiesTransferPointsResponseBody = {
+    id: string;
+    code: string;
+    campaign: string;
+    campaign_id: string;
+    category: string | null;
+    category_id: string | null;
+    categories: Category[];
+    type: 'LOYALTY_CARD';
+    loyalty_card: {
+        points: number;
+        balance: number;
+        next_expiration_date?: string;
+        next_expiration_points?: number;
+    };
+    start_date: string | null;
+    expiration_date: string | null;
+    validity_timeframe: {
+        interval?: string;
+        duration?: string;
+    } | null;
+    validity_day_of_week: number[] | null;
+    publish?: {
+        object: 'list';
+        count?: number;
+        entries?: string[];
+        url?: string;
+    };
+    redemption?: {
+        quantity: number | null;
+        redeemed_points?: number;
+        redeemed_quantity?: number;
+        redemption_entries?: string[];
+        object?: 'list';
+        url?: string;
+    };
     active: boolean;
+    additional_info: string | null;
+    metadata: Record<string, unknown>;
+    is_referral_code: boolean;
+    holder_id?: string;
+    updated_at?: string;
+    created_at: string;
 };
+export declare type LoyaltiesTransferPointsRequestBody = LoyaltiesTransferPoints[];
+export interface LoyaltiesListMemberRewardsRequestQuery {
+    affordable_only?: boolean;
+    limit?: number;
+    page?: number;
+}
+export interface LoyaltiesListMemberRewardsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: {
+        reward: Reward;
+        assignment: RewardAssignment;
+        object: 'loyalty_reward';
+    }[];
+    total: number;
+}
+export interface LoyaltiesGetPointsExpirationRequestQuery {
+    limit?: number;
+    page?: number;
+}
+export interface LoyaltiesGetPointsExpirationResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: {
+        id: string;
+        voucher_id: string;
+        campaign_id: string;
+        bucket: {
+            total_points: number;
+        };
+        created_at: string;
+        status: string;
+        expires_at: string;
+        updated_at?: string;
+        object: 'loyalty_points_bucket';
+    }[];
+    total: number;
+}
+export interface LoyaltiesListCardTransactionsRequestQuery {
+    limit?: number;
+    page?: number;
+}
+export interface LoyaltiesListCardTransactionsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: LoyaltyCardTransaction[];
+    has_more: boolean;
+}
+export interface LoyaltiesExportCardTransactionsRequestBody {
+    order?: 'created_at' | '-created_at';
+    fields?: LoyaltyCardTransactionsFields[];
+}
+export interface LoyaltiesExportCardTransactionsResponseBody {
+    id: string;
+    object: 'export';
+    created_at: string;
+    status: 'SCHEDULED';
+    channel: string;
+    exported_object: 'voucher_transactions';
+    parameters: {
+        order?: string;
+        fields?: LoyaltyCardTransactionsFields[];
+        filters: {
+            voucher_id: {
+                conditions: {
+                    $in: [string];
+                };
+            };
+        };
+    };
+    result: null;
+    user_id: null | string;
+}
+export interface LoyaltiesAddOrRemoveCardBalanceRequestBody {
+    points: number;
+    expiration_date?: string;
+    expiration_type?: PointsExpirationTypes;
+    reason?: string;
+    source_id?: string;
+}
+export interface LoyaltiesAddOrRemoveCardBalanceResponseBody {
+    points?: number;
+    amount?: number;
+    total: number;
+    balance: number;
+    type: 'LOYALTY_CARD' | 'GIFT_VOUCHER';
+    object: 'balance';
+    related_object: {
+        type: 'voucher';
+        id: string;
+    };
+    operation_type?: 'MANUAL' | 'AUTOMATIC';
+}
+export declare type LoyaltiesCreateTiersRequestBody = (LoyaltyTierBase & {
+    metadata?: Record<string, unknown>;
+})[];
+export declare type LoyaltiesCreateTiersResponseBody = LoyaltyTier[];
+export declare type LoyaltiesGetRewardAssignmentResponseBody = RewardAssignment;
+export declare type LoyaltiesGetRewardDetailsResponseBody = Reward;
+export interface LoyaltiesListTiersRequestQuery {
+    limit?: number;
+    page?: number;
+    order?: 'created_at' | '-created_at' | 'updated_at' | '-updated_at';
+}
+export interface LoyaltiesListLoyaltyTierEarningRulesRequestQuery {
+    limit?: number;
+    page?: number;
+}
+export declare type LoyaltiesGetTierResponseBody = LoyaltyTier;
+export interface LoyaltiesListTiersResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: LoyaltyTier[];
+    total: number;
+}
+export interface LoyaltiesListMemberLoyaltyTiersResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: LoyaltyTier[];
+    total: number;
+}
+export interface LoyaltiesListMemberRewardsRequestQuery {
+    affordable_only?: boolean;
+    limit?: number;
+    page?: number;
+}
+export interface LoyaltiesListMemberRewardsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: {
+        reward: Reward;
+        assignment: RewardAssignment;
+        object: 'loyalty_reward';
+    }[];
+    total: number;
+}
+export interface LoyaltiesGetPointsExpirationRequestQuery {
+    limit?: number;
+    page?: number;
+}
+export interface LoyaltiesGetPointsExpirationResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: {
+        id: string;
+        voucher_id: string;
+        campaign_id: string;
+        bucket: {
+            total_points: number;
+        };
+        created_at: string;
+        status: string;
+        expires_at: string;
+        updated_at?: string;
+        object: 'loyalty_points_bucket';
+    }[];
+    total: number;
+}
+export interface LoyaltiesListCardTransactionsRequestQuery {
+    limit?: number;
+    page?: number;
+}
+export interface LoyaltiesListCardTransactionsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: LoyaltyCardTransaction[];
+    has_more: boolean;
+}
+export interface LoyaltiesExportCardTransactionsRequestBody {
+    order?: 'created_at' | '-created_at';
+    fields?: LoyaltyCardTransactionsFields[];
+}
+export interface LoyaltiesExportCardTransactionsResponseBody {
+    id: string;
+    object: 'export';
+    created_at: string;
+    status: 'SCHEDULED';
+    channel: string;
+    exported_object: 'voucher_transactions';
+    parameters: {
+        order?: string;
+        fields?: LoyaltyCardTransactionsFields[];
+        filters: {
+            voucher_id: {
+                conditions: {
+                    $in: [string];
+                };
+            };
+        };
+    };
+    result: null;
+    user_id: null | string;
+}
+export interface LoyaltiesAddOrRemoveCardBalanceRequestBody {
+    points: number;
+    expiration_date?: string;
+    expiration_type?: PointsExpirationTypes;
+    reason?: string;
+    source_id?: string;
+}
+export interface LoyaltiesAddOrRemoveCardBalanceResponseBody {
+    points?: number;
+    amount?: number;
+    total: number;
+    balance: number;
+    type: 'LOYALTY_CARD' | 'GIFT_VOUCHER';
+    object: 'balance';
+    related_object: {
+        type: 'voucher';
+        id: string;
+    };
+    operation_type?: 'MANUAL' | 'AUTOMATIC';
+}
+export declare type LoyaltiesGetEarningRuleResponseBody = EarningRule;
 export declare type LoyaltiesEnableEarningRulesResponseBody = EarningRuleBase & {
     updated_at: string | null;
     active: true;
@@ -478,6 +733,240 @@ export declare type LoyaltiesDisableEarningRulesResponseBody = EarningRuleBase &
     updated_at: string | null;
     active: false;
 };
+export declare type LoyaltiesListLoyaltyTierEarningRulesResponseBody = {
+    object: 'list';
+    data_ref: 'data';
+    data: EarningRule[];
+    total: number;
+};
+export interface LoyaltyTierBase {
+    name: string;
+    earning_rules?: Record<string, MappingMultiply | MappingFixed>;
+    rewards?: Record<string, MappingMultiply | MappingFixed>;
+    points: {
+        from?: number;
+        to?: number;
+    };
+}
+export declare type LoyaltyTier = LoyaltyTierBase & {
+    id: string;
+    campaign_id: string;
+    metadata: Record<string, unknown> | null;
+    created_at: string;
+    updated_at?: string | null;
+    config: {
+        points: {
+            from?: number;
+            to?: number;
+        };
+    };
+    expiration?: {
+        customer_id: string;
+        campaign_id: string;
+        tier_id: string;
+        start_date?: string;
+        expiration_date?: string;
+        created_at: string;
+        updated_at?: string;
+    };
+    object: 'loyalty_tier';
+};
+interface MappingMultiply {
+    type: 'MULTIPLY';
+    multiplier: number;
+}
+interface MappingFixed {
+    type: 'CUSTOM';
+    points: number;
+}
+export 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';
+            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;
+}
+export 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';
+}
+export interface LoyaltiesTransferPoints {
+    code: string;
+    points: number;
+    reason?: string;
+    source_id: string;
+}
+export declare type LoyaltyCardTransactionsFields = 'id' | 'campaign_id' | 'voucher_id' | 'type' | 'source_id' | 'reason' | 'source' | 'balance' | 'amount' | 'related_transaction_id' | 'created_at' | 'details';
+export declare type LoyaltyCardTransactionsType = 'POINTS_ACCRUAL' | 'POINTS_CANCELLATION' | 'POINTS_REDEMPTION' | 'POINTS_REFUND' | 'POINTS_ADDITION' | 'POINTS_REMOVAL' | 'POINTS_EXPIRATION' | 'POINTS_TRANSFER_IN' | 'POINTS_TRANSFER_OUT';
+export declare type EarningRule = EarningRuleBase & {
+    validation_rule_id: string | null;
+    updated_at: string | null;
+    active: boolean;
+};
+export declare type PointsExpirationTypes = 'PROGRAM_RULES' | 'CUSTOM_DATE' | 'NON_EXPIRING';
+export 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';
+            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;
+}
+export 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';
+}
+export interface LoyaltiesTransferPoints {
+    code: string;
+    points: number;
+    reason?: string;
+    source_id: string;
+}
 export interface EarningRuleBase {
     id: string;
     created_at: string;

package/dist/types/ProductCollections.d.ts

@@ -0,0 +1,95 @@
+import { WithRequiredProperty } from './UtilityTypes';
+export interface ProductIdentity {
+    id?: string;
+    object?: 'product';
+}
+export interface SkuIdentity {
+    id?: string;
+    product_id?: string;
+    object?: 'sku';
+}
+export interface ProductBase {
+    name?: string | null;
+    price?: number | null;
+    attributes?: string[];
+    metadata?: Record<string, unknown>;
+}
+export interface SkuBase {
+    sku?: string | null;
+    price?: number | null;
+    attributes?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    product?: Required<ProductIdentity> & Required<ProductBase> & {
+        source_id: string | null;
+        object: 'product';
+    };
+    image_url?: string | null;
+}
+export interface ProductSaved {
+    created_at?: string;
+    updated_at?: string | null;
+    image_url?: string | null;
+    object?: 'product';
+}
+export interface SkuSaved {
+    created_at?: string;
+    updated_at?: string | null;
+    image_url?: string | null;
+    object?: 'sku';
+}
+export declare type ProductOrSkuIdentity = Required<SkuIdentity> | Required<ProductIdentity>;
+export interface ProductCollectionIdentity {
+    id?: string;
+}
+export interface ProductCollectionSaved {
+    created_at?: string;
+    object?: 'products_collection';
+}
+export declare type ProductCollectionBase = StaticProductCollectionBase | DynamicProductCollectionBase;
+export interface StaticProductCollectionBase {
+    name?: string;
+    type?: 'STATIC';
+    products?: ProductOrSkuIdentity[];
+}
+export interface DynamicProductCollectionBase {
+    name?: string;
+    type?: 'AUTO_UPDATE';
+    filter?: Filter;
+}
+export declare type ProductCollection = ProductCollectionBase & ProductCollectionIdentity & ProductCollectionSaved;
+export declare type Filter = {
+    junction: Junction;
+} & Partial<Record<AllowedFiltersKeys, {
+    conditions: Partial<Record<FiltersCondition, unknown>>;
+}>>;
+export declare type Junction = 'and' | 'AND' | 'or' | 'OR';
+export declare type AllowedFiltersKeys = 'id' | 'name' | 'attributes' | 'source_id' | 'price' | 'image_url' | 'product_id' | 'skus' | 'created_at' | 'updated_at' | 'object' | `metadata.${string}`;
+export declare type FiltersCondition = '$in' | '$not_in' | '$is' | '$is_days_ago' | '$is_days_in_future' | '$is_not' | '$has_value' | '$is_unknown' | '$contains' | '$not_contain' | '$starts_with' | '$ends_with' | '$more_than' | '$less_than' | '$more_than_ago' | '$less_than_ago' | '$more_than_future' | '$less_than_future' | '$more_than_equal' | '$less_than_equal' | '$after' | '$before' | '$count' | '$count_less' | '$count_more';
+export declare type ProductCollectionsCreateRequestBody = WithRequiredProperty<StaticProductCollectionBase, 'name' | 'type'> | Required<DynamicProductCollectionBase>;
+export declare type ProductCollectionsCreateResponseBody = Required<ProductCollectionBase> & Required<ProductCollectionIdentity> & Required<ProductCollectionSaved>;
+export interface ProductCollectionsListRequestQuery {
+    limit?: number;
+    page?: number;
+    order?: 'created_at' | '-created_at';
+}
+export interface ProductCollectionsListResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: Required<ProductCollection>[];
+    total: number;
+}
+export declare type ProductCollectionsGetResponseBody = Required<ProductCollection>;
+export interface ProductCollectionsListProductsRequestQuery {
+    limit?: number;
+    page?: number;
+}
+export interface ProductCollectionsListProductsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: ((Required<SkuIdentity> & Required<SkuSaved> & Required<SkuBase> & {
+        source_id: string | null;
+    }) | (Required<ProductIdentity> & Required<ProductSaved> & Required<ProductBase> & {
+        source_id: string | null;
+    }))[];
+    total: number;
+}

package/dist/types/Rewards.d.ts

@@ -16,6 +16,7 @@ export interface RewardsResponse {
     object: 'reward';
 }
 export declare type RewardsCreateResponse = RewardsResponse & RewardsTypeResponse;
+export declare type RewardsGetResponse = RewardsResponse & RewardsTypeResponse;
 export interface RewardsListResponse {
     object: 'list';
     total: number;
@@ -69,7 +70,6 @@ interface RewardsTypeCoin {
 export declare type RewardsType = RewardsTypeCampaign | RewardsTypeCoin | RewardsTypeMaterial;
 export declare type RewardsTypeResponse = Required<RewardsTypeCampaignResponse> | Required<RewardsTypeCoin> | Required<RewardsTypeMaterial>;
 export declare type RewardsCreate = Rewards & RewardsType;
-export declare type RewardsGetResponse = RewardsCreateResponse;
 export declare type RewardsUpdate = Omit<RewardsCreate, 'type'> & {
     id: string;
 };
@@ -116,4 +116,60 @@ export interface RewardRedemptionParams {
     assignment_id?: string;
     id?: string;
 }
+export declare type Reward = {
+    id: string;
+    name?: string;
+    stock?: string;
+    redeemed?: string;
+    attributes?: {
+        image_url?: string;
+        description?: string;
+    };
+    created_at: string;
+    updated_at?: string;
+    object: 'reward';
+} & RewardType;
+export interface RewardTypeCampaign {
+    type: 'CAMPAIGN';
+    parameters: {
+        campaign: {
+            id: string;
+            balance?: number;
+            type: 'DISCOUNT_COUPONS' | 'PROMOTION' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
+        };
+    };
+}
+export interface RewardTypeCoin {
+    type: 'COIN';
+    parameters: {
+        coin: {
+            exchange_ratio: number;
+            points_ratio?: number;
+        };
+    };
+}
+export interface RewardTypeMaterial {
+    type: 'MATERIAL';
+    parameters: {
+        product: {
+            id: string;
+            sku: string | null;
+        };
+    };
+}
+export declare type RewardType = RewardTypeCampaign | RewardTypeCoin | RewardTypeMaterial;
+export interface RewardAssignment {
+    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 {};

package/dist/types/UtilityTypes.d.ts

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