@voucherify/sdk 2.9.2 → 2.9.3

package/dist/types/MetadataSchemas.d.ts

@@ -1,33 +0,0 @@
-interface MetadataSchemaProperty {
-    type: string;
-    array: boolean;
-    deleted?: boolean;
-    optional: boolean;
-    objectType?: string;
-    eq?: (string | number)[];
-    ne?: (string | number)[];
-    lt?: number;
-    lte?: number;
-    gt?: number;
-    gte?: number;
-    minLength?: number;
-    maxLength?: number;
-    exactLength?: number;
-}
-export interface MetadataSchema {
-    id: string;
-    related_object: string;
-    properties: Record<string, MetadataSchemaProperty>;
-    allow_defined_only?: boolean;
-    created_at: string;
-    updated_at?: string;
-    object: 'metadata_schema';
-}
-export interface MetadataSchemasListResponse {
-    object: 'list';
-    total: number;
-    data_ref: 'schemas';
-    schemas: MetadataSchema[];
-}
-export declare type MetadataSchemasGetResponse = MetadataSchema;
-export {};

package/dist/types/Orders.d.ts

@@ -1,195 +0,0 @@
-import { Customer, CustomerId, CustomerRequest, CustomerWithSummaryLoyaltyReferrals, Referrer, ReferrerId, ReferrerWithSummaryLoyaltyReferrals } from './Customers';
-export interface OrdersItem {
-    sku_id?: string;
-    product_id?: string;
-    related_object?: 'product' | 'sku';
-    source_id?: string;
-    discount_quantity?: number;
-    initial_quantity?: number;
-    quantity?: number;
-    price?: number;
-    amount?: number;
-    discount_amount?: number;
-    initial_amount?: number;
-    applied_discount_amount?: number;
-    subtotal_amount?: number;
-    product?: {
-        id?: string;
-        source_id?: string;
-        override?: boolean;
-        name?: string;
-        metadata?: Record<string, any>;
-        price?: number;
-    };
-    sku?: {
-        id?: string;
-        source_id?: string;
-        override?: boolean;
-        sku?: string;
-        price?: number;
-    };
-    object?: 'order_item';
-    metadata?: Record<string, any>;
-}
-export interface OrdersCreate {
-    source_id?: string;
-    status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
-    customer?: CustomerRequest;
-    amount?: number;
-    discount_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;
-    initial_amount?: number;
-    discount_amount?: number;
-    items_discount_amount?: number;
-    total_discount_amount?: number;
-    applied_discount_amount?: number;
-    items_applied_discount_amount?: number;
-    total_amount?: number;
-    total_applied_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' | 'CANCELED' | 'FULFILLED';
-    items?: OrdersItem[];
-    amount?: number;
-    discount_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[];
-}
-export declare type Order = {
-    id?: string;
-    source_id?: string;
-    status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
-    amount?: number;
-    discount_amount?: number;
-    initial_amount?: number;
-    items?: OrderItem[];
-    customer?: Customer;
-    customer_id?: string;
-    referrer?: Referrer;
-    referrer_id?: string;
-    metadata?: Record<string, any>;
-};
-export declare type OrderItem = {
-    sku_id?: string;
-    product_id?: string;
-    related_object?: 'product' | 'sku';
-    source_id?: string;
-    quantity?: number;
-    discount_quantity?: number;
-    initial_quantity?: number;
-    amount?: number;
-    discount_amount?: number;
-    initial_amount?: number;
-    price?: number;
-    product?: {
-        id?: string;
-        source_id?: string;
-        override?: boolean;
-        name?: string;
-        metadata?: Record<string, any>;
-        price?: number;
-    };
-    sku?: {
-        id?: string;
-        source_id?: string;
-        override?: boolean;
-        sku?: string;
-        price?: number;
-    };
-    metadata?: Record<string, any>;
-};
-export declare type OrderCalculated = {
-    id?: string;
-    source_id?: string | null;
-    created_at?: string;
-    updated_at?: string | null;
-    status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
-    amount?: number;
-    initial_amount?: number;
-    discount_amount?: number;
-    items_discount_amount?: number;
-    total_discount_amount?: number;
-    total_amount?: number;
-    applied_discount_amount?: number;
-    items_applied_discount_amount?: number;
-    total_applied_discount_amount?: number;
-    items?: OrderItemCalculated[];
-    metadata?: Record<string, unknown>;
-    customer?: CustomerId | CustomerWithSummaryLoyaltyReferrals;
-    customer_id: string | null;
-    referrer?: ReferrerId | ReferrerWithSummaryLoyaltyReferrals;
-    referrer_id: string | null;
-    object: 'order';
-    redemptions?: Record<string, OrderRedemptions>;
-};
-export declare type OrderRedemptions = {
-    date?: string;
-    rollback_id?: string;
-    rollback_date?: string;
-    related_object_type?: string;
-    related_object_id?: string;
-    related_object_parent_id?: string;
-    stacked?: string[];
-    rollback_stacked?: string[];
-};
-export declare type OrderItemCalculated = {
-    sku_id?: string;
-    product_id?: string;
-    related_object?: 'product' | 'sku';
-    source_id?: string;
-    quantity?: number;
-    discount_quantity?: number;
-    initial_quantity?: number;
-    amount?: number;
-    discount_amount?: number;
-    initial_amount?: number;
-    total_applied_discount_amount?: number;
-    price?: number;
-    subtotal_amount?: number;
-    product?: {
-        id?: string;
-        source_id?: string;
-        override?: boolean;
-        name?: string;
-        metadata?: Record<string, any>;
-        price?: number;
-    };
-    sku?: {
-        id?: string;
-        source_id?: string;
-        override?: boolean;
-        sku?: string;
-        price?: number;
-    };
-    object: 'order_item';
-    metadata?: Record<string, any>;
-};

package/dist/types/ProductCollections.d.ts

@@ -1,96 +0,0 @@
-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 = Partial<Record<string, Junction | {
-    conditions: Partial<Record<FiltersCondition, unknown>>;
-}>>;
-export declare type Junction = 'and' | 'AND' | 'or' | 'OR';
-/**
- * @deprecated
- */
-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/Products.d.ts

@@ -1,106 +0,0 @@
-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;
-    metadata?: Record<string, any>;
-}
-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 ProductsBulkUpdateMetadata {
-    source_ids: string[];
-    metadata: Record<string, any>;
-}
-export declare type ProductsBulkUpdate = ProductsCreate[];
-export declare type ProductsBulkUpdateResponse = {
-    async_action_id: string;
-};
-export declare type ProductsBulkUpdateMetadataResponse = {
-    async_action_id: string;
-};
-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 interface SimpleProduct {
-    id: string;
-    source_id?: string;
-    name?: string;
-}
-export interface SimpleSku {
-    id: string;
-    source_id?: string;
-    sku?: string;
-}

package/dist/types/PromotionTiers.d.ts

@@ -1,127 +0,0 @@
-import { DiscountAmount, DiscountPercent, DiscountUnit, DiscountFixed } from './DiscountVoucher';
-import { OrdersCreateResponse, OrdersItem } from './Orders';
-import { SimpleCustomer } from './Customers';
-import { ValidationRulesListAssignmentsResponse } from './ValidationRules';
-import { ValidationSessionReleaseParams } from './ValidateSession';
-export interface SimplePromotionTier {
-    tracking_id: string;
-    metadata?: Record<string, any>;
-    valid: boolean;
-    id: string;
-    name: string;
-    banner?: string;
-    discount: DiscountUnit | DiscountPercent | DiscountAmount | DiscountFixed;
-    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 | DiscountFixed;
-    };
-    hierarchy: number;
-    metadata?: Record<string, any>;
-    active?: boolean;
-}
-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 declare type PromotionTierGetResponse = PromotionTier;
-export interface PromotionTiersCreateParams {
-    name?: string;
-    banner?: string;
-    action?: {
-        discount?: DiscountUnit | DiscountPercent | DiscountAmount | DiscountFixed;
-    };
-    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' | 'CANCELED' | 'FULFILLED';
-        metadata?: Record<string, any>;
-    };
-    metadata?: Record<string, any>;
-    session?: ValidationSessionReleaseParams;
-}
-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 interface PromotionTierRedeemDetailsSimple {
-    id: string;
-    name: string;
-    banner?: string;
-    campaign: {
-        id: string;
-    };
-}
-export declare type PromotionTierRedeemDetails = 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;

package/dist/types/Promotions.d.ts

@@ -1,108 +0,0 @@
-import { DiscountAmount, DiscountPercent, DiscountUnit, DiscountFixed } from './DiscountVoucher';
-import { OrdersItem } from './Orders';
-import { PromotionTier } from './PromotionTiers';
-import { SimpleCustomer } from './Customers';
-import { ValidationRulesCreateAssignmentResponse } from './ValidationRules';
-export interface PromotionsCreateResponse {
-    id: string;
-    name: string;
-    campaign_type?: 'PROMOTION';
-    type: 'STATIC';
-    description?: string;
-    start_date?: string;
-    expiration_date?: string;
-    promotion: {
-        object: 'list';
-        data_ref: 'tiers';
-        tiers?: PromotionTier[];
-        has_more: boolean;
-    };
-    category?: string;
-    auto_join: boolean;
-    join_once: boolean;
-    validation_rules_assignments: {
-        data?: ValidationRulesCreateAssignmentResponse[];
-        object: 'list';
-        total: number;
-        data_ref: 'data';
-    };
-    activity_duration_after_publishing?: string;
-    validity_timeframe?: {
-        interval?: string;
-        duration?: string;
-    };
-    validity_day_of_week?: number[];
-    metadata?: Record<string, string>;
-    created_at: string;
-    vouchers_generation_status: 'DONE';
-    active: boolean;
-    use_voucher_metadata_schema: boolean;
-    protected: boolean;
-    object: 'campaign';
-}
-export interface PromotionsCreate {
-    name: string;
-    campaign_type: 'PROMOTION';
-    start_date?: string;
-    expiration_date?: string;
-    promotion?: {
-        tiers: {
-            name: string;
-            banner: string;
-            action: {
-                discount: DiscountUnit | DiscountAmount | DiscountPercent | DiscountFixed;
-            };
-            metadata?: Record<string, any>;
-        }[];
-    };
-}
-export interface PromotionsValidateParams {
-    customer?: Omit<SimpleCustomer, 'id' | 'object'> & {
-        description?: string;
-        id?: string;
-    };
-    order?: {
-        id?: string;
-        source_id?: string;
-        items?: OrdersItem[];
-        amount?: number;
-        metadata?: Record<string, any>;
-    };
-    metadata?: Record<string, any>;
-}
-export interface PromotionsValidateQueryParams {
-    audienceRulesOnly?: boolean;
-    filters?: Record<string, any>;
-}
-export interface PromotionsValidateResponse {
-    valid: boolean;
-    promotions?: {
-        id: string;
-        object: 'promotion_tier';
-        banner?: string;
-        name: string;
-        start_date?: string;
-        expiration_date?: string;
-        discount?: DiscountUnit | DiscountAmount | DiscountPercent | DiscountFixed;
-        discount_amount?: number;
-        applied_discount_amount?: number;
-        metadata?: Record<string, any>;
-        order?: {
-            id?: string;
-            source_id?: string;
-            amount: number;
-            initial_amount?: number;
-            items_discount_amount?: number;
-            items_applied_discount_amount?: number;
-            items?: OrdersItem[];
-            metadata?: Record<string, any>;
-            discount_amount?: number;
-            total_discount_amount?: number;
-            total_amount?: number;
-            applied_discount_amount?: number;
-            total_applied_discount_amount?: number;
-        };
-        hierarchy?: number;
-    }[];
-    tracking_id?: string;
-}