@monocloud/management-core 0.1.2 → 0.2.0

package/dist/index.d.cts

@@ -1,102 +1,323 @@
 //#region src/exceptions/monocloud-exception.d.ts
+/**
+ * The MonoCloud Exception
+ * @export
+ * @class MonoCloudException
+ */
 declare class MonoCloudException extends Error {}
 //#endregion
 //#region src/models/problem-details.d.ts
+/**
+ * The Problem Details
+ * @export
+ * @class ProblemDetails
+ */
 declare class ProblemDetails {
+  /**
+   * The type of error
+   * @type {string}
+   * @memberof ProblemDetails
+   */
   type: string;
+  /**
+   * The title of the error
+   * @type {string}
+   * @memberof ProblemDetails
+   */
   title: string;
+  /**
+   * The status code representing the error
+   * @type {number}
+   * @memberof ProblemDetails
+   */
   status: number;
+  /**
+   * The error details
+   * @type {string}
+   * @memberof ProblemDetails
+   */
   detail: string;
+  /**
+   * The instance
+   * @type {string}
+   * @memberof ProblemDetails
+   */
   instance: string;
+  /**
+   * Additional data about the error
+   */
   [key: string]: any;
   constructor(response: ProblemDetails);
 }
 //#endregion
 //#region src/exceptions/monocloud-request-exception.d.ts
 declare class MonoCloudRequestException extends MonoCloudException {
+  /**
+   * The problem details received from the server.
+   * @type {ProblemDetails}
+   * @memberof MonoCloudRequestException
+   */
   response?: ProblemDetails;
+  /**
+   * Initializes the MonoCloudRequestException Class
+   * @param response - The problem details returned from the server.
+   */
   constructor(response: ProblemDetails);
+  /**
+   * Initializes the MonoCloudRequestException Class
+   * @param message - The error message.
+   */
   constructor(message: string);
+  /**
+   * Initializes the MonoCloudRequestException Class
+   * @param response - The problem details returned from the server.
+   * @param message - The error message.
+   */
   constructor(response: ProblemDetails, message: string);
 }
 //#endregion
 //#region src/exceptions/monocloud-bad-request-exception.d.ts
+/**
+ * The MonoCloud Bad Request Exception
+ * @export
+ * @class MonoCloudBadRequestException
+ */
 declare class MonoCloudBadRequestException extends MonoCloudRequestException {
+  /**
+   * Initializes the MonoCloudBadRequestException Class
+   * @param response - The problem details returned from the server.
+   */
   constructor(response: ProblemDetails);
+  /**
+   * Initializes the MonoCloudBadRequestException Class
+   * @param message - The error message.
+   */
   constructor(message: string);
 }
 //#endregion
 //#region src/exceptions/monocloud-conflict-exception.d.ts
+/**
+ * The MonoCloud Conflict Exception
+ * @export
+ * @class MonoCloudConflictException
+ */
 declare class MonoCloudConflictException extends MonoCloudRequestException {
+  /**
+   * Initializes the MonoCloudConflictException Class
+   * @param response - The problem details returned from the server.
+   */
   constructor(response: ProblemDetails);
+  /**
+   * Initializes the MonoCloudConflictException Class
+   * @param message - The error message.
+   */
   constructor(message: string);
 }
 //#endregion
-//#region src/models/error-code-validation-error.d.ts
-declare class ErrorCodeValidationError {
+//#region src/models/identity-error.d.ts
+/**
+ * Identity Error: Represents a validation or processing error returned by the identity system.
+ * @export
+ * @class IdentityError
+ */
+declare class IdentityError {
+  /**
+   * Machine-readable error code.
+   * @type {string}
+   * @memberof IdentityError
+   */
   code: string;
+  /**
+   * Human-readable description of the error.
+   * @type {string}
+   * @memberof IdentityError
+   */
   description: string;
-  field?: string;
-  constructor(code: string, description: string, field?: string);
+  constructor(code: string, description: string);
 }
 //#endregion
-//#region src/models/error-code-validation-problem-details.d.ts
-declare class ErrorCodeValidationProblemDetails extends ProblemDetails {
-  errors: ErrorCodeValidationError[];
+//#region src/models/identity-validation-problem-details.d.ts
+declare class IdentityValidationProblemDetails extends ProblemDetails {
+  errors: IdentityError[];
   constructor(response: ProblemDetails);
 }
 //#endregion
-//#region src/exceptions/monocloud-error-code-validation-exception.d.ts
-declare class MonoCloudErrorCodeValidationException extends MonoCloudRequestException {
-  errors: ErrorCodeValidationError[];
-  constructor(response: ErrorCodeValidationProblemDetails);
+//#region src/exceptions/monocloud-identity-validation-exception.d.ts
+/**
+ * The MonoCloud Identity Validation Exception
+ * @export
+ * @class MonoCloudIdentityValidationException
+ */
+declare class MonoCloudIdentityValidationException extends MonoCloudRequestException {
+  errors: IdentityError[];
+  /**
+   * Initializes the MonoCloudIdentityValidationException Class
+   * @param response - The problem details returned from the server.
+   */
+  constructor(response: IdentityValidationProblemDetails);
 }
 //#endregion
 //#region src/exceptions/monocloud-forbidden-exception.d.ts
+/**
+ * The MonoCloud Forbidden Exception
+ * @export
+ * @class MonoCloudForbiddenException
+ */
 declare class MonoCloudForbiddenException extends MonoCloudRequestException {
+  /**
+   * Initializes the MonoCloudForbiddenException Class
+   * @param response - The problem details returned from the server.
+   */
   constructor(response: ProblemDetails);
+  /**
+   * Initializes the MonoCloudForbiddenException Class
+   * @param message - The error message.
+   */
   constructor(message: string);
 }
 //#endregion
 //#region src/models/key-validation-problem-details.d.ts
+/**
+ * The Key Validation Problem Details
+ * @export
+ * @class KeyValidationProblemDetails
+ */
 declare class KeyValidationProblemDetails extends ProblemDetails {
+  /**
+   * A collection of errors
+   * @type {Record<string, string[]>}
+   * @memberof KeyValidationProblemDetails
+   */
   errors: Record<string, string[]>;
   constructor(response: ProblemDetails);
 }
 //#endregion
 //#region src/exceptions/monocloud-key-validation-exception.d.ts
+/**
+ * The MonoCloud Key Validation Exception
+ * @export
+ * @class MonoCloudKeyValidationException
+ */
 declare class MonoCloudKeyValidationException extends MonoCloudRequestException {
   errors: Record<string, string[]>;
+  /**
+   * Initializes the MonoCloudKeyValidationException Class
+   * @param response - The problem details returned from the server.
+   */
   constructor(response: KeyValidationProblemDetails);
 }
 //#endregion
 //#region src/exceptions/monocloud-model-state-exception.d.ts
+/**
+ * The MonoCloud Model State Exception
+ * @export
+ * @class MonoCloudModelStateException
+ */
 declare class MonoCloudModelStateException extends MonoCloudRequestException {
+  /**
+   * Initializes the MonoCloudModelStateException Class
+   * @param response - The problem details returned from the server.
+   */
   constructor(response: ProblemDetails);
+  /**
+   * Initializes the MonoCloudModelStateException Class
+   * @param message - The error message.
+   */
   constructor(message: string);
 }
 //#endregion
 //#region src/exceptions/monocloud-not-found-exception.d.ts
+/**
+ * The MonoCloud Not Found Exception
+ * @export
+ * @class MonoCloudNotFoundException
+ */
 declare class MonoCloudNotFoundException extends MonoCloudRequestException {
+  /**
+   * Initializes the MonoCloudNotFoundException Class
+   * @param response - The problem details returned from the server.
+   */
   constructor(response: ProblemDetails);
+  /**
+   * Initializes the MonoCloudNotFoundException Class
+   * @param message - The error message.
+   */
   constructor(message: string);
 }
 //#endregion
 //#region src/exceptions/monocloud-resource-exhausted-exception.d.ts
+/**
+ * The MonoCloud Resource Exhausted Exception
+ * @export
+ * @class MonoCloudResourceExhaustedException
+ */
 declare class MonoCloudResourceExhaustedException extends MonoCloudRequestException {
+  /**
+   * Initializes the MonoCloudResourceExhaustedException Class
+   * @param response - The problem details returned from the server.
+   */
   constructor(response: ProblemDetails);
+  /**
+   * Initializes the MonoCloudResourceExhaustedException Class
+   * @param message - The error message.
+   */
   constructor(message: string);
 }
 //#endregion
 //#region src/exceptions/monocloud-server-exception.d.ts
+/**
+ * The MonoCloud Server Exception
+ * @export
+ * @class MonoCloudServerException
+ */
 declare class MonoCloudServerException extends MonoCloudRequestException {
+  /**
+   * Initializes the MonoCloudServerException Class
+   * @param response - The problem details returned from the server.
+   */
   constructor(response: ProblemDetails);
+  /**
+   * Initializes the MonoCloudServerException Class
+   * @param message - The error message.
+   */
   constructor(message: string);
 }
 //#endregion
 //#region src/exceptions/monocloud-unauthorized-exception.d.ts
+/**
+ * The MonoCloud Unauthorized Exception
+ * @export
+ * @class MonoCloudUnauthorizedException
+ */
 declare class MonoCloudUnauthorizedException extends MonoCloudRequestException {
+  /**
+   * Initializes the MonoCloudUnauthorizedException Class
+   * @param response - The problem details returned from the server.
+   */
   constructor(response: ProblemDetails);
+  /**
+   * Initializes the MonoCloudUnauthorizedException Class
+   * @param message - The error message.
+   */
+  constructor(message: string);
+}
+//#endregion
+//#region src/exceptions/monocloud-payment-required-exception.d.ts
+/**
+ * The MonoCloud Payment Required Exception
+ * @export
+ * @class MonoCloudPaymentRequiredException
+ */
+declare class MonoCloudPaymentRequiredException extends MonoCloudRequestException {
+  /**
+   * Initializes the MonoCloudPaymentRequiredException Class
+   * @param response - The problem details returned from the server.
+   */
+  constructor(response: ProblemDetails);
+  /**
+   * Initializes the MonoCloudPaymentRequiredException Class
+   * @param message - The error message.
+   */
   constructor(message: string);
 }
 //#endregion
@@ -118,11 +339,41 @@ declare class MonoCloudResponse<TResult = unknown> {
 }
 //#endregion
 //#region src/models/page-model.d.ts
+/**
+ * The Page Model
+ * @export
+ * @interface PageModel
+ */
 interface PageModel {
+  /**
+   * Page Size
+   * @type {number}
+   * @memberof PageModel
+   */
   page_size: number;
+  /**
+   * Current Page
+   * @type {number}
+   * @memberof PageModel
+   */
   current_page: number;
+  /**
+   * Total Number of Items
+   * @type {number}
+   * @memberof PageModel
+   */
   total_count: number;
+  /**
+   * Specfies whether there is a previous page
+   * @type {boolean}
+   * @memberof PageModel
+   */
   has_previous: boolean;
+  /**
+   * Specfies whether there is a next page
+   * @type {boolean}
+   * @memberof PageModel
+   */
   has_next: boolean;
 }
 //#endregion
@@ -141,7 +392,7 @@ interface MonoCloudRequest {
 }
 //#endregion
 //#region src/models/fetcher.d.ts
-type Fetcher = (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
+type Fetcher = (input: string | URL, init?: RequestInit) => Promise<Response>;
 //#endregion
 //#region src/base/monocloud-client-base.d.ts
 declare abstract class MonoCloudClientBase {
@@ -155,5 +406,5 @@ declare abstract class MonoCloudClientBase {
   private buildUrl;
 }
 //#endregion
-export { type ErrorCodeValidationError, ErrorCodeValidationProblemDetails, type Fetcher, KeyValidationProblemDetails, MonoCloudBadRequestException, MonoCloudClientBase, type MonoCloudConfig, MonoCloudConflictException, MonoCloudErrorCodeValidationException, MonoCloudException, MonoCloudForbiddenException, MonoCloudKeyValidationException, MonoCloudModelStateException, MonoCloudNotFoundException, MonoCloudPageResponse, type MonoCloudRequest, MonoCloudRequestException, MonoCloudResourceExhaustedException, MonoCloudResponse, MonoCloudServerException, MonoCloudUnauthorizedException, ProblemDetails };
+export { type Fetcher, type IdentityError, IdentityValidationProblemDetails, KeyValidationProblemDetails, MonoCloudBadRequestException, MonoCloudClientBase, type MonoCloudConfig, MonoCloudConflictException, MonoCloudException, MonoCloudForbiddenException, MonoCloudIdentityValidationException, MonoCloudKeyValidationException, MonoCloudModelStateException, MonoCloudNotFoundException, MonoCloudPageResponse, MonoCloudPaymentRequiredException, type MonoCloudRequest, MonoCloudRequestException, MonoCloudResourceExhaustedException, MonoCloudResponse, MonoCloudServerException, MonoCloudUnauthorizedException, ProblemDetails };
 //# sourceMappingURL=index.d.cts.map