@hosterai/types 0.0.25 → 0.0.27

package/dist/dtos/country.dto.js

@@ -12,20 +12,41 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CountryDto = 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");
+/**
+ * Country information returned by the hoster.ai helper function.
+ * Used to provide a list of all available countries.
+ */
 class CountryDto {
 }
 exports.CountryDto = CountryDto;
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Name',
+        description: 'Country name.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], CountryDto.prototype, "name", void 0);
 __decorate([
     (0, class_validator_1.IsEnum)(country_enum_1.CountryEnum),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Code',
+        description: 'Country code.',
+        type: 'string',
+        enum: Object.values(country_enum_1.CountryEnum),
+    }),
     __metadata("design:type", String)
 ], CountryDto.prototype, "code", void 0);
 __decorate([
     (0, class_validator_1.IsBoolean)(),
     (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Is Europe',
+        description: 'Whether the country is in Europe.',
+        type: 'boolean',
+    }),
     __metadata("design:type", Boolean)
 ], CountryDto.prototype, "isEurope", void 0);

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

@@ -11,6 +11,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorResponseDto = void 0;
 const class_validator_1 = require("class-validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
 /**
  * DTO for error response.
  * Used to return detailed error information to the client.
@@ -21,11 +22,25 @@ exports.ErrorResponseDto = ErrorResponseDto;
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Code',
+        description: 'A unique and specific error code for programmatic error handling.',
+        type: 'number',
+        example: 400,
+    }),
     __metadata("design:type", Number)
 ], ErrorResponseDto.prototype, "code", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsArray)(),
     (0, class_validator_1.IsString)({ each: true }),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Errors',
+        description: 'A developer-friendly error message or an array of messages.',
+        oneOf: [
+            { type: 'string' },
+            { type: 'array', items: { type: 'string' } },
+        ],
+    }),
     __metadata("design:type", Object)
 ], ErrorResponseDto.prototype, "errors", void 0);

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

@@ -28,24 +28,18 @@ export declare class FieldDto {
      * Type of the field
      */
     type: FieldTypeEnum;
-    repeatableMin?: number;
-    repeatableMax?: number;
     /**
      * Indicates if the field is required
      */
-    required: boolean;
+    required?: boolean;
     /**
      * Indicates if the field is disabled
      */
-    disabled: boolean;
+    disabled?: boolean;
     /**
-     * Indicates if the field is hidden in order
+     * Indicates if the field is hidden
      */
-    visibleInOrder: boolean;
-    /**
-     * Indicates if the field is visible in client panel
-     */
-    visibleInClientPanel: boolean;
+    hidden?: boolean;
     /**
      * Regex validation pattern for the field
      */
@@ -55,11 +49,11 @@ export declare class FieldDto {
      */
     regexValidationErrorMessage?: MultilangTextDto[];
     /**
-     * Indicates if the field triggers remote validation
+     * Whether remote validation should be triggered
      */
     triggersRemoteValidation?: boolean;
     /**
-     * Error message for the field for supported languages
+     * Remote validation error message for supported languages
      */
     remoteValidationErrorMessage?: MultilangTextDto[];
     /**
@@ -67,5 +61,6 @@ export declare class FieldDto {
      * If the user has the permission to upgrade the item from his panel
      * TODO: Let's see if this approach is the best way for the user to upgrade their item
      */
-    upgradable: boolean;
+    upgradable?: boolean;
+    downgradable?: boolean;
 }

package/dist/dtos/field.dto.js

@@ -17,28 +17,23 @@ const field_type_enum_1 = require("../enums/field-type.enum");
 const multilang_text_dto_1 = require("./multilang-text.dto");
 const field_option_dto_1 = require("./field-option.dto");
 const is_regex_validator_1 = require("../decorators/is-regex.validator");
-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");
 const class_validator_jsonschema_1 = require("class-validator-jsonschema");
 /**
  * Data Transfer Object for a form field.
  * This class defines the structure and properties of a single field
  * that can be used in a user interface form.
  */
-let FieldDto = class FieldDto {
+class FieldDto {
     constructor() {
-        /**
-         * Indicates if the field triggers remote validation
-         */
-        this.triggersRemoteValidation = false;
         /**
          * The item attribute is upgradable
          * If the user has the permission to upgrade the item from his panel
          * TODO: Let's see if this approach is the best way for the user to upgrade their item
          */
         this.upgradable = false;
+        this.downgradable = false;
     }
-};
+}
 exports.FieldDto = FieldDto;
 __decorate([
     (0, class_validator_1.IsString)(),
@@ -99,16 +94,6 @@ __decorate([
     }),
     __metadata("design:type", String)
 ], FieldDto.prototype, "type", void 0);
-__decorate([
-    (0, class_validator_1.IsOptional)(),
-    (0, class_validator_1.IsNumber)(),
-    __metadata("design:type", Number)
-], FieldDto.prototype, "repeatableMin", void 0);
-__decorate([
-    (0, class_validator_1.IsOptional)(),
-    (0, class_validator_1.IsNumber)(),
-    __metadata("design:type", Number)
-], FieldDto.prototype, "repeatableMax", void 0);
 __decorate([
     (0, class_validator_1.IsBoolean)(),
     (0, class_validator_1.IsDefined)(),
@@ -131,24 +116,9 @@ __decorate([
 ], FieldDto.prototype, "disabled", void 0);
 __decorate([
     (0, class_validator_1.IsBoolean)(),
-    (0, class_validator_1.IsDefined)(),
-    (0, class_validator_jsonschema_1.JSONSchema)({
-        title: 'Visible In Order',
-        description: 'Whether the field is visible in order.',
-        type: 'boolean',
-    }),
-    __metadata("design:type", Boolean)
-], FieldDto.prototype, "visibleInOrder", void 0);
-__decorate([
-    (0, class_validator_1.IsBoolean)(),
-    (0, class_validator_1.IsDefined)(),
-    (0, class_validator_jsonschema_1.JSONSchema)({
-        title: 'Visible In Client Panel',
-        description: 'Whether the field is visible in client panel.',
-        type: 'boolean',
-    }),
+    (0, class_validator_1.IsOptional)(),
     __metadata("design:type", Boolean)
-], FieldDto.prototype, "visibleInClientPanel", void 0);
+], FieldDto.prototype, "hidden", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, is_regex_validator_1.IsRegex)(),
@@ -165,6 +135,8 @@ __decorate([
     (0, class_validator_1.ValidateIf)((o) => !!o.regexValidation),
     (0, class_validator_1.ValidateNested)({ each: true }),
     (0, class_transformer_1.Type)(() => multilang_text_dto_1.MultilangTextDto),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ArrayMinSize)(1),
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Regex Validation Error Message',
@@ -177,21 +149,18 @@ __decorate([
 __decorate([
     (0, class_validator_1.IsBoolean)(),
     (0, class_validator_1.IsOptional)(),
-    (0, class_validator_jsonschema_1.JSONSchema)({
-        title: 'Triggers Remote Validation',
-        description: 'If true, field triggers remote validation.',
-        type: 'boolean',
-    }),
     __metadata("design:type", Boolean)
 ], FieldDto.prototype, "triggersRemoteValidation", void 0);
 __decorate([
-    (0, class_validator_1.ValidateIf)((o) => o.triggersRemoteValidation === true),
+    (0, class_validator_1.ValidateIf)((o) => !!o.triggersRemoteValidation),
     (0, class_validator_1.ValidateNested)({ each: true }),
     (0, class_transformer_1.Type)(() => multilang_text_dto_1.MultilangTextDto),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ArrayMinSize)(1),
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Remote Validation Error Message',
-        description: 'Localized error messages for remote validation.',
+        description: 'Localized error message shown when remote validation fails.',
         type: 'array',
         items: { $ref: '#/components/schemas/MultilangTextDto' },
     }),
@@ -199,7 +168,7 @@ __decorate([
 ], FieldDto.prototype, "remoteValidationErrorMessage", void 0);
 __decorate([
     (0, class_validator_1.IsBoolean)(),
-    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsOptional)(),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Upgradable',
         description: 'Whether the item attribute is upgradable by the user.',
@@ -207,7 +176,13 @@ __decorate([
     }),
     __metadata("design:type", Boolean)
 ], FieldDto.prototype, "upgradable", void 0);
-exports.FieldDto = FieldDto = __decorate([
-    (0, all_or_none_validator_1.AllOrNoneProperty)(['repeatableMin', 'repeatableMax']),
-    (0, min_less_or_equal_validator_1.MinLessOrEqualMaxProperty)(['repeatableMin', 'repeatableMax'])
-], FieldDto);
+__decorate([
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Downgradable',
+        description: 'Whether the item attribute is downgradable by the user.',
+        type: 'boolean',
+    }),
+    __metadata("design:type", Boolean)
+], FieldDto.prototype, "downgradable", void 0);

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

@@ -1,4 +1,3 @@
-import { ActionsEnum } from '../enums/actions.enum';
 import { EventsEnum } from '../enums/events.enum';
 import { LanguageEnum } from '../enums/language.enum';
 import { RolesEnum } from '../enums/roles.enum';
@@ -31,10 +30,6 @@ export declare class InfoDto {
      * A list of languages supported by the integration.
      */
     supportedLanguages: LanguageEnum[];
-    /**
-     * A list of actions that are supported by this integration.
-     */
-    supportedActions?: ActionsEnum[];
     /**
      * A list of events that the integration listens to.
      * This allows the integration to react to specific events in the system.

package/dist/dtos/info.dto.js

@@ -10,7 +10,6 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoDto = void 0;
-const actions_enum_1 = require("../enums/actions.enum");
 const events_enum_1 = require("../enums/events.enum");
 const language_enum_1 = require("../enums/language.enum");
 const roles_enum_1 = require("../enums/roles.enum");
@@ -31,12 +30,6 @@ const unique_field_in_array_validator_1 = require("../decorators/unique-field-in
  * and billing details.
  */
 class InfoDto {
-    constructor() {
-        /**
-         * A list of actions that are supported by this integration.
-         */
-        this.supportedActions = [];
-    }
 }
 exports.InfoDto = InfoDto;
 __decorate([
@@ -87,18 +80,6 @@ __decorate([
     }),
     __metadata("design:type", Array)
 ], InfoDto.prototype, "supportedLanguages", void 0);
-__decorate([
-    (0, class_validator_1.IsOptional)(),
-    (0, class_validator_1.IsArray)(),
-    (0, class_validator_1.IsEnum)(actions_enum_1.ActionsEnum, { each: true }),
-    (0, class_validator_jsonschema_1.JSONSchema)({
-        title: 'Supported Actions',
-        description: 'Actions supported by this integration.',
-        type: 'array',
-        items: { type: 'string', enum: Object.values(actions_enum_1.ActionsEnum) }
-    }),
-    __metadata("design:type", Array)
-], InfoDto.prototype, "supportedActions", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsArray)(),

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

@@ -0,0 +1,15 @@
+import { CountryEnum } from "../../enums/country.enum";
+import { InfoDto } from "../info.dto";
+import { InvoiceTypesEnum } from "../../enums/invoice/invoice-types.enum";
+/**
+ * Invoice integration information.
+ * Extends base integration info with invoice-specific configuration.
+ */
+export declare class InvoiceInfoDto extends InfoDto {
+    /** Countries supported by this invoice integration */
+    supportedCountries: CountryEnum[];
+    /**
+     * A list of actions that are supported by this integration.
+     */
+    supportedTypes: InvoiceTypesEnum[];
+}

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

@@ -0,0 +1,42 @@
+"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.InvoiceInfoDto = void 0;
+const class_validator_1 = require("class-validator");
+const info_dto_1 = require("../info.dto");
+const invoice_types_enum_1 = require("../../enums/invoice/invoice-types.enum");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
+/**
+ * Invoice integration information.
+ * Extends base integration info with invoice-specific configuration.
+ */
+class InvoiceInfoDto extends info_dto_1.InfoDto {
+    constructor() {
+        super(...arguments);
+        /**
+         * A list of actions that are supported by this integration.
+         */
+        this.supportedTypes = [];
+    }
+}
+exports.InvoiceInfoDto = InvoiceInfoDto;
+__decorate([
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.IsEnum)(invoice_types_enum_1.InvoiceTypesEnum, { each: true }),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Supported Types',
+        description: 'Types of invoice supported by this integration.',
+        type: 'array',
+        items: { type: 'string', enum: Object.values(invoice_types_enum_1.InvoiceTypesEnum) }
+    }),
+    __metadata("design:type", Array)
+], InvoiceInfoDto.prototype, "supportedTypes", void 0);

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

@@ -0,0 +1,10 @@
+import { InvoiceItemActionsEnum } from "../../enums/invoice/invoice-item-actions.enum";
+import { ItemDataDto } from "../item-data.dto";
+/**
+ * Order product item data sent to invoice integrations.
+ * Uses invoice-specific actions to avoid confusion with product integration actions.
+ */
+export declare class InvoiceItemDataDto extends ItemDataDto {
+    /** Invoice-specific action type for this item */
+    action: InvoiceItemActionsEnum;
+}

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

@@ -0,0 +1,34 @@
+"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.InvoiceItemDataDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
+const invoice_item_actions_enum_1 = require("../../enums/invoice/invoice-item-actions.enum");
+const item_data_dto_1 = require("../item-data.dto");
+/**
+ * Order product item data sent to invoice integrations.
+ * Uses invoice-specific actions to avoid confusion with product integration actions.
+ */
+class InvoiceItemDataDto extends item_data_dto_1.ItemDataDto {
+}
+exports.InvoiceItemDataDto = InvoiceItemDataDto;
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsEnum)(invoice_item_actions_enum_1.InvoiceItemActionsEnum),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Action',
+        description: 'Invoice-specific action type for this item.',
+        type: 'string',
+        enum: Object.values(invoice_item_actions_enum_1.InvoiceItemActionsEnum),
+    }),
+    __metadata("design:type", String)
+], InvoiceItemDataDto.prototype, "action", void 0);

package/dist/dtos/invoice/requests/credit-note-request.dto.d.ts

@@ -0,0 +1,9 @@
+import { ProformaInvoiceRequestDto } from "./proforma-invoice-request.dto";
+/**
+ * Request payload for creating a credit note.
+ * Extends proforma invoice with minimal variations to keep the API clean for invoice integration developers.
+ */
+export declare class CreditNoteRequestDto extends ProformaInvoiceRequestDto {
+    /** Reference to the parent invoice being credited */
+    parentInvoiceId: string;
+}

package/dist/dtos/invoice/requests/credit-note-request.dto.js

@@ -0,0 +1,32 @@
+"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.CreditNoteRequestDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
+const proforma_invoice_request_dto_1 = require("./proforma-invoice-request.dto");
+/**
+ * Request payload for creating a credit note.
+ * Extends proforma invoice with minimal variations to keep the API clean for invoice integration developers.
+ */
+class CreditNoteRequestDto extends proforma_invoice_request_dto_1.ProformaInvoiceRequestDto {
+}
+exports.CreditNoteRequestDto = CreditNoteRequestDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Parent Invoice ID',
+        description: 'Reference to the parent invoice being credited.',
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], CreditNoteRequestDto.prototype, "parentInvoiceId", void 0);

package/dist/dtos/invoice/requests/invoice-request.dto.d.ts

@@ -0,0 +1,9 @@
+import { ProformaInvoiceRequestDto } from "./proforma-invoice-request.dto";
+/**
+ * Request payload for creating a standard invoice.
+ * Extends proforma invoice with minimal variations to keep the API clean for invoice integration developers.
+ */
+export declare class InvoiceRequestDto extends ProformaInvoiceRequestDto {
+    /** Reference to parent invoice if applicable */
+    parentInvoiceId?: string;
+}

package/dist/dtos/invoice/requests/invoice-request.dto.js

@@ -0,0 +1,32 @@
+"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.InvoiceRequestDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
+const proforma_invoice_request_dto_1 = require("./proforma-invoice-request.dto");
+/**
+ * Request payload for creating a standard invoice.
+ * Extends proforma invoice with minimal variations to keep the API clean for invoice integration developers.
+ */
+class InvoiceRequestDto extends proforma_invoice_request_dto_1.ProformaInvoiceRequestDto {
+}
+exports.InvoiceRequestDto = InvoiceRequestDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Parent Invoice ID',
+        description: 'Reference to parent invoice if applicable.',
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], InvoiceRequestDto.prototype, "parentInvoiceId", void 0);

package/dist/dtos/invoice/requests/proforma-invoice-request.dto.d.ts

@@ -0,0 +1,24 @@
+import { InvoiceContactData } from "../../invoice-contact-data.dto";
+import { InvoiceItemDataDto } from "../invoice-item-data.dto";
+import { TransactionData } from "../transaction-data.dto";
+import { CountryEnum } from '../../../enums/country.enum';
+/**
+ * Request payload for creating a proforma invoice.
+ * Sent from hoster.ai to invoice integrations to issue a proforma document.
+ */
+export declare class ProformaInvoiceRequestDto {
+    /** Unique identifier for the invoice */
+    invoiceId: string;
+    /** Company identifier issuing the invoice */
+    companyId: string;
+    /** Country where the company is registered */
+    companyCountry: CountryEnum;
+    /** List of transactions associated with this invoice */
+    transactions: TransactionData[];
+    /** Billing contact information for the invoice recipient */
+    invoiceContact: InvoiceContactData;
+    /** Line items included in the invoice */
+    items: InvoiceItemDataDto[];
+    /** Total invoice amount */
+    totalAmount: number;
+}

package/dist/dtos/invoice/requests/proforma-invoice-request.dto.js

@@ -0,0 +1,104 @@
+"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.ProformaInvoiceRequestDto = void 0;
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
+const invoice_contact_data_dto_1 = require("../../invoice-contact-data.dto");
+const invoice_item_data_dto_1 = require("../invoice-item-data.dto");
+const transaction_data_dto_1 = require("../transaction-data.dto");
+const country_enum_1 = require("../../../enums/country.enum");
+/**
+ * Request payload for creating a proforma invoice.
+ * Sent from hoster.ai to invoice integrations to issue a proforma document.
+ */
+class ProformaInvoiceRequestDto {
+}
+exports.ProformaInvoiceRequestDto = ProformaInvoiceRequestDto;
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Invoice ID',
+        description: 'Unique identifier for the invoice.',
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], ProformaInvoiceRequestDto.prototype, "invoiceId", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Company ID',
+        description: 'Company identifier issuing the invoice.',
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], ProformaInvoiceRequestDto.prototype, "companyId", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsEnum)(country_enum_1.CountryEnum),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Company Country',
+        description: 'Country where the company is registered.',
+        type: 'string',
+        enum: Object.values(country_enum_1.CountryEnum),
+    }),
+    __metadata("design:type", String)
+], ProformaInvoiceRequestDto.prototype, "companyCountry", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => transaction_data_dto_1.TransactionData),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Transactions',
+        description: 'List of transactions associated with this invoice.',
+        type: 'array',
+        items: { $ref: '#/components/schemas/TransactionData' },
+    }),
+    __metadata("design:type", Array)
+], ProformaInvoiceRequestDto.prototype, "transactions", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => invoice_contact_data_dto_1.InvoiceContactData),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Invoice Contact',
+        description: 'Billing contact information for the invoice recipient.',
+        $ref: '#/components/schemas/InvoiceContactData',
+    }),
+    __metadata("design:type", invoice_contact_data_dto_1.InvoiceContactData)
+], ProformaInvoiceRequestDto.prototype, "invoiceContact", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => invoice_item_data_dto_1.InvoiceItemDataDto),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Items',
+        description: 'Line items included in the invoice.',
+        type: 'array',
+        items: { $ref: '#/components/schemas/InvoiceItemDataDto' },
+    }),
+    __metadata("design:type", Array)
+], ProformaInvoiceRequestDto.prototype, "items", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsNumber)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Total Amount',
+        description: 'Total invoice amount.',
+        type: 'number',
+    }),
+    __metadata("design:type", Number)
+], ProformaInvoiceRequestDto.prototype, "totalAmount", void 0);