@voucherify/sdk 2.9.2 → 2.9.3

package/dist/types/AsyncActions.d.ts

@@ -1,21 +0,0 @@
-export interface AsyncActionsResponse {
-    id: string;
-    type: string;
-    status: string;
-    result: object;
-    created_at: string;
-    object: 'async_action';
-}
-export interface AsyncActionsListParams {
-    limit?: number;
-    end_date?: string;
-}
-export interface AsyncActionsListResponse {
-    object: 'list';
-    data_ref: 'async_actions';
-    async_actions: Omit<AsyncActionsResponse, 'result'>[];
-}
-export interface AsyncActionCreateResponse {
-    async_action_id: string;
-}
-export declare type AsyncActionsGetResponse = AsyncActionsResponse;

package/dist/types/Balance.d.ts

@@ -1,16 +0,0 @@
-export interface BalanceCreateParams {
-    amount: number;
-    source_id?: string;
-    reason?: string;
-}
-export interface BalanceCreateResponse {
-    amount: number;
-    total: number;
-    balance: number;
-    type: string;
-    object: 'balance';
-    related_object: {
-        type: string;
-        id: string;
-    };
-}

package/dist/types/Campaigns.d.ts

@@ -1,120 +0,0 @@
-import { SimpleVoucher, VouchersImport, VouchersResponse } from './Vouchers';
-import { CustomerRequest } from './Customers';
-import { OrdersGetResponse } from './Orders';
-import { ValidationRulesCreateAssignmentResponse } from './ValidationRules';
-interface ReferralProgramCustomEventRedemption {
-    conversion_event_type: 'custom_event';
-    custom_event: {
-        id: string;
-        name: string;
-    };
-    referee_reward?: {
-        related_object_parent: {
-            id: string;
-            name: string;
-            object: 'CAMPAIGN';
-        };
-        amount: number;
-        type: 'GIFT_VOUCHER' | 'LOYALTY_CARD';
-    };
-}
-interface ReferralProgramRedemption {
-    conversion_event_type: 'redemption';
-    referee_reward?: {
-        related_object_parent: {
-            id: string;
-            name: string;
-            object: 'CAMPAIGN';
-        };
-        amount: number;
-        type: 'GIFT_VOUCHER' | 'LOYALTY_CARD';
-    };
-}
-export interface CampaignResponse {
-    id: string;
-    name: string;
-    campaign_type: 'LOYALTY_PROGRAM' | 'PROMOTION' | 'DISCOUNT_COUPONS' | 'GIFT_VOUCHERS' | 'REFERRAL_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?: SimpleVoucher;
-    referral_program?: ReferralProgramCustomEventRedemption | ReferralProgramRedemption;
-    use_voucher_metadata_schema?: boolean;
-    protected?: boolean;
-    vouchers_count?: number;
-    object: 'campaign';
-}
-export interface CampaignsQualificationsBody {
-    customer?: CustomerRequest;
-    order?: Pick<OrdersGetResponse, 'id' | 'source_id' | 'items'>;
-}
-export interface CampaignsQualificationsParams {
-    audienceRulesOnly?: boolean;
-    order?: 'created_at' | '-created_at' | 'updated_at' | '-updated_at';
-    limit?: number;
-}
-export interface CampaignsQualificationsResponse {
-    object: 'list';
-    total: number;
-    data_ref: 'data';
-    data: CampaignResponse[];
-    id?: string;
-    created_at?: string;
-}
-export declare type CampaignsCreateCampaign = Omit<CampaignResponse, 'id' | 'protected' | 'vouchers_generation_status' | 'validation_rules_assignments' | 'object' | 'created_at' | 'active'> & {
-    active?: boolean;
-};
-export declare type CampaignsUpdateCampaign = Pick<CampaignResponse, 'start_date' | 'expiration_date' | 'type' | 'description' | 'metadata'>;
-export interface CampaignsDeleteParams {
-    force?: boolean;
-}
-export declare type CampaignsAddVoucherBody = Pick<Partial<VouchersImport>, 'code_config' | 'category' | 'redemption' | 'metadata' | 'additional_info'>;
-export interface CampaignsAddVoucherParams {
-    vouchers_count?: number;
-}
-export declare type CampaignsAddCertainVoucherParams = Pick<Partial<VouchersImport>, 'category' | 'redemption' | 'metadata' | 'additional_info'>;
-export declare type CampaignsAddVoucherResponse = Pick<VouchersResponse, 'code' | 'object' | 'campaign' | 'category' | 'created_at' | 'type' | 'discount' | 'gift' | 'start_date' | 'expiration_date' | 'publish' | 'redemption' | 'active' | 'additional_info' | 'metadata' | 'assets'>;
-export declare type CampaignsAddCertainVoucherResponse = CampaignsAddVoucherResponse;
-export declare type CampaignsImportVouchers = Pick<VouchersImport, 'code' | 'redemption' | 'metadata' | 'additional_info' | 'active'>;
-export interface CampaignsListParams {
-    limit?: number;
-    page?: number;
-    campaign_type?: 'DISCOUNT_COUPONS' | 'PROMOTION' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
-    filters?: {
-        junction?: string;
-        [filter_condition: string]: any;
-    };
-}
-export interface CampaignsListResponse {
-    object: 'list';
-    total: number;
-    data_ref: 'campaigns';
-    campaigns: CampaignResponse[];
-}
-export declare type CampaignsVouchersImportResponse = {
-    async_action_id: string;
-};
-export declare type CampaignsCreateCampaignResponse = CampaignResponse;
-export declare type CampaignsUpdateCampaignResponse = CampaignResponse;
-export declare type CampaignsGetCampaignResponse = CampaignResponse;
-export {};

package/dist/types/Categories.d.ts

@@ -1,38 +0,0 @@
-export interface ListCategories {
-    object: 'list';
-    data_ref: 'data';
-    data: CategoryObject[];
-    total: number;
-    has_more: boolean;
-}
-export declare type CategoryObject = ResponseCreateCategory & {
-    updated_at?: string;
-};
-export interface CreateCategory {
-    name: string;
-    hierarchy: number;
-}
-export interface ResponseCreateCategory {
-    id: string;
-    name: string;
-    hierarchy: number;
-    created_at: string;
-    object: 'category';
-}
-export declare type ResponseUpdateCategory = ResponseCreateCategory & {
-    updated_at: string;
-};
-export declare type UpdateCategoryRequest = CreateCategory;
-export declare type Category = {
-    id: string;
-    name: string;
-    hierarchy: number;
-    created_at: string;
-    updated_at?: string;
-    object: 'category';
-    stacking_rules_type?: 'JOINT' | 'EXCLUSIVE';
-};
-export declare type CategoriesListRequestQuery = {
-    limit?: number;
-    starting_after_id?: number;
-};

package/dist/types/ClientSide.d.ts

@@ -1,134 +0,0 @@
-import { CustomerRequest, CustomersCreateBody, CustomersCreateResponse, CustomersUpdateConsentsBody } from './Customers';
-import { VouchersListParams, VouchersResponse } from './Vouchers';
-import { DiscountAmount, DiscountPercent, DiscountUnit, DiscountFixed } from './DiscountVoucher';
-import { OrdersCreateResponse, OrdersItem } from './Orders';
-import { ConsentsListResponse } from './Consents';
-import { DistributionsPublicationsCreateResponse } from './Distributions';
-import { SimplePromotionTier } from './PromotionTiers';
-import { ValidationSessionReleaseParams } from './ValidateSession';
-import { ApplicableToResultList } from './ApplicableTo';
-import { ValidationsValidateStackableParams, ValidationValidateStackableResponse } from './Validations';
-import { RedemptionsRedeemStackableParams, RedemptionsRedeemStackableResponse } from './Redemptions';
-declare type ClientSideItem = Pick<OrdersItem, 'source_id' | 'sku_id' | 'product_id' | 'sku' | 'quantity' | 'related_object' | 'amount'>;
-export declare type ClientSideCustomersUpdateConsentsBody = CustomersUpdateConsentsBody;
-export declare type ClientSideCustomersCreateParams = CustomersCreateBody;
-export declare type ClientSideCustomersCreateResponse = CustomersCreateResponse;
-export 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';
-}
-export declare type ClientSideListVouchersParams = VouchersListParams;
-export declare type ClientSideVoucherListing = Pick<VouchersResponse, 'active' | 'code' | 'metadata' | 'assets' | 'object' | 'expiration_date' | 'start_date' | 'created_at'>;
-export interface ClientSideListVouchersResponse {
-    object: 'list';
-    total: number;
-    data_ref: 'vouchers';
-    vouchers: ClientSideVoucherListing[];
-}
-export 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[];
-}
-export interface ClientSideRedeemPayload {
-    tracking_id?: string;
-    customer?: CustomerRequest;
-    order?: ClientSideRedeemOrder;
-    metadata?: Record<string, any>;
-    reward?: {
-        id: string;
-    };
-    session?: ValidationSessionReleaseParams;
-}
-export 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;
-}
-export interface ClientSidePublishPayload {
-    source_id?: string;
-    channel?: 'Voucherify.js' | string;
-    customer?: CustomerRequest;
-    voucher?: string;
-    metadata?: Record<string, any>;
-}
-export declare type ClientSidePublishPreparedPayload = ClientSidePublishPayload;
-export interface ClientSidePublishQueryParams {
-    join_once?: boolean;
-    campaign?: string;
-}
-export interface ClientSidePublishCampaign {
-    name: string;
-    count?: number;
-}
-export declare type ClientSidePublishResponse = DistributionsPublicationsCreateResponse & {
-    vouchers_id?: string[];
-};
-export interface ClientSideTrackLoyalty {
-    code?: string;
-}
-export interface ClientSideTrackReferral {
-    code?: string;
-}
-export interface ClientSideTrackPayload {
-    event: string;
-    metadata?: Record<string, any>;
-    customer: CustomerRequest;
-    loyalty?: ClientSideTrackLoyalty;
-    referral?: ClientSideTrackReferral;
-}
-export interface ClientSideTrackResponse {
-    object: 'event';
-    type: string;
-}
-export declare type ClientSideRedeemOrder = Partial<Pick<OrdersCreateResponse, 'id' | 'source_id' | 'metadata' | 'amount'>> & {
-    items?: ClientSideItem[];
-};
-export interface ClientSideRedeemWidgetPayload {
-    order?: {
-        amount?: number;
-    };
-}
-export declare type ClientSideTrackCustomer = CustomerRequest;
-export declare type ClientSideConsentsListResponse = ConsentsListResponse;
-export declare type ClientSideValidationsValidateStackableParams = ValidationsValidateStackableParams;
-export declare type ClientSideValidationValidateStackableResponse = ValidationValidateStackableResponse;
-export declare type ClientSideRedemptionsRedeemStackableParams = RedemptionsRedeemStackableParams;
-export declare type ClientSideRedemptionsRedeemStackableResponse = RedemptionsRedeemStackableResponse;
-export {};

package/dist/types/Consents.d.ts

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