From 7e8b9915c6f2e55ab6b6dbbb36c7eded3bcec2db Mon Sep 17 00:00:00 2001 From: johanneswuerbach <864578+johanneswuerbach@users.noreply.github.com> Date: Mon, 1 Apr 2024 10:06:03 +0000 Subject: [PATCH] Update dependencies --- docs/openapi.json | 461 +++++++++----- src/generated/api.ts | 1043 ++++++++++++++++++++++++++++---- src/generated/base.ts | 2 +- src/generated/common.ts | 2 +- src/generated/configuration.ts | 2 +- src/generated/index.ts | 2 +- 6 files changed, 1234 insertions(+), 278 deletions(-) diff --git a/docs/openapi.json b/docs/openapi.json index 3c44c16b..af27d2f6 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "Humanitec API", - "version": "0.25.8", + "version": "0.25.9", "description": "# Introduction\nThe *Humanitec API* allows you to automate and integrate Humanitec into your developer and operational workflows.\nThe API is a REST based API. It is based around a set of concepts:\n\n* Core\n* External Resources\n* Sets and Deltas\n\n## Authentication\n\nAlmost all requests made to the Humanitec API require Authentication. See our [Developer Docs on API Authentication](https://developer.humanitec.com/platform-orchestrator/reference/api-references/#authentication) for instructions.\n\n## Content Types\nAll of the Humanitec API unless explicitly only accepts content types of `application/json` and will always return valid `application/json` or an empty response.\n\n## Response Codes\n### Success\nAny response code in the `2xx` range should be regarded as success.\n\n| **Code** | **Meaning** |\n| --- | --- |\n| `200` | Success |\n| `201` | Success (In future, `201` will be replaced by `200`) |\n| `204` | Success, but no content in response |\n\n_Note: We plan to simplify the interface by replacing 201 with 200 status codes._\n\n### Failure\nAny response code in the `4xx` should be regarded as an error which can be rectified by the client. `5xx` error codes indicate errors that cannot be corrected by the client.\n\n| **Code** | **Meaning** |\n| --- | --- |\n| `400` | General error. (Body will contain details) |\n| `401` | Attempt to access protected resource without `Authorization` Header. |\n| `403` | The `Bearer` or `JWT` does not grant access to the requested resource. |\n| `404` | Resource not found. |\n| `405` | Method not allowed |\n| `409` | Conflict. Usually indicated a resource with that ID already exists. |\n| `422` | Unprocessable Entity. The body was not valid JSON, was empty or contained an object different from what was expected. |\n| `429` | Too many requests - request rate limit has been reached. |\n| `500` | Internal Error. If it occurs repeatedly, contact support. |\n", "contact": { "name": "API Support", @@ -723,6 +723,76 @@ } } }, + "patch": { + "tags": [ + "public", + "Environment" + ], + "summary": "Update a specific Environment.", + "operationId": "updateEnvironment", + "description": "Update a specific Environment in an Application.", + "parameters": [ + { + "name": "orgId", + "in": "path", + "description": "The Organization ID.\n\n", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "appId", + "in": "path", + "description": "The Application ID.\n\n", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "envId", + "in": "path", + "description": "The Environment ID.\n\n", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EnvironmentBaseUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "description": "The updated Environment.\n\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EnvironmentResponse" + }, + "example": {} + } + } + }, + "404": { + "description": "No Environment with `id` in Application.\n\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HumanitecErrorResponse" + } + } + } + } + } + }, "delete": { "tags": [ "public", @@ -1426,6 +1496,77 @@ } } } + }, + "patch": { + "tags": [ + "public", + "EnvironmentType" + ], + "summary": "Updates Environment Type", + "operationId": "updateEnvironmentType", + "description": "Updates Environment Type.", + "parameters": [ + { + "name": "orgId", + "in": "path", + "description": "The Organization ID.\n\n", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "envTypeId", + "in": "path", + "description": "ID of the Environment Type.\n\n", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateEnvironmentTypePayloadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "The Environment Type updated.\n\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EnvironmentTypeResponse" + } + } + } + }, + "401": { + "description": "The Authorization header was not present or invalid.\n\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HumanitecErrorResponse" + } + } + } + }, + "404": { + "description": "No Environment Type with provided ID exists.\n\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HumanitecErrorResponse" + } + } + } + } + } } }, "/orgs/{orgId}/artefact-versions": { @@ -4169,6 +4310,9 @@ } } } + }, + "404": { + "$ref": "#/components/responses/404NotFound" } } } @@ -4211,13 +4355,7 @@ "operationId": "getOrganization", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" } ], "responses": { @@ -5798,6 +5936,46 @@ } } }, + "/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/batches/{batchType}": { + "get": { + "tags": [ + "public", + "Pipelines" + ], + "operationId": "GetBatch", + "summary": "Read the current state of a trigger batch", + "description": "Read the current state of a trigger batch for a Pipeline if one exists", + "parameters": [ + { + "$ref": "#/components/parameters/orgIdPathParam" + }, + { + "$ref": "#/components/parameters/appIdPathParam" + }, + { + "$ref": "#/components/parameters/pipelineIdPathParam" + }, + { + "$ref": "#/components/parameters/batchTypeParam" + } + ], + "responses": { + "200": { + "description": "Successful get batch request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Batch" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404NotFound" + } + } + } + }, "/orgs/{orgId}/registries": { "get": { "tags": [ @@ -8570,13 +8748,7 @@ "operationId": "listUserRolesInApp", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "appId", @@ -8616,13 +8788,7 @@ "operationId": "createUserRoleInApp", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "appId", @@ -8686,13 +8852,7 @@ "operationId": "getUserRoleInApp", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "appId", @@ -8748,13 +8908,7 @@ "operationId": "deleteUserRoleInApp", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "appId", @@ -8803,13 +8957,7 @@ "operationId": "updateUserRoleInApp", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "appId", @@ -8878,13 +9026,7 @@ "operationId": "listUserRolesInEnvType", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "envType", @@ -8924,13 +9066,7 @@ "operationId": "createUserRoleInEnvType", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "envType", @@ -8994,13 +9130,7 @@ "operationId": "getUserRoleInEnvType", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "envType", @@ -9056,13 +9186,7 @@ "operationId": "deleteUserRoleInEnvType", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "envType", @@ -9111,13 +9235,7 @@ "operationId": "updateUserRoleInEnvType", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "envType", @@ -9186,13 +9304,7 @@ "operationId": "listInvitesInOrg", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" } ], "responses": { @@ -9220,13 +9332,7 @@ "operationId": "createInviteInOrg", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" } ], "requestBody": { @@ -9284,13 +9390,7 @@ "operationId": "listUserRolesInOrg", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" } ], "responses": { @@ -9321,13 +9421,7 @@ "operationId": "createServiceUserInOrg", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" } ], "requestBody": { @@ -9381,13 +9475,7 @@ "operationId": "getUserRoleInOrg", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "userId", @@ -9434,13 +9522,7 @@ "operationId": "deleteUserRoleInOrg", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "userId", @@ -9480,13 +9562,7 @@ "operationId": "updateUserRoleInOrg", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { "name": "userId", @@ -11719,7 +11795,8 @@ "required": true, "schema": { "type": "string", - "pattern": "^[a-z0-9](?:-?[a-z0-9]+)+$" + "pattern": "^[a-z0-9](?:-?[a-z0-9]+)+$", + "maxLength": 50 } }, "agentIdPathParam": { @@ -12028,10 +12105,10 @@ }, "batchTypeParam": { "name": "batchType", - "description": "The batch type", + "description": "The batch type, only artefact is implemented.", "in": "path", "required": true, - "example": "image", + "example": "artefact", "schema": { "type": "string" } @@ -12593,6 +12670,7 @@ "example": "2020-06-22T09:37:23.523Z", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{3})?Z$", "title": "Simplified extended ISO format date/time string.", + "format": "date-time", "type": "string" }, "created_by": { @@ -12638,6 +12716,7 @@ "example": "2020-06-22T09:37:23.523Z", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{3})?Z$", "title": "Simplified extended ISO format date/time string.", + "format": "date-time", "type": "string" }, "value_set_version_id": { @@ -12684,6 +12763,15 @@ ], "type": "object" }, + "EnvironmentBaseUpdateRequest": { + "properties": { + "name": { + "description": "The Human-friendly name for the Environment.", + "type": "string" + } + }, + "type": "object" + }, "EnvironmentBaseResponse": { "properties": { "id": { @@ -12771,6 +12859,7 @@ "example": "2020-06-22T09:37:23.523Z", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{3})?Z$", "title": "Simplified extended ISO format date/time string.", + "format": "date-time", "type": "string" }, "created_by": { @@ -12882,6 +12971,19 @@ "message": "Could not validate token." } }, + "UpdateEnvironmentTypePayloadRequest": { + "description": "UpdateEnvironmentTypePayload contains the `description` field that should be set in the Environment Type to update.", + "example": { + "description": "Example Environment Type description" + }, + "properties": { + "description": { + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, "CreateArtefactVersionBase": { "type": "object", "required": [ @@ -14534,9 +14636,6 @@ "HumanitecPublicKey": { "description": "HumanitecPublicKey stores a Public Key Humanitec shared with an organization.", "properties": { - "id": { - "type": "string" - }, "pub_key": { "type": "string" }, @@ -14548,27 +14647,54 @@ "format": "date-time", "title": "Simplified extended ISO format date/time string.", "type": "string" + } + }, + "required": [ + "pub_key", + "active", + "created_at" + ] + }, + "Jwk": { + "description": "JSON Web Key", + "type": "object", + "properties": { + "alg": { + "type": "string" }, - "updated_at": { - "example": "2020-06-22T09:37:23.523Z", - "format": "date-time", - "title": "Simplified extended ISO format date/time string.", + "kty": { "type": "string" }, - "expired_at": { - "example": "2020-06-22T09:37:23.523Z", - "format": "date-time", - "title": "Date of key expiration.", + "use": { + "type": "string" + }, + "x5c": { + "type": "array", + "items": { + "type": "string" + } + }, + "n": { + "type": "string" + }, + "e": { + "type": "string" + }, + "kid": { + "type": "string" + }, + "x5t": { "type": "string" } }, "required": [ - "id", - "pub_key", - "active", - "created_at", - "updated_at", - "expired_at" + "alg", + "kty", + "use", + "n", + "e", + "kid", + "x5t" ] }, "LogoResponse": { @@ -14615,6 +14741,10 @@ "nullable": true, "format": "date-time", "type": "string" + }, + "scaffolding_url": { + "description": "URL of the scaffolding service.", + "type": "string" } }, "required": [ @@ -15393,6 +15523,43 @@ } } }, + "Batch": { + "description": "A batch of items that are being collected for a upcoming run.", + "required": [ + "items" + ], + "properties": { + "items": { + "description": "The list of item ids that are currently contained in this batch.", + "type": "array", + "items": { + "$ref": "#/components/schemas/BatchItem" + } + }, + "scheduled_at": { + "description": "The time at which this batch is scheduled to trigger the pipeline.", + "type": "string", + "format": "date-time" + } + } + }, + "BatchItem": { + "type": "object", + "required": [ + "type", + "ref" + ], + "properties": { + "type": { + "description": "The type of item in the batch", + "type": "string" + }, + "ref": { + "description": "The reference id of the item", + "type": "string" + } + } + }, "AccountCredsRequest": { "description": "AccountCreds represents an account credentials (either, username- or token-based).", "example": { diff --git a/src/generated/api.ts b/src/generated/api.ts index 2fc98ab4..751b27fc 100644 --- a/src/generated/api.ts +++ b/src/generated/api.ts @@ -4,7 +4,7 @@ * Humanitec API * # Introduction The *Humanitec API* allows you to automate and integrate Humanitec into your developer and operational workflows. The API is a REST based API. It is based around a set of concepts: * Core * External Resources * Sets and Deltas ## Authentication Almost all requests made to the Humanitec API require Authentication. See our [Developer Docs on API Authentication](https://developer.humanitec.com/platform-orchestrator/reference/api-references/#authentication) for instructions. ## Content Types All of the Humanitec API unless explicitly only accepts content types of `application/json` and will always return valid `application/json` or an empty response. ## Response Codes ### Success Any response code in the `2xx` range should be regarded as success. | **Code** | **Meaning** | | --- | --- | | `200` | Success | | `201` | Success (In future, `201` will be replaced by `200`) | | `204` | Success, but no content in response | _Note: We plan to simplify the interface by replacing 201 with 200 status codes._ ### Failure Any response code in the `4xx` should be regarded as an error which can be rectified by the client. `5xx` error codes indicate errors that cannot be corrected by the client. | **Code** | **Meaning** | | --- | --- | | `400` | General error. (Body will contain details) | | `401` | Attempt to access protected resource without `Authorization` Header. | | `403` | The `Bearer` or `JWT` does not grant access to the requested resource. | | `404` | Resource not found. | | `405` | Method not allowed | | `409` | Conflict. Usually indicated a resource with that ID already exists. | | `422` | Unprocessable Entity. The body was not valid JSON, was empty or contained an object different from what was expected. | | `429` | Too many requests - request rate limit has been reached. | | `500` | Internal Error. If it occurs repeatedly, contact support. | * - * The version of the OpenAPI document: 0.25.8 + * The version of the OpenAPI document: 0.25.9 * Contact: apiteam@humanitec.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -902,6 +902,44 @@ export interface AzureKVResponse { */ 'url'?: string; } +/** + * A batch of items that are being collected for a upcoming run. + * @export + * @interface Batch + */ +export interface Batch { + /** + * The list of item ids that are currently contained in this batch. + * @type {Array} + * @memberof Batch + */ + 'items': Array; + /** + * The time at which this batch is scheduled to trigger the pipeline. + * @type {string} + * @memberof Batch + */ + 'scheduled_at'?: string; +} +/** + * + * @export + * @interface BatchItem + */ +export interface BatchItem { + /** + * The type of item in the batch + * @type {string} + * @memberof BatchItem + */ + 'type': string; + /** + * The reference id of the item + * @type {string} + * @memberof BatchItem + */ + 'ref': string; +} /** * ClusterSecret represents Kubernetes secret reference. * @export @@ -2093,6 +2131,19 @@ export interface EnvironmentBaseResponse { */ 'type': string; } +/** + * + * @export + * @interface EnvironmentBaseUpdateRequest + */ +export interface EnvironmentBaseUpdateRequest { + /** + * The Human-friendly name for the Environment. + * @type {string} + * @memberof EnvironmentBaseUpdateRequest + */ + 'name'?: string; +} /** * * @export @@ -2419,12 +2470,6 @@ export interface HumanitecErrorResponse { * @interface HumanitecPublicKey */ export interface HumanitecPublicKey { - /** - * - * @type {string} - * @memberof HumanitecPublicKey - */ - 'id': string; /** * * @type {string} @@ -2443,18 +2488,6 @@ export interface HumanitecPublicKey { * @memberof HumanitecPublicKey */ 'created_at': string; - /** - * - * @type {string} - * @memberof HumanitecPublicKey - */ - 'updated_at': string; - /** - * - * @type {string} - * @memberof HumanitecPublicKey - */ - 'expired_at': string; } /** * DEPRECATED: This type exists for historical compatibility and should not be used. Please use the [Artefact API](https://api-docs.humanitec.com/#tag/Artefact) instead. Holds the metadata associated withe a Container Image Build @@ -2686,6 +2719,61 @@ export interface JSONPatchResponse { */ 'value'?: any; } +/** + * JSON Web Key + * @export + * @interface Jwk + */ +export interface Jwk { + /** + * + * @type {string} + * @memberof Jwk + */ + 'alg': string; + /** + * + * @type {string} + * @memberof Jwk + */ + 'kty': string; + /** + * + * @type {string} + * @memberof Jwk + */ + 'use': string; + /** + * + * @type {Array} + * @memberof Jwk + */ + 'x5c'?: Array; + /** + * + * @type {string} + * @memberof Jwk + */ + 'n': string; + /** + * + * @type {string} + * @memberof Jwk + */ + 'e': string; + /** + * + * @type {string} + * @memberof Jwk + */ + 'kid': string; + /** + * + * @type {string} + * @memberof Jwk + */ + 'x5t': string; +} /** * An object containing the details of a Key. * @export @@ -3120,6 +3208,12 @@ export interface OrganizationResponse { * @memberof OrganizationResponse */ 'trial_expires_at': string | null; + /** + * URL of the scaffolding service. + * @type {string} + * @memberof OrganizationResponse + */ + 'scaffolding_url'?: string; } /** * @type OrgsOrgIdAppsAppIdDeltasPost200Response @@ -5306,6 +5400,19 @@ export interface UpdateDriverRequestRequest { */ 'is_public'?: boolean; } +/** + * UpdateEnvironmentTypePayload contains the `description` field that should be set in the Environment Type to update. + * @export + * @interface UpdateEnvironmentTypePayloadRequest + */ +export interface UpdateEnvironmentTypePayloadRequest { + /** + * + * @type {string} + * @memberof UpdateEnvironmentTypePayloadRequest + */ + 'description'?: string | null; +} /** * UpdateResourceAccountRequest describes the request to update the security account details. * @export @@ -12554,6 +12661,52 @@ export const EnvironmentApiAxiosParamCreator = function (configuration?: Configu localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update a specific Environment in an Application. + * @summary Update a specific Environment. + * @param {string} orgId The Organization ID. + * @param {string} appId The Application ID. + * @param {string} envId The Environment ID. + * @param {EnvironmentBaseUpdateRequest} [environmentBaseUpdateRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateEnvironment: async (orgId: string, appId: string, envId: string, environmentBaseUpdateRequest?: EnvironmentBaseUpdateRequest, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('updateEnvironment', 'orgId', orgId) + // verify required parameter 'appId' is not null or undefined + assertParamExists('updateEnvironment', 'appId', appId) + // verify required parameter 'envId' is not null or undefined + assertParamExists('updateEnvironment', 'envId', envId) + const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) + .replace(`{${"envId"}}`, encodeURIComponent(String(envId))); + // 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: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(environmentBaseUpdateRequest, localVarRequestOptions, configuration) + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -12634,6 +12787,20 @@ export const EnvironmentApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.rebaseEnvironment(orgId, appId, envId, body, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Update a specific Environment in an Application. + * @summary Update a specific Environment. + * @param {string} orgId The Organization ID. + * @param {string} appId The Application ID. + * @param {string} envId The Environment ID. + * @param {EnvironmentBaseUpdateRequest} [environmentBaseUpdateRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateEnvironment(orgId: string, appId: string, envId: string, environmentBaseUpdateRequest?: EnvironmentBaseUpdateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateEnvironment(orgId, appId, envId, environmentBaseUpdateRequest, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, } }; @@ -12694,6 +12861,16 @@ export const EnvironmentApiFactory = function (configuration?: Configuration, ba rebaseEnvironment(requestParameters: EnvironmentApiRebaseEnvironmentRequest, options?: AxiosRequestConfig): AxiosPromise { return localVarFp.rebaseEnvironment(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.body, options).then((request) => request(axios, basePath)); }, + /** + * Update a specific Environment in an Application. + * @summary Update a specific Environment. + * @param {EnvironmentApiUpdateEnvironmentRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateEnvironment(requestParameters: EnvironmentApiUpdateEnvironmentRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.updateEnvironment(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.environmentBaseUpdateRequest, options).then((request) => request(axios, basePath)); + }, }; }; @@ -12837,6 +13014,41 @@ export interface EnvironmentApiRebaseEnvironmentRequest { readonly body: string } +/** + * Request parameters for updateEnvironment operation in EnvironmentApi. + * @export + * @interface EnvironmentApiUpdateEnvironmentRequest + */ +export interface EnvironmentApiUpdateEnvironmentRequest { + /** + * The Organization ID. + * @type {string} + * @memberof EnvironmentApiUpdateEnvironment + */ + readonly orgId: string + + /** + * The Application ID. + * @type {string} + * @memberof EnvironmentApiUpdateEnvironment + */ + readonly appId: string + + /** + * The Environment ID. + * @type {string} + * @memberof EnvironmentApiUpdateEnvironment + */ + readonly envId: string + + /** + * + * @type {EnvironmentBaseUpdateRequest} + * @memberof EnvironmentApiUpdateEnvironment + */ + readonly environmentBaseUpdateRequest?: EnvironmentBaseUpdateRequest +} + /** * EnvironmentApi - object-oriented interface * @export @@ -12903,6 +13115,18 @@ export class EnvironmentApi extends BaseAPI { public rebaseEnvironment(requestParameters: EnvironmentApiRebaseEnvironmentRequest, options?: AxiosRequestConfig) { return EnvironmentApiFp(this.configuration).rebaseEnvironment(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } + + /** + * Update a specific Environment in an Application. + * @summary Update a specific Environment. + * @param {EnvironmentApiUpdateEnvironmentRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof EnvironmentApi + */ + public updateEnvironment(requestParameters: EnvironmentApiUpdateEnvironmentRequest, options?: AxiosRequestConfig) { + return EnvironmentApiFp(this.configuration).updateEnvironment(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.environmentBaseUpdateRequest, options).then((request) => request(this.axios, this.basePath)); + } } @@ -13214,6 +13438,50 @@ export const EnvironmentTypeApiAxiosParamCreator = function (configuration?: Con let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates Environment Type. + * @summary Updates Environment Type + * @param {string} orgId The Organization ID. + * @param {string} envTypeId ID of the Environment Type. + * @param {UpdateEnvironmentTypePayloadRequest} updateEnvironmentTypePayloadRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateEnvironmentType: async (orgId: string, envTypeId: string, updateEnvironmentTypePayloadRequest: UpdateEnvironmentTypePayloadRequest, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('updateEnvironmentType', 'orgId', orgId) + // verify required parameter 'envTypeId' is not null or undefined + assertParamExists('updateEnvironmentType', 'envTypeId', envTypeId) + // verify required parameter 'updateEnvironmentTypePayloadRequest' is not null or undefined + assertParamExists('updateEnvironmentType', 'updateEnvironmentTypePayloadRequest', updateEnvironmentTypePayloadRequest) + const localVarPath = `/orgs/{orgId}/env-types/{envTypeId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"envTypeId"}}`, encodeURIComponent(String(envTypeId))); + // 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: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateEnvironmentTypePayloadRequest, localVarRequestOptions, configuration) + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -13276,6 +13544,19 @@ export const EnvironmentTypeApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.listEnvironmentTypes(orgId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Updates Environment Type. + * @summary Updates Environment Type + * @param {string} orgId The Organization ID. + * @param {string} envTypeId ID of the Environment Type. + * @param {UpdateEnvironmentTypePayloadRequest} updateEnvironmentTypePayloadRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateEnvironmentType(orgId: string, envTypeId: string, updateEnvironmentTypePayloadRequest: UpdateEnvironmentTypePayloadRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateEnvironmentType(orgId, envTypeId, updateEnvironmentTypePayloadRequest, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, } }; @@ -13326,6 +13607,16 @@ export const EnvironmentTypeApiFactory = function (configuration?: Configuration listEnvironmentTypes(requestParameters: EnvironmentTypeApiListEnvironmentTypesRequest, options?: AxiosRequestConfig): AxiosPromise> { return localVarFp.listEnvironmentTypes(requestParameters.orgId, options).then((request) => request(axios, basePath)); }, + /** + * Updates Environment Type. + * @summary Updates Environment Type + * @param {EnvironmentTypeApiUpdateEnvironmentTypeRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateEnvironmentType(requestParameters: EnvironmentTypeApiUpdateEnvironmentTypeRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.updateEnvironmentType(requestParameters.orgId, requestParameters.envTypeId, requestParameters.updateEnvironmentTypePayloadRequest, options).then((request) => request(axios, basePath)); + }, }; }; @@ -13406,6 +13697,34 @@ export interface EnvironmentTypeApiListEnvironmentTypesRequest { readonly orgId: string } +/** + * Request parameters for updateEnvironmentType operation in EnvironmentTypeApi. + * @export + * @interface EnvironmentTypeApiUpdateEnvironmentTypeRequest + */ +export interface EnvironmentTypeApiUpdateEnvironmentTypeRequest { + /** + * The Organization ID. + * @type {string} + * @memberof EnvironmentTypeApiUpdateEnvironmentType + */ + readonly orgId: string + + /** + * ID of the Environment Type. + * @type {string} + * @memberof EnvironmentTypeApiUpdateEnvironmentType + */ + readonly envTypeId: string + + /** + * + * @type {UpdateEnvironmentTypePayloadRequest} + * @memberof EnvironmentTypeApiUpdateEnvironmentType + */ + readonly updateEnvironmentTypePayloadRequest: UpdateEnvironmentTypePayloadRequest +} + /** * EnvironmentTypeApi - object-oriented interface * @export @@ -13460,6 +13779,18 @@ export class EnvironmentTypeApi extends BaseAPI { public listEnvironmentTypes(requestParameters: EnvironmentTypeApiListEnvironmentTypesRequest, options?: AxiosRequestConfig) { return EnvironmentTypeApiFp(this.configuration).listEnvironmentTypes(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath)); } + + /** + * Updates Environment Type. + * @summary Updates Environment Type + * @param {EnvironmentTypeApiUpdateEnvironmentTypeRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof EnvironmentTypeApi + */ + public updateEnvironmentType(requestParameters: EnvironmentTypeApiUpdateEnvironmentTypeRequest, options?: AxiosRequestConfig) { + return EnvironmentTypeApiFp(this.configuration).updateEnvironmentType(requestParameters.orgId, requestParameters.envTypeId, requestParameters.updateEnvironmentTypePayloadRequest, options).then((request) => request(this.axios, this.basePath)); + } } @@ -15127,7 +15458,7 @@ export const OrganizationApiAxiosParamCreator = function (configuration?: Config /** * * @summary Get the specified Organization. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -15201,7 +15532,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) { /** * * @summary Get the specified Organization. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -15258,7 +15589,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b */ export interface OrganizationApiGetOrganizationRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof OrganizationApiGetOrganization */ @@ -17767,6 +18098,52 @@ export const PipelinesApiAxiosParamCreator = function (configuration?: Configura + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Read the current state of a trigger batch for a Pipeline if one exists + * @summary Read the current state of a trigger batch + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} pipelineId The Pipeline ID + * @param {string} batchType The batch type, only artefact is implemented. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBatch: async (orgId: string, appId: string, pipelineId: string, batchType: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('getBatch', 'orgId', orgId) + // verify required parameter 'appId' is not null or undefined + assertParamExists('getBatch', 'appId', appId) + // verify required parameter 'pipelineId' is not null or undefined + assertParamExists('getBatch', 'pipelineId', pipelineId) + // verify required parameter 'batchType' is not null or undefined + assertParamExists('getBatch', 'batchType', batchType) + const localVarPath = `/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/batches/{batchType}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) + .replace(`{${"pipelineId"}}`, encodeURIComponent(String(pipelineId))) + .replace(`{${"batchType"}}`, encodeURIComponent(String(batchType))); + // 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; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -18306,6 +18683,20 @@ export const PipelinesApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.deletePipelineCriteria(orgId, appId, pipelineId, criteriaId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Read the current state of a trigger batch for a Pipeline if one exists + * @summary Read the current state of a trigger batch + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} pipelineId The Pipeline ID + * @param {string} batchType The batch type, only artefact is implemented. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getBatch(orgId: string, appId: string, pipelineId: string, batchType: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getBatch(orgId, appId, pipelineId, batchType, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Gets the latest pipeline schema @@ -18489,6 +18880,16 @@ export const PipelinesApiFactory = function (configuration?: Configuration, base deletePipelineCriteria(requestParameters: PipelinesApiDeletePipelineCriteriaRequest, options?: AxiosRequestConfig): AxiosPromise { return localVarFp.deletePipelineCriteria(requestParameters.orgId, requestParameters.appId, requestParameters.pipelineId, requestParameters.criteriaId, options).then((request) => request(axios, basePath)); }, + /** + * Read the current state of a trigger batch for a Pipeline if one exists + * @summary Read the current state of a trigger batch + * @param {PipelinesApiGetBatchRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBatch(requestParameters: PipelinesApiGetBatchRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.getBatch(requestParameters.orgId, requestParameters.appId, requestParameters.pipelineId, requestParameters.batchType, options).then((request) => request(axios, basePath)); + }, /** * * @summary Gets the latest pipeline schema @@ -18722,6 +19123,41 @@ export interface PipelinesApiDeletePipelineCriteriaRequest { readonly criteriaId: string } +/** + * Request parameters for getBatch operation in PipelinesApi. + * @export + * @interface PipelinesApiGetBatchRequest + */ +export interface PipelinesApiGetBatchRequest { + /** + * The Organization ID + * @type {string} + * @memberof PipelinesApiGetBatch + */ + readonly orgId: string + + /** + * The Application ID + * @type {string} + * @memberof PipelinesApiGetBatch + */ + readonly appId: string + + /** + * The Pipeline ID + * @type {string} + * @memberof PipelinesApiGetBatch + */ + readonly pipelineId: string + + /** + * The batch type, only artefact is implemented. + * @type {string} + * @memberof PipelinesApiGetBatch + */ + readonly batchType: string +} + /** * Request parameters for getLatestPipelineDefinitionSchema operation in PipelinesApi. * @export @@ -19141,6 +19577,18 @@ export class PipelinesApi extends BaseAPI { return PipelinesApiFp(this.configuration).deletePipelineCriteria(requestParameters.orgId, requestParameters.appId, requestParameters.pipelineId, requestParameters.criteriaId, options).then((request) => request(this.axios, this.basePath)); } + /** + * Read the current state of a trigger batch for a Pipeline if one exists + * @summary Read the current state of a trigger batch + * @param {PipelinesApiGetBatchRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PipelinesApi + */ + public getBatch(requestParameters: PipelinesApiGetBatchRequest, options?: AxiosRequestConfig) { + return PipelinesApiFp(this.configuration).getBatch(requestParameters.orgId, requestParameters.appId, requestParameters.pipelineId, requestParameters.batchType, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Gets the latest pipeline schema @@ -19671,7 +20119,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Invites a user to an Organization with a specified role. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {UserInviteRequestRequest} userInviteRequestRequest The email and the desired role * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20168,7 +20616,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Creates a new service user. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {NewServiceUserRequest} newServiceUserRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20208,7 +20656,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Adds a User to an Application with a Role - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {UserRoleRequest} userRoleRequest The user ID and the role * @param {*} [options] Override http request option. @@ -20252,7 +20700,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Adds a User to an Environment Type with a Role - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {UserRoleRequest} userRoleRequest The user ID and the role * @param {*} [options] Override http request option. @@ -21058,7 +21506,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Remove the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -21100,7 +21548,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Remove the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -21142,7 +21590,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Remove the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -21374,6 +21822,52 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Read the current state of a trigger batch for a Pipeline if one exists + * @summary Read the current state of a trigger batch + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} pipelineId The Pipeline ID + * @param {string} batchType The batch type, only artefact is implemented. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBatch: async (orgId: string, appId: string, pipelineId: string, batchType: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('getBatch', 'orgId', orgId) + // verify required parameter 'appId' is not null or undefined + assertParamExists('getBatch', 'appId', appId) + // verify required parameter 'pipelineId' is not null or undefined + assertParamExists('getBatch', 'pipelineId', pipelineId) + // verify required parameter 'batchType' is not null or undefined + assertParamExists('getBatch', 'batchType', batchType) + const localVarPath = `/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/batches/{batchType}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) + .replace(`{${"pipelineId"}}`, encodeURIComponent(String(pipelineId))) + .replace(`{${"batchType"}}`, encodeURIComponent(String(batchType))); + // 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; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -21695,7 +22189,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Get the specified Organization. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -22256,7 +22750,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Get the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -22298,7 +22792,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Get the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -22340,7 +22834,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Get the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -23178,7 +23672,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary List the invites issued for the organization. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -24136,7 +24630,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary List Users with roles in an App - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -24174,7 +24668,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary List Users with roles in an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -24212,7 +24706,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary List Users with roles in an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -27326,6 +27820,96 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio options: localVarRequestOptions, }; }, + /** + * Update a specific Environment in an Application. + * @summary Update a specific Environment. + * @param {string} orgId The Organization ID. + * @param {string} appId The Application ID. + * @param {string} envId The Environment ID. + * @param {EnvironmentBaseUpdateRequest} [environmentBaseUpdateRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateEnvironment: async (orgId: string, appId: string, envId: string, environmentBaseUpdateRequest?: EnvironmentBaseUpdateRequest, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('updateEnvironment', 'orgId', orgId) + // verify required parameter 'appId' is not null or undefined + assertParamExists('updateEnvironment', 'appId', appId) + // verify required parameter 'envId' is not null or undefined + assertParamExists('updateEnvironment', 'envId', envId) + const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) + .replace(`{${"envId"}}`, encodeURIComponent(String(envId))); + // 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: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(environmentBaseUpdateRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Updates Environment Type. + * @summary Updates Environment Type + * @param {string} orgId The Organization ID. + * @param {string} envTypeId ID of the Environment Type. + * @param {UpdateEnvironmentTypePayloadRequest} updateEnvironmentTypePayloadRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateEnvironmentType: async (orgId: string, envTypeId: string, updateEnvironmentTypePayloadRequest: UpdateEnvironmentTypePayloadRequest, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('updateEnvironmentType', 'orgId', orgId) + // verify required parameter 'envTypeId' is not null or undefined + assertParamExists('updateEnvironmentType', 'envTypeId', envTypeId) + // verify required parameter 'updateEnvironmentTypePayloadRequest' is not null or undefined + assertParamExists('updateEnvironmentType', 'updateEnvironmentTypePayloadRequest', updateEnvironmentTypePayloadRequest) + const localVarPath = `/orgs/{orgId}/env-types/{envTypeId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"envTypeId"}}`, encodeURIComponent(String(envTypeId))); + // 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: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateEnvironmentTypePayloadRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * On pause requests, all the Kubernetes Deployment resources are scaled down to 0 replicas. On resume requests, all the Kubernetes Deployment resources are scaled up to the number of replicas running before the environment was paused. When an environment is paused, it is not possible to:``` - Deploy the environment within Humanitec. - Scale the number of replicas running of any workload. ``` * @summary Pause / Resume an environment. @@ -27567,7 +28151,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Update the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user role @@ -27615,7 +28199,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Update the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user role @@ -27663,7 +28247,7 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Update the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user the role * @param {*} [options] Override http request option. @@ -27882,7 +28466,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Invites a user to an Organization with a specified role. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {UserInviteRequestRequest} userInviteRequestRequest The email and the desired role * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -28027,7 +28611,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Creates a new service user. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {NewServiceUserRequest} newServiceUserRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -28039,7 +28623,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Adds a User to an Application with a Role - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {UserRoleRequest} userRoleRequest The user ID and the role * @param {*} [options] Override http request option. @@ -28052,7 +28636,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Adds a User to an Environment Type with a Role - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {UserRoleRequest} userRoleRequest The user ID and the role * @param {*} [options] Override http request option. @@ -28297,7 +28881,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Remove the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -28310,7 +28894,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Remove the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -28323,7 +28907,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Remove the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -28396,6 +28980,20 @@ export const PublicApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.getArtefactVersion(orgId, artefactVersionId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Read the current state of a trigger batch for a Pipeline if one exists + * @summary Read the current state of a trigger batch + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} pipelineId The Pipeline ID + * @param {string} batchType The batch type, only artefact is implemented. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getBatch(orgId: string, appId: string, pipelineId: string, batchType: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getBatch(orgId, appId, pipelineId, batchType, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Gets the extended profile of the current user @@ -28497,7 +29095,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Get the specified Organization. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -28669,7 +29267,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Get the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -28682,7 +29280,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Get the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -28695,7 +29293,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Get the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -28949,7 +29547,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary List the invites issued for the organization. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -29222,7 +29820,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary List Users with roles in an App - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -29234,7 +29832,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary List Users with roles in an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -29246,7 +29844,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary List Users with roles in an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -30176,6 +30774,33 @@ export const PublicApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.updateCurrentUser(userProfileExtendedRequest, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Update a specific Environment in an Application. + * @summary Update a specific Environment. + * @param {string} orgId The Organization ID. + * @param {string} appId The Application ID. + * @param {string} envId The Environment ID. + * @param {EnvironmentBaseUpdateRequest} [environmentBaseUpdateRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateEnvironment(orgId: string, appId: string, envId: string, environmentBaseUpdateRequest?: EnvironmentBaseUpdateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateEnvironment(orgId, appId, envId, environmentBaseUpdateRequest, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Updates Environment Type. + * @summary Updates Environment Type + * @param {string} orgId The Organization ID. + * @param {string} envTypeId ID of the Environment Type. + * @param {UpdateEnvironmentTypePayloadRequest} updateEnvironmentTypePayloadRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateEnvironmentType(orgId: string, envTypeId: string, updateEnvironmentTypePayloadRequest: UpdateEnvironmentTypePayloadRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateEnvironmentType(orgId, envTypeId, updateEnvironmentTypePayloadRequest, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * On pause requests, all the Kubernetes Deployment resources are scaled down to 0 replicas. On resume requests, all the Kubernetes Deployment resources are scaled up to the number of replicas running before the environment was paused. When an environment is paused, it is not possible to:``` - Deploy the environment within Humanitec. - Scale the number of replicas running of any workload. ``` * @summary Pause / Resume an environment. @@ -30248,7 +30873,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Update the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user role @@ -30262,7 +30887,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Update the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user role @@ -30276,7 +30901,7 @@ export const PublicApiFp = function(configuration?: Configuration) { /** * * @summary Update the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user the role * @param {*} [options] Override http request option. @@ -30799,6 +31424,16 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat getArtefactVersion(requestParameters: PublicApiGetArtefactVersionRequest, options?: AxiosRequestConfig): AxiosPromise { return localVarFp.getArtefactVersion(requestParameters.orgId, requestParameters.artefactVersionId, options).then((request) => request(axios, basePath)); }, + /** + * Read the current state of a trigger batch for a Pipeline if one exists + * @summary Read the current state of a trigger batch + * @param {PublicApiGetBatchRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBatch(requestParameters: PublicApiGetBatchRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.getBatch(requestParameters.orgId, requestParameters.appId, requestParameters.pipelineId, requestParameters.batchType, options).then((request) => request(axios, basePath)); + }, /** * * @summary Gets the extended profile of the current user @@ -32138,6 +32773,26 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat updateCurrentUser(requestParameters: PublicApiUpdateCurrentUserRequest, options?: AxiosRequestConfig): AxiosPromise { return localVarFp.updateCurrentUser(requestParameters.userProfileExtendedRequest, options).then((request) => request(axios, basePath)); }, + /** + * Update a specific Environment in an Application. + * @summary Update a specific Environment. + * @param {PublicApiUpdateEnvironmentRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateEnvironment(requestParameters: PublicApiUpdateEnvironmentRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.updateEnvironment(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.environmentBaseUpdateRequest, options).then((request) => request(axios, basePath)); + }, + /** + * Updates Environment Type. + * @summary Updates Environment Type + * @param {PublicApiUpdateEnvironmentTypeRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateEnvironmentType(requestParameters: PublicApiUpdateEnvironmentTypeRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.updateEnvironmentType(requestParameters.orgId, requestParameters.envTypeId, requestParameters.updateEnvironmentTypePayloadRequest, options).then((request) => request(axios, basePath)); + }, /** * On pause requests, all the Kubernetes Deployment resources are scaled down to 0 replicas. On resume requests, all the Kubernetes Deployment resources are scaled up to the number of replicas running before the environment was paused. When an environment is paused, it is not possible to:``` - Deploy the environment within Humanitec. - Scale the number of replicas running of any workload. ``` * @summary Pause / Resume an environment. @@ -32518,7 +33173,7 @@ export interface PublicApiCreateEnvironmentTypeRequest { */ export interface PublicApiCreateInviteInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiCreateInviteInOrg */ @@ -32840,7 +33495,7 @@ export interface PublicApiCreateResourceDriverRequest { */ export interface PublicApiCreateServiceUserInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiCreateServiceUserInOrg */ @@ -32861,7 +33516,7 @@ export interface PublicApiCreateServiceUserInOrgRequest { */ export interface PublicApiCreateUserRoleInAppRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiCreateUserRoleInApp */ @@ -32889,7 +33544,7 @@ export interface PublicApiCreateUserRoleInAppRequest { */ export interface PublicApiCreateUserRoleInEnvTypeRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiCreateUserRoleInEnvType */ @@ -33407,7 +34062,7 @@ export interface PublicApiDeleteResourceDriverRequest { */ export interface PublicApiDeleteUserRoleInAppRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiDeleteUserRoleInApp */ @@ -33435,7 +34090,7 @@ export interface PublicApiDeleteUserRoleInAppRequest { */ export interface PublicApiDeleteUserRoleInEnvTypeRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiDeleteUserRoleInEnvType */ @@ -33463,7 +34118,7 @@ export interface PublicApiDeleteUserRoleInEnvTypeRequest { */ export interface PublicApiDeleteUserRoleInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiDeleteUserRoleInOrg */ @@ -33610,6 +34265,41 @@ export interface PublicApiGetArtefactVersionRequest { readonly artefactVersionId: string } +/** + * Request parameters for getBatch operation in PublicApi. + * @export + * @interface PublicApiGetBatchRequest + */ +export interface PublicApiGetBatchRequest { + /** + * The Organization ID + * @type {string} + * @memberof PublicApiGetBatch + */ + readonly orgId: string + + /** + * The Application ID + * @type {string} + * @memberof PublicApiGetBatch + */ + readonly appId: string + + /** + * The Pipeline ID + * @type {string} + * @memberof PublicApiGetBatch + */ + readonly pipelineId: string + + /** + * The batch type, only artefact is implemented. + * @type {string} + * @memberof PublicApiGetBatch + */ + readonly batchType: string +} + /** * Request parameters for getDelta operation in PublicApi. * @export @@ -33785,7 +34475,7 @@ export interface PublicApiGetLatestWorkloadProfileVersionRequest { */ export interface PublicApiGetOrganizationRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiGetOrganization */ @@ -34170,7 +34860,7 @@ export interface PublicApiGetSetsRequest { */ export interface PublicApiGetUserRoleInAppRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiGetUserRoleInApp */ @@ -34198,7 +34888,7 @@ export interface PublicApiGetUserRoleInAppRequest { */ export interface PublicApiGetUserRoleInEnvTypeRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiGetUserRoleInEnvType */ @@ -34226,7 +34916,7 @@ export interface PublicApiGetUserRoleInEnvTypeRequest { */ export interface PublicApiGetUserRoleInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiGetUserRoleInOrg */ @@ -34744,7 +35434,7 @@ export interface PublicApiListHumanitecPublicKeysRequest { */ export interface PublicApiListInvitesInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiListInvitesInOrg */ @@ -35451,7 +36141,7 @@ export interface PublicApiListRuntimeRequest { */ export interface PublicApiListUserRolesInAppRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiListUserRolesInApp */ @@ -35472,7 +36162,7 @@ export interface PublicApiListUserRolesInAppRequest { */ export interface PublicApiListUserRolesInEnvTypeRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiListUserRolesInEnvType */ @@ -35493,7 +36183,7 @@ export interface PublicApiListUserRolesInEnvTypeRequest { */ export interface PublicApiListUserRolesInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiListUserRolesInOrg */ @@ -37607,6 +38297,69 @@ export interface PublicApiUpdateCurrentUserRequest { readonly userProfileExtendedRequest: UserProfileExtendedRequest } +/** + * Request parameters for updateEnvironment operation in PublicApi. + * @export + * @interface PublicApiUpdateEnvironmentRequest + */ +export interface PublicApiUpdateEnvironmentRequest { + /** + * The Organization ID. + * @type {string} + * @memberof PublicApiUpdateEnvironment + */ + readonly orgId: string + + /** + * The Application ID. + * @type {string} + * @memberof PublicApiUpdateEnvironment + */ + readonly appId: string + + /** + * The Environment ID. + * @type {string} + * @memberof PublicApiUpdateEnvironment + */ + readonly envId: string + + /** + * + * @type {EnvironmentBaseUpdateRequest} + * @memberof PublicApiUpdateEnvironment + */ + readonly environmentBaseUpdateRequest?: EnvironmentBaseUpdateRequest +} + +/** + * Request parameters for updateEnvironmentType operation in PublicApi. + * @export + * @interface PublicApiUpdateEnvironmentTypeRequest + */ +export interface PublicApiUpdateEnvironmentTypeRequest { + /** + * The Organization ID. + * @type {string} + * @memberof PublicApiUpdateEnvironmentType + */ + readonly orgId: string + + /** + * ID of the Environment Type. + * @type {string} + * @memberof PublicApiUpdateEnvironmentType + */ + readonly envTypeId: string + + /** + * + * @type {UpdateEnvironmentTypePayloadRequest} + * @memberof PublicApiUpdateEnvironmentType + */ + readonly updateEnvironmentTypePayloadRequest: UpdateEnvironmentTypePayloadRequest +} + /** * Request parameters for updatePaused operation in PublicApi. * @export @@ -37782,7 +38535,7 @@ export interface PublicApiUpdateResourceDriverRequest { */ export interface PublicApiUpdateUserRoleInAppRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiUpdateUserRoleInApp */ @@ -37817,7 +38570,7 @@ export interface PublicApiUpdateUserRoleInAppRequest { */ export interface PublicApiUpdateUserRoleInEnvTypeRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiUpdateUserRoleInEnvType */ @@ -37852,7 +38605,7 @@ export interface PublicApiUpdateUserRoleInEnvTypeRequest { */ export interface PublicApiUpdateUserRoleInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof PublicApiUpdateUserRoleInOrg */ @@ -38496,6 +39249,18 @@ export class PublicApi extends BaseAPI { return PublicApiFp(this.configuration).getArtefactVersion(requestParameters.orgId, requestParameters.artefactVersionId, options).then((request) => request(this.axios, this.basePath)); } + /** + * Read the current state of a trigger batch for a Pipeline if one exists + * @summary Read the current state of a trigger batch + * @param {PublicApiGetBatchRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public getBatch(requestParameters: PublicApiGetBatchRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).getBatch(requestParameters.orgId, requestParameters.appId, requestParameters.pipelineId, requestParameters.batchType, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Gets the extended profile of the current user @@ -40103,6 +40868,30 @@ export class PublicApi extends BaseAPI { return PublicApiFp(this.configuration).updateCurrentUser(requestParameters.userProfileExtendedRequest, options).then((request) => request(this.axios, this.basePath)); } + /** + * Update a specific Environment in an Application. + * @summary Update a specific Environment. + * @param {PublicApiUpdateEnvironmentRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public updateEnvironment(requestParameters: PublicApiUpdateEnvironmentRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).updateEnvironment(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.environmentBaseUpdateRequest, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates Environment Type. + * @summary Updates Environment Type + * @param {PublicApiUpdateEnvironmentTypeRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public updateEnvironmentType(requestParameters: PublicApiUpdateEnvironmentTypeRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).updateEnvironmentType(requestParameters.orgId, requestParameters.envTypeId, requestParameters.updateEnvironmentTypePayloadRequest, options).then((request) => request(this.axios, this.basePath)); + } + /** * On pause requests, all the Kubernetes Deployment resources are scaled down to 0 replicas. On resume requests, all the Kubernetes Deployment resources are scaled up to the number of replicas running before the environment was paused. When an environment is paused, it is not possible to:``` - Deploy the environment within Humanitec. - Scale the number of replicas running of any workload. ``` * @summary Pause / Resume an environment. @@ -44946,7 +45735,7 @@ export const UserInviteApiAxiosParamCreator = function (configuration?: Configur /** * * @summary List the invites issued for the organization. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -44990,7 +45779,7 @@ export const UserInviteApiFp = function(configuration?: Configuration) { /** * * @summary List the invites issued for the organization. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -45028,7 +45817,7 @@ export const UserInviteApiFactory = function (configuration?: Configuration, bas */ export interface UserInviteApiListInvitesInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserInviteApiListInvitesInOrg */ @@ -45065,7 +45854,7 @@ export const UserProfileApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Creates a new service user. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {NewServiceUserRequest} newServiceUserRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -45181,7 +45970,7 @@ export const UserProfileApiFp = function(configuration?: Configuration) { /** * * @summary Creates a new service user. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {NewServiceUserRequest} newServiceUserRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -45260,7 +46049,7 @@ export const UserProfileApiFactory = function (configuration?: Configuration, ba */ export interface UserProfileApiCreateServiceUserInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserProfileApiCreateServiceUserInOrg */ @@ -45341,7 +46130,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Invites a user to an Organization with a specified role. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {UserInviteRequestRequest} userInviteRequestRequest The email and the desired role * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -45381,7 +46170,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Adds a User to an Application with a Role - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {UserRoleRequest} userRoleRequest The user ID and the role * @param {*} [options] Override http request option. @@ -45425,7 +46214,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Adds a User to an Environment Type with a Role - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {UserRoleRequest} userRoleRequest The user ID and the role * @param {*} [options] Override http request option. @@ -45469,7 +46258,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Remove the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -45511,7 +46300,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Remove the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -45553,7 +46342,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Remove the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -45591,7 +46380,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Get the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -45633,7 +46422,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Get the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -45675,7 +46464,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Get the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -45713,7 +46502,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary List Users with roles in an App - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -45751,7 +46540,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary List Users with roles in an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -45789,7 +46578,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary List Users with roles in an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -45823,7 +46612,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Update the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user role @@ -45871,7 +46660,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Update the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user role @@ -45919,7 +46708,7 @@ export const UserRoleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Update the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user the role * @param {*} [options] Override http request option. @@ -45973,7 +46762,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Invites a user to an Organization with a specified role. - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {UserInviteRequestRequest} userInviteRequestRequest The email and the desired role * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -45985,7 +46774,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Adds a User to an Application with a Role - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {UserRoleRequest} userRoleRequest The user ID and the role * @param {*} [options] Override http request option. @@ -45998,7 +46787,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Adds a User to an Environment Type with a Role - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {UserRoleRequest} userRoleRequest The user ID and the role * @param {*} [options] Override http request option. @@ -46011,7 +46800,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Remove the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -46024,7 +46813,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Remove the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -46037,7 +46826,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Remove the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -46049,7 +46838,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Get the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -46062,7 +46851,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Get the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {*} [options] Override http request option. @@ -46075,7 +46864,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Get the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -46087,7 +46876,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary List Users with roles in an App - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -46099,7 +46888,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary List Users with roles in an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -46111,7 +46900,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary List Users with roles in an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -46122,7 +46911,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Update the role of a User on an Application - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} appId The Application ID. * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user role @@ -46136,7 +46925,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Update the role of a User on an Environment Type - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} envType The Environment Type. * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user role @@ -46150,7 +46939,7 @@ export const UserRoleApiFp = function(configuration?: Configuration) { /** * * @summary Update the role of a User on an Organization - * @param {string} orgId The Organization ID. + * @param {string} orgId The Organization ID * @param {string} userId The User ID * @param {RoleRequest} roleRequest The new user the role * @param {*} [options] Override http request option. @@ -46330,7 +47119,7 @@ export const UserRoleApiFactory = function (configuration?: Configuration, baseP */ export interface UserRoleApiCreateInviteInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiCreateInviteInOrg */ @@ -46351,7 +47140,7 @@ export interface UserRoleApiCreateInviteInOrgRequest { */ export interface UserRoleApiCreateUserRoleInAppRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiCreateUserRoleInApp */ @@ -46379,7 +47168,7 @@ export interface UserRoleApiCreateUserRoleInAppRequest { */ export interface UserRoleApiCreateUserRoleInEnvTypeRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiCreateUserRoleInEnvType */ @@ -46407,7 +47196,7 @@ export interface UserRoleApiCreateUserRoleInEnvTypeRequest { */ export interface UserRoleApiDeleteUserRoleInAppRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiDeleteUserRoleInApp */ @@ -46435,7 +47224,7 @@ export interface UserRoleApiDeleteUserRoleInAppRequest { */ export interface UserRoleApiDeleteUserRoleInEnvTypeRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiDeleteUserRoleInEnvType */ @@ -46463,7 +47252,7 @@ export interface UserRoleApiDeleteUserRoleInEnvTypeRequest { */ export interface UserRoleApiDeleteUserRoleInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiDeleteUserRoleInOrg */ @@ -46484,7 +47273,7 @@ export interface UserRoleApiDeleteUserRoleInOrgRequest { */ export interface UserRoleApiGetUserRoleInAppRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiGetUserRoleInApp */ @@ -46512,7 +47301,7 @@ export interface UserRoleApiGetUserRoleInAppRequest { */ export interface UserRoleApiGetUserRoleInEnvTypeRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiGetUserRoleInEnvType */ @@ -46540,7 +47329,7 @@ export interface UserRoleApiGetUserRoleInEnvTypeRequest { */ export interface UserRoleApiGetUserRoleInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiGetUserRoleInOrg */ @@ -46561,7 +47350,7 @@ export interface UserRoleApiGetUserRoleInOrgRequest { */ export interface UserRoleApiListUserRolesInAppRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiListUserRolesInApp */ @@ -46582,7 +47371,7 @@ export interface UserRoleApiListUserRolesInAppRequest { */ export interface UserRoleApiListUserRolesInEnvTypeRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiListUserRolesInEnvType */ @@ -46603,7 +47392,7 @@ export interface UserRoleApiListUserRolesInEnvTypeRequest { */ export interface UserRoleApiListUserRolesInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiListUserRolesInOrg */ @@ -46617,7 +47406,7 @@ export interface UserRoleApiListUserRolesInOrgRequest { */ export interface UserRoleApiUpdateUserRoleInAppRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiUpdateUserRoleInApp */ @@ -46652,7 +47441,7 @@ export interface UserRoleApiUpdateUserRoleInAppRequest { */ export interface UserRoleApiUpdateUserRoleInEnvTypeRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiUpdateUserRoleInEnvType */ @@ -46687,7 +47476,7 @@ export interface UserRoleApiUpdateUserRoleInEnvTypeRequest { */ export interface UserRoleApiUpdateUserRoleInOrgRequest { /** - * The Organization ID. + * The Organization ID * @type {string} * @memberof UserRoleApiUpdateUserRoleInOrg */ diff --git a/src/generated/base.ts b/src/generated/base.ts index ec0d0e8f..07989972 100755 --- a/src/generated/base.ts +++ b/src/generated/base.ts @@ -4,7 +4,7 @@ * Humanitec API * # Introduction The *Humanitec API* allows you to automate and integrate Humanitec into your developer and operational workflows. The API is a REST based API. It is based around a set of concepts: * Core * External Resources * Sets and Deltas ## Authentication Almost all requests made to the Humanitec API require Authentication. See our [Developer Docs on API Authentication](https://developer.humanitec.com/platform-orchestrator/reference/api-references/#authentication) for instructions. ## Content Types All of the Humanitec API unless explicitly only accepts content types of `application/json` and will always return valid `application/json` or an empty response. ## Response Codes ### Success Any response code in the `2xx` range should be regarded as success. | **Code** | **Meaning** | | --- | --- | | `200` | Success | | `201` | Success (In future, `201` will be replaced by `200`) | | `204` | Success, but no content in response | _Note: We plan to simplify the interface by replacing 201 with 200 status codes._ ### Failure Any response code in the `4xx` should be regarded as an error which can be rectified by the client. `5xx` error codes indicate errors that cannot be corrected by the client. | **Code** | **Meaning** | | --- | --- | | `400` | General error. (Body will contain details) | | `401` | Attempt to access protected resource without `Authorization` Header. | | `403` | The `Bearer` or `JWT` does not grant access to the requested resource. | | `404` | Resource not found. | | `405` | Method not allowed | | `409` | Conflict. Usually indicated a resource with that ID already exists. | | `422` | Unprocessable Entity. The body was not valid JSON, was empty or contained an object different from what was expected. | | `429` | Too many requests - request rate limit has been reached. | | `500` | Internal Error. If it occurs repeatedly, contact support. | * - * The version of the OpenAPI document: 0.25.8 + * The version of the OpenAPI document: 0.25.9 * Contact: apiteam@humanitec.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/generated/common.ts b/src/generated/common.ts index b3f006fe..52d24726 100755 --- a/src/generated/common.ts +++ b/src/generated/common.ts @@ -4,7 +4,7 @@ * Humanitec API * # Introduction The *Humanitec API* allows you to automate and integrate Humanitec into your developer and operational workflows. The API is a REST based API. It is based around a set of concepts: * Core * External Resources * Sets and Deltas ## Authentication Almost all requests made to the Humanitec API require Authentication. See our [Developer Docs on API Authentication](https://developer.humanitec.com/platform-orchestrator/reference/api-references/#authentication) for instructions. ## Content Types All of the Humanitec API unless explicitly only accepts content types of `application/json` and will always return valid `application/json` or an empty response. ## Response Codes ### Success Any response code in the `2xx` range should be regarded as success. | **Code** | **Meaning** | | --- | --- | | `200` | Success | | `201` | Success (In future, `201` will be replaced by `200`) | | `204` | Success, but no content in response | _Note: We plan to simplify the interface by replacing 201 with 200 status codes._ ### Failure Any response code in the `4xx` should be regarded as an error which can be rectified by the client. `5xx` error codes indicate errors that cannot be corrected by the client. | **Code** | **Meaning** | | --- | --- | | `400` | General error. (Body will contain details) | | `401` | Attempt to access protected resource without `Authorization` Header. | | `403` | The `Bearer` or `JWT` does not grant access to the requested resource. | | `404` | Resource not found. | | `405` | Method not allowed | | `409` | Conflict. Usually indicated a resource with that ID already exists. | | `422` | Unprocessable Entity. The body was not valid JSON, was empty or contained an object different from what was expected. | | `429` | Too many requests - request rate limit has been reached. | | `500` | Internal Error. If it occurs repeatedly, contact support. | * - * The version of the OpenAPI document: 0.25.8 + * The version of the OpenAPI document: 0.25.9 * Contact: apiteam@humanitec.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/generated/configuration.ts b/src/generated/configuration.ts index 370a9203..ab7a6ee4 100755 --- a/src/generated/configuration.ts +++ b/src/generated/configuration.ts @@ -4,7 +4,7 @@ * Humanitec API * # Introduction The *Humanitec API* allows you to automate and integrate Humanitec into your developer and operational workflows. The API is a REST based API. It is based around a set of concepts: * Core * External Resources * Sets and Deltas ## Authentication Almost all requests made to the Humanitec API require Authentication. See our [Developer Docs on API Authentication](https://developer.humanitec.com/platform-orchestrator/reference/api-references/#authentication) for instructions. ## Content Types All of the Humanitec API unless explicitly only accepts content types of `application/json` and will always return valid `application/json` or an empty response. ## Response Codes ### Success Any response code in the `2xx` range should be regarded as success. | **Code** | **Meaning** | | --- | --- | | `200` | Success | | `201` | Success (In future, `201` will be replaced by `200`) | | `204` | Success, but no content in response | _Note: We plan to simplify the interface by replacing 201 with 200 status codes._ ### Failure Any response code in the `4xx` should be regarded as an error which can be rectified by the client. `5xx` error codes indicate errors that cannot be corrected by the client. | **Code** | **Meaning** | | --- | --- | | `400` | General error. (Body will contain details) | | `401` | Attempt to access protected resource without `Authorization` Header. | | `403` | The `Bearer` or `JWT` does not grant access to the requested resource. | | `404` | Resource not found. | | `405` | Method not allowed | | `409` | Conflict. Usually indicated a resource with that ID already exists. | | `422` | Unprocessable Entity. The body was not valid JSON, was empty or contained an object different from what was expected. | | `429` | Too many requests - request rate limit has been reached. | | `500` | Internal Error. If it occurs repeatedly, contact support. | * - * The version of the OpenAPI document: 0.25.8 + * The version of the OpenAPI document: 0.25.9 * Contact: apiteam@humanitec.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/generated/index.ts b/src/generated/index.ts index 344e446a..1912f7a8 100755 --- a/src/generated/index.ts +++ b/src/generated/index.ts @@ -4,7 +4,7 @@ * Humanitec API * # Introduction The *Humanitec API* allows you to automate and integrate Humanitec into your developer and operational workflows. The API is a REST based API. It is based around a set of concepts: * Core * External Resources * Sets and Deltas ## Authentication Almost all requests made to the Humanitec API require Authentication. See our [Developer Docs on API Authentication](https://developer.humanitec.com/platform-orchestrator/reference/api-references/#authentication) for instructions. ## Content Types All of the Humanitec API unless explicitly only accepts content types of `application/json` and will always return valid `application/json` or an empty response. ## Response Codes ### Success Any response code in the `2xx` range should be regarded as success. | **Code** | **Meaning** | | --- | --- | | `200` | Success | | `201` | Success (In future, `201` will be replaced by `200`) | | `204` | Success, but no content in response | _Note: We plan to simplify the interface by replacing 201 with 200 status codes._ ### Failure Any response code in the `4xx` should be regarded as an error which can be rectified by the client. `5xx` error codes indicate errors that cannot be corrected by the client. | **Code** | **Meaning** | | --- | --- | | `400` | General error. (Body will contain details) | | `401` | Attempt to access protected resource without `Authorization` Header. | | `403` | The `Bearer` or `JWT` does not grant access to the requested resource. | | `404` | Resource not found. | | `405` | Method not allowed | | `409` | Conflict. Usually indicated a resource with that ID already exists. | | `422` | Unprocessable Entity. The body was not valid JSON, was empty or contained an object different from what was expected. | | `429` | Too many requests - request rate limit has been reached. | | `500` | Internal Error. If it occurs repeatedly, contact support. | * - * The version of the OpenAPI document: 0.25.8 + * The version of the OpenAPI document: 0.25.9 * Contact: apiteam@humanitec.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).