@quantcdn/quant-client 4.3.0 → 4.4.0

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * QuantCDN API
  * Unified API for QuantCDN Admin and QuantCloud Platform services
  *
- * The version of the OpenAPI document: 4.3.0
+ * The version of the OpenAPI document: 4.4.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1652,25 +1652,6 @@ export interface CreateCommandRequest {
      */
     'command'?: string;
 }
-/**
- *
- * @export
- * @interface CreateCronJob422Response
- */
-export interface CreateCronJob422Response {
-    /**
-     *
-     * @type {string}
-     * @memberof CreateCronJob422Response
-     */
-    'message'?: string;
-    /**
-     *
-     * @type {object}
-     * @memberof CreateCronJob422Response
-     */
-    'errors'?: object;
-}
 /**
  *
  * @export
@@ -3538,6 +3519,186 @@ export interface OrganizationsList200ResponseInner {
      */
     'machine_name'?: string;
 }
+/**
+ *
+ * @export
+ * @interface PatchEnvironmentCompose202Response
+ */
+export interface PatchEnvironmentCompose202Response {
+    /**
+     *
+     * @type {string}
+     * @memberof PatchEnvironmentCompose202Response
+     */
+    'architecture'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PatchEnvironmentCompose202Response
+     */
+    'taskCpu'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PatchEnvironmentCompose202Response
+     */
+    'taskMemory'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PatchEnvironmentCompose202Response
+     */
+    'minCapacity'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PatchEnvironmentCompose202Response
+     */
+    'maxCapacity'?: number;
+    /**
+     *
+     * @type {Array<object>}
+     * @memberof PatchEnvironmentCompose202Response
+     */
+    'containers'?: Array<object>;
+    /**
+     *
+     * @type {PatchEnvironmentCompose202ResponseSpotConfiguration}
+     * @memberof PatchEnvironmentCompose202Response
+     */
+    'spotConfiguration'?: PatchEnvironmentCompose202ResponseSpotConfiguration;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PatchEnvironmentCompose202Response
+     */
+    'enableCrossEnvNetworking'?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PatchEnvironmentCompose202Response
+     */
+    'enableCrossAppNetworking'?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface PatchEnvironmentCompose202ResponseSpotConfiguration
+ */
+export interface PatchEnvironmentCompose202ResponseSpotConfiguration {
+    /**
+     *
+     * @type {string}
+     * @memberof PatchEnvironmentCompose202ResponseSpotConfiguration
+     */
+    'strategy'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PatchEnvironmentCompose202ResponseSpotConfiguration
+     */
+    'tolerateDowntime'?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface PatchEnvironmentCompose400Response
+ */
+export interface PatchEnvironmentCompose400Response {
+    /**
+     *
+     * @type {string}
+     * @memberof PatchEnvironmentCompose400Response
+     */
+    'message'?: string;
+    /**
+     *
+     * @type {object}
+     * @memberof PatchEnvironmentCompose400Response
+     */
+    'errors'?: object;
+}
+/**
+ *
+ * @export
+ * @interface PatchEnvironmentComposeRequest
+ */
+export interface PatchEnvironmentComposeRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof PatchEnvironmentComposeRequest
+     */
+    'architecture'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PatchEnvironmentComposeRequest
+     */
+    'taskCpu'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PatchEnvironmentComposeRequest
+     */
+    'taskMemory'?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof PatchEnvironmentComposeRequest
+     */
+    'minCapacity'?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof PatchEnvironmentComposeRequest
+     */
+    'maxCapacity'?: number | null;
+    /**
+     *
+     * @type {Array<object>}
+     * @memberof PatchEnvironmentComposeRequest
+     */
+    'containers'?: Array<object> | null;
+    /**
+     *
+     * @type {PatchEnvironmentComposeRequestSpotConfiguration}
+     * @memberof PatchEnvironmentComposeRequest
+     */
+    'spotConfiguration'?: PatchEnvironmentComposeRequestSpotConfiguration | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PatchEnvironmentComposeRequest
+     */
+    'enableCrossEnvNetworking'?: boolean | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PatchEnvironmentComposeRequest
+     */
+    'enableCrossAppNetworking'?: boolean | null;
+}
+/**
+ *
+ * @export
+ * @interface PatchEnvironmentComposeRequestSpotConfiguration
+ */
+export interface PatchEnvironmentComposeRequestSpotConfiguration {
+    /**
+     *
+     * @type {string}
+     * @memberof PatchEnvironmentComposeRequestSpotConfiguration
+     */
+    'strategy'?: PatchEnvironmentComposeRequestSpotConfigurationStrategyEnum;
+}
+export declare const PatchEnvironmentComposeRequestSpotConfigurationStrategyEnum: {
+    readonly Off: "off";
+    readonly SpotOnly: "spot-only";
+    readonly MixedSafe: "mixed-safe";
+    readonly MixedAggressive: "mixed-aggressive";
+};
+export type PatchEnvironmentComposeRequestSpotConfigurationStrategyEnum = typeof PatchEnvironmentComposeRequestSpotConfigurationStrategyEnum[keyof typeof PatchEnvironmentComposeRequestSpotConfigurationStrategyEnum];
 /**
  *
  * @export
@@ -5539,6 +5700,67 @@ export interface V2CrawlerRequest {
      */
     'max_errors'?: number;
 }
+/**
+ *
+ * @export
+ * @interface V2CrawlerRun
+ */
+export interface V2CrawlerRun {
+    /**
+     * Run ID
+     * @type {number}
+     * @memberof V2CrawlerRun
+     */
+    'id': number;
+    /**
+     * Crawler config ID
+     * @type {number}
+     * @memberof V2CrawlerRun
+     */
+    'crawler_config_id': number;
+    /**
+     * Project ID
+     * @type {number}
+     * @memberof V2CrawlerRun
+     */
+    'project_id': number;
+    /**
+     * Run status
+     * @type {string}
+     * @memberof V2CrawlerRun
+     */
+    'last_status': string;
+    /**
+     * Task ID
+     * @type {string}
+     * @memberof V2CrawlerRun
+     */
+    'task_id': string;
+    /**
+     * Start time (Unix timestamp)
+     * @type {number}
+     * @memberof V2CrawlerRun
+     */
+    'started_at'?: number | null;
+    /**
+     * Completion time (Unix timestamp)
+     * @type {number}
+     * @memberof V2CrawlerRun
+     */
+    'completed_at'?: number | null;
+    /**
+     * Creation timestamp
+     * @type {string}
+     * @memberof V2CrawlerRun
+     */
+    'created_at'?: string;
+    /**
+     * Last update timestamp
+     * @type {string}
+     * @memberof V2CrawlerRun
+     */
+    'updated_at'?: string;
+}
 /**
  *
  * @export
@@ -10477,6 +10699,17 @@ export declare const ComposeApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getEnvironmentCompose: (organisation: string, application: string, environment: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Partially updates top-level fields of the environment\'s compose definition, such as architecture, task-level CPU/Memory, or min/max scaling capacity. Only fields included in the request body are modified. The \'containers\' array, if provided, REPLACES the existing containers array; if omitted, the existing containers are NOT modified by this PATCH operation. (For modifying individual containers, use PATCH /containers/{containerName}). This triggers a validation, registers a new task definition, and updates the service.
+     * @summary Partially Update Environment Compose Definition
+     * @param {string} organisation The organisation ID
+     * @param {string} application The application ID
+     * @param {string} environment The environment ID
+     * @param {PatchEnvironmentComposeRequest} patchEnvironmentComposeRequest Partial compose definition updates. All fields are optional.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchEnvironmentCompose: (organisation: string, application: string, environment: string, patchEnvironmentComposeRequest: PatchEnvironmentComposeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Quant Cloud provides comprehensive support for standard Docker Compose features including commands, entrypoints, health checks, dependencies, volume mounts, resource limits, and more. For detailed documentation on supported features and examples, see: https://docs.quantcdn.io/introduction-to-quant-cloud/importing-docker-compose/. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
      * @summary Validate a compose file
@@ -10503,6 +10736,17 @@ export declare const ComposeApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getEnvironmentCompose(organisation: string, application: string, environment: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Compose>>;
+    /**
+     * Partially updates top-level fields of the environment\'s compose definition, such as architecture, task-level CPU/Memory, or min/max scaling capacity. Only fields included in the request body are modified. The \'containers\' array, if provided, REPLACES the existing containers array; if omitted, the existing containers are NOT modified by this PATCH operation. (For modifying individual containers, use PATCH /containers/{containerName}). This triggers a validation, registers a new task definition, and updates the service.
+     * @summary Partially Update Environment Compose Definition
+     * @param {string} organisation The organisation ID
+     * @param {string} application The application ID
+     * @param {string} environment The environment ID
+     * @param {PatchEnvironmentComposeRequest} patchEnvironmentComposeRequest Partial compose definition updates. All fields are optional.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchEnvironmentCompose(organisation: string, application: string, environment: string, patchEnvironmentComposeRequest: PatchEnvironmentComposeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchEnvironmentCompose202Response>>;
     /**
      * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Quant Cloud provides comprehensive support for standard Docker Compose features including commands, entrypoints, health checks, dependencies, volume mounts, resource limits, and more. For detailed documentation on supported features and examples, see: https://docs.quantcdn.io/introduction-to-quant-cloud/importing-docker-compose/. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
      * @summary Validate a compose file
@@ -10529,6 +10773,17 @@ export declare const ComposeApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getEnvironmentCompose(organisation: string, application: string, environment: string, options?: RawAxiosRequestConfig): AxiosPromise<Compose>;
+    /**
+     * Partially updates top-level fields of the environment\'s compose definition, such as architecture, task-level CPU/Memory, or min/max scaling capacity. Only fields included in the request body are modified. The \'containers\' array, if provided, REPLACES the existing containers array; if omitted, the existing containers are NOT modified by this PATCH operation. (For modifying individual containers, use PATCH /containers/{containerName}). This triggers a validation, registers a new task definition, and updates the service.
+     * @summary Partially Update Environment Compose Definition
+     * @param {string} organisation The organisation ID
+     * @param {string} application The application ID
+     * @param {string} environment The environment ID
+     * @param {PatchEnvironmentComposeRequest} patchEnvironmentComposeRequest Partial compose definition updates. All fields are optional.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchEnvironmentCompose(organisation: string, application: string, environment: string, patchEnvironmentComposeRequest: PatchEnvironmentComposeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PatchEnvironmentCompose202Response>;
     /**
      * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Quant Cloud provides comprehensive support for standard Docker Compose features including commands, entrypoints, health checks, dependencies, volume mounts, resource limits, and more. For detailed documentation on supported features and examples, see: https://docs.quantcdn.io/introduction-to-quant-cloud/importing-docker-compose/. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
      * @summary Validate a compose file
@@ -10558,6 +10813,18 @@ export declare class ComposeApi extends BaseAPI {
      * @memberof ComposeApi
      */
     getEnvironmentCompose(organisation: string, application: string, environment: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Compose, any, {}>>;
+    /**
+     * Partially updates top-level fields of the environment\'s compose definition, such as architecture, task-level CPU/Memory, or min/max scaling capacity. Only fields included in the request body are modified. The \'containers\' array, if provided, REPLACES the existing containers array; if omitted, the existing containers are NOT modified by this PATCH operation. (For modifying individual containers, use PATCH /containers/{containerName}). This triggers a validation, registers a new task definition, and updates the service.
+     * @summary Partially Update Environment Compose Definition
+     * @param {string} organisation The organisation ID
+     * @param {string} application The application ID
+     * @param {string} environment The environment ID
+     * @param {PatchEnvironmentComposeRequest} patchEnvironmentComposeRequest Partial compose definition updates. All fields are optional.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComposeApi
+     */
+    patchEnvironmentCompose(organisation: string, application: string, environment: string, patchEnvironmentComposeRequest: PatchEnvironmentComposeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchEnvironmentCompose202Response, any, {}>>;
     /**
      * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Quant Cloud provides comprehensive support for standard Docker Compose features including commands, entrypoints, health checks, dependencies, volume mounts, resource limits, and more. For detailed documentation on supported features and examples, see: https://docs.quantcdn.io/introduction-to-quant-cloud/importing-docker-compose/. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
      * @summary Validate a compose file
@@ -10962,6 +11229,27 @@ export declare const CrawlersApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     crawlersDelete: (organization: string, project: string, crawler: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get a run by ID
+     * @param {string} organization Organization identifier
+     * @param {string} project Project identifier
+     * @param {string} crawler Crawler identifier
+     * @param {number} runId Run identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    crawlersGetRunById: (organization: string, project: string, crawler: string, runId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get all runs for a crawler
+     * @param {string} organization Organization identifier
+     * @param {string} project Project identifier
+     * @param {string} crawler Crawler identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    crawlersGetRuns: (organization: string, project: string, crawler: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary List crawlers for the project
@@ -11029,6 +11317,27 @@ export declare const CrawlersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     crawlersDelete(organization: string, project: string, crawler: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Get a run by ID
+     * @param {string} organization Organization identifier
+     * @param {string} project Project identifier
+     * @param {string} crawler Crawler identifier
+     * @param {number} runId Run identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    crawlersGetRunById(organization: string, project: string, crawler: string, runId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2CrawlerRun>>;
+    /**
+     *
+     * @summary Get all runs for a crawler
+     * @param {string} organization Organization identifier
+     * @param {string} project Project identifier
+     * @param {string} crawler Crawler identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    crawlersGetRuns(organization: string, project: string, crawler: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V2CrawlerRun>>>;
     /**
      *
      * @summary List crawlers for the project
@@ -11096,6 +11405,27 @@ export declare const CrawlersApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     crawlersDelete(organization: string, project: string, crawler: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Get a run by ID
+     * @param {string} organization Organization identifier
+     * @param {string} project Project identifier
+     * @param {string} crawler Crawler identifier
+     * @param {number} runId Run identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    crawlersGetRunById(organization: string, project: string, crawler: string, runId: number, options?: RawAxiosRequestConfig): AxiosPromise<V2CrawlerRun>;
+    /**
+     *
+     * @summary Get all runs for a crawler
+     * @param {string} organization Organization identifier
+     * @param {string} project Project identifier
+     * @param {string} crawler Crawler identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    crawlersGetRuns(organization: string, project: string, crawler: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<V2CrawlerRun>>;
     /**
      *
      * @summary List crawlers for the project
@@ -11167,6 +11497,29 @@ export declare class CrawlersApi extends BaseAPI {
      * @memberof CrawlersApi
      */
     crawlersDelete(organization: string, project: string, crawler: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary Get a run by ID
+     * @param {string} organization Organization identifier
+     * @param {string} project Project identifier
+     * @param {string} crawler Crawler identifier
+     * @param {number} runId Run identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CrawlersApi
+     */
+    crawlersGetRunById(organization: string, project: string, crawler: string, runId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V2CrawlerRun, any, {}>>;
+    /**
+     *
+     * @summary Get all runs for a crawler
+     * @param {string} organization Organization identifier
+     * @param {string} project Project identifier
+     * @param {string} crawler Crawler identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CrawlersApi
+     */
+    crawlersGetRuns(organization: string, project: string, crawler: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V2CrawlerRun[], any, {}>>;
     /**
      *
      * @summary List crawlers for the project