qovery-typescript-axios 1.1.908 → 1.1.910

package/dist/api.d.ts

@@ -30,7 +30,7 @@ export declare const APIVariableScopeEnum: {
 };
 export type APIVariableScopeEnum = typeof APIVariableScopeEnum[keyof typeof APIVariableScopeEnum];
 /**
- * type of the environment variable (VALUE, FILE, ALIAS, OVERRIDE, BUIT_IN, EXTERNAL_SECRET)
+ * type of the environment variable (VALUE, FILE, ALIAS, OVERRIDE, BUIT_IN, EXTERNAL_SECRET, FILE_EXTERNAL_SECRET)
  * @export
  * @enum {string}
  */
@@ -41,6 +41,7 @@ export declare const APIVariableTypeEnum: {
     readonly BUILT_IN: "BUILT_IN";
     readonly FILE: "FILE";
     readonly EXTERNAL_SECRET: "EXTERNAL_SECRET";
+    readonly FILE_EXTERNAL_SECRET: "FILE_EXTERNAL_SECRET";
 };
 export type APIVariableTypeEnum = typeof APIVariableTypeEnum[keyof typeof APIVariableTypeEnum];
 /**
@@ -3385,7 +3386,7 @@ export interface BlueprintCreateRequest {
      * @type {{ [key: string]: any; }}
      * @memberof BlueprintCreateRequest
      */
-    'specOverrides'?: {
+    'spec_overrides'?: {
         [key: string]: any;
     } | null;
 }
@@ -3487,6 +3488,12 @@ export interface BlueprintManifestContextVariableField {
      * @memberof BlueprintManifestContextVariableField
      */
     'source'?: string | null;
+    /**
+     * Resolved value of the context variable at the time of the request
+     * @type {string}
+     * @memberof BlueprintManifestContextVariableField
+     */
+    'value'?: string | null;
 }
 export declare const BlueprintManifestContextVariableFieldKindEnum: {
     readonly CONTEXT_VARIABLE: "contextVariable";
@@ -3504,6 +3511,24 @@ export interface BlueprintManifestFieldType {
      * @memberof BlueprintManifestFieldType
      */
     'type': BlueprintManifestFieldTypeTypeEnum;
+    /**
+     * Regex pattern, only present for string fields
+     * @type {string}
+     * @memberof BlueprintManifestFieldType
+     */
+    'pattern'?: string | null;
+    /**
+     * Minimum length, only present for string fields
+     * @type {number}
+     * @memberof BlueprintManifestFieldType
+     */
+    'min_length'?: number | null;
+    /**
+     * Maximum length, only present for string fields
+     * @type {number}
+     * @memberof BlueprintManifestFieldType
+     */
+    'max_length'?: number | null;
     /**
      * Lower bound, only present for number fields
      * @type {number}
@@ -3582,6 +3607,25 @@ export declare const BlueprintManifestVariableFieldKindEnum: {
     readonly VARIABLE: "variable";
 };
 export type BlueprintManifestVariableFieldKindEnum = typeof BlueprintManifestVariableFieldKindEnum[keyof typeof BlueprintManifestVariableFieldKindEnum];
+/**
+ *
+ * @export
+ * @interface BlueprintReadmeResponse
+ */
+export interface BlueprintReadmeResponse {
+    /**
+     * README content in Markdown format
+     * @type {string}
+     * @memberof BlueprintReadmeResponse
+     */
+    'content': string;
+    /**
+     * URL of the GitHub repository hosting the blueprint
+     * @type {string}
+     * @memberof BlueprintReadmeResponse
+     */
+    'repository_url': string;
+}
 /**
  *
  * @export
@@ -3599,7 +3643,7 @@ export interface BlueprintResponse {
      * @type {string}
      * @memberof BlueprintResponse
      */
-    'catalogUrl': string;
+    'catalog_url': string;
     /**
      *
      * @type {string}
@@ -3611,7 +3655,195 @@ export interface BlueprintResponse {
      * @type {string}
      * @memberof BlueprintResponse
      */
-    'environmentId': string;
+    'environment_id': string;
+}
+/**
+ *
+ * @export
+ * @interface BlueprintUpdateNewOptionalValue
+ */
+export interface BlueprintUpdateNewOptionalValue {
+    /**
+     *
+     * @type {string}
+     * @memberof BlueprintUpdateNewOptionalValue
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof BlueprintUpdateNewOptionalValue
+     */
+    'default_value'?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface BlueprintUpdateNewRequiredValue
+ */
+export interface BlueprintUpdateNewRequiredValue {
+    /**
+     *
+     * @type {string}
+     * @memberof BlueprintUpdateNewRequiredValue
+     */
+    'name': string;
+}
+/**
+ *
+ * @export
+ * @interface BlueprintUpdatePreviewRequest
+ */
+export interface BlueprintUpdatePreviewRequest {
+    /**
+     * Display name for the service
+     * @type {string}
+     * @memberof BlueprintUpdatePreviewRequest
+     */
+    'name': string;
+    /**
+     * Catalog tag identifying the target blueprint version
+     * @type {string}
+     * @memberof BlueprintUpdatePreviewRequest
+     */
+    'tag': string;
+    /**
+     * Icon URL for the service
+     * @type {string}
+     * @memberof BlueprintUpdatePreviewRequest
+     */
+    'icon': string;
+    /**
+     * Variable overrides to apply in the preview
+     * @type {Array<BlueprintVariableRequest>}
+     * @memberof BlueprintUpdatePreviewRequest
+     */
+    'variables'?: Array<BlueprintVariableRequest> | null;
+    /**
+     * Partial spec overrides merged on top of the blueprint manifest
+     * @type {{ [key: string]: any; }}
+     * @memberof BlueprintUpdatePreviewRequest
+     */
+    'spec_overrides'?: {
+        [key: string]: any;
+    } | null;
+}
+/**
+ *
+ * @export
+ * @interface BlueprintUpdatePreviewResponse
+ */
+export interface BlueprintUpdatePreviewResponse {
+    /**
+     * Identifier of the preview execution
+     * @type {string}
+     * @memberof BlueprintUpdatePreviewResponse
+     */
+    'preview_id': string;
+    /**
+     * Type of the underlying service backing this blueprint
+     * @type {string}
+     * @memberof BlueprintUpdatePreviewResponse
+     */
+    'service_type': BlueprintUpdatePreviewResponseServiceTypeEnum;
+}
+export declare const BlueprintUpdatePreviewResponseServiceTypeEnum: {
+    readonly HELM: "HELM";
+    readonly TERRAFORM: "TERRAFORM";
+};
+export type BlueprintUpdatePreviewResponseServiceTypeEnum = typeof BlueprintUpdatePreviewResponseServiceTypeEnum[keyof typeof BlueprintUpdatePreviewResponseServiceTypeEnum];
+/**
+ *
+ * @export
+ * @interface BlueprintUpdateRemovedValue
+ */
+export interface BlueprintUpdateRemovedValue {
+    /**
+     *
+     * @type {string}
+     * @memberof BlueprintUpdateRemovedValue
+     */
+    'name': string;
+}
+/**
+ *
+ * @export
+ * @interface BlueprintUpdateResponse
+ */
+export interface BlueprintUpdateResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof BlueprintUpdateResponse
+     */
+    'is_up_to_date': boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof BlueprintUpdateResponse
+     */
+    'latest_tag': string;
+    /**
+     * Variables added in the latest version that are required with no default
+     * @type {Array<BlueprintUpdateNewRequiredValue>}
+     * @memberof BlueprintUpdateResponse
+     */
+    'new_required_values': Array<BlueprintUpdateNewRequiredValue>;
+    /**
+     * Variables added in the latest version that have a default value
+     * @type {Array<BlueprintUpdateNewOptionalValue>}
+     * @memberof BlueprintUpdateResponse
+     */
+    'new_optional_values': Array<BlueprintUpdateNewOptionalValue>;
+    /**
+     * Variables that were optional but are now required in the latest version
+     * @type {Array<BlueprintUpdateNewRequiredValue>}
+     * @memberof BlueprintUpdateResponse
+     */
+    'now_required_values': Array<BlueprintUpdateNewRequiredValue>;
+    /**
+     * Variables whose default value changed between the current and latest versions
+     * @type {Array<BlueprintUpdateUpdatedValue>}
+     * @memberof BlueprintUpdateResponse
+     */
+    'updated_values': Array<BlueprintUpdateUpdatedValue>;
+    /**
+     * Variables that no longer exist in the latest version
+     * @type {Array<BlueprintUpdateRemovedValue>}
+     * @memberof BlueprintUpdateResponse
+     */
+    'removed_values': Array<BlueprintUpdateRemovedValue>;
+}
+/**
+ *
+ * @export
+ * @interface BlueprintUpdateUpdatedValue
+ */
+export interface BlueprintUpdateUpdatedValue {
+    /**
+     *
+     * @type {string}
+     * @memberof BlueprintUpdateUpdatedValue
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof BlueprintUpdateUpdatedValue
+     */
+    'current_default_value'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BlueprintUpdateUpdatedValue
+     */
+    'new_default_value'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BlueprintUpdateUpdatedValue
+     */
+    'current_value'?: string | null;
 }
 /**
  *
@@ -3636,7 +3868,7 @@ export interface BlueprintVariableRequest {
      * @type {boolean}
      * @memberof BlueprintVariableRequest
      */
-    'isSecret'?: boolean;
+    'is_secret'?: boolean;
 }
 /**
  *
@@ -27334,10 +27566,11 @@ export declare const BlueprintCatalogApiAxiosParamCreator: (configuration?: Conf
      * @param {string} provider Cloud provider (e.g. aws, gcp, azure)
      * @param {string} serviceFamily Service family (e.g. mysql, postgresql)
      * @param {string} serviceVersion Service version (e.g. 8, 14)
+     * @param {string} environmentId Environment ID used to resolve context variables
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getBlueprintCatalogServiceManifest: (organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getBlueprintCatalogServiceManifest: (organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, environmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get the README of a blueprint catalog service
@@ -27362,10 +27595,11 @@ export declare const BlueprintCatalogApiFp: (configuration?: Configuration) => {
      * @param {string} provider Cloud provider (e.g. aws, gcp, azure)
      * @param {string} serviceFamily Service family (e.g. mysql, postgresql)
      * @param {string} serviceVersion Service version (e.g. 8, 14)
+     * @param {string} environmentId Environment ID used to resolve context variables
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getBlueprintCatalogServiceManifest(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBlueprintCatalogServiceManifest200Response>>;
+    getBlueprintCatalogServiceManifest(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, environmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBlueprintCatalogServiceManifest200Response>>;
     /**
      *
      * @summary Get the README of a blueprint catalog service
@@ -27376,7 +27610,7 @@ export declare const BlueprintCatalogApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getBlueprintCatalogServiceReadme(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    getBlueprintCatalogServiceReadme(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BlueprintReadmeResponse>>;
 };
 /**
  * BlueprintCatalogApi - factory interface
@@ -27390,10 +27624,11 @@ export declare const BlueprintCatalogApiFactory: (configuration?: Configuration,
      * @param {string} provider Cloud provider (e.g. aws, gcp, azure)
      * @param {string} serviceFamily Service family (e.g. mysql, postgresql)
      * @param {string} serviceVersion Service version (e.g. 8, 14)
+     * @param {string} environmentId Environment ID used to resolve context variables
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getBlueprintCatalogServiceManifest(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig): AxiosPromise<GetBlueprintCatalogServiceManifest200Response>;
+    getBlueprintCatalogServiceManifest(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, environmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetBlueprintCatalogServiceManifest200Response>;
     /**
      *
      * @summary Get the README of a blueprint catalog service
@@ -27404,7 +27639,7 @@ export declare const BlueprintCatalogApiFactory: (configuration?: Configuration,
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getBlueprintCatalogServiceReadme(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    getBlueprintCatalogServiceReadme(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig): AxiosPromise<BlueprintReadmeResponse>;
 };
 /**
  * BlueprintCatalogApi - object-oriented interface
@@ -27420,11 +27655,12 @@ export declare class BlueprintCatalogApi extends BaseAPI {
      * @param {string} provider Cloud provider (e.g. aws, gcp, azure)
      * @param {string} serviceFamily Service family (e.g. mysql, postgresql)
      * @param {string} serviceVersion Service version (e.g. 8, 14)
+     * @param {string} environmentId Environment ID used to resolve context variables
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof BlueprintCatalogApi
      */
-    getBlueprintCatalogServiceManifest(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBlueprintCatalogServiceManifest200Response, any, {}>>;
+    getBlueprintCatalogServiceManifest(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, environmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBlueprintCatalogServiceManifest200Response, any, {}>>;
     /**
      *
      * @summary Get the README of a blueprint catalog service
@@ -27436,13 +27672,21 @@ export declare class BlueprintCatalogApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof BlueprintCatalogApi
      */
-    getBlueprintCatalogServiceReadme(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+    getBlueprintCatalogServiceReadme(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BlueprintReadmeResponse, any, {}>>;
 }
 /**
  * BlueprintMainCallsApi - axios parameter creator
  * @export
  */
 export declare const BlueprintMainCallsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns the update availability for a deployed blueprint service, including the latest tag, and a diff of variables that are new, changed, or removed.
+     * @summary Check if a blueprint service has an available update
+     * @param {string} blueprintId Blueprint ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    checkBlueprintUpdate: (blueprintId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Instantiates a blueprint from the service catalog into the given environment. Pass `deploy=true` to trigger an immediate deployment after creation.
      * @summary Create a blueprint service in an environment
@@ -27461,12 +27705,29 @@ export declare const BlueprintMainCallsApiAxiosParamCreator: (configuration?: Co
      * @throws {RequiredError}
      */
     getBlueprintCatalog: (organizationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Dry-runs a blueprint update by applying the given variables and spec overrides without persisting any changes. Returns a preview ID and the resolved service type.
+     * @summary Preview a blueprint update
+     * @param {string} blueprintId Blueprint ID
+     * @param {BlueprintUpdatePreviewRequest} blueprintUpdatePreviewRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewBlueprintUpdate: (blueprintId: string, blueprintUpdatePreviewRequest: BlueprintUpdatePreviewRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * BlueprintMainCallsApi - functional programming interface
  * @export
  */
 export declare const BlueprintMainCallsApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns the update availability for a deployed blueprint service, including the latest tag, and a diff of variables that are new, changed, or removed.
+     * @summary Check if a blueprint service has an available update
+     * @param {string} blueprintId Blueprint ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    checkBlueprintUpdate(blueprintId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BlueprintUpdateResponse>>;
     /**
      * Instantiates a blueprint from the service catalog into the given environment. Pass `deploy=true` to trigger an immediate deployment after creation.
      * @summary Create a blueprint service in an environment
@@ -27485,12 +27746,29 @@ export declare const BlueprintMainCallsApiFp: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     getBlueprintCatalog(organizationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BlueprintCatalogResponse>>;
+    /**
+     * Dry-runs a blueprint update by applying the given variables and spec overrides without persisting any changes. Returns a preview ID and the resolved service type.
+     * @summary Preview a blueprint update
+     * @param {string} blueprintId Blueprint ID
+     * @param {BlueprintUpdatePreviewRequest} blueprintUpdatePreviewRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewBlueprintUpdate(blueprintId: string, blueprintUpdatePreviewRequest: BlueprintUpdatePreviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BlueprintUpdatePreviewResponse>>;
 };
 /**
  * BlueprintMainCallsApi - factory interface
  * @export
  */
 export declare const BlueprintMainCallsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns the update availability for a deployed blueprint service, including the latest tag, and a diff of variables that are new, changed, or removed.
+     * @summary Check if a blueprint service has an available update
+     * @param {string} blueprintId Blueprint ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    checkBlueprintUpdate(blueprintId: string, options?: RawAxiosRequestConfig): AxiosPromise<BlueprintUpdateResponse>;
     /**
      * Instantiates a blueprint from the service catalog into the given environment. Pass `deploy=true` to trigger an immediate deployment after creation.
      * @summary Create a blueprint service in an environment
@@ -27509,6 +27787,15 @@ export declare const BlueprintMainCallsApiFactory: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getBlueprintCatalog(organizationId: string, options?: RawAxiosRequestConfig): AxiosPromise<BlueprintCatalogResponse>;
+    /**
+     * Dry-runs a blueprint update by applying the given variables and spec overrides without persisting any changes. Returns a preview ID and the resolved service type.
+     * @summary Preview a blueprint update
+     * @param {string} blueprintId Blueprint ID
+     * @param {BlueprintUpdatePreviewRequest} blueprintUpdatePreviewRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    previewBlueprintUpdate(blueprintId: string, blueprintUpdatePreviewRequest: BlueprintUpdatePreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<BlueprintUpdatePreviewResponse>;
 };
 /**
  * BlueprintMainCallsApi - object-oriented interface
@@ -27517,6 +27804,15 @@ export declare const BlueprintMainCallsApiFactory: (configuration?: Configuratio
  * @extends {BaseAPI}
  */
 export declare class BlueprintMainCallsApi extends BaseAPI {
+    /**
+     * Returns the update availability for a deployed blueprint service, including the latest tag, and a diff of variables that are new, changed, or removed.
+     * @summary Check if a blueprint service has an available update
+     * @param {string} blueprintId Blueprint ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlueprintMainCallsApi
+     */
+    checkBlueprintUpdate(blueprintId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BlueprintUpdateResponse, any, {}>>;
     /**
      * Instantiates a blueprint from the service catalog into the given environment. Pass `deploy=true` to trigger an immediate deployment after creation.
      * @summary Create a blueprint service in an environment
@@ -27537,6 +27833,16 @@ export declare class BlueprintMainCallsApi extends BaseAPI {
      * @memberof BlueprintMainCallsApi
      */
     getBlueprintCatalog(organizationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BlueprintCatalogResponse, any, {}>>;
+    /**
+     * Dry-runs a blueprint update by applying the given variables and spec overrides without persisting any changes. Returns a preview ID and the resolved service type.
+     * @summary Preview a blueprint update
+     * @param {string} blueprintId Blueprint ID
+     * @param {BlueprintUpdatePreviewRequest} blueprintUpdatePreviewRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlueprintMainCallsApi
+     */
+    previewBlueprintUpdate(blueprintId: string, blueprintUpdatePreviewRequest: BlueprintUpdatePreviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BlueprintUpdatePreviewResponse, any, {}>>;
 }
 /**
  * CloudProviderApi - axios parameter creator