oneentry 1.0.144 → 1.0.146

package/dist/discounts/discountsApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { BonusTransactionType, IBonusTransactionEntity, ICouponValidationResult, IDiscountsApi, IDiscountsEntity, IDiscountsResponse } from './discountsInterfaces';
+import type { IBonusBalanceEntity, IBonusTransactionEntity, IBonusTransactionType, ICouponValidationResult, IDiscountsApi, IDiscountsEntity, IDiscountsResponse, IDiscountType } from './discountsInterfaces';
 /**
  * Controllers for working with events
  * @handle /api/content/events
@@ -28,12 +28,12 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @param {string} [type] - Optional parameter to filter discounts by type.
+     * @param {IDiscountType} [type] - Optional parameter to filter discounts by type.
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
      */
-    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT'): Promise<IDiscountsResponse | IError>;
+    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: IDiscountType): Promise<IDiscountsResponse | IError>;
     /**
      * Get discount by marker
      * @handleName getDiscountByMarker
@@ -47,14 +47,14 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
     /**
      * Get bonus balance of the current user.
      * @handleName getBonusBalance
-     * @returns {Promise<IDiscountsEntity | IError>} Returns bonus balance or an error object.
+     * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getBonusBalance(): Promise<IDiscountsEntity | IError>;
+    getBonusBalance(): Promise<IBonusBalanceEntity | IError>;
     /**
      * Get bonus transaction history of the current user.
      * @handleName getBonusHistory
-     * @param {BonusTransactionType} [type] - Transaction type filter.
+     * @param {IBonusTransactionType} [type] - Transaction type filter.
      * @param {string} [dateFrom] - Start date filter.
      * @param {string} [dateTo] - End date filter.
      * @param {number} [discountId] - Discount id filter.
@@ -63,7 +63,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @returns {Promise<IBonusTransactionEntity[] | IError>} Returns array of bonus transactions or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getBonusHistory(type?: BonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
+    getBonusHistory(type?: IBonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
     /**
      * Validate discounts coupon
      * @handleName validateDiscountsCoupon

package/dist/discounts/discountsApi.js

@@ -31,7 +31,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @param {string} [type] - Optional parameter to filter discounts by type.
+     * @param {IDiscountType} [type] - Optional parameter to filter discounts by type.
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
@@ -66,7 +66,7 @@ class DiscountsApi extends asyncModules_1.default {
     /**
      * Get bonus balance of the current user.
      * @handleName getBonusBalance
-     * @returns {Promise<IDiscountsEntity | IError>} Returns bonus balance or an error object.
+     * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async getBonusBalance() {
@@ -76,7 +76,7 @@ class DiscountsApi extends asyncModules_1.default {
     /**
      * Get bonus transaction history of the current user.
      * @handleName getBonusHistory
-     * @param {BonusTransactionType} [type] - Transaction type filter.
+     * @param {IBonusTransactionType} [type] - Transaction type filter.
      * @param {string} [dateFrom] - Start date filter.
      * @param {string} [dateTo] - End date filter.
      * @param {number} [discountId] - Discount id filter.

package/dist/discounts/discountsInterfaces.d.ts

@@ -1,4 +1,8 @@
 import type { IError } from '../base/utils';
+/**
+ * Discount type.
+ */
+type IDiscountType = 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT';
 /**
  * Interface for the Discounts API module.
  * @interface IDiscountsApi
@@ -10,12 +14,12 @@ interface IDiscountsApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @param {string} [type] - Optional parameter to filter discounts by type.
+     * @param {IDiscountType} [type] - Optional parameter to filter discounts by type.
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
      */
-    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT'): Promise<IDiscountsResponse | IError>;
+    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: IDiscountType): Promise<IDiscountsResponse | IError>;
     /**
      * Get discount by marker
      * @handleName getDiscountByMarker
@@ -38,10 +42,10 @@ interface IDiscountsApi {
     /**
      * Get bonus balance of the current user.
      * @handleName getBonusBalance
-     * @returns {Promise<IDiscountsEntity | IError>} Returns bonus balance or an error object.
+     * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getBonusBalance(): Promise<IDiscountsEntity | IError>;
+    getBonusBalance(): Promise<IBonusBalanceEntity | IError>;
     /**
      * Get bonus transaction history of the current user.
      * @handleName getBonusHistory
@@ -54,18 +58,18 @@ interface IDiscountsApi {
      * @returns {Promise<IBonusTransactionEntity[] | IError>} Returns array of bonus transactions or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getBonusHistory(type?: BonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
+    getBonusHistory(type?: IBonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
 }
 /**
  * Query parameters for fetching discounts.
  * @interface IDiscountsQuery
- * @property {'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT'} [type] - Filter discounts by type.
+ * @property {IDiscountType} [type] - Filter discounts by type.
  * @property {string} langCode - The language code for localization. Example: "en_US".
  * @property {number} [offset] - Offset for pagination. Default: 0.
  * @property {number} [limit] - Limit for pagination. Default: 30.
  */
 interface IDiscountsQuery {
-    type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT';
+    type?: IDiscountType;
     langCode: string;
     offset?: number;
     limit?: number;
@@ -88,7 +92,7 @@ interface IDiscountCondition {
  * @property {object} [localizeInfos] - The name of the discount.
  * @property {number} [version] - The version of the discount.
  * @property {string} [identifier] - The identifier of the discount.
- * @property {string} [type] - The type of the discount.
+ * @property {IDiscountType} type - The type of the discount.
  * @property {string} [startDate] - The start date of the discount.
  * @property {string} [endDate] - The end date of the discount.
  * @property {Record<string, unknown>} [discountValue] - The value of the discount.
@@ -102,6 +106,8 @@ interface IDiscountCondition {
  * @property {object} [attributeValues] - The attribute values of the discount.
  * @property {string} [attributeSetIdentifier] - The identifier of the attribute set.
  * @property {Record<string, unknown>} [bonusEvent] - Bonus event configuration.
+ * @property {number} [position] - Position number for sorting. Example: 1.
+ * @property {number | string} [total] - Total count of related entries. Example: "1".
  */
 interface IDiscountsEntity {
     id: number;
@@ -109,7 +115,7 @@ interface IDiscountsEntity {
     localizeInfos?: object;
     version?: number;
     identifier?: string;
-    type: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT';
+    type: IDiscountType;
     startDate?: string;
     endDate?: string;
     discountValue?: Record<string, unknown>;
@@ -123,6 +129,8 @@ interface IDiscountsEntity {
     attributeValues?: object;
     attributeSetIdentifier?: string;
     bonusEvent?: Record<string, unknown>;
+    position?: number;
+    total?: number | string;
 }
 /**
  * Paginated response for discounts list.
@@ -167,10 +175,10 @@ interface IDiscountByMarkerQuery {
 /**
  *
  */
-type BonusTransactionType = 'ACCRUAL' | 'USAGE' | 'REDUCE' | 'REVERSAL_ACCRUAL' | 'REVERSAL_USAGE' | 'EXPIRATION';
+type IBonusTransactionType = 'ACCRUAL' | 'USAGE' | 'REDUCE' | 'REVERSAL_ACCRUAL' | 'REVERSAL_USAGE' | 'EXPIRATION';
 /**
  * @interface IBonusHistoryQuery
- * @property {BonusTransactionType} [type] - Transaction type filter.
+ * @property {IBonusTransactionType} [type] - Transaction type filter.
  * @property {string} [dateFrom] - Start date filter.
  * @property {string} [dateTo] - End date filter.
  * @property {number} [discountId] - Discount id filter.
@@ -178,7 +186,7 @@ type BonusTransactionType = 'ACCRUAL' | 'USAGE' | 'REDUCE' | 'REVERSAL_ACCRUAL'
  * @property {boolean} [isAdmin] - Admin filter.
  */
 interface IBonusHistoryQuery {
-    type?: BonusTransactionType;
+    type?: IBonusTransactionType;
     dateFrom?: string;
     dateTo?: string;
     discountId?: number;
@@ -189,7 +197,7 @@ interface IBonusHistoryQuery {
  * @interface IBonusTransactionEntity
  * @property {number} balanceId - Balance id.
  * @property {number} amount - Transaction amount.
- * @property {BonusTransactionType} type - Transaction type.
+ * @property {IBonusTransactionType} type - Transaction type.
  * @property {number} [discountId] - Discount id.
  * @property {number} [moduleId] - Module id.
  * @property {string} [entityIdentifier] - Entity identifier.
@@ -203,7 +211,7 @@ interface IBonusHistoryQuery {
 interface IBonusTransactionEntity {
     balanceId: number;
     amount: number;
-    type: BonusTransactionType;
+    type: IBonusTransactionType;
     discountId?: number;
     moduleId?: number;
     entityIdentifier?: string;
@@ -214,4 +222,12 @@ interface IBonusTransactionEntity {
     expiresAt?: string;
     createdAt?: string;
 }
-export type { BonusTransactionType, IBonusHistoryQuery, IBonusTransactionEntity, ICouponValidationResult, IDiscountByMarkerQuery, IDiscountCondition, IDiscountsApi, IDiscountsEntity, IDiscountsQuery, IDiscountsResponse, IDiscountsValidateCoupon, };
+/**
+ * @interface IBonusBalanceEntity
+ * @description Represents the balance of bonus points.
+ * @property {number} balance - The balance of bonus points. Example: 100
+ */
+interface IBonusBalanceEntity {
+    balance: number;
+}
+export type { IBonusBalanceEntity, IBonusHistoryQuery, IBonusTransactionEntity, IBonusTransactionType, ICouponValidationResult, IDiscountByMarkerQuery, IDiscountCondition, IDiscountsApi, IDiscountsEntity, IDiscountsQuery, IDiscountsResponse, IDiscountsValidateCoupon, IDiscountType, };

package/dist/forms/formsInterfaces.d.ts

@@ -70,11 +70,13 @@ interface IFromPages {
  * @property {string} identifier - The textual identifier for the record field. Example: "form_contact_us".
  * @property {string} processingType - Type of form processing. Example: "async".
  * @property {number | null} templateId - The identifier of the template used by the form, or null if no template is used. Example: 6789.
- * @property {IAttributes[] | Record<string, any>} attributes - The attributes of the form, which can be an array of attribute objects or a record of key-value pairs.
+ * @property {IAttributes[] | Record<string, any>} [attributes] - The attributes of the form, which can be an array of attribute objects or a record of key-value pairs.
  * @example
     {
       "key": "value"
     }
+ * @property {number | string} [total] - Total count of related entries. Example: "1".
+ * @property {IFormConfig[]} [moduleFormConfigs] - Array of module form configurations associated with the form.
  * @description This interface defines the structure of a form entity, including its identifiers, attributes, and processing data.
  */
 interface IFormsEntity {
@@ -87,7 +89,9 @@ interface IFormsEntity {
     identifier: string;
     processingType: string;
     templateId: number | null;
-    attributes: IAttributes[] | Record<string, any>;
+    attributes?: IAttributes[] | Record<string, unknown>;
+    total?: number | string;
+    moduleFormConfigs?: IFormConfig[];
 }
 /**
  * Represents the structure of a form configuration.
@@ -108,7 +112,13 @@ interface IFormsEntity {
  * @property {string[]} [nestedEntityIdentifiers] - An array of nested entity identifier strings (only in products/pages API). Example: ["catalog"].
  * @property {string[]} [exceptionIds] - An array of exception identifiers.
  * @property {number} [formDataCount] - Total count of form data entries (only in products/pages API). Example: 306.
- * @property {Record<string, number>} [entityFormDataCount] - Form data count per entity identifier (only in products/pages API). Example: {"catalog": 306}.
+ * @property {Record<string, number>} [entityFormDataCount] - Form data count per entity identifier (only in products/pages API). Example: `{"catalog": 306}`.
+ * @property {boolean | null} [isRating] - Indicates whether this form config is for ratings. Example: null.
+ * @property {boolean | null} [isAnonymous] - Indicates whether anonymous submissions are allowed. Example: null.
+ * @property {boolean | null} [allowHalfRatings] - Indicates whether half ratings are allowed. Example: null.
+ * @property {boolean | null} [allowRerating] - Indicates whether re-rating is allowed. Example: null.
+ * @property {number | null} [maxRatingScale] - Maximum rating scale value. Example: 5.
+ * @property {string} [ratingCalculation] - Rating calculation method. Example: "average".
  * @description This interface defines the structure of a form configuration, including its identifiers, module association, and entity identifiers. Different APIs return different field variants.
  */
 interface IFormConfig {
@@ -130,6 +140,12 @@ interface IFormConfig {
     exceptionIds?: string[];
     formDataCount?: number;
     entityFormDataCount?: Record<string, number>;
+    isRating?: boolean | null;
+    isAnonymous?: boolean | null;
+    allowHalfRatings?: boolean | null;
+    allowRerating?: boolean | null;
+    maxRatingScale?: number | null;
+    ratingCalculation?: string;
 }
 /**
  * Represents the paginated response structure for forms.

package/dist/forms/formsSchemas.d.ts

@@ -13,6 +13,7 @@ export declare const FormEntitySchema: z.ZodObject<{
     type: z.ZodNullable<z.ZodString>;
     attributeSetId: z.ZodNullable<z.ZodNumber>;
     templateId: z.ZodNullable<z.ZodNumber>;
+    total: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
     attributes: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
     moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
 }, z.core.$strip>;
@@ -31,6 +32,7 @@ export declare const FormsResponseSchema: z.ZodObject<{
         type: z.ZodNullable<z.ZodString>;
         attributeSetId: z.ZodNullable<z.ZodNumber>;
         templateId: z.ZodNullable<z.ZodNumber>;
+        total: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
         attributes: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
         moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
     }, z.core.$strip>>;
@@ -48,6 +50,7 @@ export declare const SingleFormSchema: z.ZodObject<{
     type: z.ZodNullable<z.ZodString>;
     attributeSetId: z.ZodNullable<z.ZodNumber>;
     templateId: z.ZodNullable<z.ZodNumber>;
+    total: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
     attributes: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
     moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
 }, z.core.$strip>;

package/dist/forms/formsSchemas.js

@@ -16,6 +16,7 @@ exports.FormEntitySchema = zod_1.z.object({
     type: zod_1.z.string().nullable(),
     attributeSetId: zod_1.z.number().nullable(),
     templateId: zod_1.z.number().nullable(),
+    total: zod_1.z.union([zod_1.z.number(), zod_1.z.string()]).optional(),
     attributes: zod_1.z
         .union([zod_1.z.array(zod_1.z.any()), zod_1.z.record(zod_1.z.string(), zod_1.z.any())])
         .optional(),

package/dist/forms-data/formsDataInterfaces.d.ts

@@ -241,10 +241,9 @@ interface IFormsByMarkerDataEntity {
         "value": "Jack"
       }
     ]
- * @property {string} actionMessage - Action message for the form data. Example: "Form submitted successfully".
+ * @property {string} actionMessage - Action message for the form data (can be localized). Example: "Form submitted successfully".
  */
 interface IPostFormResponse {
-    actionMessage: string;
     formData: {
         id: number;
         formIdentifier: string;
@@ -255,8 +254,9 @@ interface IPostFormResponse {
         formModuleId: number;
         userIdentifier: string | null;
         parentId: number | null;
-        formData: FormDataType[];
+        formData: FormDataType[] | Record<string, any>;
     };
+    actionMessage: string;
 }
 /**
  * Represents the structure of the response after updating form data.

package/dist/forms-data/formsDataSchemas.d.ts

@@ -27,11 +27,7 @@ export declare const FormByMarkerDataEntitySchema: z.ZodObject<{
         marker: z.ZodString;
         type: z.ZodString;
         value: z.ZodAny;
-    }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>, z.ZodRecord<z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
-        marker: z.ZodString;
-        type: z.ZodString;
-        value: z.ZodAny;
-    }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>>]>;
+    }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
     attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     time: z.ZodUnion<readonly [z.ZodDate, z.ZodString]>;
     entityIdentifier: z.ZodOptional<z.ZodString>;
@@ -57,11 +53,7 @@ export declare const FormsByMarkerDataResponseSchema: z.ZodObject<{
             marker: z.ZodString;
             type: z.ZodString;
             value: z.ZodAny;
-        }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>, z.ZodRecord<z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
-            marker: z.ZodString;
-            type: z.ZodString;
-            value: z.ZodAny;
-        }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>>]>;
+        }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
         attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         time: z.ZodUnion<readonly [z.ZodDate, z.ZodString]>;
         entityIdentifier: z.ZodOptional<z.ZodString>;
@@ -85,8 +77,8 @@ export declare const PostFormResponseSchema: z.ZodObject<{
         fingerprint: z.ZodString;
         isUserAdmin: z.ZodBoolean;
         formModuleId: z.ZodNumber;
-        userIdentifier: z.ZodAny;
-        parentId: z.ZodAny;
+        userIdentifier: z.ZodNullable<z.ZodString>;
+        parentId: z.ZodNullable<z.ZodNumber>;
         formData: z.ZodUnion<readonly [z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
             marker: z.ZodString;
             type: z.ZodString;

package/dist/forms-data/formsDataSchemas.js

@@ -31,7 +31,7 @@ exports.FormByMarkerDataEntitySchema = zod_1.z.object({
     userIdentifier: zod_1.z.string().nullish(),
     formData: zod_1.z.union([
         zod_1.z.array(exports.FormDataTypeSchema),
-        zod_1.z.record(zod_1.z.string(), zod_1.z.array(exports.FormDataTypeSchema)),
+        zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
     ]),
     attributeSetIdentifier: zod_1.z.string().nullish(),
     time: zod_1.z.union([zod_1.z.date(), zod_1.z.string()]),
@@ -61,8 +61,8 @@ exports.PostFormResponseSchema = zod_1.z.object({
         fingerprint: zod_1.z.string(),
         isUserAdmin: zod_1.z.boolean(),
         formModuleId: zod_1.z.number(),
-        userIdentifier: zod_1.z.any(),
-        parentId: zod_1.z.any(),
+        userIdentifier: zod_1.z.string().nullable(),
+        parentId: zod_1.z.number().nullable(),
         formData: zod_1.z.union([
             zod_1.z.array(exports.FormDataTypeSchema),
             zod_1.z.record(zod_1.z.string(), zod_1.z.any()),

package/dist/orders/ordersApi.d.ts

@@ -160,16 +160,16 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @handleName createRefundRequest
      * @param {number} id - Order id. Example: 1.
      * @param {ICreateRefundRequest} body - Refund request body.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    createRefundRequest(id: number, body: ICreateRefundRequest): Promise<IOrdersEntity | IError>;
+    createRefundRequest(id: number, body: ICreateRefundRequest): Promise<boolean | IError>;
     /**
      * Cancel a refund request for an order.
      * @handleName cancelRefundRequest
      * @param {number} id - Order id. Example: 1.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was cancelled successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    cancelRefundRequest(id: number): Promise<IOrdersEntity | IError>;
+    cancelRefundRequest(id: number): Promise<boolean | IError>;
 }

package/dist/orders/ordersApi.js

@@ -219,7 +219,7 @@ class OrdersApi extends asyncModules_1.default {
      * @handleName createRefundRequest
      * @param {number} id - Order id. Example: 1.
      * @param {ICreateRefundRequest} body - Refund request body.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async createRefundRequest(id, body) {
@@ -233,7 +233,7 @@ class OrdersApi extends asyncModules_1.default {
      * Cancel a refund request for an order.
      * @handleName cancelRefundRequest
      * @param {number} id - Order id. Example: 1.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was cancelled successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
     async cancelRefundRequest(id) {

package/dist/orders/ordersInterfaces.d.ts

@@ -146,18 +146,18 @@ interface IOrdersApi {
      * @handleName createRefundRequest
      * @param {number} id - Order id.
      * @param {ICreateRefundRequest} body - Refund request body.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    createRefundRequest(id: number, body: ICreateRefundRequest): Promise<IOrdersEntity | IError>;
+    createRefundRequest(id: number, body: ICreateRefundRequest): Promise<boolean | IError>;
     /**
      * Cancel a refund request for an order.
      * @handleName cancelRefundRequest
      * @param {number} id - Order id.
-     * @returns {Promise<IOrdersEntity | IError>} Returns order entity.
+     * @returns {Promise<boolean | IError>} Returns order entity.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    cancelRefundRequest(id: number): Promise<IOrdersEntity | IError>;
+    cancelRefundRequest(id: number): Promise<boolean | IError>;
 }
 /**
  * Interface for the orders storage object.
@@ -493,15 +493,17 @@ interface IOrderByMarkerEntity {
  * @property {number} [id] - Status identifier. Example: 1.
  * @property {object} [localizeInfos] - Localized information for the status.
  * @property {string} [identifier] - Text identifier of the status. Example: "inProgress".
- * @property {Record<string, unknown>} [position] - Position of the status.
+ * @property {number} [position] - Position of the status. Example: 1.
  * @property {boolean} [isUsed] - Whether the status is in use. Example: true.
+ * @property {boolean} [isDefault] - Whether the status is the default status. Example: true.
  */
 interface IOrderStatus {
     id?: number;
     localizeInfos?: object;
     identifier?: string;
-    position?: Record<string, unknown>;
+    position?: number;
     isUsed?: boolean;
+    isDefault?: boolean;
 }
 /**
  * Interface representing a product in an order preview.
@@ -583,11 +585,22 @@ interface IRefundRequest {
     orderStorage: unknown;
     user: unknown;
 }
+/**
+ * @interface IRefundProduct
+ * @description Refund details for a single product.
+ * @property {number} quantity - Quantity of the product to refund. Example: 1.
+ */
+interface IRefundProduct {
+    quantity: number;
+}
 /**
  * @interface ICreateRefundRequest
  * @description Body for creating a refund request.
+ * @property {Record<string, IRefundProduct>} products - Map of product id to refund details. Example: `{ "146": { "quantity": 1 } }`.
+ * @property {string} [note] - Optional note for the refund request. Example: "test".
  */
 interface ICreateRefundRequest {
-    [key: string]: unknown;
+    products: Record<string, IRefundProduct>;
+    note?: string;
 }
-export type { IBaseOrdersEntity, IBaseOrdersEntityResponse, ICreateOrderPreview, ICreateRefundRequest, IOrderByMarkerEntity, IOrderData, IOrderPreviewItem, IOrderPreviewResponse, IOrderProductData, IOrderProducts, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity, IOrdersFormData, IOrderStatus, IPaymentAccountIdentifiers, IPicture, IPreviewOrderProduct, IRefundRequest, };
+export type { IBaseOrdersEntity, IBaseOrdersEntityResponse, ICreateOrderPreview, ICreateRefundRequest, IOrderByMarkerEntity, IOrderData, IOrderPreviewItem, IOrderPreviewResponse, IOrderProductData, IOrderProducts, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity, IOrdersFormData, IOrderStatus, IPaymentAccountIdentifiers, IPicture, IPreviewOrderProduct, IRefundProduct, IRefundRequest, };

package/dist/orders/ordersSchemas.d.ts

@@ -21,19 +21,19 @@ export declare const OrderItemSchema: z.ZodObject<{
  */
 export declare const OrderEntitySchema: z.ZodObject<{
     id: z.ZodNumber;
-    storageId: z.ZodOptional<z.ZodNumber>;
-    createdDate: z.ZodOptional<z.ZodString>;
+    storageId: z.ZodNumber;
+    createdDate: z.ZodString;
     statusIdentifier: z.ZodOptional<z.ZodString>;
     formIdentifier: z.ZodOptional<z.ZodString>;
-    formData: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
-    attributeSetIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    totalSum: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
-    currency: z.ZodOptional<z.ZodString>;
-    paymentAccountIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    paymentAccountLocalizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    paymentUrl: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    products: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-    isCompleted: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+    attributeSetIdentifier: z.ZodOptional<z.ZodString>;
+    totalSum: z.ZodString;
+    currency: z.ZodString;
+    paymentAccountIdentifier: z.ZodOptional<z.ZodString>;
+    paymentAccountLocalizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    paymentUrl: z.ZodNullable<z.ZodString>;
+    products: z.ZodArray<z.ZodAny>;
+    isCompleted: z.ZodNullable<z.ZodBoolean>;
     statusLocalizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
 }, z.core.$strip>;
 /**
@@ -43,19 +43,19 @@ export declare const OrderEntitySchema: z.ZodObject<{
 export declare const OrdersResponseSchema: z.ZodObject<{
     items: z.ZodArray<z.ZodObject<{
         id: z.ZodNumber;
-        storageId: z.ZodOptional<z.ZodNumber>;
-        createdDate: z.ZodOptional<z.ZodString>;
+        storageId: z.ZodNumber;
+        createdDate: z.ZodString;
         statusIdentifier: z.ZodOptional<z.ZodString>;
         formIdentifier: z.ZodOptional<z.ZodString>;
-        formData: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
-        attributeSetIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        totalSum: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
-        currency: z.ZodOptional<z.ZodString>;
-        paymentAccountIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        paymentAccountLocalizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-        paymentUrl: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        products: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-        isCompleted: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+        formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+        attributeSetIdentifier: z.ZodOptional<z.ZodString>;
+        totalSum: z.ZodString;
+        currency: z.ZodString;
+        paymentAccountIdentifier: z.ZodOptional<z.ZodString>;
+        paymentAccountLocalizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        paymentUrl: z.ZodNullable<z.ZodString>;
+        products: z.ZodArray<z.ZodAny>;
+        isCompleted: z.ZodNullable<z.ZodBoolean>;
         statusLocalizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     }, z.core.$strip>>;
     total: z.ZodNumber;
@@ -97,13 +97,20 @@ export declare const OrdersStorageResponseSchema: z.ZodArray<z.ZodObject<{
  */
 export declare const CreateOrderResponseSchema: z.ZodObject<{
     id: z.ZodNumber;
-    formIdentifier: z.ZodOptional<z.ZodString>;
-    paymentAccountIdentifier: z.ZodOptional<z.ZodString>;
-    formData: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
-    products: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-    currency: z.ZodOptional<z.ZodString>;
-    totalSum: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    formIdentifier: z.ZodString;
+    paymentAccountIdentifier: z.ZodString;
+    formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+    products: z.ZodArray<z.ZodAny>;
+    currency: z.ZodString;
+    totalSum: z.ZodNumber;
     createdDate: z.ZodOptional<z.ZodString>;
+    statusIdentifier: z.ZodOptional<z.ZodString>;
+    couponCode: z.ZodOptional<z.ZodString>;
+    additionalDiscountsMarkers: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    discountConfig: z.ZodOptional<z.ZodUnknown>;
+    bonusAmount: z.ZodOptional<z.ZodNumber>;
+    bonusApplied: z.ZodOptional<z.ZodNumber>;
+    totalDue: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 /**
  * Update order response schema
@@ -111,10 +118,18 @@ export declare const CreateOrderResponseSchema: z.ZodObject<{
  */
 export declare const UpdateOrderResponseSchema: z.ZodObject<{
     id: z.ZodNumber;
-    formIdentifier: z.ZodOptional<z.ZodString>;
-    paymentAccountIdentifier: z.ZodOptional<z.ZodString>;
-    formData: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
-    products: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-    currency: z.ZodOptional<z.ZodString>;
-    totalSum: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    formIdentifier: z.ZodString;
+    paymentAccountIdentifier: z.ZodString;
+    formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+    products: z.ZodArray<z.ZodAny>;
+    currency: z.ZodString;
+    totalSum: z.ZodNumber;
+    createdDate: z.ZodOptional<z.ZodString>;
+    statusIdentifier: z.ZodOptional<z.ZodString>;
+    couponCode: z.ZodOptional<z.ZodString>;
+    additionalDiscountsMarkers: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    discountConfig: z.ZodOptional<z.ZodUnknown>;
+    bonusAmount: z.ZodOptional<z.ZodNumber>;
+    bonusApplied: z.ZodOptional<z.ZodNumber>;
+    totalDue: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;