@voucherify/sdk 3.0.0 → 3.0.2

package/dist/types/model/VouchersUpdateResponseBodyGift.d.ts

@@ -0,0 +1,38 @@
+export default VouchersUpdateResponseBodyGift;
+/**
+ * The VouchersUpdateResponseBodyGift model module.
+ * @module model/VouchersUpdateResponseBodyGift
+ * @version 3.0.2
+ */
+declare class VouchersUpdateResponseBodyGift {
+    /**
+     * Initializes the fields of this object.
+     * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+     * Only for internal use.
+     */
+    static initialize(obj: any): void;
+    /**
+     * Constructs a <code>VouchersUpdateResponseBodyGift</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Partial<VouchersUpdateResponseBodyGift>} data The plain JavaScript object bearing properties of interest.
+     * @param {VouchersUpdateResponseBodyGift} [obj] Optional instance to populate.
+     * @returns {VouchersUpdateResponseBodyGift} The populated <code>VouchersUpdateResponseBodyGift</code> instance.
+     */
+    static constructFromObject(data: Partial<VouchersUpdateResponseBodyGift>, obj?: VouchersUpdateResponseBodyGift): VouchersUpdateResponseBodyGift;
+    /**
+     * Validates the JSON data with respect to <code>VouchersUpdateResponseBodyGift</code>.
+     * @param {Partial<VouchersUpdateResponseBodyGift>} data The plain JavaScript object bearing properties of interest.
+     * @returns {boolean} to indicate whether the JSON data is valid with respect to <code>VouchersUpdateResponseBodyGift</code>.
+     */
+    static validateJSON(data: Partial<VouchersUpdateResponseBodyGift>): boolean;
+    amount: number | undefined;
+    subtracted_amount: number | undefined;
+    balance: number | undefined;
+    effect: (keyof typeof VouchersUpdateResponseBodyGift.EffectEnum) | undefined;
+}
+declare namespace VouchersUpdateResponseBodyGift {
+    namespace EffectEnum {
+        let APPLY_TO_ORDER: string;
+        let APPLY_TO_ITEMS: string;
+    }
+}

package/dist/types/model/VouchersUpdateResponseBodyLoyaltyCard.d.ts

@@ -0,0 +1,35 @@
+export default VouchersUpdateResponseBodyLoyaltyCard;
+/**
+ * The VouchersUpdateResponseBodyLoyaltyCard model module.
+ * @module model/VouchersUpdateResponseBodyLoyaltyCard
+ * @version 3.0.2
+ */
+declare class VouchersUpdateResponseBodyLoyaltyCard {
+    /**
+     * Initializes the fields of this object.
+     * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+     * Only for internal use.
+     */
+    static initialize(obj: any): void;
+    /**
+     * Constructs a <code>VouchersUpdateResponseBodyLoyaltyCard</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Partial<VouchersUpdateResponseBodyLoyaltyCard>} data The plain JavaScript object bearing properties of interest.
+     * @param {VouchersUpdateResponseBodyLoyaltyCard} [obj] Optional instance to populate.
+     * @returns {VouchersUpdateResponseBodyLoyaltyCard} The populated <code>VouchersUpdateResponseBodyLoyaltyCard</code> instance.
+     */
+    static constructFromObject(data: Partial<VouchersUpdateResponseBodyLoyaltyCard>, obj?: VouchersUpdateResponseBodyLoyaltyCard): VouchersUpdateResponseBodyLoyaltyCard;
+    /**
+     * Validates the JSON data with respect to <code>VouchersUpdateResponseBodyLoyaltyCard</code>.
+     * @param {Partial<VouchersUpdateResponseBodyLoyaltyCard>} data The plain JavaScript object bearing properties of interest.
+     * @returns {boolean} to indicate whether the JSON data is valid with respect to <code>VouchersUpdateResponseBodyLoyaltyCard</code>.
+     */
+    static validateJSON(data: Partial<VouchersUpdateResponseBodyLoyaltyCard>): boolean;
+    points: number | undefined;
+    balance: number | undefined;
+    next_expiration_date: Date | undefined;
+    next_expiration_points: number | undefined;
+    pending_points: number | undefined;
+    expired_points: number | undefined;
+    subtracted_points: number | undefined;
+}

package/dist/types/model/VouchersUpdateResponseBodyPublish.d.ts

@@ -0,0 +1,31 @@
+export default VouchersUpdateResponseBodyPublish;
+/**
+ * The VouchersUpdateResponseBodyPublish model module.
+ * @module model/VouchersUpdateResponseBodyPublish
+ * @version 3.0.2
+ */
+declare class VouchersUpdateResponseBodyPublish {
+    /**
+     * Initializes the fields of this object.
+     * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+     * Only for internal use.
+     */
+    static initialize(obj: any): void;
+    /**
+     * Constructs a <code>VouchersUpdateResponseBodyPublish</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Partial<VouchersUpdateResponseBodyPublish>} data The plain JavaScript object bearing properties of interest.
+     * @param {VouchersUpdateResponseBodyPublish} [obj] Optional instance to populate.
+     * @returns {VouchersUpdateResponseBodyPublish} The populated <code>VouchersUpdateResponseBodyPublish</code> instance.
+     */
+    static constructFromObject(data: Partial<VouchersUpdateResponseBodyPublish>, obj?: VouchersUpdateResponseBodyPublish): VouchersUpdateResponseBodyPublish;
+    /**
+     * Validates the JSON data with respect to <code>VouchersUpdateResponseBodyPublish</code>.
+     * @param {Partial<VouchersUpdateResponseBodyPublish>} data The plain JavaScript object bearing properties of interest.
+     * @returns {boolean} to indicate whether the JSON data is valid with respect to <code>VouchersUpdateResponseBodyPublish</code>.
+     */
+    static validateJSON(data: Partial<VouchersUpdateResponseBodyPublish>): boolean;
+    object: string | undefined;
+    count: number | undefined;
+    url: string | undefined;
+}

package/dist/types/model/VouchersUpdateResponseBodyRedemption.d.ts

@@ -0,0 +1,33 @@
+export default VouchersUpdateResponseBodyRedemption;
+/**
+ * The VouchersUpdateResponseBodyRedemption model module.
+ * @module model/VouchersUpdateResponseBodyRedemption
+ * @version 3.0.2
+ */
+declare class VouchersUpdateResponseBodyRedemption {
+    /**
+     * Initializes the fields of this object.
+     * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+     * Only for internal use.
+     */
+    static initialize(obj: any): void;
+    /**
+     * Constructs a <code>VouchersUpdateResponseBodyRedemption</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Partial<VouchersUpdateResponseBodyRedemption>} data The plain JavaScript object bearing properties of interest.
+     * @param {VouchersUpdateResponseBodyRedemption} [obj] Optional instance to populate.
+     * @returns {VouchersUpdateResponseBodyRedemption} The populated <code>VouchersUpdateResponseBodyRedemption</code> instance.
+     */
+    static constructFromObject(data: Partial<VouchersUpdateResponseBodyRedemption>, obj?: VouchersUpdateResponseBodyRedemption): VouchersUpdateResponseBodyRedemption;
+    /**
+     * Validates the JSON data with respect to <code>VouchersUpdateResponseBodyRedemption</code>.
+     * @param {Partial<VouchersUpdateResponseBodyRedemption>} data The plain JavaScript object bearing properties of interest.
+     * @returns {boolean} to indicate whether the JSON data is valid with respect to <code>VouchersUpdateResponseBodyRedemption</code>.
+     */
+    static validateJSON(data: Partial<VouchersUpdateResponseBodyRedemption>): boolean;
+    quantity: number | undefined;
+    redeemed_quantity: number | undefined;
+    redeemed_points: number | undefined;
+    object: string | undefined;
+    url: string | undefined;
+}

package/docs/LoyaltyCardTransaction.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **sourceId** | **String** | The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null. | [optional] 
 **voucherId** | **String** | Unique voucher ID. | [optional] 
 **campaignId** | **String** | Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes. | [optional] 
-**source** | **String** | The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. | [optional] 
+**source** | **String** | The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. | [optional] 
 **reason** | **String** | Reason why the transaction occurred. In case of a redemption, this value is null. | [optional] 
 **relatedTransactionId** | **String** | The related transaction ID on the receiving card. | [optional] 
 **createdAt** | **Date** | Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format. | [optional] 

package/docs/LoyaltyPointsBucket.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **voucherId** | **String** | Unique identifier of the parent loyalty card. | [optional] 
 **campaignId** | **String** | Unique identifier of the parent campaign. | [optional] 
 **bucket** | [**LoyaltyPointsBucketBucket**](LoyaltyPointsBucketBucket.md) |  | [optional] 
-**status** | **String** | Loyalty point point bucket status. | [optional] 
+**status** | **String** | Loyalty point bucket status. | [optional] 
 **expiresAt** | **Date** | Date when the number of points defined in the bucket object are due to expire. | [optional] 
 **createdAt** | **Date** | Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format. | [optional] 
 **updatedAt** | **Date** | Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format. | [optional] 

package/docs/MemberActivityDataTransaction.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **sourceId** | **String** | The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null. | [optional] 
 **voucherId** | **String** | Unique voucher ID. | [optional] 
 **campaignId** | **String** | Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes. | [optional] 
-**source** | **String** | The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. | [optional] 
+**source** | **String** | The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. | [optional] 
 **reason** | **String** | Reason why the transaction occurred. In case of a redemption, this value is null. | [optional] 
 **relatedTransactionId** | **String** | The related transaction ID on the receiving card. | [optional] 
 **createdAt** | **Date** | Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format. | [optional] 

package/docs/OrdersApi.md

@@ -196,7 +196,7 @@ Name | Type | Description  | Notes
 
 Import Orders
 
-  🚧 Historical orders  This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one.   ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions    If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger  - **customers entering into segments**  - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs.   2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered.     3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc.    4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint.
+  🚧 Historical orders  This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one.   ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions    If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger  - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs.   2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered.     3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc.    4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint.
 
 ### Example
 

package/docs/OrdersImportCreateRequestBodyItem.md

@@ -12,10 +12,10 @@ Name | Type | Description | Notes
 **discountAmount** | **Number** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] 
 **items** | [**[OrderItem]**](OrderItem.md) | Array of items applied to the order. It can include up to 500 items. | [optional] 
 **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] 
-**createdAt** | **Date** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] 
 **referrerId** | **String** | Unique referrer ID. | [optional] 
 **customer** | [**Customer**](Customer.md) |  | [optional] 
 **referrer** | [**Referrer**](Referrer.md) |  | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] 
 
 
 

package/docs/ProductCollectionsApi.md

@@ -40,7 +40,7 @@ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
 X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
 
 let apiInstance = new Voucherify.ProductCollectionsApi();
-let productCollectionsCreateRequestBody = new Voucherify.ProductCollectionsCreateRequestBody(); // ProductCollectionsCreateRequestBody | 
+let productCollectionsCreateRequestBody = {"type":"STATIC","name":"Static collection example","products":[{"id":"prod_0a41dd45dc85fcab40","object":"product"}]}; // ProductCollectionsCreateRequestBody | 
 apiInstance.createProductCollection(productCollectionsCreateRequestBody, (error, data, response) => {
   if (error) {
     console.error(error);

package/docs/ProductCollectionsCreateRequestBody.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | Show that the product collection is static (manually selected products). | [optional] [default to 'STATIC']
+**type** | **String** |  | [optional] 
 **name** | **String** | Unique user-defined product collection name. | [optional] 
 **products** | [**[ProductCollectionsCreateRequestBodyProductsItem]**](ProductCollectionsCreateRequestBodyProductsItem.md) | Defines a set of products for a `STATIC` product collection type. | [optional] 
 **filter** | **Object** | Defines a set of criteria and boundary conditions for an `AUTO_UPDATE` product collection type. | [optional] 
@@ -16,6 +16,8 @@ Name | Type | Description | Notes
 
 * `STATIC` (value: `"STATIC"`)
 
+* `AUTO_UPDATE` (value: `"AUTO_UPDATE"`)
+
 
 
 

package/docs/QualificationsApi.md

@@ -36,7 +36,7 @@ let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
 X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
 
 let apiInstance = new Voucherify.QualificationsApi();
-let qualificationsCheckEligibilityRequestBody = new Voucherify.QualificationsCheckEligibilityRequestBody(); // QualificationsCheckEligibilityRequestBody | Define order and customer context.
+let qualificationsCheckEligibilityRequestBody = {"scenario":"ALL","options":{"limit":10,"expand":["redeemable"],"sorting_rule":"DEFAULT"}}; // QualificationsCheckEligibilityRequestBody | Define order and customer context.
 apiInstance.checkEligibility(qualificationsCheckEligibilityRequestBody, (error, data, response) => {
   if (error) {
     console.error(error);

package/docs/RedemptionsApi.md

@@ -212,7 +212,7 @@ Name | Type | Description  | Notes
 
 Redeem Stackable Discounts
 
-# How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts:   API keys with a Merchant role cant use this endpoint.  📘 Rollbacks  You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions).      📘 Also available on client-side  This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more.  - Use X-Client-Application-Id as the application ID header.  - Use X-Client-Token as the appliction secret key header.  - Use client-side base URL.  - Use an origin header for your custom domain.
+# How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts:   API keys with a Merchant role cant use this endpoint.  📘 Rollbacks  You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions).      📘 Also available on client-side  This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more.
 
 ### Example
 

package/docs/RewardsCreateRequestBodyParametersCampaign.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** |  | [optional] 
-**balance** | **Number** | The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**balance** | **Number** | The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
 
 

package/docs/SegmentsCreateResponseBody.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **createdAt** | **Date** | Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format. | [optional] 
 **type** | **String** | Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers. | [optional] 
 **filter** | **Object** | Defines a set of criteria for an `auto-update` or `passive` segment type. | [optional] 
-**initialSyncStatus** | **String** |  | [optional] 
 **object** | **String** | The type of the object represented by JSON. This object stores information about the customer segment. | [optional] [default to 'segment']
+**initialSyncStatus** | **String** |  | [optional] 
 
 
 
@@ -27,21 +27,21 @@ Name | Type | Description | Notes
 
 
 
-## Enum: InitialSyncStatusEnum
+## Enum: ObjectEnum
 
 
-* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
+* `segment` (value: `"segment"`)
 
-* `DONE` (value: `"DONE"`)
 
 
 
 
+## Enum: InitialSyncStatusEnum
 
-## Enum: ObjectEnum
 
+* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
 
-* `segment` (value: `"segment"`)
+* `DONE` (value: `"DONE"`)
 
 
 

package/docs/SegmentsGetResponseBody.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **createdAt** | **Date** | Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format. | [optional] 
 **type** | **String** | Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers. | [optional] 
 **filter** | **Object** | Defines a set of criteria for an `auto-update` or `passive` segment type. | [optional] 
-**initialSyncStatus** | **String** |  | [optional] 
 **object** | **String** | The type of the object represented by JSON. This object stores information about the customer segment. | [optional] [default to 'segment']
+**initialSyncStatus** | **String** |  | [optional] 
 
 
 
@@ -27,21 +27,21 @@ Name | Type | Description | Notes
 
 
 
-## Enum: InitialSyncStatusEnum
+## Enum: ObjectEnum
 
 
-* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
+* `segment` (value: `"segment"`)
 
-* `DONE` (value: `"DONE"`)
 
 
 
 
+## Enum: InitialSyncStatusEnum
 
-## Enum: ObjectEnum
 
+* `IN_PROGRESS` (value: `"IN_PROGRESS"`)
 
-* `segment` (value: `"segment"`)
+* `DONE` (value: `"DONE"`)
 
 
 

package/docs/ValidityHours.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**daily** | [**[ValidityHoursDailyItem]**](ValidityHoursDailyItem.md) | Defines the reccuring period(s) when the resource is active. The periods should not overlap. | [optional] 
+**daily** | [**[ValidityHoursDailyItem]**](ValidityHoursDailyItem.md) | Defines the recurring period(s) when the resource is active. The periods should not overlap. | [optional] 
 
 

package/docs/VoucherTransaction.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **sourceId** | **String** | The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null. | [optional] 
 **voucherId** | **String** | Unique voucher ID. | [optional] 
 **campaignId** | **String** | Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes. | [optional] 
-**source** | **String** | The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. | [optional] 
+**source** | **String** | The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. | [optional] 
 **reason** | **String** | Reason why the transaction occurred. In case of a redemption, this value is null. | [optional] 
 **relatedTransactionId** | **String** | The related transaction ID on the receiving card. | [optional] 
 **createdAt** | **Date** | Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format. | [optional] 

package/docs/VouchersApi.md

@@ -450,7 +450,7 @@ Name | Type | Description  | Notes
 
 Import Vouchers
 
-Import generic (standalone) vouchers and gift cards into the repository.  📘 Important notes  - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z.  - Custom code attributes (not supported by-default) need to be added as code **metadata**.  - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields:   - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import.   Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
+Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default.   Also, the request can include up to **10 MB** of data.  📘 Important notes  - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z.  - Custom code attributes (not supported by-default) need to be added as code **metadata**.  - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields:   - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import.   Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
 
 ### Example
 
@@ -509,7 +509,7 @@ Name | Type | Description  | Notes
 
 Import Vouchers using CSV
 
-Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object.   You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___  📘 Standard voucher fields mapping  - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section).  - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z.       - YYYY-MM-DD     - YYYY-MM-DDTHH     - YYYY-MM-DDTHH:mm     - YYYY-MM-DDTHH:mm:ss     - YYYY-MM-DDTHH:mm:ssZ     - YYYY-MM-DDTHH:mm:ssZ     - YYYY-MM-DDTHH:mm:ss.SSSZ  - Custom code attributes (not supported by-default) need to be added as code **metadata**.  - You **cannot import the same codes** to a single Voucherify project.  - You can, however, upload the same codes to update them.  📘 Categories  In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
+Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default.   Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___  📘 Standard voucher fields mapping  - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section).  - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z.       - YYYY-MM-DD     - YYYY-MM-DDTHH     - YYYY-MM-DDTHH:mm     - YYYY-MM-DDTHH:mm:ss     - YYYY-MM-DDTHH:mm:ssZ     - YYYY-MM-DDTHH:mm:ssZ     - YYYY-MM-DDTHH:mm:ss.SSSZ  - Custom code attributes (not supported by-default) need to be added as code **metadata**.  - You **cannot import the same codes** to a single Voucherify project.  - You can, however, upload the same codes to update them.  📘 Categories  In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
 
 ### Example
 
@@ -672,7 +672,8 @@ let opts = {
   'updatedAt': new Voucherify.ParameterUpdatedBeforeAfter(), // ParameterUpdatedBeforeAfter | A filter on the list based on the object updated_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [updated_at][before] 2017-09-08T13:52:18.227Z
   'order': new Voucherify.ParameterOrderVouchers(), // ParameterOrderVouchers | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
   'code': "code_example", // String | 
-  'ids': ["null"] // [String] | 
+  'ids': ["null"], // [String] | 
+  'filters': {key: null} // Object | Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples.
 };
 apiInstance.listVouchers(opts, (error, data, response) => {
   if (error) {
@@ -699,6 +700,7 @@ Name | Type | Description  | Notes
  **order** | [**ParameterOrderVouchers**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] 
  **code** | **String**|  | [optional] 
  **ids** | [**[String]**](String.md)|  | [optional] 
+ **filters** | [**Object**](.md)| Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. | [optional] 
 
 ### Return type
 

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@voucherify/sdk",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Voucherify promotion engine REST API. Please see https://docs.voucherify.io/docs for more details.",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
+  "types": "dist/types/index.d.ts",
   "scripts": {
-    "build": "rollup -c rollup.config.js",
+    "build:types": "tsc",
+    "build:js": "rollup -c rollup.config.js",
+    "build": "npm run build:types && npm run build:js",
     "prepare": "npm run build",
     "test": "npm run format:test && mocha --require @babel/register --timeout 15000 --recursive",
     "format:test": "prettier --write \"test/**/*.js\"",
@@ -25,9 +28,13 @@
     "os": false,
     "path": false
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/voucherifyio/voucherify-js-sdk.git"
+  },
   "dependencies": {
     "@babel/cli": "7.28.3",
-    "qs": "6.14.0",
+    "qs": "6.14.1",
     "superagent": "10.2.3"
   },
   "devDependencies": {