@hosterai/types 0.0.25 → 0.0.27

package/README.md

@@ -61,7 +61,11 @@ DTOs define the shape of data that is exchanged between different parts of the s
 - `country.dto.ts`: Represents country metadata (name, ISO code, Europe flag).
 - `error-response.dto.ts`: Defines the structure for error responses.
 - `field.dto.ts`: Represents a generic field for forms or dynamic data.
+- `attribute-field.dto.ts`: Extends `FieldDto` with product-specific attributes (visibleInOrder, visibleInClientPanel, repeatableMin, repeatableMax).
+- `addon-field.dto.ts`: Extends `FieldDto` for seller-defined checkout fields.
 - `field-option.dto.ts`: Represents options for form fields (used for checkboxes, radioboxes, and selects).
+- `item-data.dto.ts`: Represents the data of a specific product item (IDs, attributes, dates, pricing).
+- `invoice-contact-data.dto.ts`: Billing contact information for invoice integrations.
 - `info.dto.ts`: Contains all necessary information for a service integration.
 - `jwt.dto.ts`: DTOs related to JSON Web Tokens.
 - `menu.dto.ts`: Defines the structure for menu items.
@@ -74,13 +78,13 @@ DTOs define the shape of data that is exchanged between different parts of the s
 - `success-response.dto.ts`: Defines the structure for successful API responses.
 - `tab.dto.ts`: Represents a tab in a user interface.
 - `submenu.dto.ts`: Represents a submenu item.
-- `task-response.dto.ts`: DTO for responses related to background tasks.
 - `unit.dto.ts`: Represents a unit for pay-per-use billing.
 
 **Notification DTOs:**
 
 - `notification/notification-info.dto.ts`: Contains detailed information about a notification.
-- `notification/notification-send-request.dto.ts`: The primary DTO for requesting a new notification.
+- `notification/requests/notification-send-request.dto.ts`: The primary DTO for requesting a new notification.
+- `notification/responses/notification-send-response.dto.ts`: Response after successfully sending a notification.
 - `notification/receiver/receiver-email.dto.ts`: Defines the receiver for an email notification.
 - `notification/receiver/receiver-push.dto.ts`: Defines the receiver for a push notification.
 - `notification/receiver/receiver-sms.dto.ts`: Defines the receiver for an SMS notification.
@@ -88,21 +92,42 @@ DTOs define the shape of data that is exchanged between different parts of the s
 - `notification/sender/sender-push.dto.ts`: Defines the sender for a push notification.
 - `notification/sender/sender-sms.dto.ts`: Defines the sender for an SMS notification.
 
+**General Request/Response DTOs:**
+
+- `requests/validate-attributes-request.dto.ts`: Defines the structure for validating product attributes.
+- `responses/validate-attributes-response.dto.ts`: Response from validating product attributes.
+
 **Product DTOs:**
 
-- `product/product-info.dto.ts`: Contains detailed information about a product.
-- `product/product-item-data.dto.ts`: Represents the data of a specific product item.
-- `product/requests/product-validate-attributes-request.dto.ts`: Defines the structure for validating product attributes.
-- `product/requests/*`: DTOs for product-related requests (create, delete, upgrade, etc.).
+- `product/product-info.dto.ts`: Contains detailed information about a product. Uses `AttributeFieldDto` for product/item attributes.
+- `product/product-item-data.dto.ts`: Extends `ItemDataDto` with product-specific action type.
+- `product/requests/*`: DTOs for product-related requests (create, delete, upgrade, downgrade, renew, suspend, unsuspend, upgradable, downgradable).
 - `product/responses/*`: DTOs for product-related responses.
 
+**Invoice DTOs:**
+
+- `invoice/invoice-info.dto.ts`: Contains detailed information about an invoice integration.
+- `invoice/invoice-item-data.dto.ts`: Extends `ItemDataDto` with invoice-specific action type.
+- `invoice/transaction-data.dto.ts`: Transaction details (ID, amount, payment method, date).
+- `invoice/tin-validation-details.dto.ts`: Tax Identification Number validation details.
+- `invoice/requests/proforma-invoice-request.dto.ts`: Request payload for creating a proforma invoice.
+- `invoice/requests/invoice-request.dto.ts`: Request payload for creating a standard invoice.
+- `invoice/requests/credit-note-request.dto.ts`: Request payload for creating a credit note.
+- `invoice/requests/tax-details-request.dto.ts`: Request payload for calculating tax details.
+- `invoice/responses/proforma-invoice-response.dto.ts`: Response after creating a proforma invoice.
+- `invoice/responses/invoice-response.dto.ts`: Response after creating a standard invoice.
+- `invoice/responses/credit-note-response.dto.ts`: Response after creating a credit note.
+- `invoice/responses/tax-details-response.dto.ts`: Response with tax calculation details.
+
 ### Enums
 
 Enums provide a set of named constants for common types, preventing errors with magic strings.
 
 **Key Enums:**
 
-- `ActionsEnum`: Defines possible actions.
+- `ProductItemActionsEnum`: Defines possible product item actions (create, renew, upgrade, downgrade, etc.).
+- `InvoiceItemActionsEnum`: Defines possible invoice item actions (create, renew, upgrade, downgrade, transfer, trade).
+- `InvoiceTypesEnum`: Defines invoice document types (invoice, credit-note, proforma).
 - `CountryEnum`: A list of all countries.
 - `DurationEnum`: Defines billing durations (e.g., `MONTHLY`, `YEARLY`).
 - `EventsEnum`: Defines triggerable events.
@@ -144,7 +169,14 @@ This package includes validation functions that leverage `class-validator` to en
 - `validateJwtDto`: Validates JWT data.
 - `validateMultilangTextDto`: Validates multilingual text objects.
 - `validateUnitDto`: Validates billing unit data.
-- `validateAttributesDto`: Validates attributes.
+- `validateAttachmentDto`: Validates file attachments.
+- `validateAttributeFieldDto`: Validates attribute fields.
+- `validateAddonFieldDto`: Validates addon fields.
+- `validateCountryDto`: Validates country data.
+- `validateTabDto`: Validates tab data.
+- `validateItemDataDto`: Validates item data.
+- `validateProductItemDataDto`: Validates product item data.
+- `validateInfoDto`: Validates integration info.
 
 **Panel Validators:**
 - `validateAdminPanelDto`: Validates admin panel configuration.
@@ -164,6 +196,13 @@ This package includes validation functions that leverage `class-validator` to en
 - `validateEmailReceiverDto`, `validateSmsReceiverDto`, `validatePushReceiverDto`: Validators for notification receivers.
 - `validateEmailSenderDto`, `validateSmsSenderDto`, `validatePushSenderDto`: Validators for notification senders.
 
+**Invoice Validators:**
+- `validateInvoiceInfoDto`: Validates invoice integration info.
+- `validateInvoiceContactDataDto`: Validates invoice contact data.
+- `validateInvoiceItemDataDto`: Validates invoice item data.
+- `validateTinValidationDetailsDto`: Validates TIN validation details.
+- `validateTransactionDataDto`: Validates transaction data.
+
 **Product Validators:**
 - `validateProductInfoDto`: Validates product information.
 - `validateProductCreateRequestDto`: Validates product creation requests.
@@ -174,6 +213,8 @@ This package includes validation functions that leverage `class-validator` to en
 - `validateProductSuspendRequestDto`: Validates product suspension requests.
 - `validateProductUnsuspendRequestDto`: Validates product unsuspension requests.
 - `validateProductUpgradableRequestDto`: Validates product upgradability checks.
+- `validateProductDowngradableRequestDto`: Validates product downgradability checks.
+- `validateValidateAttributesRequestDto`: Validates attribute validation requests.
 
 
 ### Custom Decorators

package/dist/dtos/addon-field.dto.d.ts

@@ -0,0 +1,7 @@
+import { FieldDto } from "./field.dto";
+/**
+ * Fields defined by the seller for a product, requested during checkout setup.
+ * These fields contain information relevant only to the seller, not to the integration.
+ */
+export declare class AddonFieldDto extends FieldDto {
+}

package/dist/dtos/addon-field.dto.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddonFieldDto = void 0;
+const field_dto_1 = require("./field.dto");
+/**
+ * Fields defined by the seller for a product, requested during checkout setup.
+ * These fields contain information relevant only to the seller, not to the integration.
+ */
+class AddonFieldDto extends field_dto_1.FieldDto {
+}
+exports.AddonFieldDto = AddonFieldDto;

package/dist/dtos/attachment.dto.js

@@ -11,6 +11,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AttachmentDto = void 0;
 const class_validator_1 = require("class-validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
 /**
  * DTO for file attachments
  * Used for sending attached files with emails
@@ -21,16 +22,32 @@ exports.AttachmentDto = AttachmentDto;
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Filename',
+        description: 'The name of the attached file.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], AttachmentDto.prototype, "filename", void 0);
 __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsBase64)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Content',
+        description: 'The content of the file in Base64 encoding.',
+        type: 'string',
+        format: 'byte',
+    }),
     __metadata("design:type", String)
 ], AttachmentDto.prototype, "content", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Content Type',
+        description: 'The content type of the file (MIME type).',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], AttachmentDto.prototype, "contentType", void 0);

package/dist/dtos/attribute-field.dto.d.ts

@@ -0,0 +1,19 @@
+import { FieldDto } from "./field.dto";
+export declare class AttributeFieldDto extends FieldDto {
+    /**
+     * Indicates if the field is visible in orders
+     */
+    visibleInOrder?: boolean;
+    /**
+     * Indicates if the field is visible in client panel
+     */
+    visibleInClientPanel?: boolean;
+    /**
+     * Minimum repeats for repeatable fields
+     */
+    repeatableMin?: number;
+    /**
+     * Maximum repeats for repeatable fields
+     */
+    repeatableMax?: number;
+}

package/dist/dtos/attribute-field.dto.js

@@ -0,0 +1,64 @@
+"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.AttributeFieldDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
+const field_dto_1 = require("./field.dto");
+const all_or_none_validator_1 = require("../decorators/all-or-none.validator");
+const min_less_or_equal_validator_1 = require("../decorators/min-less-or-equal.validator");
+let AttributeFieldDto = class AttributeFieldDto extends field_dto_1.FieldDto {
+};
+exports.AttributeFieldDto = AttributeFieldDto;
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Visible In Order',
+        description: 'Whether the field is visible in order view.',
+        type: 'boolean',
+    }),
+    __metadata("design:type", Boolean)
+], AttributeFieldDto.prototype, "visibleInOrder", void 0);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Visible In Client Panel',
+        description: 'Whether the field is visible in the client panel.',
+        type: 'boolean',
+    }),
+    __metadata("design:type", Boolean)
+], AttributeFieldDto.prototype, "visibleInClientPanel", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Repeatable Min',
+        description: 'Minimum repeats for repeatable fields.',
+        type: 'number',
+    }),
+    __metadata("design:type", Number)
+], AttributeFieldDto.prototype, "repeatableMin", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Repeatable Max',
+        description: 'Maximum repeats for repeatable fields.',
+        type: 'number',
+    }),
+    __metadata("design:type", Number)
+], AttributeFieldDto.prototype, "repeatableMax", void 0);
+exports.AttributeFieldDto = AttributeFieldDto = __decorate([
+    (0, all_or_none_validator_1.AllOrNoneProperty)(['repeatableMin', 'repeatableMax']),
+    (0, min_less_or_equal_validator_1.MinLessOrEqualMaxProperty)(['repeatableMin', 'repeatableMax'])
+], AttributeFieldDto);

package/dist/dtos/base-response.dto.js

@@ -11,6 +11,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseResponse = void 0;
 const class_validator_1 = require("class-validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
 /**
  * Base response class
  * Used as a foundation for all API responses
@@ -21,10 +22,20 @@ exports.BaseResponse = BaseResponse;
 __decorate([
     (0, class_validator_1.IsNumber)(),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Code',
+        description: 'Response code.',
+        type: 'number',
+    }),
     __metadata("design:type", Number)
 ], BaseResponse.prototype, "code", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Message',
+        description: 'Response message.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], BaseResponse.prototype, "message", void 0);

package/dist/dtos/client-data.dto.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientDataDto = void 0;
 const class_validator_1 = require("class-validator");
 const country_enum_1 = require("../enums/country.enum");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
 /**
  * Defines the data structure for a client.
  * This object is used to transfer client data between different parts of the application.
@@ -22,16 +23,32 @@ exports.ClientDataDto = ClientDataDto;
 __decorate([
     (0, class_validator_1.IsDefined)(),
     (0, class_validator_1.IsEmail)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Email',
+        description: 'Email of the user.',
+        type: 'string',
+        format: 'email',
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "email", void 0);
 __decorate([
     (0, class_validator_1.IsDefined)(),
     (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'First Name',
+        description: 'First name of the user.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "firstName", void 0);
 __decorate([
     (0, class_validator_1.IsDefined)(),
     (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Last Name',
+        description: 'Last name of the user.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "lastName", void 0);
 __decorate([
@@ -39,11 +56,21 @@ __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsPhoneNumber)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Telephone',
+        description: 'Telephone number of the user.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "telephone", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsPhoneNumber)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Mobile',
+        description: 'Mobile number of the user.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "mobile", void 0);
 __decorate([
@@ -52,18 +79,37 @@ __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.MinLength)(1),
     (0, class_validator_1.MaxLength)(250),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Address Line 1',
+        description: 'Address line 1 of the user.',
+        type: 'string',
+        minLength: 1,
+        maxLength: 250,
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "address1", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.MinLength)(0),
     (0, class_validator_1.MaxLength)(250),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Address Line 2',
+        description: 'Address line 2 of the user.',
+        type: 'string',
+        maxLength: 250,
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "address2", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.MinLength)(0),
     (0, class_validator_1.MaxLength)(250),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Address Line 3',
+        description: 'Address line 3 of the user.',
+        type: 'string',
+        maxLength: 250,
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "address3", void 0);
 __decorate([
@@ -72,6 +118,13 @@ __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.MinLength)(1),
     (0, class_validator_1.MaxLength)(16),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Postcode',
+        description: 'Postal code of the user.',
+        type: 'string',
+        minLength: 1,
+        maxLength: 16,
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "postcode", void 0);
 __decorate([
@@ -80,27 +133,56 @@ __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.MinLength)(1),
     (0, class_validator_1.MaxLength)(250),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'City',
+        description: 'City of the user.',
+        type: 'string',
+        minLength: 1,
+        maxLength: 250,
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "city", void 0);
 __decorate([
     (0, class_validator_1.IsDefined)(),
     (0, class_validator_1.IsNotEmpty)(),
     (0, class_validator_1.IsEnum)(country_enum_1.CountryEnum),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Country',
+        description: 'Country code of the user.',
+        type: 'string',
+        enum: Object.values(country_enum_1.CountryEnum),
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "country", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.MinLength)(0),
     (0, class_validator_1.MaxLength)(250),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'State',
+        description: 'State of the user.',
+        type: 'string',
+        maxLength: 250,
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "state", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'VAT',
+        description: 'VAT number of the user.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "vat", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Tax Office',
+        description: 'Tax office of the user.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], ClientDataDto.prototype, "taxOffice", void 0);

package/dist/dtos/company-data.dto.js

@@ -13,6 +13,7 @@ exports.CompanyDataDto = void 0;
 const class_validator_1 = require("class-validator");
 const country_enum_1 = require("../enums/country.enum");
 const language_enum_1 = require("../enums/language.enum");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
 /**
  * Data Transfer Object for company data.
  */
@@ -22,82 +23,178 @@ exports.CompanyDataDto = CompanyDataDto;
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'ID',
+        description: 'The unique identifier for the company.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "id", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Name',
+        description: 'The name of the company.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "name", void 0);
 __decorate([
     (0, class_validator_1.IsEmail)({}, { each: true }),
     (0, class_validator_1.IsArray)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Emails',
+        description: 'Email addresses associated with the company.',
+        type: 'array',
+        items: { type: 'string', format: 'email' },
+    }),
     __metadata("design:type", Array)
 ], CompanyDataDto.prototype, "emails", void 0);
 __decorate([
     (0, class_validator_1.IsEmail)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Invoice Email',
+        description: 'The email address used for invoicing.',
+        type: 'string',
+        format: 'email',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "invoiceEmail", void 0);
 __decorate([
     (0, class_validator_1.IsUrl)({ protocols: ['https'], require_protocol: true }),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Privacy Policy URL',
+        description: 'The URL for the company\'s privacy policy.',
+        type: 'string',
+        format: 'uri',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "privacyPolicyUrl", void 0);
 __decorate([
     (0, class_validator_1.IsEnum)(language_enum_1.LanguageEnum),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Default Language',
+        description: 'The default language for the company.',
+        type: 'string',
+        enum: Object.values(language_enum_1.LanguageEnum),
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "defaultLanguage", void 0);
 __decorate([
     (0, class_validator_1.IsEnum)(language_enum_1.LanguageEnum, { each: true }),
     (0, class_validator_1.IsArray)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Languages',
+        description: 'Supported languages for the company.',
+        type: 'array',
+        items: { type: 'string', enum: Object.values(language_enum_1.LanguageEnum) },
+    }),
     __metadata("design:type", Array)
 ], CompanyDataDto.prototype, "languages", void 0);
 __decorate([
     (0, class_validator_1.IsPhoneNumber)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Telephone',
+        description: 'The primary telephone number for the company.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "telephone", void 0);
 __decorate([
     (0, class_validator_1.IsPhoneNumber)(),
     (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Mobile',
+        description: 'The mobile phone number for the company.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "mobile", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Address Line 1',
+        description: 'The first line of the company\'s address.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "address1", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Address Line 2',
+        description: 'The second line of the company\'s address.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "address2", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Address Line 3',
+        description: 'The third line of the company\'s address.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "address3", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Postcode',
+        description: 'The postal code for the company\'s address.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "postcode", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'City',
+        description: 'The city for the company\'s address.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "city", void 0);
 __decorate([
     (0, class_validator_1.IsEnum)(country_enum_1.CountryEnum),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Country',
+        description: 'The country for the company\'s address.',
+        type: 'string',
+        enum: Object.values(country_enum_1.CountryEnum),
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "country", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'State',
+        description: 'The state or province for the company\'s address.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "state", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'VAT',
+        description: 'The VAT number for the company.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "vat", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Tax Office',
+        description: 'The tax office for the company.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CompanyDataDto.prototype, "taxOffice", void 0);

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

@@ -1,6 +1,13 @@
 import { CountryEnum } from '../enums/country.enum';
+/**
+ * Country information returned by the hoster.ai helper function.
+ * Used to provide a list of all available countries.
+ */
 export declare class CountryDto {
+    /** Country name */
     name: string;
+    /** Country code */
     code: CountryEnum;
+    /** Whether the country is in Europe */
     isEurope?: boolean;
 }