@hosterai/types 0.0.27 → 0.0.29

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

@@ -44,7 +44,7 @@ __decorate([
         title: 'Product Attributes',
         description: 'Configurable attributes that apply at the product level.',
         type: 'array',
-        items: { $ref: '#/components/schemas/AttributeFieldDto' }
+        items: { $ref: '#/components/schemas/AttributeFieldDto' },
     }),
     __metadata("design:type", Array)
 ], ProductInfoDto.prototype, "productAttributes", void 0);
@@ -59,7 +59,7 @@ __decorate([
         title: 'Item Attributes',
         description: 'Configurable attributes that apply at the item level.',
         type: 'array',
-        items: { $ref: '#/components/schemas/AttributeFieldDto' }
+        items: { $ref: '#/components/schemas/AttributeFieldDto' },
     }),
     __metadata("design:type", Array)
 ], ProductInfoDto.prototype, "itemAttributes", void 0);
@@ -74,7 +74,13 @@ __decorate([
         description: 'Optional metering units for pay-per-use billing.',
         type: 'array',
         items: { $ref: '#/components/schemas/UnitDto' },
-        example: [{ id: 'requests', unitDescription: 'API request', intervalDescription: 'Per month' }]
+        example: [
+            {
+                id: 'requests',
+                unitDescription: 'API request',
+                intervalDescription: 'Per month',
+            },
+        ],
     }),
     __metadata("design:type", Array)
 ], ProductInfoDto.prototype, "payPerUseUnits", void 0);
@@ -86,7 +92,7 @@ __decorate([
         description: 'Mapping of field names used in provider responses.',
         type: 'object',
         additionalProperties: { type: 'string' },
-        example: { external_id: 'id', status_text: 'status' }
+        example: { external_id: 'id', status_text: 'status' },
     }),
     __metadata("design:type", Object)
 ], ProductInfoDto.prototype, "responseDataFieldNames", void 0);
@@ -98,7 +104,7 @@ __decorate([
         title: 'Supported Actions',
         description: 'Actions supported by this integration.',
         type: 'array',
-        items: { type: 'string', enum: Object.values(item_actions_enum_1.ProductItemActionsEnum) }
+        items: { type: 'string', enum: Object.values(item_actions_enum_1.ProductItemActionsEnum) },
     }),
     __metadata("design:type", Array)
 ], ProductInfoDto.prototype, "supportedActions", void 0);

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

@@ -1,5 +1,5 @@
-import { ProductItemActionsEnum } from "../../enums/item-actions.enum";
-import { ItemDataDto } from "../item-data.dto";
+import { ProductItemActionsEnum } from '../../enums/item-actions.enum';
+import { ItemDataDto } from '../item-data.dto';
 /**
  * Product item data sent to product integrations.
  * Uses product-specific actions distinct from invoice integration actions.

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

@@ -29,7 +29,7 @@ __decorate([
     (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Client Data',
-        description: 'The client\'s data for the request.',
+        description: "The client's data for the request.",
         $ref: '#/components/schemas/ClientDataDto',
     }),
     __metadata("design:type", client_data_dto_1.ClientDataDto)

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

@@ -29,8 +29,8 @@ __decorate([
     (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Client Data',
-        description: 'The client\'s data initiating the request.',
-        type: 'object',
+        description: "The client's data initiating the request.",
+        $ref: '#/components/schemas/ClientDataDto',
     }),
     __metadata("design:type", client_data_dto_1.ClientDataDto)
 ], ProductDeleteRequestDto.prototype, "clientData", void 0);
@@ -42,7 +42,7 @@ __decorate([
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Item Data',
         description: 'The data of the product item to be deleted.',
-        type: 'object',
+        $ref: '#/components/schemas/ProductItemDataDto',
     }),
     __metadata("design:type", product_item_data_dto_1.ProductItemDataDto)
 ], ProductDeleteRequestDto.prototype, "itemData", void 0);

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

@@ -29,7 +29,7 @@ __decorate([
     (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Client Data',
-        description: 'The client\'s data for the request.',
+        description: "The client's data for the request.",
         $ref: '#/components/schemas/ClientDataDto',
     }),
     __metadata("design:type", client_data_dto_1.ClientDataDto)

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

@@ -29,7 +29,7 @@ __decorate([
     (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Client Data',
-        description: 'The client\'s data for the request.',
+        description: "The client's data for the request.",
         $ref: '#/components/schemas/ClientDataDto',
     }),
     __metadata("design:type", client_data_dto_1.ClientDataDto)

package/dist/dtos/product/requests/product-downgradeable-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-downgradeable-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-renew-request.dto.js

@@ -29,7 +29,7 @@ __decorate([
     (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Client Data',
-        description: 'The client\'s data for the request.',
+        description: "The client's data for the request.",
         $ref: '#/components/schemas/ClientDataDto',
     }),
     __metadata("design:type", client_data_dto_1.ClientDataDto)

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

@@ -29,7 +29,7 @@ __decorate([
     (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Client Data',
-        description: 'The client\'s data for the request.',
+        description: "The client's data for the request.",
         $ref: '#/components/schemas/ClientDataDto',
     }),
     __metadata("design:type", client_data_dto_1.ClientDataDto)

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

@@ -29,7 +29,7 @@ __decorate([
     (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Client Data',
-        description: 'The client\'s data for the request.',
+        description: "The client's data for the request.",
         $ref: '#/components/schemas/ClientDataDto',
     }),
     __metadata("design:type", client_data_dto_1.ClientDataDto)

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

@@ -29,7 +29,7 @@ __decorate([
     (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Client Data',
-        description: 'The client\'s data for the request.',
+        description: "The client's data for the request.",
         $ref: '#/components/schemas/ClientDataDto',
     }),
     __metadata("design:type", client_data_dto_1.ClientDataDto)

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

@@ -29,7 +29,7 @@ __decorate([
     (0, class_transformer_1.Type)(() => client_data_dto_1.ClientDataDto),
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Client Data',
-        description: 'The client\'s data for the request.',
+        description: "The client's data for the request.",
         $ref: '#/components/schemas/ClientDataDto',
     }),
     __metadata("design:type", client_data_dto_1.ClientDataDto)

package/dist/dtos/product/requests/product-upgradeable-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 upgradeable.
+ * This DTO contains all the necessary information for the check.
+ */
+export declare class ProductUpgradeableRequestDto {
+    /**
+     * 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-upgradeable-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.ProductUpgradeableRequestDto = 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 upgradeable.
+ * This DTO contains all the necessary information for the check.
+ */
+class ProductUpgradeableRequestDto {
+}
+exports.ProductUpgradeableRequestDto = ProductUpgradeableRequestDto;
+__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)
+], ProductUpgradeableRequestDto.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)
+], ProductUpgradeableRequestDto.prototype, "itemData", void 0);

package/dist/dtos/product/responses/product-downgradeable-response.dto.d.ts

@@ -0,0 +1,22 @@
+import { ResponseStatusEnum } from '../../../enums/response-status.enum';
+import { BaseResponse } from '../../base-response.dto';
+/**
+ * Represents the response for a product downgradeable check.
+ * It indicates whether a product item is downgradeable and may contain additional data.
+ */
+export declare class ProductDowngradeableResponseDto extends BaseResponse {
+    /**
+     * The status of the response, indicating success or failure.
+     */
+    status: ResponseStatusEnum;
+    /**
+     * The unique identifier of the product item being checked.
+     */
+    itemId: string;
+    /**
+     * Optional data associated with the downgradeable check.
+     * Can contain details about available downgrades or reasons for failure.
+     * @optional
+     */
+    data?: Record<string, unknown>;
+}

package/dist/dtos/product/responses/product-downgradeable-response.dto.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductDowngradeableResponseDto = void 0;
+const base_response_dto_1 = require("../../base-response.dto");
+/**
+ * Represents the response for a product downgradeable check.
+ * It indicates whether a product item is downgradeable and may contain additional data.
+ */
+class ProductDowngradeableResponseDto extends base_response_dto_1.BaseResponse {
+}
+exports.ProductDowngradeableResponseDto = ProductDowngradeableResponseDto;

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

@@ -28,7 +28,7 @@ __decorate([
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Info',
         description: 'The detailed information of the product.',
-        type: 'object',
+        $ref: '#/components/schemas/ProductInfoDto',
     }),
     __metadata("design:type", product_info_dto_1.ProductInfoDto)
 ], ProductInfoResponseDto.prototype, "info", void 0);

package/dist/dtos/product/responses/product-upgradeable-response.dto.d.ts

@@ -0,0 +1,22 @@
+import { ResponseStatusEnum } from '../../../enums/response-status.enum';
+import { BaseResponse } from '../../base-response.dto';
+/**
+ * Represents the response for a product upgradeable check.
+ * It indicates whether a product item is upgradeable and may contain additional data.
+ */
+export declare class ProductUpgradeableResponseDto extends BaseResponse {
+    /**
+     * The status of the response, indicating success or failure.
+     */
+    status: ResponseStatusEnum;
+    /**
+     * The unique identifier of the product item being checked.
+     */
+    itemId: string;
+    /**
+     * Optional data associated with the upgradeable check.
+     * Can contain details about available upgrades or reasons for failure.
+     * @optional
+     */
+    data?: Record<string, unknown>;
+}

package/dist/dtos/product/responses/product-upgradeable-response.dto.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductUpgradeableResponseDto = void 0;
+const base_response_dto_1 = require("../../base-response.dto");
+/**
+ * Represents the response for a product upgradeable check.
+ * It indicates whether a product item is upgradeable and may contain additional data.
+ */
+class ProductUpgradeableResponseDto extends base_response_dto_1.BaseResponse {
+}
+exports.ProductUpgradeableResponseDto = ProductUpgradeableResponseDto;

package/dist/dtos/responses/validate-attributes-response.dto.d.ts

@@ -1,5 +1,5 @@
-import { BaseResponse } from "../base-response.dto";
-import { FieldDto } from "../field.dto";
+import { BaseResponse } from '../base-response.dto';
+import { FieldDto } from '../field.dto';
 /**
  * Represents the response from validating product attributes.
  * Contains the list of attributes that have been validated.

package/dist/dtos/tab.dto.js

@@ -25,7 +25,7 @@ __decorate([
     (0, class_validator_jsonschema_1.JSONSchema)({
         title: 'Label',
         description: 'Text label for the tab.',
-        type: 'string'
+        type: 'string',
     }),
     __metadata("design:type", String)
 ], TabDto.prototype, "label", void 0);
@@ -36,7 +36,7 @@ __decorate([
         title: 'URL',
         description: 'URL associated with the tab.',
         type: 'string',
-        format: 'uri'
+        format: 'uri',
     }),
     __metadata("design:type", String)
 ], TabDto.prototype, "url", void 0);

package/dist/dtos/tax-manager/tax-details-request.dto.d.ts

@@ -0,0 +1,31 @@
+import { CountryEnum } from '../../enums/country.enum';
+/**
+ * Request payload for calculating tax details.
+ * Contains company and customer location information for tax rate determination.
+ */
+export declare class TaxDetailsRequestDto {
+    /**
+     * Country where the company is registered
+     */
+    companyCountry: CountryEnum;
+    /**
+     * Country where the customer is located
+     */
+    customerCountry: CountryEnum;
+    /**
+     * Customer's Tax Identification Number
+     */
+    customerTIN: string;
+    /**
+     * Customer's postal code
+     */
+    customerPostalCode?: string;
+    /**
+     * Customer's state or province
+     */
+    customerState?: string;
+    /**
+     * Indicates whether the customer address has been validated
+     */
+    validatedAddress?: boolean;
+}

package/dist/dtos/tax-manager/tax-details-request.dto.js

@@ -0,0 +1,84 @@
+"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.TaxDetailsRequestDto = 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");
+/**
+ * Request payload for calculating tax details.
+ * Contains company and customer location information for tax rate determination.
+ */
+class TaxDetailsRequestDto {
+}
+exports.TaxDetailsRequestDto = TaxDetailsRequestDto;
+__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)
+], TaxDetailsRequestDto.prototype, "companyCountry", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsEnum)(country_enum_1.CountryEnum),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Customer Country',
+        description: 'Country where the customer is located.',
+        type: 'string',
+        enum: Object.values(country_enum_1.CountryEnum),
+    }),
+    __metadata("design:type", String)
+], TaxDetailsRequestDto.prototype, "customerCountry", void 0);
+__decorate([
+    (0, class_validator_1.IsDefined)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Customer TIN',
+        description: "Customer's Tax Identification Number.",
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], TaxDetailsRequestDto.prototype, "customerTIN", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Customer Postal Code',
+        description: "Customer's postal code.",
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], TaxDetailsRequestDto.prototype, "customerPostalCode", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Customer State',
+        description: "Customer's state or province.",
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], TaxDetailsRequestDto.prototype, "customerState", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsBoolean)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Validated Address',
+        description: 'Whether the customer address has been validated.',
+        type: 'boolean',
+    }),
+    __metadata("design:type", Boolean)
+], TaxDetailsRequestDto.prototype, "validatedAddress", void 0);

package/dist/dtos/unit.dto.js

@@ -27,7 +27,7 @@ __decorate([
         title: 'Unit ID',
         description: 'Unit identifier.',
         type: 'string',
-        example: 'messages'
+        example: 'messages',
     }),
     __metadata("design:type", String)
 ], UnitDto.prototype, "id", void 0);
@@ -39,7 +39,7 @@ __decorate([
         title: 'Unit Description',
         description: 'What is measured.',
         type: 'string',
-        example: 'Message sent'
+        example: 'Message sent',
     }),
     __metadata("design:type", String)
 ], UnitDto.prototype, "unitDescription", void 0);
@@ -51,7 +51,7 @@ __decorate([
         title: 'Interval Description',
         description: 'Billing interval.',
         type: 'string',
-        example: 'Per month'
+        example: 'Per month',
     }),
     __metadata("design:type", String)
 ], UnitDto.prototype, "intervalDescription", void 0);

package/dist/enums/country.enum.d.ts

@@ -1,4 +1,4 @@
-import { CountryDto } from "../dtos/country.dto";
+import { CountryDto } from '../dtos/country.dto';
 export declare enum CountryEnum {
     AFGHANISTAN = "AF",
     ALAND_ISLANDS = "AX",