@voucherify/sdk 3.0.0 → 3.0.1

package/dist/types/api/ValidationRulesApi.d.ts

@@ -0,0 +1,210 @@
+/**
+* ValidationRules service.
+* @module api/ValidationRulesApi
+* @version 3.0.1
+*/
+export default class ValidationRulesApi {
+    /**
+    * Constructs a new ValidationRulesApi.
+    * @alias ValidationRulesApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the createValidationRuleAssignment operation.
+     * @callback createValidationRuleAssignmentCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ValidationRulesAssignmentsCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Create Validation Rules Assignments
+     * Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution.
+     * @param {String} validationRuleId Unique validation rule ID.
+     * @param {ValidationRulesAssignmentsCreateRequestBody} validationRulesAssignmentsCreateRequestBody Specify the resource that you would like to assign the validation rule to.
+     * @param {{
+        force?: Boolean,
+     }} [opts] Optional parameters
+     * @param {createValidationRuleAssignmentCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ValidationRulesAssignmentsCreateResponseBody}
+     * @returns {Promise<(ValidationRulesAssignmentsCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ValidationRulesAssignmentsCreateResponseBody` object or with `undefined`.
+     */
+    createValidationRuleAssignment(validationRuleId: string, validationRulesAssignmentsCreateRequestBody: ValidationRulesAssignmentsCreateRequestBody, opts?: {
+        force?: boolean;
+    }, callback?: (error: Error | null, data?: ValidationRulesAssignmentsCreateResponseBody, response?: any) => any): Promise<(ValidationRulesAssignmentsCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the createValidationRules operation.
+     * @callback createValidationRulesCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ValidationRulesCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Create Validation Rules
+     * Create a validation rule.  🚧 Managing validation rules  It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules.
+     * @param {ValidationRulesCreateRequestBody} validationRulesCreateRequestBody Specify the validation rules parameters.
+     * @param {createValidationRulesCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ValidationRulesCreateResponseBody}
+     * @returns {Promise<(ValidationRulesCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ValidationRulesCreateResponseBody` object or with `undefined`.
+     */
+    createValidationRules(validationRulesCreateRequestBody: ValidationRulesCreateRequestBody, callback?: (error: Error | null, data?: ValidationRulesCreateResponseBody, response?: any) => any): Promise<(ValidationRulesCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the deleteValidationRuleAssignment operation.
+     * @callback deleteValidationRuleAssignmentCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param data This operation does not return a value.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Delete Validation Rule Assignment
+     * This method deletes a validation rule assignment.
+     * @param {String} validationRuleId A unique validation rule ID.
+     * @param {String} assignmentId A unique validation rule assignment ID.
+     * @param {deleteValidationRuleAssignmentCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * @returns {Promise<( | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `` object or with `undefined`.
+     */
+    deleteValidationRuleAssignment(validationRuleId: string, assignmentId: string, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+    /**
+     * Callback function to receive the result of the deleteValidationRules operation.
+     * @callback deleteValidationRulesCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param data This operation does not return a value.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Delete Validation Rule
+     * This method deletes a validation rule.
+     * @param {String} validationRuleId A unique validation rule ID.
+     * @param {deleteValidationRulesCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * @returns {Promise<( | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `` object or with `undefined`.
+     */
+    deleteValidationRules(validationRuleId: string, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+    /**
+     * Callback function to receive the result of the getValidationRule operation.
+     * @callback getValidationRuleCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ValidationRulesGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get Validation Rule
+     * Retrieve the details of a validation rule.
+     * @param {String} validationRuleId A unique validation rule ID.
+     * @param {getValidationRuleCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ValidationRulesGetResponseBody}
+     * @returns {Promise<(ValidationRulesGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ValidationRulesGetResponseBody` object or with `undefined`.
+     */
+    getValidationRule(validationRuleId: string, callback?: (error: Error | null, data?: ValidationRulesGetResponseBody, response?: any) => any): Promise<(ValidationRulesGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listValidationRuleAssignments operation.
+     * @callback listValidationRuleAssignmentsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ValidationRulesAssignmentsListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Validation Rule Assignments
+     * Retrieve validation rule assignments for a specific validation rule.
+     * @param {String} validationRuleId Unique validation rule ID.
+     * @param {{
+        limit?: Number,
+        page?: Number,
+        order?: Exclude<keyof typeof ParameterOrderListValidationRuleAssignments, "prototype" | "constructFromObject">,
+     }} [opts] Optional parameters
+     * @param {listValidationRuleAssignmentsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ValidationRulesAssignmentsListResponseBody}
+     * @returns {Promise<(ValidationRulesAssignmentsListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ValidationRulesAssignmentsListResponseBody` object or with `undefined`.
+     */
+    listValidationRuleAssignments(validationRuleId: string, opts?: {
+        limit?: number;
+        page?: number;
+        order?: Exclude<keyof typeof ParameterOrderListValidationRuleAssignments, "prototype" | "constructFromObject">;
+    }, callback?: (error: Error | null, data?: ValidationRulesAssignmentsListResponseBody, response?: any) => any): Promise<(ValidationRulesAssignmentsListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listValidationRules operation.
+     * @callback listValidationRulesCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ValidationRulesListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Validation Rules
+     * Retrieve validation rules.
+     * @param {{
+        limit?: Number,
+        page?: Number,
+        order?: Exclude<keyof typeof ParameterOrderListValidationRules, "prototype" | "constructFromObject">,
+        startDate?: Date,
+        endDate?: Date,
+     }} [opts] Optional parameters
+     * @param {listValidationRulesCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ValidationRulesListResponseBody}
+     * @returns {Promise<(ValidationRulesListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ValidationRulesListResponseBody` object or with `undefined`.
+     */
+    listValidationRules(opts?: {
+        limit?: number;
+        page?: number;
+        order?: Exclude<keyof typeof ParameterOrderListValidationRules, "prototype" | "constructFromObject">;
+        startDate?: Date;
+        endDate?: Date;
+    }, callback?: (error: Error | null, data?: ValidationRulesListResponseBody, response?: any) => any): Promise<(ValidationRulesListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listValidationRulesAssignments operation.
+     * @callback listValidationRulesAssignmentsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ValidationRulesAssignmentsListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Validation Rules' Assignment(s)
+     * List all validation rules assignments or filter the results using the related object ID or the validation rule ID query parameters.
+     * @param {{
+        relatedObjectId?: String,
+        rule?: String,
+        page?: Number,
+        limit?: Number,
+        order?: String,
+     }} [opts] Optional parameters
+     * @param {listValidationRulesAssignmentsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ValidationRulesAssignmentsListResponseBody}
+     * @returns {Promise<(ValidationRulesAssignmentsListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ValidationRulesAssignmentsListResponseBody` object or with `undefined`.
+     */
+    listValidationRulesAssignments(opts?: {
+        relatedObjectId?: string;
+        rule?: string;
+        page?: number;
+        limit?: number;
+        order?: string;
+    }, callback?: (error: Error | null, data?: ValidationRulesAssignmentsListResponseBody, response?: any) => any): Promise<(ValidationRulesAssignmentsListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updateValidationRule operation.
+     * @callback updateValidationRuleCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ValidationRulesUpdateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update Validation Rule
+     * Update validation rule parameters.  🚧 Managing validation rules  It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules.
+     * @param {String} validationRuleId A unique validation rule ID.
+     * @param {ValidationRulesUpdateRequestBody} validationRulesUpdateRequestBody Specify the parameters to be updated.
+     * @param {updateValidationRuleCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ValidationRulesUpdateResponseBody}
+     * @returns {Promise<(ValidationRulesUpdateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ValidationRulesUpdateResponseBody` object or with `undefined`.
+     */
+    updateValidationRule(validationRuleId: string, validationRulesUpdateRequestBody: ValidationRulesUpdateRequestBody, callback?: (error: Error | null, data?: ValidationRulesUpdateResponseBody, response?: any) => any): Promise<(ValidationRulesUpdateResponseBody | undefined)>;
+}
+import ValidationRulesAssignmentsCreateRequestBody from '../model/ValidationRulesAssignmentsCreateRequestBody';
+import ValidationRulesAssignmentsCreateResponseBody from '../model/ValidationRulesAssignmentsCreateResponseBody';
+import ValidationRulesCreateRequestBody from '../model/ValidationRulesCreateRequestBody';
+import ValidationRulesCreateResponseBody from '../model/ValidationRulesCreateResponseBody';
+import ValidationRulesGetResponseBody from '../model/ValidationRulesGetResponseBody';
+import ParameterOrderListValidationRuleAssignments from '../model/ParameterOrderListValidationRuleAssignments';
+import ValidationRulesAssignmentsListResponseBody from '../model/ValidationRulesAssignmentsListResponseBody';
+import ParameterOrderListValidationRules from '../model/ParameterOrderListValidationRules';
+import ValidationRulesListResponseBody from '../model/ValidationRulesListResponseBody';
+import ValidationRulesUpdateRequestBody from '../model/ValidationRulesUpdateRequestBody';
+import ValidationRulesUpdateResponseBody from '../model/ValidationRulesUpdateResponseBody';

package/dist/types/api/ValidationsApi.d.ts

@@ -0,0 +1,34 @@
+/**
+* Validations service.
+* @module api/ValidationsApi
+* @version 3.0.1
+*/
+export default class ValidationsApi {
+    /**
+    * Constructs a new ValidationsApi.
+    * @alias ValidationsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the validateStackedDiscounts operation.
+     * @callback validateStackedDiscountsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ValidationsValidateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Validate Stackable Discounts
+     * Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint.
+     * @param {ValidationsValidateRequestBody} validationsValidateRequestBody
+     * @param {validateStackedDiscountsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ValidationsValidateResponseBody}
+     * @returns {Promise<(ValidationsValidateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ValidationsValidateResponseBody` object or with `undefined`.
+     */
+    validateStackedDiscounts(validationsValidateRequestBody: ValidationsValidateRequestBody, callback?: (error: Error | null, data?: ValidationsValidateResponseBody, response?: any) => any): Promise<(ValidationsValidateResponseBody | undefined)>;
+}
+import ValidationsValidateRequestBody from '../model/ValidationsValidateRequestBody';
+import ValidationsValidateResponseBody from '../model/ValidationsValidateResponseBody';

package/dist/types/api/VouchersApi.d.ts

@@ -0,0 +1,344 @@
+/**
+* Vouchers service.
+* @module api/VouchersApi
+* @version 3.0.1
+*/
+export default class VouchersApi {
+    /**
+    * Constructs a new VouchersApi.
+    * @alias VouchersApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the createVoucher operation.
+     * @callback createVoucherCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Create Voucher
+     * Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In the case of the loyalty card, a campaign name or ID is required. 🚧 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 created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features.
+     * @param {String} code A unique **code** that identifies the voucher.
+     * @param {VouchersCreateWithSpecificCodeRequestBody} vouchersCreateWithSpecificCodeRequestBody Specify the details of the voucher that you would like to create.
+     * @param {createVoucherCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersCreateResponseBody}
+     * @returns {Promise<(VouchersCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersCreateResponseBody` object or with `undefined`.
+     */
+    createVoucher(code: string, vouchersCreateWithSpecificCodeRequestBody: VouchersCreateWithSpecificCodeRequestBody, callback?: (error: Error | null, data?: VouchersCreateResponseBody, response?: any) => any): Promise<(VouchersCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the deleteVoucher operation.
+     * @callback deleteVoucherCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param data This operation does not return a value.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Delete Voucher
+     * Deletes a voucher. This operation cannot be undone. Additionally, this operation removes any redemptions on the voucher. If the force parameter is set to false or not set at all, the voucher will be moved to [the bin](/api-reference/bin/list-bin-entries).
+     * @param {String} code A unique **code** that identifies the voucher.
+     * @param {{
+        force?: Boolean,
+     }} [opts] Optional parameters
+     * @param {deleteVoucherCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * @returns {Promise<( | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `` object or with `undefined`.
+     */
+    deleteVoucher(code: string, opts?: {
+        force?: boolean;
+    }, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+    /**
+     * Callback function to receive the result of the disableVoucher operation.
+     * @callback disableVoucherCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersDisableResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Disable Voucher
+     * There are various times when youll want to manage a vouchers accessibility. This can be done by two API methods for managing the voucher state - *enable* and *disable*.   ___ This method sets the voucher state to **inactive**. The voucher cannot be redeemed.
+     * @param {String} code A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
+     * @param {disableVoucherCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersDisableResponseBody}
+     * @returns {Promise<(VouchersDisableResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersDisableResponseBody` object or with `undefined`.
+     */
+    disableVoucher(code: string, callback?: (error: Error | null, data?: VouchersDisableResponseBody, response?: any) => any): Promise<(VouchersDisableResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the enableVoucher operation.
+     * @callback enableVoucherCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersEnableResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Enable Voucher
+     * There are various times when youll want to manage a vouchers accessibility. This can be done by two API methods for managing the voucher state - *enable* and *disable*.   ___ The method sets the voucher state to **active**. The voucher can be redeemed - only if the redemption occurs after the start date and the voucher is not expired.
+     * @param {String} code A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
+     * @param {enableVoucherCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersEnableResponseBody}
+     * @returns {Promise<(VouchersEnableResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersEnableResponseBody` object or with `undefined`.
+     */
+    enableVoucher(code: string, callback?: (error: Error | null, data?: VouchersEnableResponseBody, response?: any) => any): Promise<(VouchersEnableResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the exportVoucherTransactions operation.
+     * @callback exportVoucherTransactionsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersTransactionsExportCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Export Voucher Transactions
+     * Export transactions that are associated with credit movements on a gift card or loyalty card.
+     * @param {String} code A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
+     * @param {VouchersTransactionsExportCreateRequestBody} vouchersTransactionsExportCreateRequestBody Specify the parameters for the camapign transaction export.
+     * @param {exportVoucherTransactionsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersTransactionsExportCreateResponseBody}
+     * @returns {Promise<(VouchersTransactionsExportCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersTransactionsExportCreateResponseBody` object or with `undefined`.
+     */
+    exportVoucherTransactions(code: string, vouchersTransactionsExportCreateRequestBody: VouchersTransactionsExportCreateRequestBody, callback?: (error: Error | null, data?: VouchersTransactionsExportCreateResponseBody, response?: any) => any): Promise<(VouchersTransactionsExportCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the generateRandomCode operation.
+     * @callback generateRandomCodeCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Generate Random Code
+     * Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD.  When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 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 created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features.
+     * @param {VouchersCreateRequestBody} vouchersCreateRequestBody Specify the details of the voucher that you would like to create.
+     * @param {generateRandomCodeCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersCreateResponseBody}
+     * @returns {Promise<(VouchersCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersCreateResponseBody` object or with `undefined`.
+     */
+    generateRandomCode(vouchersCreateRequestBody: VouchersCreateRequestBody, callback?: (error: Error | null, data?: VouchersCreateResponseBody, response?: any) => any): Promise<(VouchersCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the getVoucher operation.
+     * @callback getVoucherCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get Voucher
+     * Retrieves the voucher with the given code or unique Voucherify ID. You can either pass the voucher ID which was assigned by Voucherify, e.g., v_7HxHkf4VAkMuc8u4lZs78lyRwhRze5UE, or the code of the voucher as the path parameter value, e.g., 7fjWdr.
+     * @param {String} code A unique **code** that identifies the voucher.
+     * @param {getVoucherCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersGetResponseBody}
+     * @returns {Promise<(VouchersGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersGetResponseBody` object or with `undefined`.
+     */
+    getVoucher(code: string, callback?: (error: Error | null, data?: VouchersGetResponseBody, response?: any) => any): Promise<(VouchersGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the importVouchers operation.
+     * @callback importVouchersCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersImportCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * 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.
+     * @param {Array.<VouchersImportCreateItemRequestBody>} vouchersImportCreateItemRequestBody The request body is an array of objects. Each object contains details about a specific voucher.
+     * @param {importVouchersCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersImportCreateResponseBody}
+     * @returns {Promise<(VouchersImportCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersImportCreateResponseBody` object or with `undefined`.
+     */
+    importVouchers(vouchersImportCreateItemRequestBody: Array<VouchersImportCreateItemRequestBody>, callback?: (error: Error | null, data?: VouchersImportCreateResponseBody, response?: any) => any): Promise<(VouchersImportCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the importVouchersUsingCsv operation.
+     * @callback importVouchersUsingCsvCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersImportCsvCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * 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.
+     * @param {{
+        file?: File,
+        webhooksEnable?: Boolean,
+     }} [opts] Optional parameters
+     * @param {importVouchersUsingCsvCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersImportCsvCreateResponseBody}
+     * @returns {Promise<(VouchersImportCsvCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersImportCsvCreateResponseBody` object or with `undefined`.
+     */
+    importVouchersUsingCsv(opts?: {
+        file?: File;
+        webhooksEnable?: boolean;
+    }, callback?: (error: Error | null, data?: VouchersImportCsvCreateResponseBody, response?: any) => any): Promise<(VouchersImportCsvCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listVoucherTransactions operation.
+     * @callback listVoucherTransactionsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersTransactionsListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Voucher Transactions
+     * List transactions that are associated with credit movements on a gift card or loyalty card.
+     * @param {String} code A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
+     * @param {{
+        limit?: Number,
+        order?: Exclude<keyof typeof ParameterOrderListTransactions, "prototype" | "constructFromObject">,
+        startingAfterId?: String,
+     }} [opts] Optional parameters
+     * @param {listVoucherTransactionsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersTransactionsListResponseBody}
+     * @returns {Promise<(VouchersTransactionsListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersTransactionsListResponseBody` object or with `undefined`.
+     */
+    listVoucherTransactions(code: string, opts?: {
+        limit?: number;
+        order?: Exclude<keyof typeof ParameterOrderListTransactions, "prototype" | "constructFromObject">;
+        startingAfterId?: string;
+    }, callback?: (error: Error | null, data?: VouchersTransactionsListResponseBody, response?: any) => any): Promise<(VouchersTransactionsListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listVouchers operation.
+     * @callback listVouchersCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Vouchers
+     * Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers.
+     * @param {{
+        limit?: Number,
+        page?: Number,
+        category?: String,
+        campaignId?: String,
+        customer?: String,
+        campaign?: String,
+        createdAt?: ParameterCreatedBeforeAfter,
+        updatedAt?: ParameterUpdatedBeforeAfter,
+        order?: Exclude<keyof typeof ParameterOrderVouchers, "prototype" | "constructFromObject">,
+        code?: String,
+        ids?: Array.<String>,
+     }} [opts] Optional parameters
+     * @param {listVouchersCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersListResponseBody}
+     * @returns {Promise<(VouchersListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersListResponseBody` object or with `undefined`.
+     */
+    listVouchers(opts?: {
+        limit?: number;
+        page?: number;
+        category?: string;
+        campaignId?: string;
+        customer?: string;
+        campaign?: string;
+        createdAt?: ParameterCreatedBeforeAfter;
+        updatedAt?: ParameterUpdatedBeforeAfter;
+        order?: Exclude<keyof typeof ParameterOrderVouchers, "prototype" | "constructFromObject">;
+        code?: string;
+        ids?: Array<string>;
+    }, callback?: (error: Error | null, data?: VouchersListResponseBody, response?: any) => any): Promise<(VouchersListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the releaseValidationSession operation.
+     * @callback releaseValidationSessionCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param data This operation does not return a value.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Release Validation Session
+     * Manually release a validation session that has been set up for the voucher. This method undoes the actions that are explained in the [Locking validation session](/guides/locking-validation-session) guide.   📘 Release session in the Dashboard  You can also use the [Validations Manager](https://support.voucherify.io/article/16-dashboard-sections#sessions) in the Dashboard to unlock sessions.
+     * @param {String} code A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify.
+     * @param {String} sessionKey A unique session identifier.
+     * @param {releaseValidationSessionCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * @returns {Promise<( | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `` object or with `undefined`.
+     */
+    releaseValidationSession(code: string, sessionKey: string, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+    /**
+     * Callback function to receive the result of the updateVoucher operation.
+     * @callback updateVoucherCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersUpdateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update Voucher
+     * Updates the specified voucher by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body wont be modified. Even if provided, they will be silently skipped. If you want to change the amount on a gift card or the number of points on a loyalty card, use the [Adjust voucher balance](/api-reference/vouchers/adjust-voucher-balance) endpoint.
+     * @param {String} code A unique **code** that identifies the voucher.
+     * @param {VouchersUpdateRequestBody} vouchersUpdateRequestBody Specify the parameters to be updated.
+     * @param {updateVoucherCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersUpdateResponseBody}
+     * @returns {Promise<(VouchersUpdateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersUpdateResponseBody` object or with `undefined`.
+     */
+    updateVoucher(code: string, vouchersUpdateRequestBody: VouchersUpdateRequestBody, callback?: (error: Error | null, data?: VouchersUpdateResponseBody, response?: any) => any): Promise<(VouchersUpdateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updateVoucherBalance operation.
+     * @callback updateVoucherBalanceCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersBalanceUpdateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Adjust Voucher Balance
+     * Add balance to an existing gift card or loyalty card. For loyalty cards, it must be assigned to a holder.
+     * @param {String} code A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
+     * @param {VouchersBalanceUpdateRequestBody} vouchersBalanceUpdateRequestBody Provide the amount to be added to/subtracted from the voucher.
+     * @param {updateVoucherBalanceCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersBalanceUpdateResponseBody}
+     * @returns {Promise<(VouchersBalanceUpdateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersBalanceUpdateResponseBody` object or with `undefined`.
+     */
+    updateVoucherBalance(code: string, vouchersBalanceUpdateRequestBody: VouchersBalanceUpdateRequestBody, callback?: (error: Error | null, data?: VouchersBalanceUpdateResponseBody, response?: any) => any): Promise<(VouchersBalanceUpdateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updateVouchersInBulk operation.
+     * @callback updateVouchersInBulkCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersUpdateInBulkResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update Vouchers in Bulk
+     * Updates specific metadata parameters for each code, respectively, in one asynchronous operation. The request can include up to **10 MB** of data. Upserts are not supported.  🚧 Currently, only **metadata** updates are supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
+     * @param {Array.<VouchersUpdateInBulkItemRequestBody>} vouchersUpdateInBulkItemRequestBody List the codes to be updated with the metadata key/value pairs for that code.
+     * @param {updateVouchersInBulkCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersUpdateInBulkResponseBody}
+     * @returns {Promise<(VouchersUpdateInBulkResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersUpdateInBulkResponseBody` object or with `undefined`.
+     */
+    updateVouchersInBulk(vouchersUpdateInBulkItemRequestBody: Array<VouchersUpdateInBulkItemRequestBody>, callback?: (error: Error | null, data?: VouchersUpdateInBulkResponseBody, response?: any) => any): Promise<(VouchersUpdateInBulkResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the updateVouchersMetadataInBulk operation.
+     * @callback updateVouchersMetadataInBulkCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersMetadataUpdateInBulkResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Update Vouchers' Metadata in Bulk
+     * Updates metadata parameters for a list of codes. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. Upserts are not supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
+     * @param {VouchersMetadataUpdateInBulkRequestBody} vouchersMetadataUpdateInBulkRequestBody List the codes of the vouchers you would like to update with the metadata key/value pairs.
+     * @param {updateVouchersMetadataInBulkCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersMetadataUpdateInBulkResponseBody}
+     * @returns {Promise<(VouchersMetadataUpdateInBulkResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersMetadataUpdateInBulkResponseBody` object or with `undefined`.
+     */
+    updateVouchersMetadataInBulk(vouchersMetadataUpdateInBulkRequestBody: VouchersMetadataUpdateInBulkRequestBody, callback?: (error: Error | null, data?: VouchersMetadataUpdateInBulkResponseBody, response?: any) => any): Promise<(VouchersMetadataUpdateInBulkResponseBody | undefined)>;
+}
+import VouchersCreateWithSpecificCodeRequestBody from '../model/VouchersCreateWithSpecificCodeRequestBody';
+import VouchersCreateResponseBody from '../model/VouchersCreateResponseBody';
+import VouchersDisableResponseBody from '../model/VouchersDisableResponseBody';
+import VouchersEnableResponseBody from '../model/VouchersEnableResponseBody';
+import VouchersTransactionsExportCreateRequestBody from '../model/VouchersTransactionsExportCreateRequestBody';
+import VouchersTransactionsExportCreateResponseBody from '../model/VouchersTransactionsExportCreateResponseBody';
+import VouchersCreateRequestBody from '../model/VouchersCreateRequestBody';
+import VouchersGetResponseBody from '../model/VouchersGetResponseBody';
+import VouchersImportCreateItemRequestBody from '../model/VouchersImportCreateItemRequestBody';
+import VouchersImportCreateResponseBody from '../model/VouchersImportCreateResponseBody';
+import VouchersImportCsvCreateResponseBody from '../model/VouchersImportCsvCreateResponseBody';
+import ParameterOrderListTransactions from '../model/ParameterOrderListTransactions';
+import VouchersTransactionsListResponseBody from '../model/VouchersTransactionsListResponseBody';
+import ParameterCreatedBeforeAfter from '../model/ParameterCreatedBeforeAfter';
+import ParameterUpdatedBeforeAfter from '../model/ParameterUpdatedBeforeAfter';
+import ParameterOrderVouchers from '../model/ParameterOrderVouchers';
+import VouchersListResponseBody from '../model/VouchersListResponseBody';
+import VouchersUpdateRequestBody from '../model/VouchersUpdateRequestBody';
+import VouchersUpdateResponseBody from '../model/VouchersUpdateResponseBody';
+import VouchersBalanceUpdateRequestBody from '../model/VouchersBalanceUpdateRequestBody';
+import VouchersBalanceUpdateResponseBody from '../model/VouchersBalanceUpdateResponseBody';
+import VouchersUpdateInBulkItemRequestBody from '../model/VouchersUpdateInBulkItemRequestBody';
+import VouchersUpdateInBulkResponseBody from '../model/VouchersUpdateInBulkResponseBody';
+import VouchersMetadataUpdateInBulkRequestBody from '../model/VouchersMetadataUpdateInBulkRequestBody';
+import VouchersMetadataUpdateInBulkResponseBody from '../model/VouchersMetadataUpdateInBulkResponseBody';