@hosterai/types 0.0.12 → 0.0.14

package/dist/dtos/info.dto.js

@@ -2,15 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoDto = void 0;
 /**
- * DTO for integration information
- * Contains all information related to a service integration
+ * DTO for integration information.
+ * This is a central DTO that contains all the necessary information
+ * for a service integration, including UI configuration, supported features,
+ * and billing details.
  */
 class InfoDto {
     constructor() {
         /**
-         * Actions that are not supported by the integration.
+         * A list of actions that are supported by this integration.
          */
-        this.unsupportedActions = [];
+        this.supportedActions = [];
     }
 }
 exports.InfoDto = InfoDto;

package/dist/dtos/jwt.dto.d.ts

@@ -1,31 +1,34 @@
 import { RolesEnum } from '../enums/roles.enum';
+/**
+ * DTO for the JWT payload.
+ * This defines the structure of the data contained within the JWT.
+ */
 declare class JwtPayloadDto {
     /**
-     * Integration identifier
+     * The unique identifier for the integration.
      */
     integrationId: string;
     /**
-     * Unique user identifier that triggers the API call (only the /send method will not contain userId).
+     * The unique identifier for the user who triggered the API call.
+     * This is optional and may not be present in all requests (e.g., /send).
      */
     userId?: string;
     /**
-     * Unique company identifier
+     * The unique identifier for the company.
      */
     companyId: string;
     /**
-     * The roles accepted by the company for this integration
+     * The roles that have been accepted by the company for this integration.
      */
     acceptedRoles: RolesEnum[];
 }
 /**
- * DTO for JWT payload
- * Used for user authentication and authorization
+ * DTO for the JWT itself.
+ * This is the main DTO used for user authentication and authorization.
  */
 export declare class JwtDto {
     /**
-     * User information contained in the JWT token
-     * Includes user and company identifiers, admin rights
-     * and optional sender details
+     * The JWT payload containing user and company information.
      */
     jwt: JwtPayloadDto;
 }

package/dist/dtos/jwt.dto.js

@@ -13,6 +13,10 @@ exports.JwtDto = void 0;
 const class_validator_1 = require("class-validator");
 const class_transformer_1 = require("class-transformer");
 const roles_enum_1 = require("../enums/roles.enum");
+/**
+ * DTO for the JWT payload.
+ * This defines the structure of the data contained within the JWT.
+ */
 class JwtPayloadDto {
 }
 __decorate([
@@ -36,8 +40,8 @@ __decorate([
     __metadata("design:type", Array)
 ], JwtPayloadDto.prototype, "acceptedRoles", void 0);
 /**
- * DTO for JWT payload
- * Used for user authentication and authorization
+ * DTO for the JWT itself.
+ * This is the main DTO used for user authentication and authorization.
  */
 class JwtDto {
 }

package/dist/dtos/menu.dto.d.ts

@@ -1,39 +1,54 @@
-import { SubmenuDto } from './tab.dto';
+import { SubmenuDto } from './submenu.dto';
 /**
- * Base properties shared by all menu items
+ * Base properties shared by all menu items.
  */
 interface BaseMenuDto {
     /**
-     * The icon to be displayed for the menu item
+     * The icon to be displayed for the menu item.
+     * @example "home"
      */
     icon: string;
     /**
-     * The name to be displayed for the menu item
+     * The name to be displayed for the menu item.
+     * @example "Dashboard"
      */
     label: string;
 }
 /**
- * Menu item with URL (no submenu)
+ * Represents a menu item that links directly to a URL.
+ * This type of menu item does not have a submenu.
  */
 export interface MenuDtoWithUrl extends BaseMenuDto {
+    /**
+     * The type of the menu item. This is a discriminator property.
+     */
     type: 'only-url';
     /**
-     * The URL associated with the tab.
-     * The requests coming from the hoster will be signed
-     * with jwt, which will contain information about the company
+     * The URL associated with the menu item.
+     * Requests from the hoster will be signed with a JWT containing company information.
      */
     url: string;
+    /**
+     * Explicitly prevents a submenu from being added to this type of menu item.
+     */
     submenu?: never;
 }
 /**
- * Menu item with submenu (no URL)
+ * Represents a menu item that contains a submenu.
+ * This type of menu item does not have a direct URL.
  */
 export interface MenuDtoWithSubmenu extends BaseMenuDto {
+    /**
+     * The type of the menu item. This is a discriminator property.
+     */
     type: 'with-submenu';
+    /**
+     * Explicitly prevents a URL from being added to this type of menu item.
+     */
     url?: never;
     /**
-     * The list of tabs that will appear in the submenu and as a navigation bar above the main content
-     * In case of only one tab, there will be neither a submenu nor a navigation bar.
+     * The list of tabs that will appear in the submenu.
+     * If there is only one tab, no submenu or navigation bar will be displayed.
      */
     submenu: SubmenuDto[];
 }

package/dist/dtos/multilang-text.dto.d.ts

@@ -1,5 +1,16 @@
 import { LanguageEnum } from '../enums/language.enum';
+/**
+ * DTO for multilingual text.
+ * Used for providing text in multiple languages.
+ */
 export declare class MultilangTextDto {
+    /**
+     * The language of the text.
+     * @see LanguageEnum
+     */
     language: LanguageEnum;
+    /**
+     * The text content in the specified language.
+     */
     text: string;
 }

package/dist/dtos/multilang-text.dto.js

@@ -12,6 +12,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MultilangTextDto = void 0;
 const class_validator_1 = require("class-validator");
 const language_enum_1 = require("../enums/language.enum");
+/**
+ * DTO for multilingual text.
+ * Used for providing text in multiple languages.
+ */
 class MultilangTextDto {
 }
 exports.MultilangTextDto = MultilangTextDto;

package/dist/dtos/notification/notification-info.dto.d.ts

@@ -1,5 +1,20 @@
 import { NotificationMessageTypeEnum } from '../../enums/notification/notification-message-type.enum';
 import { InfoDto } from '../info.dto';
+import { UnitDto } from '../unit.dto';
+/**
+ * DTO for notification information.
+ * Extends the base InfoDto to include the notification message type.
+ */
 export declare class NotificationInfoDto extends InfoDto {
+    /**
+     * The type of the notification message.
+     * @see NotificationMessageTypeEnum
+     */
     type: NotificationMessageTypeEnum;
+    /**
+     * Defines the units for pay-per-use billing.
+     * This allows the administrator to set a price for each unit per interval.
+     * @example [{ id: "ram", unitDescription: "MB", intervalDescription: "month" }]
+     */
+    payPerUseUnits?: UnitDto[];
 }

package/dist/dtos/notification/notification-info.dto.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotificationInfoDto = void 0;
 const info_dto_1 = require("../info.dto");
+/**
+ * DTO for notification information.
+ * Extends the base InfoDto to include the notification message type.
+ */
 class NotificationInfoDto extends info_dto_1.InfoDto {
 }
 exports.NotificationInfoDto = NotificationInfoDto;

package/dist/dtos/notification/{notification-request.dto.d.ts → notification-send-request.dto.d.ts}

@@ -4,7 +4,12 @@ import { SmsReceiverDto } from './receiver/receiver-sms.dto';
 import { EmailSenderDto } from './sender/sender-email.dto';
 import { PushSenderDto } from './sender/sender-push.dto';
 import { SmsSenderDto } from './sender/sender-sms.dto';
-export declare class NotificationRequestDto {
+/**
+ * Represents a request to send a notification.
+ * This DTO encapsulates all the necessary information for sending a notification,
+ * including the notification ID, sender details, and receiver details.
+ */
+export declare class NotificationSendRequestDto {
     /**
      * Unique identifier of the hoster message
      */

package/dist/dtos/notification/{notification-request.dto.js → notification-send-request.dto.js}

@@ -9,23 +9,28 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationRequestDto = void 0;
+exports.NotificationSendRequestDto = void 0;
 const class_validator_1 = require("class-validator");
-class NotificationRequestDto {
+/**
+ * Represents a request to send a notification.
+ * This DTO encapsulates all the necessary information for sending a notification,
+ * including the notification ID, sender details, and receiver details.
+ */
+class NotificationSendRequestDto {
 }
-exports.NotificationRequestDto = NotificationRequestDto;
+exports.NotificationSendRequestDto = NotificationSendRequestDto;
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)
-], NotificationRequestDto.prototype, "notificationId", void 0);
+], NotificationSendRequestDto.prototype, "notificationId", void 0);
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsObject)(),
     __metadata("design:type", Object)
-], NotificationRequestDto.prototype, "sender", void 0);
+], NotificationSendRequestDto.prototype, "sender", void 0);
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsObject)(),
     __metadata("design:type", Object)
-], NotificationRequestDto.prototype, "receiver", void 0);
+], NotificationSendRequestDto.prototype, "receiver", void 0);

package/dist/dtos/product/product-info.dto.d.ts

@@ -0,0 +1,30 @@
+import { FieldDto } from '../field.dto';
+import { InfoDto } from '../info.dto';
+import { UnitDto } from '../unit.dto';
+/**
+ * DTO for notification information.
+ * Extends the base InfoDto to include the notification message type.
+ */
+export declare class ProductInfoDto extends InfoDto {
+    /**
+     * Custom attributes that can be defined for products.
+     * These attributes will be displayed in the product configuration section.
+     */
+    productAttributes?: FieldDto[];
+    /**
+     * Custom attributes that can be defined for items.
+     * These attributes will be displayed in the item details section.
+     */
+    itemAttributes?: FieldDto[];
+    /**
+     * Defines the units for pay-per-use billing.
+     * This allows the administrator to set a price for each unit per interval.
+     * @example [{ id: "ram", unitDescription: "MB", intervalDescription: "month" }]
+     */
+    payPerUseUnits?: UnitDto[];
+    /**
+     * Specifies the field names that will be returned in the response data after a successful creation.
+     * This allows the system to know what to expect in the response before the creation is executed.
+     */
+    responseDataFieldNames?: Record<string, unknown>;
+}

package/dist/dtos/product/product-info.dto.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductInfoDto = void 0;
+const info_dto_1 = require("../info.dto");
+/**
+ * DTO for notification information.
+ * Extends the base InfoDto to include the notification message type.
+ */
+class ProductInfoDto extends info_dto_1.InfoDto {
+}
+exports.ProductInfoDto = ProductInfoDto;

package/dist/dtos/product/product-item-data.dto.d.ts

@@ -0,0 +1,31 @@
+import { DurationEnum } from '../../enums/duration.enum';
+/**
+ * Represents the data of a specific product item.
+ * This DTO is used to transfer detailed information about a product instance.
+ */
+export declare class ProductItemDataDto {
+    /**
+     * The unique identifier for the product item.
+     */
+    itemId?: string;
+    /**
+     * A record of product-level attributes.
+     * These are general attributes defined for the product type.
+     */
+    productAttributes: Record<string, unknown>;
+    /**
+     * A record of item-specific attributes.
+     * These are attributes that are unique to this particular instance of the product.
+     */
+    itemAttributes: Record<string, unknown>;
+    /**
+     * Data returned from the creation response.
+     * This field should not be present in the create request.
+     * @optional
+     */
+    creationResponseData?: Record<string, unknown>;
+    /**
+     * The duration of the product subscription or license.
+     */
+    duration: DurationEnum;
+}

package/dist/dtos/product/product-item-data.dto.js

@@ -0,0 +1,43 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductItemDataDto = void 0;
+const class_validator_1 = require("class-validator");
+const duration_enum_1 = require("../../enums/duration.enum");
+/**
+ * Represents the data of a specific product item.
+ * This DTO is used to transfer detailed information about a product instance.
+ */
+class ProductItemDataDto {
+}
+exports.ProductItemDataDto = ProductItemDataDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], ProductItemDataDto.prototype, "itemId", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    __metadata("design:type", Object)
+], ProductItemDataDto.prototype, "productAttributes", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    __metadata("design:type", Object)
+], ProductItemDataDto.prototype, "itemAttributes", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Object)
+], ProductItemDataDto.prototype, "creationResponseData", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsEnum)(duration_enum_1.DurationEnum),
+    __metadata("design:type", String)
+], ProductItemDataDto.prototype, "duration", void 0);

package/dist/dtos/product/product.interface.d.ts

@@ -0,0 +1,44 @@
+import { Request } from 'express';
+import { JwtDto } from '../jwt.dto';
+import { ProductInfoResponseDto } from './responses/product-info-response.dto';
+import { ErrorResponseDto } from '../error-response.dto';
+import { ProductCreateRequestDto } from './requests/product-create-request.dto';
+import { ProductCreateResponseDto } from './responses/product-create-response.dto';
+import { ProductRenewRequestDto } from './requests/product-renew-request.dto';
+import { ProductRenewResponseDto } from './responses/product-renew-response.dto';
+import { ProductUpgradeResponseDto } from './responses/product-upgrade-response.dto';
+import { ProductUpgradeRequestDto } from './requests/product-upgrade-request.dto';
+import { ProductDowngradeRequestDto } from './requests/product-downgrade-request.dto';
+import { ProductSuspendRequestDto } from './requests/product-suspend-request.dto';
+import { ProductUnsuspendRequestDto } from './requests/product-unsuspend-request.dto';
+import { ProductUpgradableRequestDto } from './requests/product-upgradable-request.dto';
+import { ProductDowngradableRequestDto } from './requests/product-downgradable-request.dto';
+import { ProductDowngradeResponseDto } from './responses/product-downgrade-response.dto';
+import { ProductUpgradableResponseDto } from './responses/product-upgradable-response.dto';
+import { ProductSuspendResponseDto } from './responses/product-suspend-response.dto';
+import { ProductUnsuspendResponseDto } from './responses/product-unsuspend-response.dto';
+import { ProductDowngradableResponseDto } from './responses/product-downgradable-response.dto';
+import { ProductDeleteResponseDto } from './responses/product-delete-response.dto';
+import { ProductDeleteRequestDto } from './requests/product-delete-request.dto';
+import { ProductValidateAttributesRequestDto } from './requests/product-validate-attributes-request.dto';
+import { ProductValidateAttributesResponseDto } from './responses/product-validate-attributes-response.dto';
+import { SetupStatusResponseDto } from '../setup-status-response.dto';
+export interface ProductControllerInterface {
+    info(request: Request & JwtDto): ProductInfoResponseDto | ErrorResponseDto;
+    create(requestBody: ProductCreateRequestDto & JwtDto): Promise<ProductCreateResponseDto>;
+    renew(requestBody: ProductRenewRequestDto & JwtDto): Promise<ProductRenewResponseDto>;
+    upgrade(requestBody: ProductUpgradeRequestDto & JwtDto): Promise<ProductUpgradeResponseDto>;
+    downgrade(requestBody: ProductDowngradeRequestDto & JwtDto): Promise<ProductDowngradeResponseDto>;
+    suspend(requestBody: ProductSuspendRequestDto & JwtDto): Promise<ProductSuspendResponseDto>;
+    unsuspend(requestBody: ProductUnsuspendRequestDto & JwtDto): Promise<ProductUnsuspendResponseDto>;
+    upgradable(requestBody: ProductUpgradableRequestDto & JwtDto): Promise<ProductUpgradableResponseDto>;
+    Downgradable(requestBody: ProductDowngradableRequestDto & JwtDto): Promise<ProductDowngradableResponseDto>;
+    delete(requestBody: ProductDeleteRequestDto & JwtDto): Promise<ProductDeleteResponseDto>;
+    validateProductAttributes(requestBody: ProductValidateAttributesRequestDto): Promise<ProductValidateAttributesResponseDto | ErrorResponseDto>;
+    validateItemAttributes(requestBody: ProductValidateAttributesRequestDto): Promise<ProductValidateAttributesResponseDto | ErrorResponseDto>;
+    setupStatus(): Promise<SetupStatusResponseDto>;
+    install(request: Request & JwtDto): Promise<null | ErrorResponseDto>;
+    uninstall(request: Request & JwtDto, requestBody: {
+        companyId: string;
+    }): Promise<null | ErrorResponseDto>;
+}

package/dist/dtos/product/product.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/dtos/product/requests/product-create-request.dto.d.ts

@@ -0,0 +1,18 @@
+import { ProductItemDataDto } from '../product-item-data.dto';
+import { ClientDataDto } from '../../client-data.dto';
+/**
+ * Represents a request to create a new product item.
+ * This DTO contains all the necessary information for the creation process.
+ */
+export declare class ProductCreateRequestDto {
+    /**
+     * The client's data.
+     * This object holds all the relevant information about the client initiating the request.
+     */
+    clientData: ClientDataDto;
+    /**
+     * The data for the new product item to be created.
+     * This object contains the specific details of the product instance being provisioned.
+     */
+    itemData: ProductItemDataDto;
+}

package/dist/dtos/product/requests/product-create-request.dto.js

@@ -0,0 +1,37 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductCreateRequestDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const product_item_data_dto_1 = require("../product-item-data.dto");
+const client_data_dto_1 = require("../../client-data.dto");
+/**
+ * Represents a request to create a new product item.
+ * This DTO contains all the necessary information for the creation process.
+ */
+class ProductCreateRequestDto {
+}
+exports.ProductCreateRequestDto = ProductCreateRequestDto;
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
+    __metadata("design:type", client_data_dto_1.ClientDataDto)
+], ProductCreateRequestDto.prototype, "clientData", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => product_item_data_dto_1.ProductItemDataDto),
+    __metadata("design:type", product_item_data_dto_1.ProductItemDataDto)
+], ProductCreateRequestDto.prototype, "itemData", void 0);

package/dist/dtos/product/requests/product-delete-request.dto.d.ts

@@ -0,0 +1,18 @@
+import { ProductItemDataDto } from '../product-item-data.dto';
+import { ClientDataDto } from '../../client-data.dto';
+/**
+ * Represents a request to delete a product item.
+ * This DTO contains all the necessary information for the deletion process.
+ */
+export declare class ProductDeleteRequestDto {
+    /**
+     * The client's data.
+     * This object holds all the relevant information about the client initiating the request.
+     */
+    clientData: ClientDataDto;
+    /**
+     * The data of the product item to be deleted.
+     * This object contains the specific details of the product instance being removed.
+     */
+    itemData: ProductItemDataDto;
+}

package/dist/dtos/product/requests/product-delete-request.dto.js

@@ -0,0 +1,37 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductDeleteRequestDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const product_item_data_dto_1 = require("../product-item-data.dto");
+const client_data_dto_1 = require("../../client-data.dto");
+/**
+ * Represents a request to delete a product item.
+ * This DTO contains all the necessary information for the deletion process.
+ */
+class ProductDeleteRequestDto {
+}
+exports.ProductDeleteRequestDto = ProductDeleteRequestDto;
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
+    __metadata("design:type", client_data_dto_1.ClientDataDto)
+], ProductDeleteRequestDto.prototype, "clientData", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => product_item_data_dto_1.ProductItemDataDto),
+    __metadata("design:type", product_item_data_dto_1.ProductItemDataDto)
+], ProductDeleteRequestDto.prototype, "itemData", void 0);

package/dist/dtos/product/requests/product-downgradable-request.dto.d.ts

@@ -0,0 +1,18 @@
+import { ProductItemDataDto } from '../product-item-data.dto';
+import { ClientDataDto } from '../../client-data.dto';
+/**
+ * Represents a request to check if a product item is downgradable.
+ * This DTO contains all the necessary information for the check.
+ */
+export declare class ProductDowngradableRequestDto {
+    /**
+     * The client's data.
+     * This object holds all the relevant information about the client initiating the request.
+     */
+    clientData: ClientDataDto;
+    /**
+     * The data of the product item to be checked.
+     * This object contains the specific details of the product instance being evaluated.
+     */
+    itemData: ProductItemDataDto;
+}

package/dist/dtos/product/requests/product-downgradable-request.dto.js

@@ -0,0 +1,37 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductDowngradableRequestDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const product_item_data_dto_1 = require("../product-item-data.dto");
+const client_data_dto_1 = require("../../client-data.dto");
+/**
+ * Represents a request to check if a product item is downgradable.
+ * This DTO contains all the necessary information for the check.
+ */
+class ProductDowngradableRequestDto {
+}
+exports.ProductDowngradableRequestDto = ProductDowngradableRequestDto;
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
+    __metadata("design:type", client_data_dto_1.ClientDataDto)
+], ProductDowngradableRequestDto.prototype, "clientData", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsObject)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => product_item_data_dto_1.ProductItemDataDto),
+    __metadata("design:type", product_item_data_dto_1.ProductItemDataDto)
+], ProductDowngradableRequestDto.prototype, "itemData", void 0);

package/dist/dtos/product/requests/product-downgrade-request.dto.d.ts

@@ -0,0 +1,24 @@
+import { ProductItemDataDto } from '../product-item-data.dto';
+import { ClientDataDto } from '../../client-data.dto';
+/**
+ * Represents a request to downgrade a product item.
+ * This DTO contains all the necessary information for the downgrade process.
+ */
+export declare class ProductDowngradeRequestDto {
+    /**
+     * The client's data.
+     * This object holds all the relevant information about the client initiating the request.
+     */
+    clientData: ClientDataDto;
+    /**
+     * The data of the product item to be downgraded.
+     * This object contains the specific details of the product instance being modified.
+     */
+    itemData: ProductItemDataDto;
+    /**
+     * The data of the product item before the downgrade.
+     * This object contains the state of the product instance prior to the downgrade.
+     * @optional
+     */
+    previousItemData?: ProductItemDataDto;
+}