@voucherify/sdk 2.4.0 → 2.6.0

package/dist/Promotions.d.ts

@@ -1,10 +1,12 @@
 import * as T from './types/Promotions';
 import type { RequestController } from './RequestController';
 import type { PromotionTiers } from './PromotionTiers';
+import { PromotionsStacks } from './PromotionsStacks';
 export declare class Promotions {
     private client;
     tiers: PromotionTiers;
-    constructor(client: RequestController, tiers: PromotionTiers);
+    stack: PromotionsStacks;
+    constructor(client: RequestController, tiers: PromotionTiers, stack: PromotionsStacks);
     /**
      * @see https://docs.voucherify.io/reference/create-promotion-campaign
      */

package/dist/PromotionsStacks.d.ts

@@ -0,0 +1,30 @@
+import * as T from './types/PromotionsStacks';
+import type { RequestController } from './RequestController';
+export declare class PromotionsStacks {
+    private client;
+    constructor(client: RequestController);
+    /**
+     * @see https://docs.voucherify.io/reference/list-promotion-stacks-in-campaign
+     */
+    listInCampaign(campaignId: string): Promise<T.PromotionsStacksListInCampaignResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-promotion-stacks-in-campaign
+     */
+    createInCampaign(campaignId: string, body: T.PromotionsStacksCreateInCampaignRequestBody): Promise<T.PromotionsStacksCreateInCampaignResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/delete-promotion-stack
+     */
+    delete(campaignId: string, stackId: string): Promise<{}>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-promotion-stack
+     */
+    get(campaignId: string, stackId: string): Promise<T.PromotionStack>;
+    /**
+     * @see https://docs.voucherify.io/reference/update-promotion-stack
+     */
+    update(campaignId: string, stackId: string, body: T.PromotionsStacksUpdateRequestBody): Promise<T.PromotionsStacksUpdateResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-promotion-stacks-in-campaign
+     */
+    list(params?: T.PromotionsStacksListRequestQuery): Promise<T.PromotionsStacksListResponseBody>;
+}

package/dist/Rewards.d.ts

@@ -23,17 +23,21 @@ export declare class Rewards {
      * @see https://docs.voucherify.io/reference/delete-reward
      */
     delete(rewardId: string): Promise<unknown>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-reward-assignment
+     */
+    getAssignment(rewardId: string, assignmentId: string): Promise<T.RewardAssignment>;
     /**
      * @see https://docs.voucherify.io/reference/list-reward-assignments
      */
-    listAssignments(rewardId: string, params?: T.RewardsListAssignmentsParams): Promise<T.RewardsListAssignmentsResponse>;
+    listAssignments(rewardId: string, params?: T.RewardsListAssignmentsRequestQuery): Promise<T.RewardsListAssignmentsResponseBody>;
     /**
      * @see https://docs.voucherify.io/reference/create-reward-assignment
      */
-    createAssignment(rewardId: string, assignment: T.RewardsCreateAssignment): Promise<T.RewardsAssignmentObject>;
+    createAssignment(rewardId: string, assignment: T.RewardsCreateAssignmentRequestBody): Promise<T.RewardAssignment>;
     /**
      * @see https://docs.voucherify.io/reference/update-reward-assignment
      */
-    updateAssignment(rewardId: string, assignment: T.RewardsUpdateAssignment): Promise<T.RewardsAssignmentObject>;
+    updateAssignment(rewardId: string, assignment: T.RewardsUpdateAssignmentRequestBody): Promise<T.RewardAssignment>;
     deleteAssignment(rewardId: string, assignmentId: string): Promise<unknown>;
 }

package/dist/ValidationRules.d.ts

@@ -32,6 +32,10 @@ export declare class ValidationRules {
      * @see https://docs.voucherify.io/reference/list-validation-rules
      */
     list(params?: T.ValidationRulesListParams): Promise<T.ValidationRulesListResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-validation-rules-assignments
+     */
+    listRulesAssignments(params?: T.ValidationRulesListRulesAssignmentsRequestQuery): Promise<T.ValidationRulesListRulesAssignmentsResponseBody>;
     /**
      * @see https://docs.voucherify.io/reference/list-validation-rule-assignments
      */

package/dist/VoucherifyServerSide.d.ts

@@ -17,6 +17,7 @@ import { Segments } from './Segments';
 import { ApiLimitsHandler } from './ApiLimitsHandler';
 import { MetadataSchemas } from './MetadataSchemas';
 import { Categories } from './Categories';
+import { ProductCollections } from './ProductCollections';
 export interface VoucherifyServerSideOptions {
     /**
      * Optionally, you can add `apiUrl` to the client options if you want to use Voucherify running in a specific region.
@@ -116,6 +117,7 @@ export declare function VoucherifyServerSide(options: VoucherifyServerSideOption
     consents: Consents;
     orders: Orders;
     products: Products;
+    productCollections: ProductCollections;
     rewards: Rewards;
     loyalties: Loyalties;
     segments: Segments;

package/dist/Vouchers.d.ts

@@ -66,5 +66,13 @@ export declare class Vouchers {
      * @see https://docs.voucherify.io/reference/import-vouchers-using-csv
      */
     importCSV(filePath: string): Promise<AAT.AsyncActionCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-voucher-transactions
+     */
+    listTransactions(code: string, params?: T.VouchersListTransactionsRequestQuery): Promise<T.VouchersListTransactionsResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/export-voucher-transactions
+     */
+    exportTransactions(code: string, body: T.VouchersExportTransactionsRequestBody): Promise<T.VouchersExportTransactionsResponseBody>;
 }
 export {};

package/dist/types/Categories.d.ts

@@ -3,6 +3,7 @@ export interface ListCategories {
     data_ref: 'data';
     data: CategoryObject[];
     total: number;
+    has_more: boolean;
 }
 export declare type CategoryObject = ResponseCreateCategory & {
     updated_at?: string;
@@ -22,3 +23,15 @@ 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';
+};
+export declare type CategoriesListRequestQuery = {
+    limit?: number;
+    starting_after_id?: number;
+};

package/dist/types/Exports.d.ts

@@ -28,3 +28,122 @@ export interface ExportsCreateResponse {
     };
 }
 export declare type ExportsGetResponse = ExportsCreateResponse;
+export interface ExportsListRequestQuery {
+    limit?: number;
+    order?: 'created_at' | '-created_at' | 'status' | '-status';
+    page?: number;
+}
+export interface ExportsListResponseBody {
+    object: 'list';
+    data_ref: 'exports';
+    exports: Export[];
+    total: number;
+}
+export interface ExportBase {
+    id: string;
+    object: 'export';
+    created_at: string;
+    status: 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'ERROR';
+    channel?: string;
+    result: {
+        url: string;
+    } | null;
+    user_id: string | null;
+}
+export declare type Export = ExportBase & (ExportVoucher | ExportRedemption | ExportCustomer | ExportPublication | ExportOrder | ExportPointsExpiration | ExportVoucherTransactionsExpiration);
+export declare type FieldConditions = {
+    conditions?: Partial<Record<FiltersCondition, unknown>>;
+};
+export interface ExportVoucher {
+    exported_object: 'voucher';
+    parameters: {
+        order?: ExportVoucherOrder;
+        fields?: ExportVoucherFields[];
+        filters?: ExportVoucherFilters;
+    };
+}
+export declare type ExportVoucherFilters = {
+    junction?: Junction;
+} & Partial<Record<ExportVoucherFields, FieldConditions>>;
+export interface ExportRedemption {
+    exported_object: 'redemption';
+    parameters: {
+        order?: ExportRedemptionOrder;
+        fields?: ExportRedemptionFields[];
+        filters?: ExportRedemptionFilters;
+    };
+}
+export declare type ExportRedemptionFilters = {
+    junction?: Junction;
+} & Partial<Record<ExportRedemptionFields, FieldConditions>>;
+export interface ExportCustomer {
+    exported_object: 'customer';
+    parameters: {
+        order?: ExportCustomerOrder;
+        fields?: ExportCustomerFields[];
+        filters?: ExportCustomerFilters;
+    };
+}
+export declare type ExportCustomerFilters = {
+    junction?: Junction;
+} & Partial<Record<ExportCustomerFields, FieldConditions>>;
+export interface ExportPublication {
+    exported_object: 'publication';
+    parameters: {
+        order?: ExportPublicationOrder;
+        fields?: ExportPublicationFields[];
+        filters?: ExportPublicationFilters;
+    };
+}
+export declare type ExportPublicationFilters = {
+    junction?: Junction;
+} & Partial<Record<ExportPublicationFields, FieldConditions>>;
+export interface ExportOrder {
+    exported_object: 'order';
+    parameters: {
+        order?: ExportOrderOrder;
+        fields?: ExportOrderFields[];
+        filters?: ExportOrderFilters;
+    };
+}
+export declare type ExportOrderFilters = {
+    junction?: Junction;
+} & Partial<Record<ExportOrderFields, FieldConditions>>;
+export interface ExportPointsExpiration {
+    exported_object: 'points_expiration';
+    parameters: {
+        order?: ExportPointsExpirationOrder;
+        fields?: ExportPointsExpirationFields[];
+        filters?: ExportPointsExpirationFilters;
+    };
+}
+export declare type ExportPointsExpirationFilters = {
+    junction?: Junction;
+} & Partial<Record<ExportPointsExpirationFields, FieldConditions>>;
+export interface ExportVoucherTransactionsExpiration {
+    exported_object: 'voucher_transactions';
+    parameters: {
+        order?: ExportVoucherTransactionsOrder;
+        fields?: ExportVoucherTransactionsFields[];
+        filters?: ExportVoucherTransactionsFilters;
+    };
+}
+export declare type ExportVoucherTransactionsFilters = {
+    junction?: Junction;
+} & Partial<Record<ExportVoucherTransactionsFields, FieldConditions>>;
+export declare type Junction = 'and' | 'AND' | 'or' | 'OR';
+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 ExportCustomerFields = 'name' | 'id' | 'description' | 'email' | 'source_id' | 'created_at' | 'address_city' | 'address_state' | 'address_line_1' | 'address_line_2' | 'address_country' | 'address_postal_code' | 'redemptions_total_redeemed' | 'redemptions_total_failed' | 'redemptions_total_succeeded' | 'redemptions_total_rolled_back' | 'redemptions_total_rollback_failed' | 'redemptions_total_rollback_succeeded' | 'orders_total_amount' | 'orders_total_count' | 'orders_average_amount' | 'orders_last_order_amount' | 'orders_last_order_date' | 'loyalty_points' | 'loyalty_referred_customers' | 'updated_at' | 'phone' | 'birthday' | 'metadata' | 'birthdate';
+export declare type ExportCustomerOrder = ExportCustomerFields | '-name' | '-id' | '-description' | '-email' | '-source_id' | '-created_at' | '-address_city' | '-address_state' | '-address_line_1' | '-address_line_2' | '-address_country' | '-address_postal_code' | '-redemptions_total_redeemed' | '-redemptions_total_failed' | '-redemptions_total_succeeded' | '-redemptions_total_rolled_back' | '-redemptions_total_rollback_failed' | '-redemptions_total_rollback_succeeded' | '-orders_total_amount' | '-orders_total_count' | '-orders_average_amount' | '-orders_last_order_amount' | '-orders_last_order_date' | '-loyalty_points' | '-loyalty_referred_customers' | '-updated_at' | '-phone' | '-birthday' | '-metadata' | '-birthdate';
+export declare type ExportPublicationFields = 'voucher_code' | 'customer_id' | 'customer_source_id' | 'date' | 'channel' | 'campaign' | 'is_winner' | 'metadata';
+export declare type ExportPublicationOrder = ExportPublicationFields | '-voucher_code' | '-customer_id' | '-customer_source_id' | '-date' | '-channel' | '-campaign' | '-is_winner' | '-metadata';
+export declare type ExportRedemptionFields = 'id' | 'object' | 'date' | 'voucher_code' | 'campaign' | 'promotion_tier_id' | 'customer_id' | 'customer_source_id' | 'customer_name' | 'tracking_id' | 'order_amount' | 'gift_amount' | 'loyalty_points' | 'result' | 'failure_code' | 'failure_message' | 'metadata';
+export declare type ExportRedemptionOrder = ExportRedemptionFields | '-id' | '-object' | '-date' | '-voucher_code' | '-campaign' | '-promotion_tier_id' | '-customer_id' | '-customer_source_id' | '-customer_name' | '-tracking_id' | '-order_amount' | '-gift_amount' | '-loyalty_points' | '-result' | '-failure_code' | '-failure_message' | '-metadata';
+export declare type ExportVoucherFields = 'code' | 'voucher_type' | 'value' | 'discount_type' | 'campaign' | 'category' | 'start_date' | 'expiration_date' | 'gift_balance' | 'loyalty_balance' | 'redemption_quantity' | 'redemption_count' | 'active' | 'qr_code' | 'bar_code' | 'metadata' | 'id' | 'is_referral_code' | 'created_at' | 'updated_at' | 'validity_timeframe_interval' | 'validity_timeframe_duration' | 'validity_day_of_week' | 'discount_amount_limit' | 'campaign_id' | 'additional_info' | 'customer_id' | 'discount_unit_type' | 'discount_unit_effect' | 'customer_source_id';
+export declare type ExportVoucherOrder = ExportVoucherFields | '-code' | '-voucher_type' | '-value' | '-discount_type' | '-campaign' | '-category' | '-start_date' | '-expiration_date' | '-gift_balance' | '-loyalty_balance' | '-redemption_quantity' | '-redemption_count' | '-active' | '-qr_code' | '-bar_code' | '-metadata' | '-id' | '-is_referral_code' | '-created_at' | '-updated_at' | '-validity_timeframe_interval' | '-validity_timeframe_duration' | '-validity_day_of_week' | '-discount_amount_limit' | '-campaign_id' | '-additional_info' | '-customer_id' | '-discount_unit_type' | '-discount_unit_effect' | '-customer_source_id';
+export declare type ExportOrderFields = 'id' | 'source_id' | 'created_at' | 'updated_at' | 'status' | 'amount' | 'discount_amount' | 'items_discount_amount' | 'total_discount_amount' | 'total_amount' | 'customer_id' | 'referrer_id' | 'metadata';
+export declare type ExportOrderOrder = ExportOrderFields | '-id' | '-source_id' | '-created_at' | '-updated_at' | '-status' | '-amount' | '-discount_amount' | '-items_discount_amount' | '-total_discount_amount' | '-total_amount' | '-customer_id' | '-referrer_id' | '-metadata';
+export declare type ExportPointsExpirationFields = 'id' | 'campaign_id' | 'voucher_id' | 'points' | 'status' | 'expires_at';
+export declare type ExportPointsExpirationOrder = ExportPointsExpirationFields | '-id' | '-campaign_id' | '-voucher_id' | '-points' | '-status' | '-expires_at';
+export declare type ExportVoucherTransactionsFields = 'id' | 'campaign_id' | 'voucher_id' | 'type' | 'source_id' | 'reason' | 'source' | 'balance' | 'amount' | 'related_transaction_id' | 'created_at' | 'details';
+export declare type ExportVoucherTransactionsOrder = ExportVoucherTransactionsFields | '-id' | '-campaign_id' | '-voucher_id' | '-type' | '-source_id' | '-reason' | '-source' | '-balance' | '-amount' | '-related_transaction_id' | '-created_at' | '-details';