@voucherify/sdk 2.9.3 → 2.9.4

package/dist/types/MetadataSchemas.d.ts

@@ -0,0 +1,34 @@
+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;
+}
+interface MetadataSchema {
+    id: string;
+    related_object: string;
+    properties: Record<string, MetadataSchemaProperty>;
+    allow_defined_only?: boolean;
+    created_at: string;
+    updated_at?: string;
+    object: 'metadata_schema';
+}
+interface MetadataSchemasListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'schemas';
+    schemas: MetadataSchema[];
+}
+type MetadataSchemasGetResponse = MetadataSchema;
+
+export type { MetadataSchema, MetadataSchemasGetResponse, MetadataSchemasListResponse };

package/dist/types/Orders.d.ts

@@ -0,0 +1,199 @@
+import { CustomerRequest, Customer, Referrer, CustomerId, CustomerWithSummaryLoyaltyReferrals, ReferrerId, ReferrerWithSummaryLoyaltyReferrals } from './Customers.js';
+import './DiscountVoucher.js';
+
+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>;
+}
+interface OrdersCreate {
+    source_id?: string;
+    status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
+    customer?: CustomerRequest;
+    amount?: number;
+    discount_amount?: number;
+    items?: OrdersItem[];
+    metadata?: Record<string, any>;
+}
+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';
+}
+type OrdersGetResponse = OrdersCreateResponse;
+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;
+    };
+}
+type OrdersUpdateResponse = OrdersGetResponse;
+interface OrdersListParams {
+    limit?: number;
+    page?: number;
+}
+interface OrdersListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'orders';
+    orders: OrdersGetResponse[];
+}
+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>;
+};
+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>;
+};
+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>;
+};
+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[];
+};
+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>;
+};
+
+export type { Order, OrderCalculated, OrderItem, OrderItemCalculated, OrderRedemptions, OrdersCreate, OrdersCreateResponse, OrdersGetResponse, OrdersItem, OrdersListParams, OrdersListResponse, OrdersUpdate, OrdersUpdateResponse };

package/dist/types/ProductCollections.d.ts

@@ -0,0 +1,99 @@
+import { WithRequiredProperty } from './UtilityTypes.js';
+
+interface ProductIdentity {
+    id?: string;
+    object?: 'product';
+}
+interface SkuIdentity {
+    id?: string;
+    product_id?: string;
+    object?: 'sku';
+}
+interface ProductBase {
+    name?: string | null;
+    price?: number | null;
+    attributes?: string[];
+    metadata?: Record<string, unknown>;
+}
+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;
+}
+interface ProductSaved {
+    created_at?: string;
+    updated_at?: string | null;
+    image_url?: string | null;
+    object?: 'product';
+}
+interface SkuSaved {
+    created_at?: string;
+    updated_at?: string | null;
+    image_url?: string | null;
+    object?: 'sku';
+}
+type ProductOrSkuIdentity = Required<SkuIdentity> | Required<ProductIdentity>;
+interface ProductCollectionIdentity {
+    id?: string;
+}
+interface ProductCollectionSaved {
+    created_at?: string;
+    object?: 'products_collection';
+}
+type ProductCollectionBase = StaticProductCollectionBase | DynamicProductCollectionBase;
+interface StaticProductCollectionBase {
+    name?: string;
+    type?: 'STATIC';
+    products?: ProductOrSkuIdentity[];
+}
+interface DynamicProductCollectionBase {
+    name?: string;
+    type?: 'AUTO_UPDATE';
+    filter?: Filter;
+}
+type ProductCollection = ProductCollectionBase & ProductCollectionIdentity & ProductCollectionSaved;
+type Filter = Partial<Record<string, Junction | {
+    conditions: Partial<Record<FiltersCondition, unknown>>;
+}>>;
+declare type Junction = 'and' | 'AND' | 'or' | 'OR';
+/**
+ * @deprecated
+ */
+type AllowedFiltersKeys = 'id' | 'name' | 'attributes' | 'source_id' | 'price' | 'image_url' | 'product_id' | 'skus' | 'created_at' | 'updated_at' | 'object' | `metadata.${string}`;
+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';
+type ProductCollectionsCreateRequestBody = WithRequiredProperty<StaticProductCollectionBase, 'name' | 'type'> | Required<DynamicProductCollectionBase>;
+type ProductCollectionsCreateResponseBody = Required<ProductCollectionBase> & Required<ProductCollectionIdentity> & Required<ProductCollectionSaved>;
+interface ProductCollectionsListRequestQuery {
+    limit?: number;
+    page?: number;
+    order?: 'created_at' | '-created_at';
+}
+interface ProductCollectionsListResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: Required<ProductCollection>[];
+    total: number;
+}
+type ProductCollectionsGetResponseBody = Required<ProductCollection>;
+interface ProductCollectionsListProductsRequestQuery {
+    limit?: number;
+    page?: number;
+}
+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;
+}
+
+export type { AllowedFiltersKeys, DynamicProductCollectionBase, Filter, FiltersCondition, Junction, ProductBase, ProductCollection, ProductCollectionBase, ProductCollectionIdentity, ProductCollectionSaved, ProductCollectionsCreateRequestBody, ProductCollectionsCreateResponseBody, ProductCollectionsGetResponseBody, ProductCollectionsListProductsRequestQuery, ProductCollectionsListProductsResponseBody, ProductCollectionsListRequestQuery, ProductCollectionsListResponseBody, ProductIdentity, ProductOrSkuIdentity, ProductSaved, SkuBase, SkuIdentity, SkuSaved, StaticProductCollectionBase };

package/dist/types/Products.d.ts

@@ -0,0 +1,108 @@
+interface ProductsCreate {
+    name?: string;
+    source_id?: string;
+    price?: number;
+    attributes?: string[];
+    metadata?: Record<string, any>;
+    image_url?: string;
+}
+interface ProductsGetResponseSkus {
+    skus?: {
+        object: 'list';
+        total: number;
+        data?: ProductsGetSkuResponse[];
+    };
+}
+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>;
+}
+type ProductsGetResponse = ProductsCreateResponse & ProductsGetResponseSkus;
+type ProductsUpdate = {
+    name?: string;
+    id?: string;
+    source_id?: string;
+    attributes?: string[];
+    price?: number;
+    image_url?: string;
+    metadata?: Record<string, any>;
+};
+type ProductsUpdateResponse = ProductsCreateResponse;
+interface ProductsBulkUpdateMetadata {
+    source_ids: string[];
+    metadata: Record<string, any>;
+}
+type ProductsBulkUpdate = ProductsCreate[];
+type ProductsBulkUpdateResponse = {
+    async_action_id: string;
+};
+type ProductsBulkUpdateMetadataResponse = {
+    async_action_id: string;
+};
+interface ProductsDeleteParams {
+    force?: boolean;
+}
+interface ProductsListParams {
+    page?: number;
+    limit?: number;
+}
+interface ProductsListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'products';
+    products: ProductsGetResponse[];
+}
+interface ProductsCreateSku {
+    sku: string;
+    source_id?: string;
+    attributes?: Record<string, string>;
+    metadata?: Record<string, any>;
+    price?: number;
+    image_url?: string;
+    currency?: string;
+}
+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';
+}
+type ProductsGetSkuResponse = ProductsCreateSkuResponse;
+type ProductsUpdateSku = ProductsCreateSku & {
+    id?: string;
+    source_id?: string;
+};
+type ProductsUpdateSkuResponse = ProductsGetSkuResponse;
+interface ProductsDeleteSkuParams {
+    force?: boolean;
+}
+interface ProductsListSkus {
+    object: 'list';
+    total: number;
+    skus: ProductsGetSkuResponse[];
+}
+interface SimpleProduct {
+    id: string;
+    source_id?: string;
+    name?: string;
+}
+interface SimpleSku {
+    id: string;
+    source_id?: string;
+    sku?: string;
+}
+
+export type { ProductsBulkUpdate, ProductsBulkUpdateMetadata, ProductsBulkUpdateMetadataResponse, ProductsBulkUpdateResponse, ProductsCreate, ProductsCreateResponse, ProductsCreateSku, ProductsCreateSkuResponse, ProductsDeleteParams, ProductsDeleteSkuParams, ProductsGetResponse, ProductsGetResponseSkus, ProductsGetSkuResponse, ProductsListParams, ProductsListResponse, ProductsListSkus, ProductsUpdate, ProductsUpdateResponse, ProductsUpdateSku, ProductsUpdateSkuResponse, SimpleProduct, SimpleSku };

package/dist/types/PromotionTiers.d.ts

@@ -0,0 +1,131 @@
+import { DiscountUnit, DiscountPercent, DiscountAmount, DiscountFixed } from './DiscountVoucher.js';
+import { OrdersItem, OrdersCreateResponse } from './Orders.js';
+import { SimpleCustomer } from './Customers.js';
+import { ValidationRulesListAssignmentsResponse } from './ValidationRules.js';
+import { ValidationSessionReleaseParams } from './ValidateSession.js';
+import './ApplicableTo.js';
+
+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';
+}
+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;
+}
+interface PromotionTiersListAllParams {
+    is_available?: boolean;
+    limit?: number;
+    page?: number;
+}
+interface PromotionTiersListAllResponse {
+    object: 'list';
+    data_ref: 'tiers';
+    tiers: PromotionTier[];
+    has_more: boolean;
+}
+type PromotionTiersListResponse = PromotionTiersListAllResponse;
+type PromotionTierGetResponse = PromotionTier;
+interface PromotionTiersCreateParams {
+    name?: string;
+    banner?: string;
+    action?: {
+        discount?: DiscountUnit | DiscountPercent | DiscountAmount | DiscountFixed;
+    };
+    metadata?: Record<string, any>;
+}
+type PromotionTiersCreateResponse = PromotionTier;
+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;
+}
+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;
+            };
+        };
+    };
+}
+interface PromotionTierRedeemDetailsSimple {
+    id: string;
+    name: string;
+    banner?: string;
+    campaign: {
+        id: string;
+    };
+}
+type PromotionTierRedeemDetails = PromotionTier & {
+    summary: {
+        redemptions: {
+            total_redeemed: number;
+        };
+        orders: {
+            total_amount: number;
+            total_discount_amount: number;
+        };
+    };
+};
+type PromotionTiersUpdateParams = PromotionTiersCreateParams & {
+    id: string;
+};
+type PromotionTiersUpdateResponse = PromotionTier;
+
+export type { PromotionTier, PromotionTierGetResponse, PromotionTierRedeemDetails, PromotionTierRedeemDetailsSimple, PromotionTiersCreateParams, PromotionTiersCreateResponse, PromotionTiersListAllParams, PromotionTiersListAllResponse, PromotionTiersListResponse, PromotionTiersRedeemParams, PromotionTiersRedeemResponse, PromotionTiersUpdateParams, PromotionTiersUpdateResponse, SimplePromotionTier };

package/dist/types/Promotions.d.ts

@@ -0,0 +1,113 @@
+import { DiscountUnit, DiscountAmount, DiscountPercent, DiscountFixed } from './DiscountVoucher.js';
+import { OrdersItem } from './Orders.js';
+import { PromotionTier } from './PromotionTiers.js';
+import { SimpleCustomer } from './Customers.js';
+import { ValidationRulesCreateAssignmentResponse } from './ValidationRules.js';
+import './ValidateSession.js';
+import './ApplicableTo.js';
+
+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';
+}
+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>;
+        }[];
+    };
+}
+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>;
+}
+interface PromotionsValidateQueryParams {
+    audienceRulesOnly?: boolean;
+    filters?: Record<string, any>;
+}
+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;
+}
+
+export type { PromotionsCreate, PromotionsCreateResponse, PromotionsValidateParams, PromotionsValidateQueryParams, PromotionsValidateResponse };