@voucherify/sdk 2.9.2 → 2.9.4

package/dist/Segments.d.ts

@@ -1,22 +1,25 @@
-import * as T from './types/Segments';
-import type { RequestController } from './RequestController';
-export declare class Segments {
-    private client;
-    constructor(client: RequestController);
-    /**
-     * @see https://docs.voucherify.io/reference/create-segment
-     */
-    create(segment: T.SegmentsCreate): Promise<T.SegmentsCreateResponse>;
-    /**
-     * @see https://docs.voucherify.io/reference/get-segment
-     */
-    get(segmentId: string): Promise<T.SegmentsCreateResponse>;
-    /**
-     * @see https://docs.voucherify.io/reference/delete-segment
-     */
-    delete(segmentId: string): Promise<unknown>;
-    /**
-     * @see https://docs.voucherify.io/reference/list-segments
-     */
-    list(customerId: string): Promise<T.SegmentsListResponse>;
-}
+import { SegmentsCreate, SegmentsCreateResponse, SegmentsListResponse } from './types/Segments.js';
+import { RequestController } from './RequestController.js';
+
+declare class Segments {
+    private client;
+    constructor(client: RequestController);
+    /**
+     * @see https://docs.voucherify.io/reference/create-segment
+     */
+    create(segment: SegmentsCreate): Promise<SegmentsCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-segment
+     */
+    get(segmentId: string): Promise<SegmentsCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/delete-segment
+     */
+    delete(segmentId: string): Promise<unknown>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-segments
+     */
+    list(customerId: string): Promise<SegmentsListResponse>;
+}
+
+export { Segments };

package/dist/ValidationRules.d.ts

@@ -1,43 +1,47 @@
-import * as T from './types/ValidationRules';
-import type { RequestController } from './RequestController';
-export declare class ValidationRules {
-    private client;
-    constructor(client: RequestController);
-    /**
-     * @see https://docs.voucherify.io/reference/create-validation-rules
-     */
-    create(validationRule: T.ValidationRulesCreate): Promise<T.ValidationRulesCreateResponse>;
-    /**
-     * @see https://docs.voucherify.io/reference/get-validation-rules
-     */
-    get(validationRuleId: string): Promise<T.ValidationRulesGetResponse>;
-    /**
-     * @see https://docs.voucherify.io/reference/update-validation-rules
-     */
-    update(validationRule: T.ValidationRulesUpdate): Promise<T.ValidationRulesCreateResponse>;
-    /**
-     * @see https://docs.voucherify.io/reference/delete-validation-rules
-     */
-    delete(validationRuleId: string): Promise<unknown>;
-    /**
-     * @see https://docs.voucherify.io/reference/create-validation-rules-assignment
-     */
-    createAssignment(validationRuleId: string, assignment: T.ValidationRulesCreateAssignment): Promise<T.ValidationRulesCreateAssignmentResponse>;
-    /**
-     * @see https://docs.voucherify.io/reference/delete-validation-rules-assignment
-     */
-    deleteAssignment(validationRuleId: string, assignmentId: string): Promise<unknown>;
-    validate(validationRuleId: string, params?: any): Promise<T.ValidationRulesValidateResponse>;
-    /**
-     * @see https://docs.voucherify.io/reference/list-validation-rules
-     */
-    list(params?: T.ValidationRulesListParams): Promise<T.ValidationRulesListResponse>;
-    /**
-     * @see https://docs.voucherify.io/reference/list-validation-rules-assignments
-     */
-    listRulesAssignments(params?: T.ValidationRulesListRulesAssignmentsRequestQuery): Promise<T.ValidationRulesListRulesAssignmentsResponseBody>;
-    /**
-     * @see https://docs.voucherify.io/reference/list-validation-rule-assignments
-     */
-    listAssignments(validationRuleId: string, params?: T.ValidationRulesListAssignmentsParams): Promise<T.ValidationRulesListAssignmentsResponse>;
-}
+import { ValidationRulesCreate, ValidationRulesCreateResponse, ValidationRulesGetResponse, ValidationRulesUpdate, ValidationRulesCreateAssignment, ValidationRulesCreateAssignmentResponse, ValidationRulesValidateResponse, ValidationRulesListParams, ValidationRulesListResponse, ValidationRulesListRulesAssignmentsRequestQuery, ValidationRulesListRulesAssignmentsResponseBody, ValidationRulesListAssignmentsParams, ValidationRulesListAssignmentsResponse } from './types/ValidationRules.js';
+import { RequestController } from './RequestController.js';
+import './types/ApplicableTo.js';
+
+declare class ValidationRules {
+    private client;
+    constructor(client: RequestController);
+    /**
+     * @see https://docs.voucherify.io/reference/create-validation-rules
+     */
+    create(validationRule: ValidationRulesCreate): Promise<ValidationRulesCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-validation-rules
+     */
+    get(validationRuleId: string): Promise<ValidationRulesGetResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/update-validation-rules
+     */
+    update(validationRule: ValidationRulesUpdate): Promise<ValidationRulesCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/delete-validation-rules
+     */
+    delete(validationRuleId: string): Promise<unknown>;
+    /**
+     * @see https://docs.voucherify.io/reference/create-validation-rules-assignment
+     */
+    createAssignment(validationRuleId: string, assignment: ValidationRulesCreateAssignment): Promise<ValidationRulesCreateAssignmentResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/delete-validation-rules-assignment
+     */
+    deleteAssignment(validationRuleId: string, assignmentId: string): Promise<unknown>;
+    validate(validationRuleId: string, params?: any): Promise<ValidationRulesValidateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-validation-rules
+     */
+    list(params?: ValidationRulesListParams): Promise<ValidationRulesListResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-validation-rules-assignments
+     */
+    listRulesAssignments(params?: ValidationRulesListRulesAssignmentsRequestQuery): Promise<ValidationRulesListRulesAssignmentsResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-validation-rule-assignments
+     */
+    listAssignments(validationRuleId: string, params?: ValidationRulesListAssignmentsParams): Promise<ValidationRulesListAssignmentsResponse>;
+}
+
+export { ValidationRules };

package/dist/Validations.d.ts

@@ -1,17 +1,39 @@
-import * as T from './types/Validations';
-import type { RequestController } from './RequestController';
-import type { Promotions } from './Promotions';
-export declare class Validations {
-    private client;
-    private promotions;
-    constructor(client: RequestController, promotions: Promotions);
-    /**
-     * @see https://docs.voucherify.io/reference/validate-voucher
-     */
-    validateVoucher(code: string, params?: T.ValidationsValidateVoucherParams): Promise<T.ValidationsValidateVoucherResponse>;
-    validate(code: string | T.ValidationsValidateCode, context?: T.ValidationsValidateContext): Promise<T.ValidationsValidateVoucherResponse> | Promise<import("./types").PromotionsValidateResponse>;
-    /**
-     * @see https://docs.voucherify.io/reference/validate-stacked-discounts-1
-     */
-    validateStackable(params: T.ValidationsValidateStackableParams): Promise<T.ValidationValidateStackableResponse>;
-}
+import { ValidationsValidateVoucherParams, ValidationsValidateVoucherResponse, ValidationsValidateCode, ValidationsValidateContext, ValidationsValidateStackableParams, ValidationValidateStackableResponse } from './types/Validations.js';
+import { PromotionsValidateResponse } from './types/Promotions.js';
+import { RequestController } from './RequestController.js';
+import { Promotions } from './Promotions.js';
+import './types/DiscountVoucher.js';
+import './types/Customers.js';
+import './types/Stackable.js';
+import './types/Rewards.js';
+import './types/Gift.js';
+import './types/Orders.js';
+import './types/ApplicableTo.js';
+import './types/Products.js';
+import './types/Loyalties.js';
+import './types/ValidationRules.js';
+import './types/Vouchers.js';
+import './types/Categories.js';
+import './types/ValidationError.js';
+import './types/ValidateSession.js';
+import './types/PromotionTiers.js';
+import './PromotionTiers.js';
+import './PromotionsStacks.js';
+import './types/PromotionsStacks.js';
+
+declare class Validations {
+    private client;
+    private promotions;
+    constructor(client: RequestController, promotions: Promotions);
+    /**
+     * @see https://docs.voucherify.io/reference/validate-voucher
+     */
+    validateVoucher(code: string, params?: ValidationsValidateVoucherParams): Promise<ValidationsValidateVoucherResponse>;
+    validate(code: string | ValidationsValidateCode, context?: ValidationsValidateContext): Promise<PromotionsValidateResponse> | Promise<ValidationsValidateVoucherResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/validate-stacked-discounts-1
+     */
+    validateStackable(params: ValidationsValidateStackableParams): Promise<ValidationValidateStackableResponse>;
+}
+
+export { Validations };

package/dist/VoucherifyClientSide.d.ts

@@ -1,86 +1,112 @@
-import { ClientSide } from './ClientSide';
-export type { ClientSide };
-export interface VoucherifyClientSideOptions {
-    /**
-     * Optionally, you can add `apiUrl` to the client options if you want to use Voucherify running in a specific region.
-     *
-     * ```javascript
-     * const client = VoucherifyClientSide({
-     *		clientApplicationId: 'YOUR-CLIENT-APPLICATION-ID',
-     *		clientSecretKey: 'YOUR-CLIENT-SECRET-KEY',
-     *		apiUrl: 'https://<region>.api.voucherify.io'
-     * })
-     * ```
-     */
-    apiUrl?: string;
-    /**
-     * [Log-in](https://app.voucherify.io/#/login) to Voucherify web interface and obtain your `Client-side Keys` from [Configuration](https://app.voucherify.io/#/app/core/projects/current/general):
-     *
-     * ```javascript
-     * const client = VoucherifyClientSide({
-     *		clientApplicationId: 'YOUR-CLIENT-APPLICATION-ID',
-     *		clientSecretKey: 'YOUR-CLIENT-SECRET-KEY'
-     * })
-     * ```
-     */
-    clientApplicationId: string;
-    /**
-     * [Log-in](https://app.voucherify.io/#/login) to Voucherify web interface and obtain your `Client-side Keys` from [Configuration](https://app.voucherify.io/#/app/core/projects/current/general):
-     *
-     * ```javascript
-     * const client = VoucherifyClientSide({
-     *		clientApplicationId: 'YOUR-CLIENT-APPLICATION-ID',
-     *		clientSecretKey: 'YOUR-CLIENT-SECRET-KEY'
-     * })
-     * ```
-     */
-    clientSecretKey: string;
-    /**
-     * Set customer identity when using React Widget. In other situations, use `setIdentity` method:
-     *
-     * ```javascript
-     * client.setIdentity('gustav@purpleson.com')
-     * ```
-     */
-    trackingId?: string;
-    /**
-     * **(Required in Node.js)** Set the origin from where the requests are made.
-     *
-     * ```javascript
-     * const client = VoucherifyClientSide({
-     *		clientApplicationId: 'YOUR-CLIENT-APPLICATION-ID',
-     *		clientSecretKey: 'YOUR-CLIENT-SECRET-KEY',
-     *		origin: 'your-domain.com'
-     * })
-     * ```
-     *
-     * @note in the browser, this option will be ignored. The `origin` header is a [forbidden header name](https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_header_name) and it'll be automatically set by the browser for every request.
-     */
-    origin?: string;
-    /**
-     * You can pass additional headers to requests made by the API Client.
-     * It can prove to be useful when debugging various scenarios.
-     * ```javascript
-     * const voucherify = VoucherifyServerSide({
-     *		clientApplicationId: 'YOUR-CLIENT-APPLICATION-ID',
-     *		clientSecretKey: 'YOUR-CLIENT-SECRET-KEY',
-     *		customHeaders: {
-     *			"DEBUG-HEADER": "my_value",
-     *			"TEST-HEADER": "another_value"
-     *		}
-     * })
-     * ```
-     */
-    customHeaders?: Record<string, string>;
-    /**
-     * If you wish to include original Axios error in VoucherifyError instance set this to true
-     * It can prove to be useful when debugging various scenarios.
-     * The original Axios error will be included in cause property of VoucherifyError
-     */
-    exposeErrorCause?: boolean;
-    /**
-     * Optionally, you can set timeout in miliseconds. After this time request will be aborted. By default Voucherify's API has timeout value of 3 minutes.
-     */
-    timeoutMs?: number;
-}
-export declare function VoucherifyClientSide(options: VoucherifyClientSideOptions): ClientSide;
+import { ClientSide } from './ClientSide.js';
+import './types/Customers.js';
+import './types/DiscountVoucher.js';
+import './types/ClientSide.js';
+import './types/Vouchers.js';
+import './types/Orders.js';
+import './types/Consents.js';
+import './types/Distributions.js';
+import './types/PromotionTiers.js';
+import './types/ValidationRules.js';
+import './types/ApplicableTo.js';
+import './types/ValidateSession.js';
+import './types/Validations.js';
+import './types/Stackable.js';
+import './types/Rewards.js';
+import './types/Gift.js';
+import './types/Products.js';
+import './types/Loyalties.js';
+import './types/Categories.js';
+import './types/ValidationError.js';
+import './types/Promotions.js';
+import './types/Redemptions.js';
+import './types/Qualifications.js';
+import './types/Exports.js';
+import './RequestController.js';
+
+interface VoucherifyClientSideOptions {
+    /**
+     * Optionally, you can add `apiUrl` to the client options if you want to use Voucherify running in a specific region.
+     *
+     * ```javascript
+     * const client = VoucherifyClientSide({
+     *		clientApplicationId: 'YOUR-CLIENT-APPLICATION-ID',
+     *		clientSecretKey: 'YOUR-CLIENT-SECRET-KEY',
+     *		apiUrl: 'https://<region>.api.voucherify.io'
+     * })
+     * ```
+     */
+    apiUrl?: string;
+    /**
+     * [Log-in](https://app.voucherify.io/#/login) to Voucherify web interface and obtain your `Client-side Keys` from [Configuration](https://app.voucherify.io/#/app/core/projects/current/general):
+     *
+     * ```javascript
+     * const client = VoucherifyClientSide({
+     *		clientApplicationId: 'YOUR-CLIENT-APPLICATION-ID',
+     *		clientSecretKey: 'YOUR-CLIENT-SECRET-KEY'
+     * })
+     * ```
+     */
+    clientApplicationId: string;
+    /**
+     * [Log-in](https://app.voucherify.io/#/login) to Voucherify web interface and obtain your `Client-side Keys` from [Configuration](https://app.voucherify.io/#/app/core/projects/current/general):
+     *
+     * ```javascript
+     * const client = VoucherifyClientSide({
+     *		clientApplicationId: 'YOUR-CLIENT-APPLICATION-ID',
+     *		clientSecretKey: 'YOUR-CLIENT-SECRET-KEY'
+     * })
+     * ```
+     */
+    clientSecretKey: string;
+    /**
+     * Set customer identity when using React Widget. In other situations, use `setIdentity` method:
+     *
+     * ```javascript
+     * client.setIdentity('gustav@purpleson.com')
+     * ```
+     */
+    trackingId?: string;
+    /**
+     * **(Required in Node.js)** Set the origin from where the requests are made.
+     *
+     * ```javascript
+     * const client = VoucherifyClientSide({
+     *		clientApplicationId: 'YOUR-CLIENT-APPLICATION-ID',
+     *		clientSecretKey: 'YOUR-CLIENT-SECRET-KEY',
+     *		origin: 'your-domain.com'
+     * })
+     * ```
+     *
+     * @note in the browser, this option will be ignored. The `origin` header is a [forbidden header name](https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_header_name) and it'll be automatically set by the browser for every request.
+     */
+    origin?: string;
+    /**
+     * You can pass additional headers to requests made by the API Client.
+     * It can prove to be useful when debugging various scenarios.
+     * ```javascript
+     * const voucherify = VoucherifyServerSide({
+     *		clientApplicationId: 'YOUR-CLIENT-APPLICATION-ID',
+     *		clientSecretKey: 'YOUR-CLIENT-SECRET-KEY',
+     *		customHeaders: {
+     *			"DEBUG-HEADER": "my_value",
+     *			"TEST-HEADER": "another_value"
+     *		}
+     * })
+     * ```
+     */
+    customHeaders?: Record<string, string>;
+    /**
+     * If you wish to include original Axios error in VoucherifyError instance set this to true
+     * It can prove to be useful when debugging various scenarios.
+     * The original Axios error will be included in cause property of VoucherifyError
+     */
+    exposeErrorCause?: boolean;
+    /**
+     * Optionally, you can set timeout in miliseconds. After this time request will be aborted. By default Voucherify's API has timeout value of 3 minutes.
+     */
+    timeoutMs?: number;
+}
+declare function VoucherifyClientSide(options: VoucherifyClientSideOptions): ClientSide;
+
+export { ClientSide, VoucherifyClientSide, type VoucherifyClientSideOptions };

package/dist/VoucherifyError.d.ts

@@ -1,20 +1,23 @@
-import { AxiosError } from 'axios';
-/**
- * @internal
- */
-export declare class VoucherifyError extends Error {
-    code: number;
-    key: string;
-    details?: string;
-    request_id?: string;
-    resource_id?: string;
-    resource_type?: string;
-    related_object_ids?: string[];
-    related_object_type?: string;
-    related_object_total?: number;
-    error?: {
-        message: string;
-    };
-    cause?: AxiosError;
-    constructor(statusCode: number, body?: unknown, axiosError?: AxiosError);
-}
+import { AxiosError } from 'axios';
+
+/**
+ * @internal
+ */
+declare class VoucherifyError extends Error {
+    code: number;
+    key: string;
+    details?: string;
+    request_id?: string;
+    resource_id?: string;
+    resource_type?: string;
+    related_object_ids?: string[];
+    related_object_type?: string;
+    related_object_total?: number;
+    error?: {
+        message: string;
+    };
+    cause?: AxiosError;
+    constructor(statusCode: number, body?: unknown, axiosError?: AxiosError);
+}
+
+export { VoucherifyError };