qovery-typescript-axios 1.1.941 → 1.1.943

package/api.ts

@@ -21167,6 +21167,166 @@ export const OrganizationOnboardingStatusEnum = {
 export type OrganizationOnboardingStatusEnum = typeof OrganizationOnboardingStatusEnum[keyof typeof OrganizationOnboardingStatusEnum];
 
 
+/**
+ * 
+ * @export
+ * @interface OrganizationPolicyApiToken
+ */
+export interface OrganizationPolicyApiToken {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiToken
+     */
+    'id': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiToken
+     */
+    'created_at': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiToken
+     */
+    'updated_at'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiToken
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiToken
+     */
+    'description'?: string;
+    /**
+     * the Open Policy Agent (rego) policy evaluated on every request made with this token
+     * @type {string}
+     * @memberof OrganizationPolicyApiToken
+     */
+    'opa_policy'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiToken
+     */
+    'creator_name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiToken
+     */
+    'expires_at'?: string | null;
+}
+/**
+ * 
+ * @export
+ * @interface OrganizationPolicyApiTokenCreate
+ */
+export interface OrganizationPolicyApiTokenCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreate
+     */
+    'id': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreate
+     */
+    'created_at': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreate
+     */
+    'updated_at'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreate
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreate
+     */
+    'description'?: string;
+    /**
+     * the generated token to send in \'Authorization\' header prefixed by \'Token \'. It is returned only here and cannot be retrieved afterwards.
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreate
+     */
+    'token'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreate
+     */
+    'creator_name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreate
+     */
+    'user_sub'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreate
+     */
+    'expires_at'?: string | null;
+}
+/**
+ * 
+ * @export
+ * @interface OrganizationPolicyApiTokenCreateRequest
+ */
+export interface OrganizationPolicyApiTokenCreateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreateRequest
+     */
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreateRequest
+     */
+    'description'?: string;
+    /**
+     * Open Policy Agent (rego) rule definitions, without a `package` declaration: Qovery prepends a per-token package so that one token\'s rules cannot authorize another\'s. The policy must define an `allow` rule, and the request is denied unless it evaluates to true.
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreateRequest
+     */
+    'opa_policy': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationPolicyApiTokenCreateRequest
+     */
+    'expires_at'?: string | null;
+}
+/**
+ * 
+ * @export
+ * @interface OrganizationPolicyApiTokenResponseList
+ */
+export interface OrganizationPolicyApiTokenResponseList {
+    /**
+     * 
+     * @type {Array<OrganizationPolicyApiToken>}
+     * @memberof OrganizationPolicyApiTokenResponseList
+     */
+    'results'?: Array<OrganizationPolicyApiToken>;
+}
 /**
  * 
  * @export
@@ -68585,6 +68745,287 @@ export class OrganizationMainCallsApi extends BaseAPI {
 
 
 
+/**
+ * OrganizationPolicyApiTokenApi - axios parameter creator
+ * @export
+ */
+export const OrganizationPolicyApiTokenApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Create a policy api token, intended for autonomous agents calling the Qovery API.  Unlike a regular api token, a policy api token carries **no organization role**. The Open Policy Agent (rego) policy attached to it is evaluated on every request and is the only thing constraining what the token can do: a policy that allows everything grants full organization admin access. For that reason only an organization owner or admin can create one.  The generated token value is returned only in this response and cannot be retrieved afterwards.
+         * @summary Create an organization policy api token
+         * @param {string} organizationId Organization ID
+         * @param {OrganizationPolicyApiTokenCreateRequest} [organizationPolicyApiTokenCreateRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createOrganizationPolicyApiToken: async (organizationId: string, organizationPolicyApiTokenCreateRequest?: OrganizationPolicyApiTokenCreateRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'organizationId' is not null or undefined
+            assertParamExists('createOrganizationPolicyApiToken', 'organizationId', organizationId)
+            const localVarPath = `/organization/{organizationId}/policyApiToken`
+                .replace(`{${"organizationId"}}`, encodeURIComponent(String(organizationId)));
+            // 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: 'POST', ...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)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(organizationPolicyApiTokenCreateRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Delete organization policy api token
+         * @summary Delete organization policy api token
+         * @param {string} organizationId Organization ID
+         * @param {string} policyApiTokenId Organization Policy Api Token ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteOrganizationPolicyApiToken: async (organizationId: string, policyApiTokenId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'organizationId' is not null or undefined
+            assertParamExists('deleteOrganizationPolicyApiToken', 'organizationId', organizationId)
+            // verify required parameter 'policyApiTokenId' is not null or undefined
+            assertParamExists('deleteOrganizationPolicyApiToken', 'policyApiTokenId', policyApiTokenId)
+            const localVarPath = `/organization/{organizationId}/policyApiToken/{policyApiTokenId}`
+                .replace(`{${"organizationId"}}`, encodeURIComponent(String(organizationId)))
+                .replace(`{${"policyApiTokenId"}}`, encodeURIComponent(String(policyApiTokenId)));
+            // 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: 'DELETE', ...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,
+            };
+        },
+        /**
+         * List the policy api tokens of the organization, each with the Open Policy Agent (rego) policy it carries. The token value itself is never returned here, it is only shown once at creation.
+         * @summary List organization policy api tokens
+         * @param {string} organizationId Organization ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listOrganizationPolicyApiTokens: async (organizationId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'organizationId' is not null or undefined
+            assertParamExists('listOrganizationPolicyApiTokens', 'organizationId', organizationId)
+            const localVarPath = `/organization/{organizationId}/policyApiToken`
+                .replace(`{${"organizationId"}}`, encodeURIComponent(String(organizationId)));
+            // 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,
+            };
+        },
+    }
+};
+
+/**
+ * OrganizationPolicyApiTokenApi - functional programming interface
+ * @export
+ */
+export const OrganizationPolicyApiTokenApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = OrganizationPolicyApiTokenApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Create a policy api token, intended for autonomous agents calling the Qovery API.  Unlike a regular api token, a policy api token carries **no organization role**. The Open Policy Agent (rego) policy attached to it is evaluated on every request and is the only thing constraining what the token can do: a policy that allows everything grants full organization admin access. For that reason only an organization owner or admin can create one.  The generated token value is returned only in this response and cannot be retrieved afterwards.
+         * @summary Create an organization policy api token
+         * @param {string} organizationId Organization ID
+         * @param {OrganizationPolicyApiTokenCreateRequest} [organizationPolicyApiTokenCreateRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createOrganizationPolicyApiToken(organizationId: string, organizationPolicyApiTokenCreateRequest?: OrganizationPolicyApiTokenCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationPolicyApiTokenCreate>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createOrganizationPolicyApiToken(organizationId, organizationPolicyApiTokenCreateRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrganizationPolicyApiTokenApi.createOrganizationPolicyApiToken']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Delete organization policy api token
+         * @summary Delete organization policy api token
+         * @param {string} organizationId Organization ID
+         * @param {string} policyApiTokenId Organization Policy Api Token ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async deleteOrganizationPolicyApiToken(organizationId: string, policyApiTokenId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOrganizationPolicyApiToken(organizationId, policyApiTokenId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrganizationPolicyApiTokenApi.deleteOrganizationPolicyApiToken']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * List the policy api tokens of the organization, each with the Open Policy Agent (rego) policy it carries. The token value itself is never returned here, it is only shown once at creation.
+         * @summary List organization policy api tokens
+         * @param {string} organizationId Organization ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listOrganizationPolicyApiTokens(organizationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationPolicyApiTokenResponseList>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listOrganizationPolicyApiTokens(organizationId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrganizationPolicyApiTokenApi.listOrganizationPolicyApiTokens']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * OrganizationPolicyApiTokenApi - factory interface
+ * @export
+ */
+export const OrganizationPolicyApiTokenApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = OrganizationPolicyApiTokenApiFp(configuration)
+    return {
+        /**
+         * Create a policy api token, intended for autonomous agents calling the Qovery API.  Unlike a regular api token, a policy api token carries **no organization role**. The Open Policy Agent (rego) policy attached to it is evaluated on every request and is the only thing constraining what the token can do: a policy that allows everything grants full organization admin access. For that reason only an organization owner or admin can create one.  The generated token value is returned only in this response and cannot be retrieved afterwards.
+         * @summary Create an organization policy api token
+         * @param {string} organizationId Organization ID
+         * @param {OrganizationPolicyApiTokenCreateRequest} [organizationPolicyApiTokenCreateRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createOrganizationPolicyApiToken(organizationId: string, organizationPolicyApiTokenCreateRequest?: OrganizationPolicyApiTokenCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrganizationPolicyApiTokenCreate> {
+            return localVarFp.createOrganizationPolicyApiToken(organizationId, organizationPolicyApiTokenCreateRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Delete organization policy api token
+         * @summary Delete organization policy api token
+         * @param {string} organizationId Organization ID
+         * @param {string} policyApiTokenId Organization Policy Api Token ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteOrganizationPolicyApiToken(organizationId: string, policyApiTokenId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.deleteOrganizationPolicyApiToken(organizationId, policyApiTokenId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * List the policy api tokens of the organization, each with the Open Policy Agent (rego) policy it carries. The token value itself is never returned here, it is only shown once at creation.
+         * @summary List organization policy api tokens
+         * @param {string} organizationId Organization ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listOrganizationPolicyApiTokens(organizationId: string, options?: RawAxiosRequestConfig): AxiosPromise<OrganizationPolicyApiTokenResponseList> {
+            return localVarFp.listOrganizationPolicyApiTokens(organizationId, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * OrganizationPolicyApiTokenApi - object-oriented interface
+ * @export
+ * @class OrganizationPolicyApiTokenApi
+ * @extends {BaseAPI}
+ */
+export class OrganizationPolicyApiTokenApi extends BaseAPI {
+    /**
+     * Create a policy api token, intended for autonomous agents calling the Qovery API.  Unlike a regular api token, a policy api token carries **no organization role**. The Open Policy Agent (rego) policy attached to it is evaluated on every request and is the only thing constraining what the token can do: a policy that allows everything grants full organization admin access. For that reason only an organization owner or admin can create one.  The generated token value is returned only in this response and cannot be retrieved afterwards.
+     * @summary Create an organization policy api token
+     * @param {string} organizationId Organization ID
+     * @param {OrganizationPolicyApiTokenCreateRequest} [organizationPolicyApiTokenCreateRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrganizationPolicyApiTokenApi
+     */
+    public createOrganizationPolicyApiToken(organizationId: string, organizationPolicyApiTokenCreateRequest?: OrganizationPolicyApiTokenCreateRequest, options?: RawAxiosRequestConfig) {
+        return OrganizationPolicyApiTokenApiFp(this.configuration).createOrganizationPolicyApiToken(organizationId, organizationPolicyApiTokenCreateRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Delete organization policy api token
+     * @summary Delete organization policy api token
+     * @param {string} organizationId Organization ID
+     * @param {string} policyApiTokenId Organization Policy Api Token ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrganizationPolicyApiTokenApi
+     */
+    public deleteOrganizationPolicyApiToken(organizationId: string, policyApiTokenId: string, options?: RawAxiosRequestConfig) {
+        return OrganizationPolicyApiTokenApiFp(this.configuration).deleteOrganizationPolicyApiToken(organizationId, policyApiTokenId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * List the policy api tokens of the organization, each with the Open Policy Agent (rego) policy it carries. The token value itself is never returned here, it is only shown once at creation.
+     * @summary List organization policy api tokens
+     * @param {string} organizationId Organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrganizationPolicyApiTokenApi
+     */
+    public listOrganizationPolicyApiTokens(organizationId: string, options?: RawAxiosRequestConfig) {
+        return OrganizationPolicyApiTokenApiFp(this.configuration).listOrganizationPolicyApiTokens(organizationId, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+
+
 /**
  * OrganizationWebhookApi - axios parameter creator
  * @export