qovery-typescript-axios 1.1.906 → 1.1.908

package/api.ts

@@ -3584,6 +3584,134 @@ export interface BlueprintMajorVersion {
      */
     'latestTag': string;
 }
+/**
+ * An auto-sourced, read-only value (from spec.contextVariables); not user-editable.
+ * @export
+ * @interface BlueprintManifestContextVariableField
+ */
+export interface BlueprintManifestContextVariableField {
+    /**
+     * 
+     * @type {string}
+     * @memberof BlueprintManifestContextVariableField
+     */
+    'kind': BlueprintManifestContextVariableFieldKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof BlueprintManifestContextVariableField
+     */
+    'name': string;
+    /**
+     * Origin of the auto-sourced value (e.g. cluster.region)
+     * @type {string}
+     * @memberof BlueprintManifestContextVariableField
+     */
+    'source'?: string | null;
+}
+
+export const BlueprintManifestContextVariableFieldKindEnum = {
+    CONTEXT_VARIABLE: 'contextVariable'
+} as const;
+
+export type BlueprintManifestContextVariableFieldKindEnum = typeof BlueprintManifestContextVariableFieldKindEnum[keyof typeof BlueprintManifestContextVariableFieldKindEnum];
+
+/**
+ * Field type with its type-specific validation conditions, discriminated by \"type\".
+ * @export
+ * @interface BlueprintManifestFieldType
+ */
+export interface BlueprintManifestFieldType {
+    /**
+     * 
+     * @type {string}
+     * @memberof BlueprintManifestFieldType
+     */
+    'type': BlueprintManifestFieldTypeTypeEnum;
+    /**
+     * Lower bound, only present for number fields
+     * @type {number}
+     * @memberof BlueprintManifestFieldType
+     */
+    'min'?: number | null;
+    /**
+     * Upper bound, only present for number fields
+     * @type {number}
+     * @memberof BlueprintManifestFieldType
+     */
+    'max'?: number | null;
+}
+
+export const BlueprintManifestFieldTypeTypeEnum = {
+    STRING: 'string',
+    BOOL: 'bool',
+    NUMBER: 'number'
+} as const;
+
+export type BlueprintManifestFieldTypeTypeEnum = typeof BlueprintManifestFieldTypeTypeEnum[keyof typeof BlueprintManifestFieldTypeTypeEnum];
+
+/**
+ * An editable form input the user fills in (from spec.variables).
+ * @export
+ * @interface BlueprintManifestVariableField
+ */
+export interface BlueprintManifestVariableField {
+    /**
+     * 
+     * @type {string}
+     * @memberof BlueprintManifestVariableField
+     */
+    'kind': BlueprintManifestVariableFieldKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof BlueprintManifestVariableField
+     */
+    'name': string;
+    /**
+     * 
+     * @type {BlueprintManifestFieldType}
+     * @memberof BlueprintManifestVariableField
+     */
+    'type': BlueprintManifestFieldType;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof BlueprintManifestVariableField
+     */
+    'required': boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof BlueprintManifestVariableField
+     */
+    'is_secret': boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof BlueprintManifestVariableField
+     */
+    'description'?: string | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof BlueprintManifestVariableField
+     */
+    'allowed_values'?: Array<string> | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof BlueprintManifestVariableField
+     */
+    'default_value'?: string | null;
+}
+
+export const BlueprintManifestVariableFieldKindEnum = {
+    VARIABLE: 'variable'
+} as const;
+
+export type BlueprintManifestVariableFieldKindEnum = typeof BlueprintManifestVariableFieldKindEnum[keyof typeof BlueprintManifestVariableFieldKindEnum];
+
 /**
  * 
  * @export
@@ -12657,6 +12785,25 @@ export interface GenericObjectCurrentCost {
      */
     'cost': Cost;
 }
+/**
+ * 
+ * @export
+ * @interface GetBlueprintCatalogServiceManifest200Response
+ */
+export interface GetBlueprintCatalogServiceManifest200Response {
+    /**
+     * 
+     * @type {Array<GetBlueprintCatalogServiceManifest200ResponseResultsInner>}
+     * @memberof GetBlueprintCatalogServiceManifest200Response
+     */
+    'results'?: Array<GetBlueprintCatalogServiceManifest200ResponseResultsInner>;
+}
+/**
+ * @type GetBlueprintCatalogServiceManifest200ResponseResultsInner
+ * @export
+ */
+export type GetBlueprintCatalogServiceManifest200ResponseResultsInner = { kind: 'contextVariable' } & BlueprintManifestContextVariableField | { kind: 'variable' } & BlueprintManifestVariableField;
+
 /**
  * 
  * @export
@@ -32227,6 +32374,59 @@ export class BillingApi extends BaseAPI {
  */
 export const BlueprintCatalogApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Returns the list of form fields the console must display to deploy the selected blueprint, derived from the blueprint\'s qbm.yml manifest. Includes editable variables (overridable=true) and auto-sourced context variables (overridable=false, with a source).
+         * @summary Get the input fields to display for a blueprint catalog service
+         * @param {string} organizationId Organization ID
+         * @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 {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getBlueprintCatalogServiceManifest: async (organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'organizationId' is not null or undefined
+            assertParamExists('getBlueprintCatalogServiceManifest', 'organizationId', organizationId)
+            // verify required parameter 'provider' is not null or undefined
+            assertParamExists('getBlueprintCatalogServiceManifest', 'provider', provider)
+            // verify required parameter 'serviceFamily' is not null or undefined
+            assertParamExists('getBlueprintCatalogServiceManifest', 'serviceFamily', serviceFamily)
+            // verify required parameter 'serviceVersion' is not null or undefined
+            assertParamExists('getBlueprintCatalogServiceManifest', 'serviceVersion', serviceVersion)
+            const localVarPath = `/organization/{organizationId}/blueprint/catalog/{provider}/{serviceFamily}/{serviceVersion}/manifest`
+                .replace(`{${"organizationId"}}`, encodeURIComponent(String(organizationId)))
+                .replace(`{${"provider"}}`, encodeURIComponent(String(provider)))
+                .replace(`{${"serviceFamily"}}`, encodeURIComponent(String(serviceFamily)))
+                .replace(`{${"serviceVersion"}}`, encodeURIComponent(String(serviceVersion)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication ApiKeyAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Get the README of a blueprint catalog service
@@ -32290,6 +32490,22 @@ export const BlueprintCatalogApiAxiosParamCreator = function (configuration?: Co
 export const BlueprintCatalogApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = BlueprintCatalogApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Returns the list of form fields the console must display to deploy the selected blueprint, derived from the blueprint\'s qbm.yml manifest. Includes editable variables (overridable=true) and auto-sourced context variables (overridable=false, with a source).
+         * @summary Get the input fields to display for a blueprint catalog service
+         * @param {string} organizationId Organization ID
+         * @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 {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getBlueprintCatalogServiceManifest(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBlueprintCatalogServiceManifest200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getBlueprintCatalogServiceManifest(organizationId, provider, serviceFamily, serviceVersion, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BlueprintCatalogApi.getBlueprintCatalogServiceManifest']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Get the README of a blueprint catalog service
@@ -32316,6 +32532,19 @@ export const BlueprintCatalogApiFp = function(configuration?: Configuration) {
 export const BlueprintCatalogApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = BlueprintCatalogApiFp(configuration)
     return {
+        /**
+         * Returns the list of form fields the console must display to deploy the selected blueprint, derived from the blueprint\'s qbm.yml manifest. Includes editable variables (overridable=true) and auto-sourced context variables (overridable=false, with a source).
+         * @summary Get the input fields to display for a blueprint catalog service
+         * @param {string} organizationId Organization ID
+         * @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 {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getBlueprintCatalogServiceManifest(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig): AxiosPromise<GetBlueprintCatalogServiceManifest200Response> {
+            return localVarFp.getBlueprintCatalogServiceManifest(organizationId, provider, serviceFamily, serviceVersion, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Get the README of a blueprint catalog service
@@ -32339,6 +32568,21 @@ export const BlueprintCatalogApiFactory = function (configuration?: Configuratio
  * @extends {BaseAPI}
  */
 export class BlueprintCatalogApi extends BaseAPI {
+    /**
+     * Returns the list of form fields the console must display to deploy the selected blueprint, derived from the blueprint\'s qbm.yml manifest. Includes editable variables (overridable=true) and auto-sourced context variables (overridable=false, with a source).
+     * @summary Get the input fields to display for a blueprint catalog service
+     * @param {string} organizationId Organization ID
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlueprintCatalogApi
+     */
+    public getBlueprintCatalogServiceManifest(organizationId: string, provider: string, serviceFamily: string, serviceVersion: string, options?: RawAxiosRequestConfig) {
+        return BlueprintCatalogApiFp(this.configuration).getBlueprintCatalogServiceManifest(organizationId, provider, serviceFamily, serviceVersion, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Get the README of a blueprint catalog service
@@ -36554,10 +36798,11 @@ export const ClustersApiAxiosParamCreator = function (configuration?: Configurat
          * @param {string} organizationId Organization ID
          * @param {string} clusterId Cluster ID
          * @param {boolean} [withTokenFromCli] If true, the user auth part will have an exec command with qovery cli
+         * @param {boolean} [readOnly] If true, the kubeconfig exec plugin will request a read-only token backed by a Kubernetes ServiceAccount with the view ClusterRole
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getClusterKubeconfig: async (organizationId: string, clusterId: string, withTokenFromCli?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getClusterKubeconfig: async (organizationId: string, clusterId: string, withTokenFromCli?: boolean, readOnly?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'organizationId' is not null or undefined
             assertParamExists('getClusterKubeconfig', 'organizationId', organizationId)
             // verify required parameter 'clusterId' is not null or undefined
@@ -36587,6 +36832,10 @@ export const ClustersApiAxiosParamCreator = function (configuration?: Configurat
                 localVarQueryParameter['with_token_from_cli'] = withTokenFromCli;
             }
 
+            if (readOnly !== undefined) {
+                localVarQueryParameter['read_only'] = readOnly;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -37890,11 +38139,12 @@ export const ClustersApiFp = function(configuration?: Configuration) {
          * @param {string} organizationId Organization ID
          * @param {string} clusterId Cluster ID
          * @param {boolean} [withTokenFromCli] If true, the user auth part will have an exec command with qovery cli
+         * @param {boolean} [readOnly] If true, the kubeconfig exec plugin will request a read-only token backed by a Kubernetes ServiceAccount with the view ClusterRole
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getClusterKubeconfig(organizationId: string, clusterId: string, withTokenFromCli?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterKubeconfig(organizationId, clusterId, withTokenFromCli, options);
+        async getClusterKubeconfig(organizationId: string, clusterId: string, withTokenFromCli?: boolean, readOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterKubeconfig(organizationId, clusterId, withTokenFromCli, readOnly, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['ClustersApi.getClusterKubeconfig']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -38362,11 +38612,12 @@ export const ClustersApiFactory = function (configuration?: Configuration, baseP
          * @param {string} organizationId Organization ID
          * @param {string} clusterId Cluster ID
          * @param {boolean} [withTokenFromCli] If true, the user auth part will have an exec command with qovery cli
+         * @param {boolean} [readOnly] If true, the kubeconfig exec plugin will request a read-only token backed by a Kubernetes ServiceAccount with the view ClusterRole
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getClusterKubeconfig(organizationId: string, clusterId: string, withTokenFromCli?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<string> {
-            return localVarFp.getClusterKubeconfig(organizationId, clusterId, withTokenFromCli, options).then((request) => request(axios, basePath));
+        getClusterKubeconfig(organizationId: string, clusterId: string, withTokenFromCli?: boolean, readOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<string> {
+            return localVarFp.getClusterKubeconfig(organizationId, clusterId, withTokenFromCli, readOnly, options).then((request) => request(axios, basePath));
         },
         /**
          * List Cluster Kubernetes Events
@@ -38785,12 +39036,13 @@ export class ClustersApi extends BaseAPI {
      * @param {string} organizationId Organization ID
      * @param {string} clusterId Cluster ID
      * @param {boolean} [withTokenFromCli] If true, the user auth part will have an exec command with qovery cli
+     * @param {boolean} [readOnly] If true, the kubeconfig exec plugin will request a read-only token backed by a Kubernetes ServiceAccount with the view ClusterRole
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ClustersApi
      */
-    public getClusterKubeconfig(organizationId: string, clusterId: string, withTokenFromCli?: boolean, options?: RawAxiosRequestConfig) {
-        return ClustersApiFp(this.configuration).getClusterKubeconfig(organizationId, clusterId, withTokenFromCli, options).then((request) => request(this.axios, this.basePath));
+    public getClusterKubeconfig(organizationId: string, clusterId: string, withTokenFromCli?: boolean, readOnly?: boolean, options?: RawAxiosRequestConfig) {
+        return ClustersApiFp(this.configuration).getClusterKubeconfig(organizationId, clusterId, withTokenFromCli, readOnly, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
@@ -45527,10 +45779,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
          * 
          * @summary Get cluster token by clusterId
          * @param {string} clusterId 
+         * @param {boolean} [readOnly] If true, returns a short-lived token for the qovery-readonly ServiceAccount (bound to view ClusterRole) generated by the cluster-agent
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getClusterTokenByClusterId: async (clusterId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getClusterTokenByClusterId: async (clusterId: string, readOnly?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'clusterId' is not null or undefined
             assertParamExists('getClusterTokenByClusterId', 'clusterId', clusterId)
             const localVarPath = `/cluster/{clusterId}/token`
@@ -45553,6 +45806,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
             // http bearer authentication required
             await setBearerAuthToObject(localVarHeaderParameter, configuration)
 
+            if (readOnly !== undefined) {
+                localVarQueryParameter['read_only'] = readOnly;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -45622,11 +45879,12 @@ export const DefaultApiFp = function(configuration?: Configuration) {
          * 
          * @summary Get cluster token by clusterId
          * @param {string} clusterId 
+         * @param {boolean} [readOnly] If true, returns a short-lived token for the qovery-readonly ServiceAccount (bound to view ClusterRole) generated by the cluster-agent
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getClusterTokenByClusterId(clusterId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClusterTokenByClusterId200Response>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterTokenByClusterId(clusterId, options);
+        async getClusterTokenByClusterId(clusterId: string, readOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClusterTokenByClusterId200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterTokenByClusterId(clusterId, readOnly, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['DefaultApi.getClusterTokenByClusterId']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -45658,11 +45916,12 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
          * 
          * @summary Get cluster token by clusterId
          * @param {string} clusterId 
+         * @param {boolean} [readOnly] If true, returns a short-lived token for the qovery-readonly ServiceAccount (bound to view ClusterRole) generated by the cluster-agent
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getClusterTokenByClusterId(clusterId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetClusterTokenByClusterId200Response> {
-            return localVarFp.getClusterTokenByClusterId(clusterId, options).then((request) => request(axios, basePath));
+        getClusterTokenByClusterId(clusterId: string, readOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetClusterTokenByClusterId200Response> {
+            return localVarFp.getClusterTokenByClusterId(clusterId, readOnly, options).then((request) => request(axios, basePath));
         },
         /**
          * 
@@ -45688,12 +45947,13 @@ export class DefaultApi extends BaseAPI {
      * 
      * @summary Get cluster token by clusterId
      * @param {string} clusterId 
+     * @param {boolean} [readOnly] If true, returns a short-lived token for the qovery-readonly ServiceAccount (bound to view ClusterRole) generated by the cluster-agent
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    public getClusterTokenByClusterId(clusterId: string, options?: RawAxiosRequestConfig) {
-        return DefaultApiFp(this.configuration).getClusterTokenByClusterId(clusterId, options).then((request) => request(this.axios, this.basePath));
+    public getClusterTokenByClusterId(clusterId: string, readOnly?: boolean, options?: RawAxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).getClusterTokenByClusterId(clusterId, readOnly, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**