@voucherify/sdk 1.2.0

package/dist/types/Customers.d.ts

@@ -0,0 +1,113 @@
+export interface SimpleCustomer {
+    id: string;
+    name?: string;
+    email?: string;
+    source_id?: string;
+    metadata?: Record<string, any>;
+    object: 'customer';
+}
+export interface CustomerObject {
+    id: string;
+    source_id?: string;
+    name?: string;
+    email?: string;
+    phone?: string;
+    description?: string;
+    address: {
+        city?: string;
+        state?: string;
+        line_1?: string;
+        line_2?: string;
+        country?: string;
+        postal_code?: string;
+    };
+    summary: {
+        redemptions: {
+            total_redeemed: number;
+            total_failed: number;
+            total_succeeded: number;
+            total_rolled_back: number;
+            total_rollback_failed: number;
+            total_rollback_succeeded: number;
+            gift?: {
+                redeemed_amount: number;
+                amount_to_go: number;
+            };
+            loyalty?: {
+                redeemed_points: number;
+                points_to_go: number;
+            };
+        };
+        orders: {
+            total_amount: number;
+            total_count: number;
+            average_amount: number;
+            last_order_amount: number;
+            last_order_date?: string;
+        };
+    };
+    loyalty: {
+        points: number;
+        referred_customers: number;
+        campaigns?: Record<string, {
+            points: number;
+            referred_customers: number;
+        }>;
+    };
+    metadata: Record<string, any>;
+    created_at: string;
+    object: 'customer';
+}
+export declare type CustomerUnconfirmed = Pick<CustomerObject, 'summary' | 'email' | 'loyalty'> & {
+    object: 'unconfirmed_customer';
+};
+export interface CustomerRequest {
+    id?: string;
+    source_id?: string;
+    name?: string;
+    email?: string;
+    metadata?: Record<string, any>;
+    description?: string;
+    address?: {
+        city?: string;
+        state?: string;
+        line_1?: string;
+        line_2?: string;
+        country?: string;
+        postal_code?: string;
+    };
+    phone?: string;
+}
+export interface CustomersCommonListRequest {
+    limit?: number;
+    page?: number;
+    email?: string;
+    city?: string;
+    name?: string;
+    order?: 'created_at' | '-created_at';
+    starting_after?: Date | string;
+}
+export interface CustomersCommonListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'customers';
+    customers: CustomerObject[];
+    has_more?: boolean;
+}
+export declare type CustomersCreateBody = CustomerRequest;
+export declare type CustomersCreateResponse = CustomerObject | CustomerUnconfirmed;
+export declare type CustomersGetResponse = CustomerObject | CustomerUnconfirmed;
+export declare type CustomersListParams = CustomersCommonListRequest;
+export declare type CustomersListResponse = CustomersCommonListResponse;
+export declare type CustomersScrollParams = CustomersCommonListRequest;
+export declare type CustomersScrollResponse = CustomersCommonListResponse;
+export declare type CustomersScrollYield = CustomerObject;
+declare type IdOrSourceId = {
+    id: string;
+} | {
+    source_id: string;
+};
+export declare type CustomersUpdateParams = CustomerRequest & IdOrSourceId;
+export declare type CustomersUpdateResponse = CustomerObject | CustomerUnconfirmed;
+export declare type CustomersUpdateConsentsBody = Record<string, boolean>;
+export {};

package/dist/types/Distributions.d.ts

@@ -0,0 +1,141 @@
+import { CustomerRequest, SimpleCustomer } from './Customers';
+import { VoucherType } from './Vouchers';
+declare type OrderType = 'id' | '-id' | 'voucher_code' | '-voucher_code' | 'tracking_id' | '-tracking_id' | 'customer_id' | '-customer_id' | 'created_at' | '-created_at' | 'channel' | '-channel';
+export interface VoucherDiscount {
+    type: 'UNIT' | 'AMOUNT' | 'DISCOUNT';
+    unit_off?: number;
+    effect?: string;
+    amount_off?: number;
+    percent_off?: number;
+    amount_limit?: number;
+}
+interface DistributionsPublicationsVoucher {
+    code?: string;
+    object?: 'voucher';
+    campaign?: string;
+    gift?: {
+        amount: number;
+        balance: number;
+    };
+    loyalty_card?: {
+        amount: number;
+        balance: number;
+    };
+    is_referral_code?: boolean;
+    discount?: VoucherDiscount;
+}
+interface DistributionsPublicationsCreateResponseVoucher {
+    id: string;
+    code: string;
+    campaign?: string;
+    campaign_id?: string;
+    category?: string;
+    type?: VoucherType;
+    discount?: VoucherDiscount;
+    gift?: {
+        amount: number;
+        balance: number;
+    };
+    loyalty_card?: {
+        amount: number;
+        balance: number;
+    };
+    start_date?: string;
+    expiration_date?: string;
+    validity_timeframe?: string;
+    validity_day_of_week?: string;
+    active?: boolean;
+    additional_info?: string;
+    metadata?: Record<string, any>;
+    assets: {
+        qr: {
+            id: string;
+            url: string;
+        };
+        barcode: {
+            id: string;
+            url: string;
+        };
+    };
+    is_referral_code?: boolean;
+    created_at: string;
+    updated_at?: string;
+    holder_id?: string;
+    object: 'voucher';
+    publish: {
+        object: string;
+        count: number;
+        url: string;
+    };
+    redemption: {
+        object: string;
+        quantity: number;
+        redeemed_quantity: number;
+        url: string;
+    };
+}
+export interface DistributionsPublicationsListParams {
+    limit?: number;
+    page?: number;
+    order?: OrderType;
+    campaign?: string;
+    customer?: string;
+    voucher?: string;
+    result?: 'SUCCESS' | 'FAILURE';
+    voucher_type?: 'GIFT' | 'DISCOUNT' | 'LOYALTY_CARD' | 'LUCKY_DRAW';
+    is_referral_code?: boolean;
+    filters?: {
+        junction?: 'OR' | 'AND';
+        [filter_condition: string]: any;
+    };
+}
+interface PublicationResponse {
+    id: string;
+    source_id?: string;
+    object: 'publication';
+    created_at: string;
+    customer_id?: string;
+    tracking_id?: string;
+    metadata?: Record<string, any>;
+    channel?: string;
+    result: 'SUCCESS' | 'FAILURE';
+    customer?: {
+        object?: string;
+        id: string;
+    };
+    voucher?: DistributionsPublicationsVoucher;
+    vouchers?: string[];
+    failure_code?: string;
+    failure_message?: string;
+}
+export interface DistributionsPublicationsListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'publications';
+    publications?: PublicationResponse[];
+}
+export interface DistributionsPublicationsCreateParams {
+    join_once?: boolean;
+    source_id?: string;
+    campaign?: {
+        name: string;
+        count?: number;
+    };
+    voucher?: string;
+    channel?: string;
+    customer: CustomerRequest;
+}
+export interface DistributionsPublicationsCreateResponse {
+    id: string;
+    object: 'publication';
+    created_at: string;
+    customer_id: string;
+    tracking_id?: string;
+    metadata?: Record<string, any>;
+    channel?: string;
+    source_id?: string;
+    result: 'SUCCESS' | 'FAILURE';
+    customer?: SimpleCustomer;
+    voucher: DistributionsPublicationsCreateResponseVoucher;
+}
+export {};

package/dist/types/Events.d.ts

@@ -0,0 +1,17 @@
+import { CustomerRequest } from './Customers';
+export interface EventsParams {
+    event: string;
+    customer: CustomerRequest;
+    metadata?: Record<string, any>;
+    referral?: {
+        code: string;
+        referrer_id?: string;
+    };
+    loyalty?: {
+        code: string;
+    };
+}
+export interface EventsResponse {
+    object: 'event';
+    type: string;
+}

package/dist/types/Exports.d.ts

@@ -0,0 +1,30 @@
+export interface ExportResource {
+    exported_object: 'voucher' | 'redemption' | 'publication' | 'customer';
+    parameters?: {
+        order?: string;
+        fields?: string[];
+        filters?: {
+            junction?: 'AND' | 'OR';
+            [filter_condition: string]: any;
+        };
+    };
+}
+export interface ExportsCreateResponse {
+    id: string;
+    object: 'export';
+    created_at: string;
+    status: 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'ERROR';
+    channel?: string;
+    exported_object: 'voucher' | 'redemption' | 'publication' | 'customer';
+    parameters?: {
+        fields?: string[];
+        filters?: {
+            junction?: string;
+            [filter_condition: string]: any;
+        };
+    };
+    result?: {
+        url: string;
+    };
+}
+export declare type ExportsGetResponse = ExportsCreateResponse;