From dacd54aa6977669c7fbe92965887aa52cd06b443 Mon Sep 17 00:00:00 2001 From: johanneswuerbach <864578+johanneswuerbach@users.noreply.github.com> Date: Mon, 27 May 2024 10:05:52 +0000 Subject: [PATCH] Update dependencies --- docs/openapi.json | 1217 ++++++++--- src/generated/api.ts | 3761 ++++++++++++++++++++++++-------- src/generated/base.ts | 2 +- src/generated/common.ts | 2 +- src/generated/configuration.ts | 2 +- src/generated/index.ts | 2 +- 6 files changed, 3708 insertions(+), 1278 deletions(-) diff --git a/docs/openapi.json b/docs/openapi.json index c896c615..31088d0f 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "Humanitec API", - "version": "0.25.14", + "version": "0.25.17", "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", @@ -2612,39 +2612,22 @@ "public", "AutomationRule" ], + "operationId": "listAutomationRules", "summary": "List all Automation Rules in an Environment.", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { - "name": "appId", - "in": "path", - "description": "The Application ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/appIdPathParam" }, { - "name": "envId", - "in": "path", - "description": "The Environment ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/envIdPathParam" } ], "responses": { "200": { - "description": "A possibly empty array of Automation Rules\n\n", + "description": "A possibly empty array of Automation Rules", "content": { "application/json": { "schema": { @@ -2652,32 +2635,9 @@ "$ref": "#/components/schemas/AutomationRuleResponse" }, "type": "array" - }, - "example": [ - { - "active": true, - "artefacts_filter": [ - "http://registry.org/sample-service" - ], - "created_at": "2021-07-22T14:53:27Z", - "created_by": "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70", - "exclude_artefacts_filter": false, - "exclude_images_filter": false, - "id": "923486d012f20324", - "images_filter": [ - "sample-service" - ], - "match": "^pr-[0-9]+-.*$", - "match_ref": "^refs/heads/pr-[0-9]+-.*$", - "type": "update", - "update_to": "branch" - } - ] + } } } - }, - "500": { - "description": "Internal Server error.\n\n" } } }, @@ -2686,60 +2646,34 @@ "public", "AutomationRule" ], + "operationId": "createAutomationRule", "summary": "Create a new Automation Rule for an Environment.", "description": "Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`.", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { - "name": "appId", - "in": "path", - "description": "The Application ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/appIdPathParam" }, { - "name": "envId", - "in": "path", - "description": "The Environment ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/envIdPathParam" } ], "requestBody": { - "description": "The definition of the Automation Rule.\n\n", + "description": "The definition of the Automation Rule.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRuleRequest" - }, - "example": { - "active": true, - "artefacts_filter": [ - "http://registry.org/sample-service" - ], - "exclude_artefacts_filter": false, - "match_ref": "^refs/heads/pr-[0-9]+-.*$", - "type": "update" } } } }, "responses": { "201": { - "description": "The AutomationRule\n\n", + "description": "The Automation Rule that was created.", "content": { "application/json": { "schema": { @@ -2749,17 +2683,13 @@ } }, "400": { - "description": "The input was not a valid Automation Rule.\n\n", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorInfoResponse" - } - } - } + "$ref": "#/components/responses/400BadRequest" + }, + "409": { + "$ref": "#/components/responses/409Conflict" }, "422": { - "description": "The request body could not be processed.\n\n" + "$ref": "#/components/responses/422UnprocessableContent" } } } @@ -2770,39 +2700,22 @@ "public", "AutomationRule" ], + "operationId": "getAutomationRule", "summary": "Get a specific Automation Rule for an Environment.", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { - "name": "appId", - "in": "path", - "description": "The Application ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/appIdPathParam" }, { - "name": "envId", - "in": "path", - "description": "The Environment ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/envIdPathParam" }, { "name": "ruleId", "in": "path", - "description": "The Automation Rule ID.\n\n", + "description": "The Automation Rule ID.", "required": true, "schema": { "type": "string" @@ -2811,35 +2724,17 @@ ], "responses": { "200": { - "description": "The AutomationRule\n\n", + "description": "The Automation Rule.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRuleResponse" - }, - "example": { - "active": true, - "artefacts_filter": [ - "http://registry.org/sample-service" - ], - "created_at": "2021-07-22T14:53:27Z", - "created_by": "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70", - "exclude_artefacts_filter": false, - "exclude_images_filter": false, - "id": "923486d012f20324", - "images_filter": [ - "sample-service" - ], - "match": "^pr-[0-9]+-.*$", - "match_ref": "^refs/heads/pr-[0-9]+-.*$", - "type": "update", - "update_to": "branch" } } } }, "404": { - "description": "There is no automation rule with the supplied ID.\n\n" + "$ref": "#/components/responses/404NotFound" } } }, @@ -2848,40 +2743,23 @@ "public", "AutomationRule" ], + "operationId": "updateAutomationRule", "summary": "Update an existing Automation Rule for an Environment.", "description": "Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`.", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { - "name": "appId", - "in": "path", - "description": "The Application ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/appIdPathParam" }, { - "name": "envId", - "in": "path", - "description": "The Environment ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/envIdPathParam" }, { "name": "ruleId", "in": "path", - "description": "The Automation Rule ID.\n\n", + "description": "The Automation Rule ID.", "required": true, "schema": { "type": "string" @@ -2889,28 +2767,19 @@ } ], "requestBody": { - "description": "The definition of the Automation Rule.\n\n", + "description": "The definition of the Automation Rule.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRuleRequest" - }, - "example": { - "active": true, - "artefacts_filter": [ - "http://registry.org/sample-service" - ], - "exclude_artefacts_filter": false, - "match_ref": "^refs/heads/pr-[0-9]+-.*$", - "type": "update" } } } }, "responses": { "200": { - "description": "The AutomationRule\n\n", + "description": "The updated Automation Rule.", "content": { "application/json": { "schema": { @@ -2920,20 +2789,13 @@ } }, "400": { - "description": "The input was not a valid Automation Rule.\n\n", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorInfoResponse" - } - } - } + "$ref": "#/components/responses/400BadRequest" }, "404": { - "description": "There is no automation rule with the supplied ID.\n\n" + "$ref": "#/components/responses/404NotFound" }, "422": { - "description": "The request body could not be processed.\n\n" + "$ref": "#/components/responses/422UnprocessableContent" } } }, @@ -2942,39 +2804,22 @@ "public", "AutomationRule" ], + "operationId": "deleteAutomationRule", "summary": "Delete Automation Rule from an Environment.", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { - "name": "appId", - "in": "path", - "description": "The Application ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/appIdPathParam" }, { - "name": "envId", - "in": "path", - "description": "The Environment ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/envIdPathParam" }, { "name": "ruleId", "in": "path", - "description": "The Automation Rule ID.\n\n", + "description": "The Automation Rule ID.", "required": true, "schema": { "type": "string" @@ -2983,10 +2828,10 @@ ], "responses": { "204": { - "description": "The AutomationRule was deleted.\n\n" + "description": "The Automation Rule was deleted." }, "404": { - "description": "There is no automation rule with the supplied ID.\n\n" + "$ref": "#/components/responses/404NotFound" } } } @@ -7059,7 +6904,7 @@ ], "summary": "List Resource Definitions.", "operationId": "listResourceDefinitions", - "description": "Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank.", + "description": "Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. Resources marked as deleted are not listed in the response, unless specified via `deleted` query parameter.", "parameters": [ { "name": "orgId", @@ -7117,6 +6962,15 @@ "schema": { "type": "string" } + }, + { + "name": "deleted", + "in": "query", + "description": "If returns also resource definitions which has been deleted.", + "schema": { + "type": "boolean", + "default": false + } } ], "responses": { @@ -7224,7 +7078,7 @@ "public", "ResourceDefinition" ], - "summary": "Get a specific Resource Definition.", + "summary": "Get a specific Resource Definition. If the resource is marked as deleted it is not shown in the response, unless specified via `deleted` query parameter.", "operationId": "getResourceDefinition", "parameters": [ { @@ -7244,6 +7098,15 @@ "schema": { "type": "string" } + }, + { + "name": "deleted", + "in": "query", + "description": "If returns the resource definition even if it has been deleted.", + "schema": { + "type": "boolean", + "default": false + } } ], "responses": { @@ -7367,7 +7230,7 @@ ], "summary": "Delete a Resource Definition.", "operationId": "deleteResourceDefinition", - "description": "If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately.\n\nIf there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced.\n\nThe request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is **marked as** pending deletion and will be deleted (purged) as soon as no existing Active Resources reference it. With the next deployment matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available).\n\nThe Resource Definition that has been marked for deletion cannot be used to provision new resources.", + "description": "If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately.\nIf there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced.\nThe request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is deleted immediately even if there are Active Resources linked to it.\nThe Resource Definition that has been marked for deletion cannot be used to provision new resources.\nWith the next deployment, matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available).", "parameters": [ { "name": "orgId", @@ -7398,7 +7261,7 @@ ], "responses": { "204": { - "description": "Resource Definition has been marked for deletion.\n\n" + "description": "Resource Definition has been marked as deleted.\n\n" }, "404": { "description": "A Resource Driver with the 'driverId' ID is not found or is not accessible by the organization.\n\n", @@ -7517,71 +7380,55 @@ } } }, - "/orgs/{orgId}/resources/defs/{defId}/criteria": { - "put": { + "/orgs/{orgId}/resources/defs/{defId}/versions": { + "get": { "tags": [ "public", - "ResourceDefinition", - "MatchingCriteria" + "ResourceDefinitionVersion" ], - "summary": "Update all Matching Criteria of a Resource Definition.", - "operationId": "updateResourceDefinitionCriteria", - "description": "Matching Criteria are combined with Resource Type to select a specific definition. Matching Criteria can be set for any combination of Application ID, Environment ID, Environment Type, and Resource ID. In the event of multiple matches, the most specific match is chosen.\n\nFor example, given 3 sets of matching criteria for the same type:\n\n```\n 1. {\"env_type\":\"test\"}\n 2. {\"env_type\":\"development\"}\n 3. {\"env_type\":\"test\", \"app_id\":\"my-app\"}\n```\n\nIf, a resource of that type was needed in an Application `my-app`, Environment `qa-team` with Type `test` and Resource ID `modules.my-module-externals.my-resource`, there would be two resource definitions matching the criteria: #1 & #3. Definition #3 will be chosen because its matching criteria is the most specific.", + "summary": "Get Resource Definition Versions of a specific Resource Definition. First 50 Versions are kept along with all the Versions referenced by an Active Resource.\nTo obtain Versions of a deleted Resource Definition, the `deleted` parameter needs to be used.\n", + "operationId": "listResourceDefinitionVersions", "parameters": [ { - "name": "orgId", - "in": "path", - "description": "The Organization ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/orgIdPathParam" }, { - "name": "defId", - "in": "path", - "description": "The Resource Definition ID.\n\n", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/defIdPathParam" + }, + { + "$ref": "#/components/parameters/deletedQueryParam" + }, + { + "$ref": "#/components/parameters/perPageQueryParam" + }, + { + "$ref": "#/components/parameters/pageTokenQueryParam" } ], - "requestBody": { - "description": "Matching Criteria rules.\n\n", - "required": true, - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/MatchingCriteriaRuleRequest" - }, - "type": "array" - }, - "example": [ - { - "env_id": "production" - } - ] - } - } - }, "responses": { "200": { - "description": "The newly added Matching Criteria details.\n\n", + "description": "A list or Resource Definition Version.\n", + "headers": { + "Link": { + "schema": { + "type": "string" + }, + "description": "A list of request links, optionally including a \"next\" page link for pagination." + } + }, "content": { "application/json": { "schema": { + "type": "array", "items": { - "$ref": "#/components/schemas/MatchingCriteriaResponse" - }, - "type": "array" + "$ref": "#/components/schemas/ResourceDefinitionVersion" + } } } } }, "400": { - "description": "One or more request parameters is missing or invalid.\n\n", + "description": "Bad Request.", "content": { "application/json": { "schema": { @@ -7591,7 +7438,7 @@ } }, "404": { - "description": "The Resource Definition is not found.\n\n", + "description": "The Resource Definition is not found.", "content": { "application/json": { "schema": { @@ -7599,9 +7446,138 @@ } } } + } + } + } + }, + "/orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}": { + "get": { + "tags": [ + "public", + "ResourceDefinitionVersion" + ], + "summary": "Get a Specific Resource Definition Version.", + "operationId": "getResourceDefinitionVersion", + "parameters": [ + { + "$ref": "#/components/parameters/orgIdPathParam" }, - "409": { - "description": "A Matching Criteria already exists.\n\n", + { + "$ref": "#/components/parameters/defIdPathParam" + }, + { + "$ref": "#/components/parameters/defVersionIdPathParam" + } + ], + "responses": { + "200": { + "description": "The Resource Definition Version with the specified ID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceDefinitionVersion" + } + } + } + }, + "404": { + "description": "The Resource Definition Version is not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HumanitecErrorResponse" + } + } + } + } + } + } + }, + "/orgs/{orgId}/resources/defs/{defId}/criteria": { + "put": { + "tags": [ + "public", + "ResourceDefinition", + "MatchingCriteria" + ], + "summary": "Update all Matching Criteria of a Resource Definition.", + "operationId": "updateResourceDefinitionCriteria", + "description": "Matching Criteria are combined with Resource Type to select a specific definition. Matching Criteria can be set for any combination of Application ID, Environment ID, Environment Type, and Resource ID. In the event of multiple matches, the most specific match is chosen.\n\nFor example, given 3 sets of matching criteria for the same type:\n\n```\n 1. {\"env_type\":\"test\"}\n 2. {\"env_type\":\"development\"}\n 3. {\"env_type\":\"test\", \"app_id\":\"my-app\"}\n```\n\nIf, a resource of that type was needed in an Application `my-app`, Environment `qa-team` with Type `test` and Resource ID `modules.my-module-externals.my-resource`, there would be two resource definitions matching the criteria: #1 & #3. Definition #3 will be chosen because its matching criteria is the most specific.", + "parameters": [ + { + "name": "orgId", + "in": "path", + "description": "The Organization ID.\n\n", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "defId", + "in": "path", + "description": "The Resource Definition ID.\n\n", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Matching Criteria rules.\n\n", + "required": true, + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/MatchingCriteriaRuleRequest" + }, + "type": "array" + }, + "example": [ + { + "env_id": "production" + } + ] + } + } + }, + "responses": { + "200": { + "description": "The newly added Matching Criteria details.\n\n", + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/MatchingCriteriaResponse" + }, + "type": "array" + } + } + } + }, + "400": { + "description": "One or more request parameters is missing or invalid.\n\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HumanitecErrorResponse" + } + } + } + }, + "404": { + "description": "The Resource Definition is not found.\n\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HumanitecErrorResponse" + } + } + } + }, + "409": { + "description": "A Matching Criteria already exists.\n\n", "content": { "application/json": { "schema": { @@ -8212,6 +8188,308 @@ } } }, + "/orgs/{orgId}/resources/classes": { + "get": { + "tags": [ + "public", + "ResourceClass" + ], + "summary": "List resource classes.", + "operationId": "listResourceClasses", + "parameters": [ + { + "name": "orgId", + "in": "path", + "description": "The organization ID.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + } + ], + "responses": { + "200": { + "description": "A possibly empty list of resources classes.\n", + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ResourceClassResponse" + }, + "type": "array" + } + } + } + } + } + } + }, + "/orgs/{orgId}/resources/types/{typeId}/classes": { + "post": { + "tags": [ + "public", + "ResourceClass" + ], + "summary": "Creates a new resources class.", + "operationId": "createResourceClass", + "parameters": [ + { + "name": "orgId", + "in": "path", + "description": "The organization ID.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + { + "name": "typeId", + "in": "path", + "description": "The resource type.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceClassRequest" + } + } + } + }, + "responses": { + "200": { + "description": "The newly created resources class details.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceClassResponse" + } + } + } + }, + "400": { + "description": "One or more request parameters is missing or invalid.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HumanitecErrorResponse" + } + } + } + }, + "409": { + "description": "A resources class of this ID already exists in this resource type.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HumanitecErrorResponse" + } + } + } + } + } + } + }, + "/orgs/{orgId}/resources/types/{typeId}/classes/{classId}": { + "get": { + "tags": [ + "public", + "ResourceClass" + ], + "summary": "Get resource class by ID.", + "operationId": "getResourceClass", + "parameters": [ + { + "name": "orgId", + "in": "path", + "description": "The organization ID.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + { + "name": "typeId", + "in": "path", + "description": "The resource type.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + { + "name": "classId", + "in": "path", + "description": "The resource class ID.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + } + ], + "responses": { + "200": { + "description": "Requested resource class details\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceClassResponse" + } + } + } + }, + "404": { + "description": "A resource class with the 'classId' id is not found in resource type typeId.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HumanitecErrorResponse" + } + } + } + } + } + }, + "patch": { + "tags": [ + "public", + "ResourceClass" + ], + "summary": "Update a resource class description.", + "operationId": "updateResourceClass", + "parameters": [ + { + "name": "orgId", + "in": "path", + "description": "The organization ID.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + { + "name": "typeId", + "in": "path", + "description": "The resource type ID.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + { + "name": "classId", + "in": "path", + "description": "The resource class ID.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateResourceClassRequest" + } + } + } + }, + "responses": { + "200": { + "description": "The updated resource class.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResourceClassResponse" + } + } + } + }, + "404": { + "description": "A resource class with the 'classId' id is not found in resource type 'typeId'.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HumanitecErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "public", + "ResourceClass" + ], + "summary": "Delete a resource class.", + "operationId": "deleteResourceClass", + "parameters": [ + { + "name": "orgId", + "in": "path", + "description": "The organization ID.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + { + "name": "typeId", + "in": "path", + "description": "The resource type.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + { + "name": "classId", + "in": "path", + "description": "The resource class id.\n", + "required": true, + "schema": { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + } + ], + "responses": { + "204": { + "description": "Resource class deleted successfully.\n" + }, + "404": { + "description": "A resource class with the 'classId' id is not found in resource type 'typeId'.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HumanitecErrorResponse" + } + } + } + } + } + } + }, "/orgs/{orgId}/apps/{appId}/envs/{envId}/runtime": { "get": { "tags": [ @@ -11893,6 +12171,16 @@ "pattern": "^[a-z0-9](?:-?[a-z0-9]+)+$" } }, + "envIdPathParam": { + "name": "envId", + "in": "path", + "description": "The Environment ID", + "example": "development", + "required": true, + "schema": { + "type": "string" + } + }, "pipelineIdPathParam": { "name": "pipelineId", "in": "path", @@ -12134,16 +12422,37 @@ "type": "string" } }, - "envIdPathParam": { - "name": "envId", + "defVersionIdPathParam": { + "name": "defVersionId", "in": "path", - "description": "The Environment ID", - "example": "development", + "description": "The Resource Definition Version ID.", + "example": "01234567-89ab-cdef-0123-4567890abcdef", "required": true, "schema": { "type": "string" } }, + "defIdPathParam": { + "name": "defId", + "in": "path", + "description": "The Resource Definition ID.", + "example": "sample-def", + "required": true, + "schema": { + "type": "string" + } + }, + "deletedQueryParam": { + "name": "deleted", + "in": "query", + "description": "If to show also deleted records in the response.", + "required": false, + "example": true, + "schema": { + "type": "boolean", + "default": false + } + }, "profileQidPathParam": { "name": "profileQid", "in": "path", @@ -12838,8 +13147,7 @@ }, "required": [ "id", - "name", - "from_deploy_id" + "name" ], "type": "object" }, @@ -13127,6 +13435,37 @@ "description": "A map of additional workload spec fields that will be merged.", "type": "object", "additionalProperties": true + }, + "deploy": { + "description": "An optional deploy condition for the workload.", + "type": "object", + "additionalProperties": false, + "properties": { + "when": { + "description": "The stage the deployment should occur. \"deploy\", deployed in-parallel with other workloads (the default). \"before\", deployed before other workloads. \"after\", deployed after other workloads.", + "type": "string", + "enum": [ + "before", + "deploy", + "after" + ], + "example": "before" + }, + "success": { + "description": "The success criteria for the deployment. \"deploy\", workload deployed. \"available\", workload available. \"complete\", workload complete (often used with jobs).", + "type": "string", + "enum": [ + "deploy", + "available", + "complete" + ], + "example": "complete" + }, + "timeout": { + "description": "The timeout in seconds for the deployment to reach it's success condition.", + "type": "integer" + } + } } }, "example": { @@ -13682,68 +14021,67 @@ }, "AutomationRuleRequest": { "description": "An Automation Rule defining how and when artefacts in an environment should be updated.", - "example": { - "active": true, - "artefacts_filter": [ - "http://registry.org/sample-service" - ], - "created_at": "2021-07-22T14:53:27Z", - "created_by": "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70", - "exclude_artefacts_filter": false, - "exclude_images_filter": false, - "id": "923486d012f20324", - "images_filter": [ - "sample-service" - ], - "match": "^pr-[0-9]+-.*$", - "match_ref": "^refs/heads/pr-[0-9]+-.*$", - "type": "update", - "update_to": "branch" - }, "properties": { "active": { "description": "Whether the rule will be processed or not.", - "type": "boolean" + "type": "boolean", + "example": true }, "artefacts_filter": { "description": "A list of artefact names to be processed by the rule. If the array is empty, it implies include all. If `exclude_artefacts_filter` is true, this list describes the artefacts to exclude.", "items": { "type": "string" }, - "type": "array" + "type": "array", + "example": [ + "http://registry.org/sample-service" + ] }, "exclude_artefacts_filter": { "description": "Whether the artefacts specified in `artefacts_filter` should be excluded (true) or included (false) in the automation rule.", - "type": "boolean" + "type": "boolean", + "example": false }, "exclude_images_filter": { "description": "DEPRECATED: Whether the images specified in `images_filter` should be excluded (true) or included (false) in the automation rule.", - "type": "boolean" + "type": "boolean", + "example": false, + "deprecated": true }, "images_filter": { "description": "DEPRECATED: A list of image IDs to be processed by the rule. If the array is empty, it implies include all. If `exclude_images_filter` is true, this list describes images to exclude.", "items": { "type": "string" }, - "type": "array" + "type": "array", + "example": [ + "sample-service" + ], + "deprecated": true }, "match": { "description": "DEPRECATED: A regular expression applied to the branch or tag name depending on the value of `update_to`. Defaults to match all if omitted or empty.", - "type": "string" + "type": "string", + "example": "^pr-[0-9]+-.*$", + "deprecated": true }, "match_ref": { "description": "A regular expression applied to the ref of a new artefact version. Defaults to match all if omitted or empty.", - "type": "string" + "type": "string", + "example": "^refs/heads/pr-[0-9]+-.*$" }, "type": { "description": "Specifies the type of event. Currently, only updates to either branches or tags are supported. Must be `\"update\"`.", "pattern": "^(?:update)$", - "type": "string" + "type": "string", + "example": "update" }, "update_to": { "description": "DEPRECATED: Specifies whether the update occurs on commit to branch or creation of tag. Must be one of `\"branch\"` or `\"tag\"`.", "pattern": "^(?:branch|tag)$", - "type": "string" + "type": "string", + "example": "branch", + "deprecated": true } }, "required": [ @@ -13753,86 +14091,86 @@ }, "AutomationRuleResponse": { "description": "An Automation Rule defining how and when artefacts in an environment should be updated.", - "example": { - "active": true, - "artefacts_filter": [ - "http://registry.org/sample-service" - ], - "created_at": "2021-07-22T14:53:27Z", - "created_by": "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70", - "exclude_artefacts_filter": false, - "exclude_images_filter": false, - "id": "923486d012f20324", - "images_filter": [ - "sample-service" - ], - "match": "^pr-[0-9]+-.*$", - "match_ref": "^refs/heads/pr-[0-9]+-.*$", - "type": "update", - "update_to": "branch" - }, "properties": { "active": { "description": "Whether the rule will be processed or not.", - "type": "boolean" + "type": "boolean", + "example": true }, "artefacts_filter": { "description": "A list of artefact names to be processed by the rule. If the array is empty, it implies include all. If `exclude_artefacts_filter` is true, this list describes the artefacts to exclude.", "items": { "type": "string" }, - "type": "array" + "type": "array", + "example": [ + "http://registry.org/sample-service" + ] }, "created_at": { "description": "The timestamp in UTC of when the Automation Rule was created.", "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.", - "type": "string" + "type": "string", + "format": "date-time" }, "exclude_artefacts_filter": { "description": "Whether the artefacts specified in `artefacts_filter` should be excluded (true) or included (false) in the automation rule.", - "type": "boolean" + "type": "boolean", + "example": false }, "exclude_images_filter": { "description": "DEPRECATED: Whether the images specified in `images_filter` should be excluded (true) or included (false) in the automation rule.", - "type": "boolean" + "type": "boolean", + "example": false, + "deprecated": true }, "id": { "description": "The unique ID for this rule.", - "type": "string" + "type": "string", + "example": "923486d012f20324" }, "images_filter": { "description": "DEPRECATED: A list of image IDs to be processed by the rule. If the array is empty, it implies include all. If `exclude_images_filter` is true, this list describes images to exclude.", "items": { "type": "string" }, - "type": "array" + "type": "array", + "example": [ + "sample-service" + ], + "deprecated": true }, "match": { "description": "DEPRECATED: A regular expression applied to the branch or tag name depending on the value of `update_to`. Defaults to match all if omitted or empty.", - "type": "string" + "type": "string", + "example": "^pr-[0-9]+-.*$", + "deprecated": true }, "match_ref": { "description": "A regular expression applied to the ref of a new artefact version. Defaults to match all if omitted or empty.", - "type": "string" + "type": "string", + "example": "^refs/heads/pr-[0-9]+-.*$" }, "type": { "description": "Specifies the type of event. Currently, only updates to either branches or tags are supported. Must be `\"update\"`.", "pattern": "^(?:update)$", - "type": "string" + "type": "string", + "example": "update" }, "update_to": { "description": "DEPRECATED: Specifies whether the update occurs on commit to branch or creation of tag. Must be one of `\"branch\"` or `\"tag\"`.", "pattern": "^(?:branch|tag)$", - "type": "string" + "type": "string", + "example": "branch", + "deprecated": true }, "updated_at": { "description": "The timestamp in UTC of when the Automation Rule was updated.", "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.", - "type": "string" + "type": "string", + "format": "date-time" } }, "required": [ @@ -13851,19 +14189,6 @@ ], "type": "object" }, - "ErrorInfoResponse": { - "description": "ErrorInfo is returned by a handler in case of an error.", - "properties": { - "error": { - "description": "An error details", - "type": "string" - } - }, - "required": [ - "error" - ], - "type": "object" - }, "EnvironmentID": { "type": "string", "pattern": "^[a-z0-9](?:-?[a-z0-9]+)+$", @@ -15696,6 +16021,19 @@ }, "type": "object" }, + "ErrorInfoResponse": { + "description": "ErrorInfo is returned by a handler in case of an error.", + "properties": { + "error": { + "description": "An error details", + "type": "string" + } + }, + "required": [ + "error" + ], + "type": "object" + }, "ImagesRegistryCredsRequest": { "description": "ImagesRegistryCreds stores registry credentials details alongside with associated images.", "properties": { @@ -15966,6 +16304,7 @@ "app_id": "test-app", "class": "default", "def_id": "gcp-dev-postgres", + "def_version_id": "01234567-89ab-cdef-0123-4567890abcdef", "deploy_id": "172a1013b", "env_id": "gcp-dev", "env_type": "development", @@ -16000,6 +16339,10 @@ "description": "The Resource Definition that this resource was provisioned from.", "type": "string" }, + "def_version_id": { + "description": "The Resource Definition Version that this resource was provisioned from.", + "type": "string" + }, "deploy_id": { "description": "The deployment that the resource was last provisioned in.", "type": "string" @@ -16072,7 +16415,8 @@ "resource", "updated_at", "deploy_id", - "gu_res_id" + "gu_res_id", + "def_version_id" ] }, "ActiveResourceResponse": { @@ -16081,6 +16425,7 @@ "app_id": "test-app", "class": "default", "def_id": "gcp-dev-postgres", + "def_version_id": "01234567-89ab-cdef-0123-4567890abcdef", "deploy_id": "172a1013b", "env_id": "gcp-dev", "env_type": "development", @@ -16115,6 +16460,10 @@ "description": "The Resource Definition that this resource was provisioned from.", "type": "string" }, + "def_version_id": { + "description": "The Resource Definition Version that this resource was provisioned from.", + "type": "string" + }, "deploy_id": { "description": "The deployment that the resource was last provisioned in.", "type": "string" @@ -16179,6 +16528,7 @@ "env_type", "res_id", "def_id", + "def_version_id", "type", "driver_type", "class", @@ -16503,6 +16853,7 @@ "class": "default", "criteria_id": "09876545321", "def_id": "dns-res-def", + "def_version_id": "01234567-89ab-cdef-0123-4567890abcdef", "depends_on": [ "ff09876545321" ], @@ -16536,6 +16887,10 @@ "def_id": { "type": "string" }, + "def_version_id": { + "description": "The Resource Definition Version ID that was used to provision the resource.", + "type": "string" + }, "depends_on": { "items": { "type": "string" @@ -16584,7 +16939,8 @@ "criteria_id", "driver_type", "resource_schema", - "depends_on" + "depends_on", + "def_version_id" ], "type": "object" }, @@ -16812,6 +17168,17 @@ "description": "The user who created this record.", "type": "string" }, + "updated_at": { + "description": "The timestamp of when this record has been updated.", + "example": "2020-06-22T09:37:23.523Z", + "title": "Simplified extended ISO format date/time string.", + "type": "string", + "format": "date-time" + }, + "updated_by": { + "description": "The user who updated this record.", + "type": "string" + }, "criteria": { "description": "(Optional) The criteria to use when looking for a Resource Definition during the deployment.", "items": { @@ -16835,6 +17202,10 @@ "description": "The Resource Definition ID.", "type": "string" }, + "current_version_id": { + "description": "The Resource Definition Version ID.", + "type": "string" + }, "is_default": { "description": "Indicates this definition is a built-in one (provided by Humanitec).", "type": "boolean" @@ -16872,7 +17243,118 @@ "created_by", "is_default", "is_deleted", - "driver_type" + "driver_type", + "current_version_id" + ], + "type": "object" + }, + "ResourceDefinitionVersion": { + "description": "A Resource Definition Version represents a version of a Resource Definition.", + "example": { + "id": "01234567-89ab-cdef-0123-4567890abcdef", + "org_id": "test-org", + "def_id": "dev-postgres", + "name": "Dev Postgres Instance", + "type": "postgres", + "driver_type": "humanitec/postgres-cloudsql", + "driver_account": "gcp-dev-cloudsql", + "driver_inputs": { + "secret_refs": { + "credentials": { + "password": { + "value": "" + }, + "user": { + "ref": "vault/path/to/data/secrets/user", + "store": "my-external-vault", + "version": "1" + } + } + }, + "values": { + "instance": "my-dev-project:my-region:dev-db" + } + }, + "provision": { + "aws-policy": { + "is_dependent": false, + "match_dependents": false + }, + "dns#my-dns": {} + }, + "created_at": "2020-05-23T12:32:16Z", + "created_by": "a.user@example.com", + "action": "created" + }, + "properties": { + "id": { + "description": "The Resource Definition Version ID.", + "type": "string" + }, + "org_id": { + "description": "The Organization ID.", + "type": "string" + }, + "def_id": { + "description": "The Resource Definition ID.", + "type": "string" + }, + "name": { + "description": "The display name.", + "type": "string" + }, + "type": { + "description": "The Resource Type.", + "type": "string" + }, + "driver_type": { + "description": "The driver to be used to create the resource.", + "type": "string" + }, + "driver_account": { + "description": "(Optional) Security account required by the driver.", + "type": "string" + }, + "driver_inputs": { + "$ref": "#/components/schemas/ValuesSecretsRefsResponse", + "description": "(Optional) Additional input data to be passed to the driver." + }, + "provision": { + "additionalProperties": { + "$ref": "#/components/schemas/ProvisionDependenciesResponse" + }, + "description": "(Optional) A map where the keys are resType#resId (if resId is omitted, the same id of the current resource definition is used) of the resources that should be provisioned when the current resource is provisioned. This also specifies if the resources have a dependency on the current resource.", + "type": "object" + }, + "action": { + "type": "string", + "description": "The action that generated the Resource Definition Version. Might be one of `created`, `updated` or `deleted`." + }, + "created_at": { + "description": "The timestamp of when this record has been created.", + "example": "2020-06-22T09:37:23.523Z", + "title": "Simplified extended ISO format date/time string.", + "type": "string", + "format": "date-time" + }, + "created_by": { + "description": "The user who created this record.", + "type": "string" + } + }, + "required": [ + "org_id", + "id", + "name", + "def_id", + "type", + "driver_type", + "driver_account", + "driver_inputs", + "provision", + "action", + "created_at", + "created_by" ], "type": "object" }, @@ -17162,6 +17644,78 @@ ], "type": "object" }, + "ResourceClassRequest": { + "description": "Resource Classes provide a way of specializing Resource Types.\nDevelopers can set the class of a Resource alongside the type in their Score File.\nPlatform teams can match the class of a Resource via Matching Criteria.", + "type": "object", + "required": [ + "id", + "description" + ], + "properties": { + "id": { + "description": "ID of the resource class.", + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$", + "minLength": 2, + "maxLength": 63 + }, + "description": { + "description": "A human readable description when this class should be used.", + "type": "string", + "minLength": 0, + "maxLength": 1024 + } + } + }, + "ResourceClassResponse": { + "description": "Resource Classes provide a way of specializing Resource Types.\nDevelopers can set the class of a Resource alongside the type in their Score File.\nPlatform teams can match the class of a Resource via Matching Criteria.", + "type": "object", + "required": [ + "id", + "resource_type", + "description", + "created_by", + "created_at" + ], + "properties": { + "id": { + "description": "ID of the resource class.", + "type": "string" + }, + "resource_type": { + "description": "Defines the resource type this class is applicable for.", + "type": "string" + }, + "description": { + "description": "A human readable description when this class should be used.", + "type": "string" + }, + "created_by": { + "type": "string", + "description": "usedID of the user who created the resource class" + }, + "created_at": { + "type": "string", + "description": "UTC timestamp at which the resource class was created", + "format": "date-time" + } + } + }, + "UpdateResourceClassRequest": { + "description": "UpdateResourceClassRequest describes the update class description request.", + "type": "object", + "required": [ + "description" + ], + "properties": { + "description": { + "description": "New description for the resource class.", + "type": "string", + "minLength": 0, + "maxLength": 1024 + } + } + }, "UpdateResourceAccountRequestRequest": { "description": "UpdateResourceAccountRequest describes the request to update the security account details.", "example": { @@ -19164,7 +19718,8 @@ "ResourceDefinition", "ResourceProvision", "ResourceAccount", - "ResourceType" + "ResourceType", + "ResourceClass" ] }, { diff --git a/src/generated/api.ts b/src/generated/api.ts index ef2d85a8..46ce15c6 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.14 + * The version of the OpenAPI document: 0.25.17 * Contact: apiteam@humanitec.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -183,6 +183,12 @@ export interface ActiveResourceRequest { * @memberof ActiveResourceRequest */ 'def_id': string; + /** + * The Resource Definition Version that this resource was provisioned from. + * @type {string} + * @memberof ActiveResourceRequest + */ + 'def_version_id': string; /** * The deployment that the resource was last provisioned in. * @type {string} @@ -292,6 +298,12 @@ export interface ActiveResourceResponse { * @memberof ActiveResourceResponse */ 'def_id': string; + /** + * The Resource Definition Version that this resource was provisioned from. + * @type {string} + * @memberof ActiveResourceResponse + */ + 'def_version_id': string; /** * The deployment that the resource was last provisioned in. * @type {string} @@ -727,18 +739,21 @@ export interface AutomationRuleRequest { * DEPRECATED: Whether the images specified in `images_filter` should be excluded (true) or included (false) in the automation rule. * @type {boolean} * @memberof AutomationRuleRequest + * @deprecated */ 'exclude_images_filter'?: boolean; /** * DEPRECATED: A list of image IDs to be processed by the rule. If the array is empty, it implies include all. If `exclude_images_filter` is true, this list describes images to exclude. * @type {Array} * @memberof AutomationRuleRequest + * @deprecated */ 'images_filter'?: Array; /** * DEPRECATED: A regular expression applied to the branch or tag name depending on the value of `update_to`. Defaults to match all if omitted or empty. * @type {string} * @memberof AutomationRuleRequest + * @deprecated */ 'match'?: string; /** @@ -757,6 +772,7 @@ export interface AutomationRuleRequest { * DEPRECATED: Specifies whether the update occurs on commit to branch or creation of tag. Must be one of `\"branch\"` or `\"tag\"`. * @type {string} * @memberof AutomationRuleRequest + * @deprecated */ 'update_to'?: string; } @@ -794,6 +810,7 @@ export interface AutomationRuleResponse { * DEPRECATED: Whether the images specified in `images_filter` should be excluded (true) or included (false) in the automation rule. * @type {boolean} * @memberof AutomationRuleResponse + * @deprecated */ 'exclude_images_filter': boolean; /** @@ -806,12 +823,14 @@ export interface AutomationRuleResponse { * DEPRECATED: A list of image IDs to be processed by the rule. If the array is empty, it implies include all. If `exclude_images_filter` is true, this list describes images to exclude. * @type {Array} * @memberof AutomationRuleResponse + * @deprecated */ 'images_filter': Array; /** * DEPRECATED: A regular expression applied to the branch or tag name depending on the value of `update_to`. Defaults to match all if omitted or empty. * @type {string} * @memberof AutomationRuleResponse + * @deprecated */ 'match': string; /** @@ -830,6 +849,7 @@ export interface AutomationRuleResponse { * DEPRECATED: Specifies whether the update occurs on commit to branch or creation of tag. Must be one of `\"branch\"` or `\"tag\"`. * @type {string} * @memberof AutomationRuleResponse + * @deprecated */ 'update_to': string; /** @@ -1520,7 +1540,54 @@ export interface CreateWorkloadArtefactVersionExtensions { * @memberof CreateWorkloadArtefactVersionExtensions */ 'spec'?: { [key: string]: any; }; + /** + * + * @type {CreateWorkloadArtefactVersionExtensionsDeploy} + * @memberof CreateWorkloadArtefactVersionExtensions + */ + 'deploy'?: CreateWorkloadArtefactVersionExtensionsDeploy; } +/** + * An optional deploy condition for the workload. + * @export + * @interface CreateWorkloadArtefactVersionExtensionsDeploy + */ +export interface CreateWorkloadArtefactVersionExtensionsDeploy { + /** + * The stage the deployment should occur. \"deploy\", deployed in-parallel with other workloads (the default). \"before\", deployed before other workloads. \"after\", deployed after other workloads. + * @type {string} + * @memberof CreateWorkloadArtefactVersionExtensionsDeploy + */ + 'when'?: CreateWorkloadArtefactVersionExtensionsDeployWhenEnum; + /** + * The success criteria for the deployment. \"deploy\", workload deployed. \"available\", workload available. \"complete\", workload complete (often used with jobs). + * @type {string} + * @memberof CreateWorkloadArtefactVersionExtensionsDeploy + */ + 'success'?: CreateWorkloadArtefactVersionExtensionsDeploySuccessEnum; + /** + * The timeout in seconds for the deployment to reach it\'s success condition. + * @type {number} + * @memberof CreateWorkloadArtefactVersionExtensionsDeploy + */ + 'timeout'?: number; +} + +export const CreateWorkloadArtefactVersionExtensionsDeployWhenEnum = { + Before: 'before', + Deploy: 'deploy', + After: 'after' +} as const; + +export type CreateWorkloadArtefactVersionExtensionsDeployWhenEnum = typeof CreateWorkloadArtefactVersionExtensionsDeployWhenEnum[keyof typeof CreateWorkloadArtefactVersionExtensionsDeployWhenEnum]; +export const CreateWorkloadArtefactVersionExtensionsDeploySuccessEnum = { + Deploy: 'deploy', + Available: 'available', + Complete: 'complete' +} as const; + +export type CreateWorkloadArtefactVersionExtensionsDeploySuccessEnum = typeof CreateWorkloadArtefactVersionExtensionsDeploySuccessEnum[keyof typeof CreateWorkloadArtefactVersionExtensionsDeploySuccessEnum]; + /** * * @export @@ -2155,7 +2222,7 @@ export interface EnvironmentDefinitionRequest { * @type {string} * @memberof EnvironmentDefinitionRequest */ - 'from_deploy_id': string; + 'from_deploy_id'?: string; /** * The ID the Environment is referenced as. * @type {string} @@ -3105,6 +3172,12 @@ export interface NodeBodyResponse { * @memberof NodeBodyResponse */ 'def_id': string; + /** + * The Resource Definition Version ID that was used to provision the resource. + * @type {string} + * @memberof NodeBodyResponse + */ + 'def_version_id': string; /** * * @type {Array} @@ -4360,6 +4433,62 @@ export interface ResourceAccountResponse { */ 'type': string; } +/** + * Resource Classes provide a way of specializing Resource Types. Developers can set the class of a Resource alongside the type in their Score File. Platform teams can match the class of a Resource via Matching Criteria. + * @export + * @interface ResourceClassRequest + */ +export interface ResourceClassRequest { + /** + * ID of the resource class. + * @type {string} + * @memberof ResourceClassRequest + */ + 'id': string; + /** + * A human readable description when this class should be used. + * @type {string} + * @memberof ResourceClassRequest + */ + 'description': string; +} +/** + * Resource Classes provide a way of specializing Resource Types. Developers can set the class of a Resource alongside the type in their Score File. Platform teams can match the class of a Resource via Matching Criteria. + * @export + * @interface ResourceClassResponse + */ +export interface ResourceClassResponse { + /** + * ID of the resource class. + * @type {string} + * @memberof ResourceClassResponse + */ + 'id': string; + /** + * Defines the resource type this class is applicable for. + * @type {string} + * @memberof ResourceClassResponse + */ + 'resource_type': string; + /** + * A human readable description when this class should be used. + * @type {string} + * @memberof ResourceClassResponse + */ + 'description': string; + /** + * usedID of the user who created the resource class + * @type {string} + * @memberof ResourceClassResponse + */ + 'created_by': string; + /** + * UTC timestamp at which the resource class was created + * @type {string} + * @memberof ResourceClassResponse + */ + 'created_at': string; +} /** * ResourceDefinitionChange describes the effects of a Resource Definition or Matching Criteria update/deletion. * @export @@ -4415,6 +4544,18 @@ export interface ResourceDefinitionResponse { * @memberof ResourceDefinitionResponse */ 'created_by': string; + /** + * The timestamp of when this record has been updated. + * @type {string} + * @memberof ResourceDefinitionResponse + */ + 'updated_at'?: string; + /** + * The user who updated this record. + * @type {string} + * @memberof ResourceDefinitionResponse + */ + 'updated_by'?: string; /** * (Optional) The criteria to use when looking for a Resource Definition during the deployment. * @type {Array} @@ -4445,6 +4586,12 @@ export interface ResourceDefinitionResponse { * @memberof ResourceDefinitionResponse */ 'id': string; + /** + * The Resource Definition Version ID. + * @type {string} + * @memberof ResourceDefinitionResponse + */ + 'current_version_id': string; /** * Indicates this definition is a built-in one (provided by Humanitec). * @type {boolean} @@ -4482,6 +4629,85 @@ export interface ResourceDefinitionResponse { */ 'type': string; } +/** + * A Resource Definition Version represents a version of a Resource Definition. + * @export + * @interface ResourceDefinitionVersion + */ +export interface ResourceDefinitionVersion { + /** + * The Resource Definition Version ID. + * @type {string} + * @memberof ResourceDefinitionVersion + */ + 'id': string; + /** + * The Organization ID. + * @type {string} + * @memberof ResourceDefinitionVersion + */ + 'org_id': string; + /** + * The Resource Definition ID. + * @type {string} + * @memberof ResourceDefinitionVersion + */ + 'def_id': string; + /** + * The display name. + * @type {string} + * @memberof ResourceDefinitionVersion + */ + 'name': string; + /** + * The Resource Type. + * @type {string} + * @memberof ResourceDefinitionVersion + */ + 'type': string; + /** + * The driver to be used to create the resource. + * @type {string} + * @memberof ResourceDefinitionVersion + */ + 'driver_type': string; + /** + * (Optional) Security account required by the driver. + * @type {string} + * @memberof ResourceDefinitionVersion + */ + 'driver_account': string; + /** + * + * @type {ValuesSecretsRefsResponse} + * @memberof ResourceDefinitionVersion + */ + 'driver_inputs': ValuesSecretsRefsResponse; + /** + * (Optional) A map where the keys are resType#resId (if resId is omitted, the same id of the current resource definition is used) of the resources that should be provisioned when the current resource is provisioned. This also specifies if the resources have a dependency on the current resource. + * @type {{ [key: string]: ProvisionDependenciesResponse; }} + * @memberof ResourceDefinitionVersion + */ + 'provision': { [key: string]: ProvisionDependenciesResponse; }; + /** + * The action that generated the Resource Definition Version. Might be one of `created`, `updated` or `deleted`. + * @type {string} + * @memberof ResourceDefinitionVersion + */ + 'action': string; + /** + * The timestamp of when this record has been created. + * @type {string} + * @memberof ResourceDefinitionVersion + */ + 'created_at': string; + /** + * The user who created this record. + * @type {string} + * @memberof ResourceDefinitionVersion + */ + 'created_by': string; +} /** * ResourceProvisionRequest is the payload passed to the resource provisioner, specifying the resources to be provisioned. * @export @@ -5444,6 +5670,19 @@ export interface UpdateResourceAccountRequestRequest { */ 'name'?: string; } +/** + * UpdateResourceClassRequest describes the update class description request. + * @export + * @interface UpdateResourceClassRequest + */ +export interface UpdateResourceClassRequest { + /** + * New description for the resource class. + * @type {string} + * @memberof UpdateResourceClassRequest + */ + 'description': string; +} /** * UpdateResourceDefinitionRequest describes a ResourceDefinition change request. * @export @@ -9871,21 +10110,24 @@ export class AuditLogsApi extends BaseAPI { export const AutomationRuleApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * - * @summary List all Automation Rules in an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. + * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. + * @summary Create a new Automation Rule for an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesGet: async (orgId: string, appId: string, envId: string, options: AxiosRequestConfig = {}): Promise => { + createAutomationRule: async (orgId: string, appId: string, envId: string, automationRuleRequest: AutomationRuleRequest, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesGet', 'orgId', orgId) + assertParamExists('createAutomationRule', 'orgId', orgId) // verify required parameter 'appId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesGet', 'appId', appId) + assertParamExists('createAutomationRule', 'appId', appId) // verify required parameter 'envId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesGet', 'envId', envId) + assertParamExists('createAutomationRule', 'envId', envId) + // verify required parameter 'automationRuleRequest' is not null or undefined + assertParamExists('createAutomationRule', 'automationRuleRequest', automationRuleRequest) const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules` .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) @@ -9897,15 +10139,18 @@ export const AutomationRuleApiAxiosParamCreator = function (configuration?: Conf baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'POST', ...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(automationRuleRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -9913,28 +10158,29 @@ export const AutomationRuleApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. - * @summary Create a new Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. + * + * @summary Delete Automation Rule from an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesPost: async (orgId: string, appId: string, envId: string, automationRuleRequest: AutomationRuleRequest, options: AxiosRequestConfig = {}): Promise => { + deleteAutomationRule: async (orgId: string, appId: string, envId: string, ruleId: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesPost', 'orgId', orgId) + assertParamExists('deleteAutomationRule', 'orgId', orgId) // verify required parameter 'appId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesPost', 'appId', appId) + assertParamExists('deleteAutomationRule', 'appId', appId) // verify required parameter 'envId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesPost', 'envId', envId) - // verify required parameter 'automationRuleRequest' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesPost', 'automationRuleRequest', automationRuleRequest) - const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules` + assertParamExists('deleteAutomationRule', 'envId', envId) + // verify required parameter 'ruleId' is not null or undefined + assertParamExists('deleteAutomationRule', 'ruleId', ruleId) + const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}` .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) - .replace(`{${"envId"}}`, encodeURIComponent(String(envId))); + .replace(`{${"envId"}}`, encodeURIComponent(String(envId))) + .replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -9942,18 +10188,15 @@ export const AutomationRuleApiAxiosParamCreator = function (configuration?: Conf baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'DELETE', ...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(automationRuleRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -9962,23 +10205,23 @@ export const AutomationRuleApiAxiosParamCreator = function (configuration?: Conf }, /** * - * @summary Delete Automation Rule from an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. + * @summary Get a specific Automation Rule for an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete: async (orgId: string, appId: string, envId: string, ruleId: string, options: AxiosRequestConfig = {}): Promise => { + getAutomationRule: async (orgId: string, appId: string, envId: string, ruleId: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete', 'orgId', orgId) + assertParamExists('getAutomationRule', 'orgId', orgId) // verify required parameter 'appId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete', 'appId', appId) + assertParamExists('getAutomationRule', 'appId', appId) // verify required parameter 'envId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete', 'envId', envId) + assertParamExists('getAutomationRule', 'envId', envId) // verify required parameter 'ruleId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete', 'ruleId', ruleId) + assertParamExists('getAutomationRule', 'ruleId', ruleId) const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}` .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) @@ -9991,7 +10234,7 @@ export const AutomationRuleApiAxiosParamCreator = function (configuration?: Conf baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -10008,28 +10251,24 @@ export const AutomationRuleApiAxiosParamCreator = function (configuration?: Conf }, /** * - * @summary Get a specific Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. + * @summary List all Automation Rules in an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet: async (orgId: string, appId: string, envId: string, ruleId: string, options: AxiosRequestConfig = {}): Promise => { + listAutomationRules: async (orgId: string, appId: string, envId: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet', 'orgId', orgId) + assertParamExists('listAutomationRules', 'orgId', orgId) // verify required parameter 'appId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet', 'appId', appId) + assertParamExists('listAutomationRules', 'appId', appId) // verify required parameter 'envId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet', 'envId', envId) - // verify required parameter 'ruleId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet', 'ruleId', ruleId) - const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}` + assertParamExists('listAutomationRules', 'envId', envId) + const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules` .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) - .replace(`{${"envId"}}`, encodeURIComponent(String(envId))) - .replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId))); + .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; @@ -10055,25 +10294,25 @@ export const AutomationRuleApiAxiosParamCreator = function (configuration?: Conf /** * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. * @summary Update an existing Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. - * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. + * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut: async (orgId: string, appId: string, envId: string, ruleId: string, automationRuleRequest: AutomationRuleRequest, options: AxiosRequestConfig = {}): Promise => { + updateAutomationRule: async (orgId: string, appId: string, envId: string, ruleId: string, automationRuleRequest: AutomationRuleRequest, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut', 'orgId', orgId) + assertParamExists('updateAutomationRule', 'orgId', orgId) // verify required parameter 'appId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut', 'appId', appId) + assertParamExists('updateAutomationRule', 'appId', appId) // verify required parameter 'envId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut', 'envId', envId) + assertParamExists('updateAutomationRule', 'envId', envId) // verify required parameter 'ruleId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut', 'ruleId', ruleId) + assertParamExists('updateAutomationRule', 'ruleId', ruleId) // verify required parameter 'automationRuleRequest' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut', 'automationRuleRequest', automationRuleRequest) + assertParamExists('updateAutomationRule', 'automationRuleRequest', automationRuleRequest) const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}` .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) @@ -10115,73 +10354,73 @@ export const AutomationRuleApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = AutomationRuleApiAxiosParamCreator(configuration) return { /** - * - * @summary List all Automation Rules in an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. + * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. + * @summary Create a new Automation Rule for an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(orgId: string, appId: string, envId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(orgId, appId, envId, options); + async createAutomationRule(orgId: string, appId: string, envId: string, automationRuleRequest: AutomationRuleRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAutomationRule(orgId, appId, envId, automationRuleRequest, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. - * @summary Create a new Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. + * + * @summary Delete Automation Rule from an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(orgId: string, appId: string, envId: string, automationRuleRequest: AutomationRuleRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(orgId, appId, envId, automationRuleRequest, options); + async deleteAutomationRule(orgId: string, appId: string, envId: string, ruleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAutomationRule(orgId, appId, envId, ruleId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @summary Delete Automation Rule from an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. + * @summary Get a specific Automation Rule for an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(orgId: string, appId: string, envId: string, ruleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(orgId, appId, envId, ruleId, options); + async getAutomationRule(orgId: string, appId: string, envId: string, ruleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAutomationRule(orgId, appId, envId, ruleId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @summary Get a specific Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. + * @summary List all Automation Rules in an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(orgId: string, appId: string, envId: string, ruleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(orgId, appId, envId, ruleId, options); + async listAutomationRules(orgId: string, appId: string, envId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAutomationRules(orgId, appId, envId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. * @summary Update an existing Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. - * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. + * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(orgId: string, appId: string, envId: string, ruleId: string, automationRuleRequest: AutomationRuleRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(orgId, appId, envId, ruleId, automationRuleRequest, options); + async updateAutomationRule(orgId: string, appId: string, envId: string, ruleId: string, automationRuleRequest: AutomationRuleRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAutomationRule(orgId, appId, envId, ruleId, automationRuleRequest, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -10194,230 +10433,230 @@ export const AutomationRuleApiFp = function(configuration?: Configuration) { export const AutomationRuleApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = AutomationRuleApiFp(configuration) return { - /** - * - * @summary List all Automation Rules in an Environment. - * @param {AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(requestParameters: AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest, options?: AxiosRequestConfig): AxiosPromise> { - return localVarFp.orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(requestParameters.orgId, requestParameters.appId, requestParameters.envId, options).then((request) => request(axios, basePath)); - }, /** * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. * @summary Create a new Automation Rule for an Environment. - * @param {AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest} requestParameters Request parameters. + * @param {AutomationRuleApiCreateAutomationRuleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(requestParameters: AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest, options?: AxiosRequestConfig): AxiosPromise { - return localVarFp.orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.automationRuleRequest, options).then((request) => request(axios, basePath)); + createAutomationRule(requestParameters: AutomationRuleApiCreateAutomationRuleRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.createAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.automationRuleRequest, options).then((request) => request(axios, basePath)); }, /** * * @summary Delete Automation Rule from an Environment. - * @param {AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest} requestParameters Request parameters. + * @param {AutomationRuleApiDeleteAutomationRuleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(requestParameters: AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest, options?: AxiosRequestConfig): AxiosPromise { - return localVarFp.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(axios, basePath)); + deleteAutomationRule(requestParameters: AutomationRuleApiDeleteAutomationRuleRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.deleteAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(axios, basePath)); }, /** * * @summary Get a specific Automation Rule for an Environment. - * @param {AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest} requestParameters Request parameters. + * @param {AutomationRuleApiGetAutomationRuleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(requestParameters: AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest, options?: AxiosRequestConfig): AxiosPromise { - return localVarFp.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(axios, basePath)); + getAutomationRule(requestParameters: AutomationRuleApiGetAutomationRuleRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.getAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary List all Automation Rules in an Environment. + * @param {AutomationRuleApiListAutomationRulesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listAutomationRules(requestParameters: AutomationRuleApiListAutomationRulesRequest, options?: AxiosRequestConfig): AxiosPromise> { + return localVarFp.listAutomationRules(requestParameters.orgId, requestParameters.appId, requestParameters.envId, options).then((request) => request(axios, basePath)); }, /** * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. * @summary Update an existing Automation Rule for an Environment. - * @param {AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest} requestParameters Request parameters. + * @param {AutomationRuleApiUpdateAutomationRuleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(requestParameters: AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest, options?: AxiosRequestConfig): AxiosPromise { - return localVarFp.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, requestParameters.automationRuleRequest, options).then((request) => request(axios, basePath)); + updateAutomationRule(requestParameters: AutomationRuleApiUpdateAutomationRuleRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.updateAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, requestParameters.automationRuleRequest, options).then((request) => request(axios, basePath)); }, }; }; /** - * Request parameters for orgsOrgIdAppsAppIdEnvsEnvIdRulesGet operation in AutomationRuleApi. + * Request parameters for createAutomationRule operation in AutomationRuleApi. * @export - * @interface AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest + * @interface AutomationRuleApiCreateAutomationRuleRequest */ -export interface AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest { +export interface AutomationRuleApiCreateAutomationRuleRequest { /** - * The Organization ID. + * The Organization ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGet + * @memberof AutomationRuleApiCreateAutomationRule */ readonly orgId: string /** - * The Application ID. + * The Application ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGet + * @memberof AutomationRuleApiCreateAutomationRule */ readonly appId: string /** - * The Environment ID. + * The Environment ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGet + * @memberof AutomationRuleApiCreateAutomationRule */ readonly envId: string + + /** + * The definition of the Automation Rule. + * @type {AutomationRuleRequest} + * @memberof AutomationRuleApiCreateAutomationRule + */ + readonly automationRuleRequest: AutomationRuleRequest } /** - * Request parameters for orgsOrgIdAppsAppIdEnvsEnvIdRulesPost operation in AutomationRuleApi. + * Request parameters for deleteAutomationRule operation in AutomationRuleApi. * @export - * @interface AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest + * @interface AutomationRuleApiDeleteAutomationRuleRequest */ -export interface AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest { +export interface AutomationRuleApiDeleteAutomationRuleRequest { /** - * The Organization ID. + * The Organization ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPost + * @memberof AutomationRuleApiDeleteAutomationRule */ readonly orgId: string /** - * The Application ID. + * The Application ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPost + * @memberof AutomationRuleApiDeleteAutomationRule */ readonly appId: string /** - * The Environment ID. + * The Environment ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPost + * @memberof AutomationRuleApiDeleteAutomationRule */ readonly envId: string /** - * The definition of the Automation Rule. - * @type {AutomationRuleRequest} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPost + * The Automation Rule ID. + * @type {string} + * @memberof AutomationRuleApiDeleteAutomationRule */ - readonly automationRuleRequest: AutomationRuleRequest + readonly ruleId: string } /** - * Request parameters for orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete operation in AutomationRuleApi. + * Request parameters for getAutomationRule operation in AutomationRuleApi. * @export - * @interface AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest + * @interface AutomationRuleApiGetAutomationRuleRequest */ -export interface AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest { +export interface AutomationRuleApiGetAutomationRuleRequest { /** - * The Organization ID. + * The Organization ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete + * @memberof AutomationRuleApiGetAutomationRule */ readonly orgId: string /** - * The Application ID. + * The Application ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete + * @memberof AutomationRuleApiGetAutomationRule */ readonly appId: string /** - * The Environment ID. + * The Environment ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete + * @memberof AutomationRuleApiGetAutomationRule */ readonly envId: string /** - * The Automation Rule ID. + * The Automation Rule ID. * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete + * @memberof AutomationRuleApiGetAutomationRule */ readonly ruleId: string } /** - * Request parameters for orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet operation in AutomationRuleApi. + * Request parameters for listAutomationRules operation in AutomationRuleApi. * @export - * @interface AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest + * @interface AutomationRuleApiListAutomationRulesRequest */ -export interface AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest { +export interface AutomationRuleApiListAutomationRulesRequest { /** - * The Organization ID. + * The Organization ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet + * @memberof AutomationRuleApiListAutomationRules */ readonly orgId: string /** - * The Application ID. + * The Application ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet + * @memberof AutomationRuleApiListAutomationRules */ readonly appId: string /** - * The Environment ID. + * The Environment ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet + * @memberof AutomationRuleApiListAutomationRules */ readonly envId: string - - /** - * The Automation Rule ID. - * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet - */ - readonly ruleId: string } /** - * Request parameters for orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut operation in AutomationRuleApi. + * Request parameters for updateAutomationRule operation in AutomationRuleApi. * @export - * @interface AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest + * @interface AutomationRuleApiUpdateAutomationRuleRequest */ -export interface AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest { +export interface AutomationRuleApiUpdateAutomationRuleRequest { /** - * The Organization ID. + * The Organization ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut + * @memberof AutomationRuleApiUpdateAutomationRule */ readonly orgId: string /** - * The Application ID. + * The Application ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut + * @memberof AutomationRuleApiUpdateAutomationRule */ readonly appId: string /** - * The Environment ID. + * The Environment ID * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut + * @memberof AutomationRuleApiUpdateAutomationRule */ readonly envId: string /** - * The Automation Rule ID. + * The Automation Rule ID. * @type {string} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut + * @memberof AutomationRuleApiUpdateAutomationRule */ readonly ruleId: string /** - * The definition of the Automation Rule. + * The definition of the Automation Rule. * @type {AutomationRuleRequest} - * @memberof AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut + * @memberof AutomationRuleApiUpdateAutomationRule */ readonly automationRuleRequest: AutomationRuleRequest } @@ -10430,63 +10669,63 @@ export interface AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutReque */ export class AutomationRuleApi extends BaseAPI { /** - * - * @summary List all Automation Rules in an Environment. - * @param {AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest} requestParameters Request parameters. + * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. + * @summary Create a new Automation Rule for an Environment. + * @param {AutomationRuleApiCreateAutomationRuleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AutomationRuleApi */ - public orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(requestParameters: AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest, options?: AxiosRequestConfig) { - return AutomationRuleApiFp(this.configuration).orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(requestParameters.orgId, requestParameters.appId, requestParameters.envId, options).then((request) => request(this.axios, this.basePath)); + public createAutomationRule(requestParameters: AutomationRuleApiCreateAutomationRuleRequest, options?: AxiosRequestConfig) { + return AutomationRuleApiFp(this.configuration).createAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.automationRuleRequest, options).then((request) => request(this.axios, this.basePath)); } /** - * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. - * @summary Create a new Automation Rule for an Environment. - * @param {AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest} requestParameters Request parameters. + * + * @summary Delete Automation Rule from an Environment. + * @param {AutomationRuleApiDeleteAutomationRuleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AutomationRuleApi */ - public orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(requestParameters: AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest, options?: AxiosRequestConfig) { - return AutomationRuleApiFp(this.configuration).orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.automationRuleRequest, options).then((request) => request(this.axios, this.basePath)); + public deleteAutomationRule(requestParameters: AutomationRuleApiDeleteAutomationRuleRequest, options?: AxiosRequestConfig) { + return AutomationRuleApiFp(this.configuration).deleteAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(this.axios, this.basePath)); } /** * - * @summary Delete Automation Rule from an Environment. - * @param {AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest} requestParameters Request parameters. + * @summary Get a specific Automation Rule for an Environment. + * @param {AutomationRuleApiGetAutomationRuleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AutomationRuleApi */ - public orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(requestParameters: AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest, options?: AxiosRequestConfig) { - return AutomationRuleApiFp(this.configuration).orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(this.axios, this.basePath)); + public getAutomationRule(requestParameters: AutomationRuleApiGetAutomationRuleRequest, options?: AxiosRequestConfig) { + return AutomationRuleApiFp(this.configuration).getAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(this.axios, this.basePath)); } /** * - * @summary Get a specific Automation Rule for an Environment. - * @param {AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest} requestParameters Request parameters. + * @summary List all Automation Rules in an Environment. + * @param {AutomationRuleApiListAutomationRulesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AutomationRuleApi */ - public orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(requestParameters: AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest, options?: AxiosRequestConfig) { - return AutomationRuleApiFp(this.configuration).orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(this.axios, this.basePath)); + public listAutomationRules(requestParameters: AutomationRuleApiListAutomationRulesRequest, options?: AxiosRequestConfig) { + return AutomationRuleApiFp(this.configuration).listAutomationRules(requestParameters.orgId, requestParameters.appId, requestParameters.envId, options).then((request) => request(this.axios, this.basePath)); } /** * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. * @summary Update an existing Automation Rule for an Environment. - * @param {AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest} requestParameters Request parameters. + * @param {AutomationRuleApiUpdateAutomationRuleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AutomationRuleApi */ - public orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(requestParameters: AutomationRuleApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest, options?: AxiosRequestConfig) { - return AutomationRuleApiFp(this.configuration).orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, requestParameters.automationRuleRequest, options).then((request) => request(this.axios, this.basePath)); + public updateAutomationRule(requestParameters: AutomationRuleApiUpdateAutomationRuleRequest, options?: AxiosRequestConfig) { + return AutomationRuleApiFp(this.configuration).updateAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, requestParameters.automationRuleRequest, options).then((request) => request(this.axios, this.basePath)); } } @@ -19970,6 +20209,54 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio options: localVarRequestOptions, }; }, + /** + * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. + * @summary Create a new Automation Rule for an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createAutomationRule: async (orgId: string, appId: string, envId: string, automationRuleRequest: AutomationRuleRequest, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('createAutomationRule', 'orgId', orgId) + // verify required parameter 'appId' is not null or undefined + assertParamExists('createAutomationRule', 'appId', appId) + // verify required parameter 'envId' is not null or undefined + assertParamExists('createAutomationRule', 'envId', envId) + // verify required parameter 'automationRuleRequest' is not null or undefined + assertParamExists('createAutomationRule', 'automationRuleRequest', automationRuleRequest) + const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules` + .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: 'POST', ...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(automationRuleRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * At Humanitec, Deployments are defined as changes to the state of the Environment. The state can be changed by defining a set of desired changes to the current state via a Deployment Delta or by resetting the current state after a previous Deployment. (See Environment Rebase.) Both types of changes can be combined into a single Deployment during which the Delta is applied to the Rebased state. When specifying a Delta, a Delta ID must be used. That Delta must have been committed to the Delta store prior to the Deployment. A Set ID can also be defined in the deployment to force the state of the environment to a particular state. This will be ignored if the Delta is specified. **NOTE:** Directly setting a `set_id` in a deployment is not recommended as it will not record history of where the set came from. If the intention is to replicate an existing environment, use the environment rebasing approach described above. * @summary Start a new Deployment. @@ -20519,6 +20806,50 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio options: localVarRequestOptions, }; }, + /** + * + * @summary Creates a new resources class. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {ResourceClassRequest} resourceClassRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createResourceClass: async (orgId: string, typeId: string, resourceClassRequest: ResourceClassRequest, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('createResourceClass', 'orgId', orgId) + // verify required parameter 'typeId' is not null or undefined + assertParamExists('createResourceClass', 'typeId', typeId) + // verify required parameter 'resourceClassRequest' is not null or undefined + assertParamExists('createResourceClass', 'resourceClassRequest', resourceClassRequest) + const localVarPath = `/orgs/{orgId}/resources/types/{typeId}/classes` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"typeId"}}`, encodeURIComponent(String(typeId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(resourceClassRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * * @summary Create a new Resource Definition. @@ -21054,6 +21385,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, + }; + }, + /** + * + * @summary Delete Automation Rule from an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteAutomationRule: async (orgId: string, appId: string, envId: string, ruleId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('deleteAutomationRule', 'orgId', orgId) + // verify required parameter 'appId' is not null or undefined + assertParamExists('deleteAutomationRule', 'appId', appId) + // verify required parameter 'envId' is not null or undefined + assertParamExists('deleteAutomationRule', 'envId', envId) + // verify required parameter 'ruleId' is not null or undefined + assertParamExists('deleteAutomationRule', 'ruleId', ruleId) + const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) + .replace(`{${"envId"}}`, encodeURIComponent(String(envId))) + .replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -21406,7 +21783,49 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is **marked as** pending deletion and will be deleted (purged) as soon as no existing Active Resources reference it. With the next deployment matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). The Resource Definition that has been marked for deletion cannot be used to provision new resources. + * + * @summary Delete a resource class. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {string} classId The resource class id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteResourceClass: async (orgId: string, typeId: string, classId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('deleteResourceClass', 'orgId', orgId) + // verify required parameter 'typeId' is not null or undefined + assertParamExists('deleteResourceClass', 'typeId', typeId) + // verify required parameter 'classId' is not null or undefined + assertParamExists('deleteResourceClass', 'classId', classId) + const localVarPath = `/orgs/{orgId}/resources/types/{typeId}/classes/{classId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"typeId"}}`, encodeURIComponent(String(typeId))) + .replace(`{${"classId"}}`, encodeURIComponent(String(classId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is deleted immediately even if there are Active Resources linked to it. The Resource Definition that has been marked for deletion cannot be used to provision new resources. With the next deployment, matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). * @summary Delete a Resource Definition. * @param {string} orgId The Organization ID. * @param {string} defId The Resource Definition ID. @@ -21862,29 +22281,29 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * Read the current state of a trigger batch for a Pipeline if one exists - * @summary Read the current state of a trigger batch + * + * @summary Get a specific Automation Rule for an Environment. * @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 {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getBatch: async (orgId: string, appId: string, pipelineId: string, batchType: string, options: AxiosRequestConfig = {}): Promise => { + getAutomationRule: async (orgId: string, appId: string, envId: string, ruleId: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined - assertParamExists('getBatch', 'orgId', orgId) + assertParamExists('getAutomationRule', '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}` + assertParamExists('getAutomationRule', 'appId', appId) + // verify required parameter 'envId' is not null or undefined + assertParamExists('getAutomationRule', 'envId', envId) + // verify required parameter 'ruleId' is not null or undefined + assertParamExists('getAutomationRule', 'ruleId', ruleId) + const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}` .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) - .replace(`{${"pipelineId"}}`, encodeURIComponent(String(pipelineId))) - .replace(`{${"batchType"}}`, encodeURIComponent(String(batchType))); + .replace(`{${"envId"}}`, encodeURIComponent(String(envId))) + .replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -21908,13 +22327,29 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * - * @summary Gets the extended profile of the current user + * 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} */ - getCurrentUser: async (options: AxiosRequestConfig = {}): Promise => { - const localVarPath = `/current-user`; + 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; @@ -21939,24 +22374,54 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio }, /** * - * @summary Fetch an existing Delta - * @param {string} orgId The Organization ID - * @param {string} appId The Application ID - * @param {string} deltaId ID of the Delta to fetch. + * @summary Gets the extended profile of the current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDelta: async (orgId: string, appId: string, deltaId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'orgId' is not null or undefined - assertParamExists('getDelta', 'orgId', orgId) - // verify required parameter 'appId' is not null or undefined - assertParamExists('getDelta', 'appId', appId) - // verify required parameter 'deltaId' is not null or undefined - assertParamExists('getDelta', 'deltaId', deltaId) - const localVarPath = `/orgs/{orgId}/apps/{appId}/deltas/{deltaId}` - .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) - .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) - .replace(`{${"deltaId"}}`, encodeURIComponent(String(deltaId))); + getCurrentUser: async (options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/current-user`; + // 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}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Fetch an existing Delta + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} deltaId ID of the Delta to fetch. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getDelta: async (orgId: string, appId: string, deltaId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('getDelta', 'orgId', orgId) + // verify required parameter 'appId' is not null or undefined + assertParamExists('getDelta', 'appId', appId) + // verify required parameter 'deltaId' is not null or undefined + assertParamExists('getDelta', 'deltaId', deltaId) + const localVarPath = `/orgs/{orgId}/apps/{appId}/deltas/{deltaId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) + .replace(`{${"deltaId"}}`, encodeURIComponent(String(deltaId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -22623,13 +23088,56 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio }, /** * - * @summary Get a specific Resource Definition. + * @summary Get resource class by ID. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {string} classId The resource class ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getResourceClass: async (orgId: string, typeId: string, classId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('getResourceClass', 'orgId', orgId) + // verify required parameter 'typeId' is not null or undefined + assertParamExists('getResourceClass', 'typeId', typeId) + // verify required parameter 'classId' is not null or undefined + assertParamExists('getResourceClass', 'classId', classId) + const localVarPath = `/orgs/{orgId}/resources/types/{typeId}/classes/{classId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"typeId"}}`, encodeURIComponent(String(typeId))) + .replace(`{${"classId"}}`, encodeURIComponent(String(classId))); + // 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}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Get a specific Resource Definition. If the resource is marked as deleted it is not shown in the response, unless specified via `deleted` query parameter. * @param {string} orgId The Organization ID. * @param {string} defId The Resource Definition ID. + * @param {boolean} [deleted] If returns the resource definition even if it has been deleted. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getResourceDefinition: async (orgId: string, defId: string, options: AxiosRequestConfig = {}): Promise => { + getResourceDefinition: async (orgId: string, defId: string, deleted?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined assertParamExists('getResourceDefinition', 'orgId', orgId) // verify required parameter 'defId' is not null or undefined @@ -22648,6 +23156,52 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (deleted !== undefined) { + localVarQueryParameter['deleted'] = deleted; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Get a Specific Resource Definition Version. + * @param {string} orgId The Organization ID + * @param {string} defId The Resource Definition ID. + * @param {string} defVersionId The Resource Definition Version ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getResourceDefinitionVersion: async (orgId: string, defId: string, defVersionId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('getResourceDefinitionVersion', 'orgId', orgId) + // verify required parameter 'defId' is not null or undefined + assertParamExists('getResourceDefinitionVersion', 'defId', defId) + // verify required parameter 'defVersionId' is not null or undefined + assertParamExists('getResourceDefinitionVersion', 'defVersionId', defVersionId) + const localVarPath = `/orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"defId"}}`, encodeURIComponent(String(defId))) + .replace(`{${"defVersionId"}}`, encodeURIComponent(String(defVersionId))); + // 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); @@ -23414,6 +23968,48 @@ 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, + }; + }, + /** + * + * @summary List all Automation Rules in an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listAutomationRules: async (orgId: string, appId: string, envId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('listAutomationRules', 'orgId', orgId) + // verify required parameter 'appId' is not null or undefined + assertParamExists('listAutomationRules', 'appId', appId) + // verify required parameter 'envId' is not null or undefined + assertParamExists('listAutomationRules', 'envId', envId) + const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules` + .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: '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}; @@ -24483,22 +25079,16 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. - * @summary List Resource Definitions. - * @param {string} orgId The Organization ID. - * @param {string} [app] (Optional) Filter Resource Definitions that may match a specific Application. - * @param {string} [env] (Optional) Filter Resource Definitions that may match a specific Environment. - * @param {string} [envType] (Optional) Filter Resource Definitions that may match a specific Environment Type. - * @param {string} [res] (Optional) Filter Resource Definitions that may match a specific Resource. - * @param {string} [resType] (Optional) Filter Resource Definitions that may match a specific Resource Type. - * @param {string} [_class] (Optional) Filter Resource Definitions that may match a specific Class. + * + * @summary List resource classes. + * @param {string} orgId The organization ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listResourceDefinitions: async (orgId: string, app?: string, env?: string, envType?: string, res?: string, resType?: string, _class?: string, options: AxiosRequestConfig = {}): Promise => { + listResourceClasses: async (orgId: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined - assertParamExists('listResourceDefinitions', 'orgId', orgId) - const localVarPath = `/orgs/{orgId}/resources/defs` + assertParamExists('listResourceClasses', 'orgId', orgId) + const localVarPath = `/orgs/{orgId}/resources/classes` .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -24511,30 +25101,6 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (app !== undefined) { - localVarQueryParameter['app'] = app; - } - - if (env !== undefined) { - localVarQueryParameter['env'] = env; - } - - if (envType !== undefined) { - localVarQueryParameter['env_type'] = envType; - } - - if (res !== undefined) { - localVarQueryParameter['res'] = res; - } - - if (resType !== undefined) { - localVarQueryParameter['res_type'] = resType; - } - - if (_class !== undefined) { - localVarQueryParameter['class'] = _class; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -24548,16 +25114,23 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio }, /** * - * @summary List Resource Drivers. - * @param {string} orgId The Organization ID. + * @summary Get Resource Definition Versions of a specific Resource Definition. First 50 Versions are kept along with all the Versions referenced by an Active Resource. To obtain Versions of a deleted Resource Definition, the `deleted` parameter needs to be used. + * @param {string} orgId The Organization ID + * @param {string} defId The Resource Definition ID. + * @param {boolean} [deleted] If to show also deleted records in the response. + * @param {number} [perPage] The maximum number of items to return in a page of results + * @param {string} [page] The page token to request from * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listResourceDrivers: async (orgId: string, options: AxiosRequestConfig = {}): Promise => { + listResourceDefinitionVersions: async (orgId: string, defId: string, deleted?: boolean, perPage?: number, page?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined - assertParamExists('listResourceDrivers', 'orgId', orgId) - const localVarPath = `/orgs/{orgId}/resources/drivers` - .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))); + assertParamExists('listResourceDefinitionVersions', 'orgId', orgId) + // verify required parameter 'defId' is not null or undefined + assertParamExists('listResourceDefinitionVersions', 'defId', defId) + const localVarPath = `/orgs/{orgId}/resources/defs/{defId}/versions` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"defId"}}`, encodeURIComponent(String(defId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -24569,6 +25142,18 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (deleted !== undefined) { + localVarQueryParameter['deleted'] = deleted; + } + + if (perPage !== undefined) { + localVarQueryParameter['per_page'] = perPage; + } + + if (page !== undefined) { + localVarQueryParameter['page'] = page; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -24581,16 +25166,23 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * - * @summary List Resource Types. + * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. Resources marked as deleted are not listed in the response, unless specified via `deleted` query parameter. + * @summary List Resource Definitions. * @param {string} orgId The Organization ID. + * @param {string} [app] (Optional) Filter Resource Definitions that may match a specific Application. + * @param {string} [env] (Optional) Filter Resource Definitions that may match a specific Environment. + * @param {string} [envType] (Optional) Filter Resource Definitions that may match a specific Environment Type. + * @param {string} [res] (Optional) Filter Resource Definitions that may match a specific Resource. + * @param {string} [resType] (Optional) Filter Resource Definitions that may match a specific Resource Type. + * @param {string} [_class] (Optional) Filter Resource Definitions that may match a specific Class. + * @param {boolean} [deleted] If returns also resource definitions which has been deleted. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listResourceTypes: async (orgId: string, options: AxiosRequestConfig = {}): Promise => { + listResourceDefinitions: async (orgId: string, app?: string, env?: string, envType?: string, res?: string, resType?: string, _class?: string, deleted?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined - assertParamExists('listResourceTypes', 'orgId', orgId) - const localVarPath = `/orgs/{orgId}/resources/types` + assertParamExists('listResourceDefinitions', 'orgId', orgId) + const localVarPath = `/orgs/{orgId}/resources/defs` .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -24603,6 +25195,34 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (app !== undefined) { + localVarQueryParameter['app'] = app; + } + + if (env !== undefined) { + localVarQueryParameter['env'] = env; + } + + if (envType !== undefined) { + localVarQueryParameter['env_type'] = envType; + } + + if (res !== undefined) { + localVarQueryParameter['res'] = res; + } + + if (resType !== undefined) { + localVarQueryParameter['res_type'] = resType; + } + + if (_class !== undefined) { + localVarQueryParameter['class'] = _class; + } + + if (deleted !== undefined) { + localVarQueryParameter['deleted'] = deleted; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -24616,21 +25236,16 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio }, /** * - * @summary Get Runtime information about specific multiple environments. - * @param {string} orgId The Organization ID - * @param {string} appId The Application ID - * @param {Array} [id] Filter environments by ID (required). Up to 5 ids can be supplied per request. + * @summary List Resource Drivers. + * @param {string} orgId The Organization ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listRuntime: async (orgId: string, appId: string, id?: Array, options: AxiosRequestConfig = {}): Promise => { + listResourceDrivers: async (orgId: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined - assertParamExists('listRuntime', 'orgId', orgId) - // verify required parameter 'appId' is not null or undefined - assertParamExists('listRuntime', 'appId', appId) - const localVarPath = `/orgs/{orgId}/apps/{appId}/runtime` - .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) - .replace(`{${"appId"}}`, encodeURIComponent(String(appId))); + assertParamExists('listResourceDrivers', 'orgId', orgId) + const localVarPath = `/orgs/{orgId}/resources/drivers` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -24642,10 +25257,6 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (id) { - localVarQueryParameter['id'] = id; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -24659,20 +25270,97 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio }, /** * - * @summary List Users with roles in an App - * @param {string} orgId The Organization ID - * @param {string} appId The Application ID. + * @summary List Resource Types. + * @param {string} orgId The Organization ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listUserRolesInApp: async (orgId: string, appId: string, options: AxiosRequestConfig = {}): Promise => { + listResourceTypes: async (orgId: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined - assertParamExists('listUserRolesInApp', 'orgId', orgId) - // verify required parameter 'appId' is not null or undefined - assertParamExists('listUserRolesInApp', 'appId', appId) - const localVarPath = `/orgs/{orgId}/apps/{appId}/users` - .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) - .replace(`{${"appId"}}`, encodeURIComponent(String(appId))); + assertParamExists('listResourceTypes', 'orgId', orgId) + const localVarPath = `/orgs/{orgId}/resources/types` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))); + // 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}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Get Runtime information about specific multiple environments. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {Array} [id] Filter environments by ID (required). Up to 5 ids can be supplied per request. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listRuntime: async (orgId: string, appId: string, id?: Array, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('listRuntime', 'orgId', orgId) + // verify required parameter 'appId' is not null or undefined + assertParamExists('listRuntime', 'appId', appId) + const localVarPath = `/orgs/{orgId}/apps/{appId}/runtime` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"appId"}}`, encodeURIComponent(String(appId))); + // 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; + + if (id) { + localVarQueryParameter['id'] = id; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary List Users with roles in an App + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listUserRolesInApp: async (orgId: string, appId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('listUserRolesInApp', 'orgId', orgId) + // verify required parameter 'appId' is not null or undefined + assertParamExists('listUserRolesInApp', 'appId', appId) + const localVarPath = `/orgs/{orgId}/apps/{appId}/users` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"appId"}}`, encodeURIComponent(String(appId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -25270,240 +25958,6 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio options: localVarRequestOptions, }; }, - /** - * - * @summary List all Automation Rules in an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesGet: async (orgId: string, appId: string, envId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'orgId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesGet', 'orgId', orgId) - // verify required parameter 'appId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesGet', 'appId', appId) - // verify required parameter 'envId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesGet', 'envId', envId) - const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules` - .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: '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}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. - * @summary Create a new Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesPost: async (orgId: string, appId: string, envId: string, automationRuleRequest: AutomationRuleRequest, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'orgId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesPost', 'orgId', orgId) - // verify required parameter 'appId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesPost', 'appId', appId) - // verify required parameter 'envId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesPost', 'envId', envId) - // verify required parameter 'automationRuleRequest' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesPost', 'automationRuleRequest', automationRuleRequest) - const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules` - .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: 'POST', ...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(automationRuleRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @summary Delete Automation Rule from an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete: async (orgId: string, appId: string, envId: string, ruleId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'orgId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete', 'orgId', orgId) - // verify required parameter 'appId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete', 'appId', appId) - // verify required parameter 'envId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete', 'envId', envId) - // verify required parameter 'ruleId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete', 'ruleId', ruleId) - const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}` - .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) - .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) - .replace(`{${"envId"}}`, encodeURIComponent(String(envId))) - .replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @summary Get a specific Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet: async (orgId: string, appId: string, envId: string, ruleId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'orgId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet', 'orgId', orgId) - // verify required parameter 'appId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet', 'appId', appId) - // verify required parameter 'envId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet', 'envId', envId) - // verify required parameter 'ruleId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet', 'ruleId', ruleId) - const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}` - .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) - .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) - .replace(`{${"envId"}}`, encodeURIComponent(String(envId))) - .replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId))); - // 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}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. - * @summary Update an existing Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. - * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut: async (orgId: string, appId: string, envId: string, ruleId: string, automationRuleRequest: AutomationRuleRequest, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'orgId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut', 'orgId', orgId) - // verify required parameter 'appId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut', 'appId', appId) - // verify required parameter 'envId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut', 'envId', envId) - // verify required parameter 'ruleId' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut', 'ruleId', ruleId) - // verify required parameter 'automationRuleRequest' is not null or undefined - assertParamExists('orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut', 'automationRuleRequest', automationRuleRequest) - const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}` - .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) - .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) - .replace(`{${"envId"}}`, encodeURIComponent(String(envId))) - .replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId))); - // 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: 'PUT', ...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(automationRuleRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, /** * A new Value Set Version is created on every modification of a Value inside the an Environment of an App. In case this environment has no overrides the response is the same as the App level endpoint. * @summary List Value Set Versions in an Environment of an App @@ -27814,6 +28268,58 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio options: localVarRequestOptions, }; }, + /** + * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. + * @summary Update an existing Automation Rule for an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. + * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateAutomationRule: async (orgId: string, appId: string, envId: string, ruleId: string, automationRuleRequest: AutomationRuleRequest, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('updateAutomationRule', 'orgId', orgId) + // verify required parameter 'appId' is not null or undefined + assertParamExists('updateAutomationRule', 'appId', appId) + // verify required parameter 'envId' is not null or undefined + assertParamExists('updateAutomationRule', 'envId', envId) + // verify required parameter 'ruleId' is not null or undefined + assertParamExists('updateAutomationRule', 'ruleId', ruleId) + // verify required parameter 'automationRuleRequest' is not null or undefined + assertParamExists('updateAutomationRule', 'automationRuleRequest', automationRuleRequest) + const localVarPath = `/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"appId"}}`, encodeURIComponent(String(appId))) + .replace(`{${"envId"}}`, encodeURIComponent(String(envId))) + .replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId))); + // 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: 'PUT', ...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(automationRuleRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * * @summary Updates the extended profile of the current user. @@ -28046,6 +28552,54 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio options: localVarRequestOptions, }; }, + /** + * + * @summary Update a resource class description. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type ID. + * @param {string} classId The resource class ID. + * @param {UpdateResourceClassRequest} updateResourceClassRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateResourceClass: async (orgId: string, typeId: string, classId: string, updateResourceClassRequest: UpdateResourceClassRequest, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('updateResourceClass', 'orgId', orgId) + // verify required parameter 'typeId' is not null or undefined + assertParamExists('updateResourceClass', 'typeId', typeId) + // verify required parameter 'classId' is not null or undefined + assertParamExists('updateResourceClass', 'classId', classId) + // verify required parameter 'updateResourceClassRequest' is not null or undefined + assertParamExists('updateResourceClass', 'updateResourceClassRequest', updateResourceClassRequest) + const localVarPath = `/orgs/{orgId}/resources/types/{typeId}/classes/{classId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"typeId"}}`, encodeURIComponent(String(typeId))) + .replace(`{${"classId"}}`, encodeURIComponent(String(classId))); + // 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(updateResourceClassRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * * @summary Update a Resource Definition. @@ -28442,6 +28996,20 @@ export const PublicApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.createArtefactVersion(orgId, createArtefactVersion, vcs, dryRun, accept, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. + * @summary Create a new Automation Rule for an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createAutomationRule(orgId: string, appId: string, envId: string, automationRuleRequest: AutomationRuleRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAutomationRule(orgId, appId, envId, automationRuleRequest, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * At Humanitec, Deployments are defined as changes to the state of the Environment. The state can be changed by defining a set of desired changes to the current state via a Deployment Delta or by resetting the current state after a previous Deployment. (See Environment Rebase.) Both types of changes can be combined into a single Deployment during which the Delta is applied to the Rebased state. When specifying a Delta, a Delta ID must be used. That Delta must have been committed to the Delta store prior to the Deployment. A Set ID can also be defined in the deployment to force the state of the environment to a particular state. This will be ignored if the Delta is specified. **NOTE:** Directly setting a `set_id` in a deployment is not recommended as it will not record history of where the set came from. If the intention is to replicate an existing environment, use the environment rebasing approach described above. * @summary Start a new Deployment. @@ -28602,6 +29170,19 @@ export const PublicApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.createResourceAccount(orgId, createResourceAccountRequestRequest, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Creates a new resources class. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {ResourceClassRequest} resourceClassRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createResourceClass(orgId: string, typeId: string, resourceClassRequest: ResourceClassRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createResourceClass(orgId, typeId, resourceClassRequest, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Create a new Resource Definition. @@ -28765,6 +29346,20 @@ export const PublicApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteArtefact(orgId, artefactId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Delete Automation Rule from an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteAutomationRule(orgId: string, appId: string, envId: string, ruleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAutomationRule(orgId, appId, envId, ruleId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * Deletes a specific Environment in an Application. Deleting an Environment will also delete the Deployment history of the Environment. _Deletions are currently irreversible._ * @summary Delete a specific Environment. @@ -28871,7 +29466,20 @@ export const PublicApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is **marked as** pending deletion and will be deleted (purged) as soon as no existing Active Resources reference it. With the next deployment matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). The Resource Definition that has been marked for deletion cannot be used to provision new resources. + * + * @summary Delete a resource class. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {string} classId The resource class id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteResourceClass(orgId: string, typeId: string, classId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteResourceClass(orgId, typeId, classId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is deleted immediately even if there are Active Resources linked to it. The Resource Definition that has been marked for deletion cannot be used to provision new resources. With the next deployment, matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). * @summary Delete a Resource Definition. * @param {string} orgId The Organization ID. * @param {string} defId The Resource Definition ID. @@ -29011,6 +29619,20 @@ export const PublicApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.getArtefactVersion(orgId, artefactVersionId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Get a specific Automation Rule for an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getAutomationRule(orgId: string, appId: string, envId: string, ruleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAutomationRule(orgId, appId, envId, ruleId, 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 @@ -29248,14 +29870,41 @@ export const PublicApiFp = function(configuration?: Configuration) { }, /** * - * @summary Get a specific Resource Definition. + * @summary Get resource class by ID. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {string} classId The resource class ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getResourceClass(orgId: string, typeId: string, classId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getResourceClass(orgId, typeId, classId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Get a specific Resource Definition. If the resource is marked as deleted it is not shown in the response, unless specified via `deleted` query parameter. * @param {string} orgId The Organization ID. * @param {string} defId The Resource Definition ID. + * @param {boolean} [deleted] If returns the resource definition even if it has been deleted. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getResourceDefinition(orgId: string, defId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getResourceDefinition(orgId, defId, options); + async getResourceDefinition(orgId: string, defId: string, deleted?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getResourceDefinition(orgId, defId, deleted, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Get a Specific Resource Definition Version. + * @param {string} orgId The Organization ID + * @param {string} defId The Resource Definition ID. + * @param {string} defVersionId The Resource Definition Version ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getResourceDefinitionVersion(orgId: string, defId: string, defVersionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getResourceDefinitionVersion(orgId, defId, defVersionId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -29489,6 +30138,19 @@ export const PublicApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.listAuditLogEntries(orgId, perPage, page, from, to, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary List all Automation Rules in an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listAutomationRules(orgId: string, appId: string, envId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAutomationRules(orgId, appId, envId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary List errors that occurred in a Deployment. @@ -29797,7 +30459,33 @@ export const PublicApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. + * + * @summary List resource classes. + * @param {string} orgId The organization ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listResourceClasses(orgId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listResourceClasses(orgId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Get Resource Definition Versions of a specific Resource Definition. First 50 Versions are kept along with all the Versions referenced by an Active Resource. To obtain Versions of a deleted Resource Definition, the `deleted` parameter needs to be used. + * @param {string} orgId The Organization ID + * @param {string} defId The Resource Definition ID. + * @param {boolean} [deleted] If to show also deleted records in the response. + * @param {number} [perPage] The maximum number of items to return in a page of results + * @param {string} [page] The page token to request from + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listResourceDefinitionVersions(orgId: string, defId: string, deleted?: boolean, perPage?: number, page?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listResourceDefinitionVersions(orgId, defId, deleted, perPage, page, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. Resources marked as deleted are not listed in the response, unless specified via `deleted` query parameter. * @summary List Resource Definitions. * @param {string} orgId The Organization ID. * @param {string} [app] (Optional) Filter Resource Definitions that may match a specific Application. @@ -29806,11 +30494,12 @@ export const PublicApiFp = function(configuration?: Configuration) { * @param {string} [res] (Optional) Filter Resource Definitions that may match a specific Resource. * @param {string} [resType] (Optional) Filter Resource Definitions that may match a specific Resource Type. * @param {string} [_class] (Optional) Filter Resource Definitions that may match a specific Class. + * @param {boolean} [deleted] If returns also resource definitions which has been deleted. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async listResourceDefinitions(orgId: string, app?: string, env?: string, envType?: string, res?: string, resType?: string, _class?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listResourceDefinitions(orgId, app, env, envType, res, resType, _class, options); + async listResourceDefinitions(orgId: string, app?: string, env?: string, envType?: string, res?: string, resType?: string, _class?: string, deleted?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listResourceDefinitions(orgId, app, env, envType, res, resType, _class, deleted, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -30031,76 +30720,6 @@ export const PublicApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.orgsOrgIdAppsAppIdDeltasPost(orgId, appId, deltaRequest, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, - /** - * - * @summary List all Automation Rules in an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(orgId: string, appId: string, envId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(orgId, appId, envId, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. - * @summary Create a new Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(orgId: string, appId: string, envId: string, automationRuleRequest: AutomationRuleRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(orgId, appId, envId, automationRuleRequest, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Delete Automation Rule from an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(orgId: string, appId: string, envId: string, ruleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(orgId, appId, envId, ruleId, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Get a specific Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(orgId: string, appId: string, envId: string, ruleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(orgId, appId, envId, ruleId, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. - * @summary Update an existing Automation Rule for an Environment. - * @param {string} orgId The Organization ID. - * @param {string} appId The Application ID. - * @param {string} envId The Environment ID. - * @param {string} ruleId The Automation Rule ID. - * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(orgId: string, appId: string, envId: string, ruleId: string, automationRuleRequest: AutomationRuleRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(orgId, appId, envId, ruleId, automationRuleRequest, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, /** * A new Value Set Version is created on every modification of a Value inside the an Environment of an App. In case this environment has no overrides the response is the same as the App level endpoint. * @summary List Value Set Versions in an Environment of an App @@ -30794,6 +31413,21 @@ export const PublicApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.restartPipelineRun(orgId, appId, pipelineId, runId, idempotencyKey, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. + * @summary Update an existing Automation Rule for an Environment. + * @param {string} orgId The Organization ID + * @param {string} appId The Application ID + * @param {string} envId The Environment ID + * @param {string} ruleId The Automation Rule ID. + * @param {AutomationRuleRequest} automationRuleRequest The definition of the Automation Rule. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateAutomationRule(orgId: string, appId: string, envId: string, ruleId: string, automationRuleRequest: AutomationRuleRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAutomationRule(orgId, appId, envId, ruleId, automationRuleRequest, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Updates the extended profile of the current user. @@ -30862,6 +31496,20 @@ export const PublicApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.updatePipeline(orgId, appId, pipelineId, body, ifMatch, dryRun, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Update a resource class description. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type ID. + * @param {string} classId The resource class ID. + * @param {UpdateResourceClassRequest} updateResourceClassRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateResourceClass(orgId: string, typeId: string, classId: string, updateResourceClassRequest: UpdateResourceClassRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateResourceClass(orgId, typeId, classId, updateResourceClassRequest, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Update a Resource Definition. @@ -31015,6 +31663,16 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat createArtefactVersion(requestParameters: PublicApiCreateArtefactVersionRequest, options?: AxiosRequestConfig): AxiosPromise { return localVarFp.createArtefactVersion(requestParameters.orgId, requestParameters.createArtefactVersion, requestParameters.vcs, requestParameters.dryRun, requestParameters.accept, options).then((request) => request(axios, basePath)); }, + /** + * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. + * @summary Create a new Automation Rule for an Environment. + * @param {PublicApiCreateAutomationRuleRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createAutomationRule(requestParameters: PublicApiCreateAutomationRuleRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.createAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.automationRuleRequest, options).then((request) => request(axios, basePath)); + }, /** * At Humanitec, Deployments are defined as changes to the state of the Environment. The state can be changed by defining a set of desired changes to the current state via a Deployment Delta or by resetting the current state after a previous Deployment. (See Environment Rebase.) Both types of changes can be combined into a single Deployment during which the Delta is applied to the Rebased state. When specifying a Delta, a Delta ID must be used. That Delta must have been committed to the Delta store prior to the Deployment. A Set ID can also be defined in the deployment to force the state of the environment to a particular state. This will be ignored if the Delta is specified. **NOTE:** Directly setting a `set_id` in a deployment is not recommended as it will not record history of where the set came from. If the intention is to replicate an existing environment, use the environment rebasing approach described above. * @summary Start a new Deployment. @@ -31135,6 +31793,16 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat createResourceAccount(requestParameters: PublicApiCreateResourceAccountRequest, options?: AxiosRequestConfig): AxiosPromise { return localVarFp.createResourceAccount(requestParameters.orgId, requestParameters.createResourceAccountRequestRequest, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Creates a new resources class. + * @param {PublicApiCreateResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createResourceClass(requestParameters: PublicApiCreateResourceClassRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.createResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.resourceClassRequest, options).then((request) => request(axios, basePath)); + }, /** * * @summary Create a new Resource Definition. @@ -31265,6 +31933,16 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat deleteArtefact(requestParameters: PublicApiDeleteArtefactRequest, options?: AxiosRequestConfig): AxiosPromise { return localVarFp.deleteArtefact(requestParameters.orgId, requestParameters.artefactId, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Delete Automation Rule from an Environment. + * @param {PublicApiDeleteAutomationRuleRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteAutomationRule(requestParameters: PublicApiDeleteAutomationRuleRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.deleteAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(axios, basePath)); + }, /** * Deletes a specific Environment in an Application. Deleting an Environment will also delete the Deployment history of the Environment. _Deletions are currently irreversible._ * @summary Delete a specific Environment. @@ -31346,7 +32024,17 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat return localVarFp.deleteResourceAccount(requestParameters.orgId, requestParameters.accId, options).then((request) => request(axios, basePath)); }, /** - * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is **marked as** pending deletion and will be deleted (purged) as soon as no existing Active Resources reference it. With the next deployment matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). The Resource Definition that has been marked for deletion cannot be used to provision new resources. + * + * @summary Delete a resource class. + * @param {PublicApiDeleteResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteResourceClass(requestParameters: PublicApiDeleteResourceClassRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.deleteResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, options).then((request) => request(axios, basePath)); + }, + /** + * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is deleted immediately even if there are Active Resources linked to it. The Resource Definition that has been marked for deletion cannot be used to provision new resources. With the next deployment, matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). * @summary Delete a Resource Definition. * @param {PublicApiDeleteResourceDefinitionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -31455,6 +32143,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)); }, + /** + * + * @summary Get a specific Automation Rule for an Environment. + * @param {PublicApiGetAutomationRuleRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAutomationRule(requestParameters: PublicApiGetAutomationRuleRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.getAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, 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 @@ -31637,13 +32335,33 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat }, /** * - * @summary Get a specific Resource Definition. + * @summary Get resource class by ID. + * @param {PublicApiGetResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getResourceClass(requestParameters: PublicApiGetResourceClassRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.getResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Get a specific Resource Definition. If the resource is marked as deleted it is not shown in the response, unless specified via `deleted` query parameter. * @param {PublicApiGetResourceDefinitionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResourceDefinition(requestParameters: PublicApiGetResourceDefinitionRequest, options?: AxiosRequestConfig): AxiosPromise { - return localVarFp.getResourceDefinition(requestParameters.orgId, requestParameters.defId, options).then((request) => request(axios, basePath)); + return localVarFp.getResourceDefinition(requestParameters.orgId, requestParameters.defId, requestParameters.deleted, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Get a Specific Resource Definition Version. + * @param {PublicApiGetResourceDefinitionVersionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getResourceDefinitionVersion(requestParameters: PublicApiGetResourceDefinitionVersionRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.getResourceDefinitionVersion(requestParameters.orgId, requestParameters.defId, requestParameters.defVersionId, options).then((request) => request(axios, basePath)); }, /** * # Only drivers that belongs to the given organization or registered as `public` are accessible through this endpoint @@ -31825,6 +32543,16 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat listAuditLogEntries(requestParameters: PublicApiListAuditLogEntriesRequest, options?: AxiosRequestConfig): AxiosPromise> { return localVarFp.listAuditLogEntries(requestParameters.orgId, requestParameters.perPage, requestParameters.page, requestParameters.from, requestParameters.to, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary List all Automation Rules in an Environment. + * @param {PublicApiListAutomationRulesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listAutomationRules(requestParameters: PublicApiListAutomationRulesRequest, options?: AxiosRequestConfig): AxiosPromise> { + return localVarFp.listAutomationRules(requestParameters.orgId, requestParameters.appId, requestParameters.envId, options).then((request) => request(axios, basePath)); + }, /** * * @summary List errors that occurred in a Deployment. @@ -32045,14 +32773,34 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat return localVarFp.listResourceAccounts(requestParameters.orgId, options).then((request) => request(axios, basePath)); }, /** - * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. + * + * @summary List resource classes. + * @param {PublicApiListResourceClassesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listResourceClasses(requestParameters: PublicApiListResourceClassesRequest, options?: AxiosRequestConfig): AxiosPromise> { + return localVarFp.listResourceClasses(requestParameters.orgId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Get Resource Definition Versions of a specific Resource Definition. First 50 Versions are kept along with all the Versions referenced by an Active Resource. To obtain Versions of a deleted Resource Definition, the `deleted` parameter needs to be used. + * @param {PublicApiListResourceDefinitionVersionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listResourceDefinitionVersions(requestParameters: PublicApiListResourceDefinitionVersionsRequest, options?: AxiosRequestConfig): AxiosPromise> { + return localVarFp.listResourceDefinitionVersions(requestParameters.orgId, requestParameters.defId, requestParameters.deleted, requestParameters.perPage, requestParameters.page, options).then((request) => request(axios, basePath)); + }, + /** + * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. Resources marked as deleted are not listed in the response, unless specified via `deleted` query parameter. * @summary List Resource Definitions. * @param {PublicApiListResourceDefinitionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listResourceDefinitions(requestParameters: PublicApiListResourceDefinitionsRequest, options?: AxiosRequestConfig): AxiosPromise> { - return localVarFp.listResourceDefinitions(requestParameters.orgId, requestParameters.app, requestParameters.env, requestParameters.envType, requestParameters.res, requestParameters.resType, requestParameters._class, options).then((request) => request(axios, basePath)); + return localVarFp.listResourceDefinitions(requestParameters.orgId, requestParameters.app, requestParameters.env, requestParameters.envType, requestParameters.res, requestParameters.resType, requestParameters._class, requestParameters.deleted, options).then((request) => request(axios, basePath)); }, /** * @@ -32224,56 +32972,6 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat orgsOrgIdAppsAppIdDeltasPost(requestParameters: PublicApiOrgsOrgIdAppsAppIdDeltasPostRequest, options?: AxiosRequestConfig): AxiosPromise { return localVarFp.orgsOrgIdAppsAppIdDeltasPost(requestParameters.orgId, requestParameters.appId, requestParameters.deltaRequest, options).then((request) => request(axios, basePath)); }, - /** - * - * @summary List all Automation Rules in an Environment. - * @param {PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(requestParameters: PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest, options?: AxiosRequestConfig): AxiosPromise> { - return localVarFp.orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(requestParameters.orgId, requestParameters.appId, requestParameters.envId, options).then((request) => request(axios, basePath)); - }, - /** - * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. - * @summary Create a new Automation Rule for an Environment. - * @param {PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(requestParameters: PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest, options?: AxiosRequestConfig): AxiosPromise { - return localVarFp.orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.automationRuleRequest, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Delete Automation Rule from an Environment. - * @param {PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(requestParameters: PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest, options?: AxiosRequestConfig): AxiosPromise { - return localVarFp.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get a specific Automation Rule for an Environment. - * @param {PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(requestParameters: PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest, options?: AxiosRequestConfig): AxiosPromise { - return localVarFp.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(axios, basePath)); - }, - /** - * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. - * @summary Update an existing Automation Rule for an Environment. - * @param {PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(requestParameters: PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest, options?: AxiosRequestConfig): AxiosPromise { - return localVarFp.orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, requestParameters.automationRuleRequest, options).then((request) => request(axios, basePath)); - }, /** * A new Value Set Version is created on every modification of a Value inside the an Environment of an App. In case this environment has no overrides the response is the same as the App level endpoint. * @summary List Value Set Versions in an Environment of an App @@ -32794,6 +33492,16 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat restartPipelineRun(requestParameters: PublicApiRestartPipelineRunRequest, options?: AxiosRequestConfig): AxiosPromise { return localVarFp.restartPipelineRun(requestParameters.orgId, requestParameters.appId, requestParameters.pipelineId, requestParameters.runId, requestParameters.idempotencyKey, options).then((request) => request(axios, basePath)); }, + /** + * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. + * @summary Update an existing Automation Rule for an Environment. + * @param {PublicApiUpdateAutomationRuleRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateAutomationRule(requestParameters: PublicApiUpdateAutomationRuleRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.updateAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, requestParameters.automationRuleRequest, options).then((request) => request(axios, basePath)); + }, /** * * @summary Updates the extended profile of the current user. @@ -32844,6 +33552,16 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat updatePipeline(requestParameters: PublicApiUpdatePipelineRequest, options?: AxiosRequestConfig): AxiosPromise { return localVarFp.updatePipeline(requestParameters.orgId, requestParameters.appId, requestParameters.pipelineId, requestParameters.body, requestParameters.ifMatch, requestParameters.dryRun, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Update a resource class description. + * @param {PublicApiUpdateResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateResourceClass(requestParameters: PublicApiUpdateResourceClassRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.updateResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, requestParameters.updateResourceClassRequest, options).then((request) => request(axios, basePath)); + }, /** * * @summary Update a Resource Definition. @@ -33092,6 +33810,41 @@ export interface PublicApiCreateArtefactVersionRequest { readonly accept?: string } +/** + * Request parameters for createAutomationRule operation in PublicApi. + * @export + * @interface PublicApiCreateAutomationRuleRequest + */ +export interface PublicApiCreateAutomationRuleRequest { + /** + * The Organization ID + * @type {string} + * @memberof PublicApiCreateAutomationRule + */ + readonly orgId: string + + /** + * The Application ID + * @type {string} + * @memberof PublicApiCreateAutomationRule + */ + readonly appId: string + + /** + * The Environment ID + * @type {string} + * @memberof PublicApiCreateAutomationRule + */ + readonly envId: string + + /** + * The definition of the Automation Rule. + * @type {AutomationRuleRequest} + * @memberof PublicApiCreateAutomationRule + */ + readonly automationRuleRequest: AutomationRuleRequest +} + /** * Request parameters for createDeployment operation in PublicApi. * @export @@ -33456,6 +34209,34 @@ export interface PublicApiCreateResourceAccountRequest { readonly createResourceAccountRequestRequest: CreateResourceAccountRequestRequest } +/** + * Request parameters for createResourceClass operation in PublicApi. + * @export + * @interface PublicApiCreateResourceClassRequest + */ +export interface PublicApiCreateResourceClassRequest { + /** + * The organization ID. + * @type {string} + * @memberof PublicApiCreateResourceClass + */ + readonly orgId: string + + /** + * The resource type. + * @type {string} + * @memberof PublicApiCreateResourceClass + */ + readonly typeId: string + + /** + * + * @type {ResourceClassRequest} + * @memberof PublicApiCreateResourceClass + */ + readonly resourceClassRequest: ResourceClassRequest +} + /** * Request parameters for createResourceDefinition operation in PublicApi. * @export @@ -33778,6 +34559,41 @@ export interface PublicApiDeleteArtefactRequest { readonly artefactId: string } +/** + * Request parameters for deleteAutomationRule operation in PublicApi. + * @export + * @interface PublicApiDeleteAutomationRuleRequest + */ +export interface PublicApiDeleteAutomationRuleRequest { + /** + * The Organization ID + * @type {string} + * @memberof PublicApiDeleteAutomationRule + */ + readonly orgId: string + + /** + * The Application ID + * @type {string} + * @memberof PublicApiDeleteAutomationRule + */ + readonly appId: string + + /** + * The Environment ID + * @type {string} + * @memberof PublicApiDeleteAutomationRule + */ + readonly envId: string + + /** + * The Automation Rule ID. + * @type {string} + * @memberof PublicApiDeleteAutomationRule + */ + readonly ruleId: string +} + /** * Request parameters for deleteEnvironment operation in PublicApi. * @export @@ -34009,6 +34825,34 @@ export interface PublicApiDeleteResourceAccountRequest { readonly accId: string } +/** + * Request parameters for deleteResourceClass operation in PublicApi. + * @export + * @interface PublicApiDeleteResourceClassRequest + */ +export interface PublicApiDeleteResourceClassRequest { + /** + * The organization ID. + * @type {string} + * @memberof PublicApiDeleteResourceClass + */ + readonly orgId: string + + /** + * The resource type. + * @type {string} + * @memberof PublicApiDeleteResourceClass + */ + readonly typeId: string + + /** + * The resource class id. + * @type {string} + * @memberof PublicApiDeleteResourceClass + */ + readonly classId: string +} + /** * Request parameters for deleteResourceDefinition operation in PublicApi. * @export @@ -34303,6 +35147,41 @@ export interface PublicApiGetArtefactVersionRequest { readonly artefactVersionId: string } +/** + * Request parameters for getAutomationRule operation in PublicApi. + * @export + * @interface PublicApiGetAutomationRuleRequest + */ +export interface PublicApiGetAutomationRuleRequest { + /** + * The Organization ID + * @type {string} + * @memberof PublicApiGetAutomationRule + */ + readonly orgId: string + + /** + * The Application ID + * @type {string} + * @memberof PublicApiGetAutomationRule + */ + readonly appId: string + + /** + * The Environment ID + * @type {string} + * @memberof PublicApiGetAutomationRule + */ + readonly envId: string + + /** + * The Automation Rule ID. + * @type {string} + * @memberof PublicApiGetAutomationRule + */ + readonly ruleId: string +} + /** * Request parameters for getBatch operation in PublicApi. * @export @@ -34800,6 +35679,34 @@ export interface PublicApiGetResourceAccountRequest { readonly accId: string } +/** + * Request parameters for getResourceClass operation in PublicApi. + * @export + * @interface PublicApiGetResourceClassRequest + */ +export interface PublicApiGetResourceClassRequest { + /** + * The organization ID. + * @type {string} + * @memberof PublicApiGetResourceClass + */ + readonly orgId: string + + /** + * The resource type. + * @type {string} + * @memberof PublicApiGetResourceClass + */ + readonly typeId: string + + /** + * The resource class ID. + * @type {string} + * @memberof PublicApiGetResourceClass + */ + readonly classId: string +} + /** * Request parameters for getResourceDefinition operation in PublicApi. * @export @@ -34819,6 +35726,41 @@ export interface PublicApiGetResourceDefinitionRequest { * @memberof PublicApiGetResourceDefinition */ readonly defId: string + + /** + * If returns the resource definition even if it has been deleted. + * @type {boolean} + * @memberof PublicApiGetResourceDefinition + */ + readonly deleted?: boolean +} + +/** + * Request parameters for getResourceDefinitionVersion operation in PublicApi. + * @export + * @interface PublicApiGetResourceDefinitionVersionRequest + */ +export interface PublicApiGetResourceDefinitionVersionRequest { + /** + * The Organization ID + * @type {string} + * @memberof PublicApiGetResourceDefinitionVersion + */ + readonly orgId: string + + /** + * The Resource Definition ID. + * @type {string} + * @memberof PublicApiGetResourceDefinitionVersion + */ + readonly defId: string + + /** + * The Resource Definition Version ID. + * @type {string} + * @memberof PublicApiGetResourceDefinitionVersion + */ + readonly defVersionId: string } /** @@ -35304,6 +36246,34 @@ export interface PublicApiListAuditLogEntriesRequest { readonly to?: string } +/** + * Request parameters for listAutomationRules operation in PublicApi. + * @export + * @interface PublicApiListAutomationRulesRequest + */ +export interface PublicApiListAutomationRulesRequest { + /** + * The Organization ID + * @type {string} + * @memberof PublicApiListAutomationRules + */ + readonly orgId: string + + /** + * The Application ID + * @type {string} + * @memberof PublicApiListAutomationRules + */ + readonly appId: string + + /** + * The Environment ID + * @type {string} + * @memberof PublicApiListAutomationRules + */ + readonly envId: string +} + /** * Request parameters for listDeploymentErrors operation in PublicApi. * @export @@ -36060,6 +37030,62 @@ export interface PublicApiListResourceAccountsRequest { readonly orgId: string } +/** + * Request parameters for listResourceClasses operation in PublicApi. + * @export + * @interface PublicApiListResourceClassesRequest + */ +export interface PublicApiListResourceClassesRequest { + /** + * The organization ID. + * @type {string} + * @memberof PublicApiListResourceClasses + */ + readonly orgId: string +} + +/** + * Request parameters for listResourceDefinitionVersions operation in PublicApi. + * @export + * @interface PublicApiListResourceDefinitionVersionsRequest + */ +export interface PublicApiListResourceDefinitionVersionsRequest { + /** + * The Organization ID + * @type {string} + * @memberof PublicApiListResourceDefinitionVersions + */ + readonly orgId: string + + /** + * The Resource Definition ID. + * @type {string} + * @memberof PublicApiListResourceDefinitionVersions + */ + readonly defId: string + + /** + * If to show also deleted records in the response. + * @type {boolean} + * @memberof PublicApiListResourceDefinitionVersions + */ + readonly deleted?: boolean + + /** + * The maximum number of items to return in a page of results + * @type {number} + * @memberof PublicApiListResourceDefinitionVersions + */ + readonly perPage?: number + + /** + * The page token to request from + * @type {string} + * @memberof PublicApiListResourceDefinitionVersions + */ + readonly page?: string +} + /** * Request parameters for listResourceDefinitions operation in PublicApi. * @export @@ -36114,6 +37140,13 @@ export interface PublicApiListResourceDefinitionsRequest { * @memberof PublicApiListResourceDefinitions */ readonly _class?: string + + /** + * If returns also resource definitions which has been deleted. + * @type {boolean} + * @memberof PublicApiListResourceDefinitions + */ + readonly deleted?: boolean } /** @@ -36571,181 +37604,6 @@ export interface PublicApiOrgsOrgIdAppsAppIdDeltasPostRequest { readonly deltaRequest: DeltaRequest } -/** - * Request parameters for orgsOrgIdAppsAppIdEnvsEnvIdRulesGet operation in PublicApi. - * @export - * @interface PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest - */ -export interface PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest { - /** - * The Organization ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGet - */ - readonly orgId: string - - /** - * The Application ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGet - */ - readonly appId: string - - /** - * The Environment ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGet - */ - readonly envId: string -} - -/** - * Request parameters for orgsOrgIdAppsAppIdEnvsEnvIdRulesPost operation in PublicApi. - * @export - * @interface PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest - */ -export interface PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest { - /** - * The Organization ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPost - */ - readonly orgId: string - - /** - * The Application ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPost - */ - readonly appId: string - - /** - * The Environment ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPost - */ - readonly envId: string - - /** - * The definition of the Automation Rule. - * @type {AutomationRuleRequest} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPost - */ - readonly automationRuleRequest: AutomationRuleRequest -} - -/** - * Request parameters for orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete operation in PublicApi. - * @export - * @interface PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest - */ -export interface PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest { - /** - * The Organization ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete - */ - readonly orgId: string - - /** - * The Application ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete - */ - readonly appId: string - - /** - * The Environment ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete - */ - readonly envId: string - - /** - * The Automation Rule ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete - */ - readonly ruleId: string -} - -/** - * Request parameters for orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet operation in PublicApi. - * @export - * @interface PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest - */ -export interface PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest { - /** - * The Organization ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet - */ - readonly orgId: string - - /** - * The Application ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet - */ - readonly appId: string - - /** - * The Environment ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet - */ - readonly envId: string - - /** - * The Automation Rule ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet - */ - readonly ruleId: string -} - -/** - * Request parameters for orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut operation in PublicApi. - * @export - * @interface PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest - */ -export interface PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest { - /** - * The Organization ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut - */ - readonly orgId: string - - /** - * The Application ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut - */ - readonly appId: string - - /** - * The Environment ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut - */ - readonly envId: string - - /** - * The Automation Rule ID. - * @type {string} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut - */ - readonly ruleId: string - - /** - * The definition of the Automation Rule. - * @type {AutomationRuleRequest} - * @memberof PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut - */ - readonly automationRuleRequest: AutomationRuleRequest -} - /** * Request parameters for orgsOrgIdAppsAppIdEnvsEnvIdValueSetVersionsGet operation in PublicApi. * @export @@ -38321,6 +39179,48 @@ export interface PublicApiRestartPipelineRunRequest { readonly idempotencyKey?: string } +/** + * Request parameters for updateAutomationRule operation in PublicApi. + * @export + * @interface PublicApiUpdateAutomationRuleRequest + */ +export interface PublicApiUpdateAutomationRuleRequest { + /** + * The Organization ID + * @type {string} + * @memberof PublicApiUpdateAutomationRule + */ + readonly orgId: string + + /** + * The Application ID + * @type {string} + * @memberof PublicApiUpdateAutomationRule + */ + readonly appId: string + + /** + * The Environment ID + * @type {string} + * @memberof PublicApiUpdateAutomationRule + */ + readonly envId: string + + /** + * The Automation Rule ID. + * @type {string} + * @memberof PublicApiUpdateAutomationRule + */ + readonly ruleId: string + + /** + * The definition of the Automation Rule. + * @type {AutomationRuleRequest} + * @memberof PublicApiUpdateAutomationRule + */ + readonly automationRuleRequest: AutomationRuleRequest +} + /** * Request parameters for updateCurrentUser operation in PublicApi. * @export @@ -38482,6 +39382,41 @@ export interface PublicApiUpdatePipelineRequest { readonly dryRun?: boolean } +/** + * Request parameters for updateResourceClass operation in PublicApi. + * @export + * @interface PublicApiUpdateResourceClassRequest + */ +export interface PublicApiUpdateResourceClassRequest { + /** + * The organization ID. + * @type {string} + * @memberof PublicApiUpdateResourceClass + */ + readonly orgId: string + + /** + * The resource type ID. + * @type {string} + * @memberof PublicApiUpdateResourceClass + */ + readonly typeId: string + + /** + * The resource class ID. + * @type {string} + * @memberof PublicApiUpdateResourceClass + */ + readonly classId: string + + /** + * + * @type {UpdateResourceClassRequest} + * @memberof PublicApiUpdateResourceClass + */ + readonly updateResourceClassRequest: UpdateResourceClassRequest +} + /** * Request parameters for updateResourceDefinition operation in PublicApi. * @export @@ -38759,6 +39694,18 @@ export class PublicApi extends BaseAPI { return PublicApiFp(this.configuration).createArtefactVersion(requestParameters.orgId, requestParameters.createArtefactVersion, requestParameters.vcs, requestParameters.dryRun, requestParameters.accept, options).then((request) => request(this.axios, this.basePath)); } + /** + * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. + * @summary Create a new Automation Rule for an Environment. + * @param {PublicApiCreateAutomationRuleRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public createAutomationRule(requestParameters: PublicApiCreateAutomationRuleRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).createAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.automationRuleRequest, options).then((request) => request(this.axios, this.basePath)); + } + /** * At Humanitec, Deployments are defined as changes to the state of the Environment. The state can be changed by defining a set of desired changes to the current state via a Deployment Delta or by resetting the current state after a previous Deployment. (See Environment Rebase.) Both types of changes can be combined into a single Deployment during which the Delta is applied to the Rebased state. When specifying a Delta, a Delta ID must be used. That Delta must have been committed to the Delta store prior to the Deployment. A Set ID can also be defined in the deployment to force the state of the environment to a particular state. This will be ignored if the Delta is specified. **NOTE:** Directly setting a `set_id` in a deployment is not recommended as it will not record history of where the set came from. If the intention is to replicate an existing environment, use the environment rebasing approach described above. * @summary Start a new Deployment. @@ -38903,6 +39850,18 @@ export class PublicApi extends BaseAPI { return PublicApiFp(this.configuration).createResourceAccount(requestParameters.orgId, requestParameters.createResourceAccountRequestRequest, options).then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Creates a new resources class. + * @param {PublicApiCreateResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public createResourceClass(requestParameters: PublicApiCreateResourceClassRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).createResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.resourceClassRequest, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Create a new Resource Definition. @@ -39059,6 +40018,18 @@ export class PublicApi extends BaseAPI { return PublicApiFp(this.configuration).deleteArtefact(requestParameters.orgId, requestParameters.artefactId, options).then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Delete Automation Rule from an Environment. + * @param {PublicApiDeleteAutomationRuleRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public deleteAutomationRule(requestParameters: PublicApiDeleteAutomationRuleRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).deleteAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(this.axios, this.basePath)); + } + /** * Deletes a specific Environment in an Application. Deleting an Environment will also delete the Deployment history of the Environment. _Deletions are currently irreversible._ * @summary Delete a specific Environment. @@ -39156,7 +40127,19 @@ export class PublicApi extends BaseAPI { } /** - * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is **marked as** pending deletion and will be deleted (purged) as soon as no existing Active Resources reference it. With the next deployment matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). The Resource Definition that has been marked for deletion cannot be used to provision new resources. + * + * @summary Delete a resource class. + * @param {PublicApiDeleteResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public deleteResourceClass(requestParameters: PublicApiDeleteResourceClassRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).deleteResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is deleted immediately even if there are Active Resources linked to it. The Resource Definition that has been marked for deletion cannot be used to provision new resources. With the next deployment, matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). * @summary Delete a Resource Definition. * @param {PublicApiDeleteResourceDefinitionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -39287,6 +40270,18 @@ export class PublicApi extends BaseAPI { return PublicApiFp(this.configuration).getArtefactVersion(requestParameters.orgId, requestParameters.artefactVersionId, options).then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Get a specific Automation Rule for an Environment. + * @param {PublicApiGetAutomationRuleRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public getAutomationRule(requestParameters: PublicApiGetAutomationRuleRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).getAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, 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 @@ -39505,14 +40500,38 @@ export class PublicApi extends BaseAPI { /** * - * @summary Get a specific Resource Definition. + * @summary Get resource class by ID. + * @param {PublicApiGetResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public getResourceClass(requestParameters: PublicApiGetResourceClassRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).getResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Get a specific Resource Definition. If the resource is marked as deleted it is not shown in the response, unless specified via `deleted` query parameter. * @param {PublicApiGetResourceDefinitionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PublicApi */ public getResourceDefinition(requestParameters: PublicApiGetResourceDefinitionRequest, options?: AxiosRequestConfig) { - return PublicApiFp(this.configuration).getResourceDefinition(requestParameters.orgId, requestParameters.defId, options).then((request) => request(this.axios, this.basePath)); + return PublicApiFp(this.configuration).getResourceDefinition(requestParameters.orgId, requestParameters.defId, requestParameters.deleted, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Get a Specific Resource Definition Version. + * @param {PublicApiGetResourceDefinitionVersionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public getResourceDefinitionVersion(requestParameters: PublicApiGetResourceDefinitionVersionRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).getResourceDefinitionVersion(requestParameters.orgId, requestParameters.defId, requestParameters.defVersionId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -39731,6 +40750,18 @@ export class PublicApi extends BaseAPI { return PublicApiFp(this.configuration).listAuditLogEntries(requestParameters.orgId, requestParameters.perPage, requestParameters.page, requestParameters.from, requestParameters.to, options).then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary List all Automation Rules in an Environment. + * @param {PublicApiListAutomationRulesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public listAutomationRules(requestParameters: PublicApiListAutomationRulesRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).listAutomationRules(requestParameters.orgId, requestParameters.appId, requestParameters.envId, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary List errors that occurred in a Deployment. @@ -39995,7 +41026,31 @@ export class PublicApi extends BaseAPI { } /** - * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. + * + * @summary List resource classes. + * @param {PublicApiListResourceClassesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public listResourceClasses(requestParameters: PublicApiListResourceClassesRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).listResourceClasses(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Get Resource Definition Versions of a specific Resource Definition. First 50 Versions are kept along with all the Versions referenced by an Active Resource. To obtain Versions of a deleted Resource Definition, the `deleted` parameter needs to be used. + * @param {PublicApiListResourceDefinitionVersionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public listResourceDefinitionVersions(requestParameters: PublicApiListResourceDefinitionVersionsRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).listResourceDefinitionVersions(requestParameters.orgId, requestParameters.defId, requestParameters.deleted, requestParameters.perPage, requestParameters.page, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. Resources marked as deleted are not listed in the response, unless specified via `deleted` query parameter. * @summary List Resource Definitions. * @param {PublicApiListResourceDefinitionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -40003,7 +41058,7 @@ export class PublicApi extends BaseAPI { * @memberof PublicApi */ public listResourceDefinitions(requestParameters: PublicApiListResourceDefinitionsRequest, options?: AxiosRequestConfig) { - return PublicApiFp(this.configuration).listResourceDefinitions(requestParameters.orgId, requestParameters.app, requestParameters.env, requestParameters.envType, requestParameters.res, requestParameters.resType, requestParameters._class, options).then((request) => request(this.axios, this.basePath)); + return PublicApiFp(this.configuration).listResourceDefinitions(requestParameters.orgId, requestParameters.app, requestParameters.env, requestParameters.envType, requestParameters.res, requestParameters.resType, requestParameters._class, requestParameters.deleted, options).then((request) => request(this.axios, this.basePath)); } /** @@ -40210,66 +41265,6 @@ export class PublicApi extends BaseAPI { return PublicApiFp(this.configuration).orgsOrgIdAppsAppIdDeltasPost(requestParameters.orgId, requestParameters.appId, requestParameters.deltaRequest, options).then((request) => request(this.axios, this.basePath)); } - /** - * - * @summary List all Automation Rules in an Environment. - * @param {PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PublicApi - */ - public orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(requestParameters: PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesGetRequest, options?: AxiosRequestConfig) { - return PublicApiFp(this.configuration).orgsOrgIdAppsAppIdEnvsEnvIdRulesGet(requestParameters.orgId, requestParameters.appId, requestParameters.envId, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. - * @summary Create a new Automation Rule for an Environment. - * @param {PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PublicApi - */ - public orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(requestParameters: PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesPostRequest, options?: AxiosRequestConfig) { - return PublicApiFp(this.configuration).orgsOrgIdAppsAppIdEnvsEnvIdRulesPost(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.automationRuleRequest, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Delete Automation Rule from an Environment. - * @param {PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PublicApi - */ - public orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(requestParameters: PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDeleteRequest, options?: AxiosRequestConfig) { - return PublicApiFp(this.configuration).orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Get a specific Automation Rule for an Environment. - * @param {PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PublicApi - */ - public orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(requestParameters: PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGetRequest, options?: AxiosRequestConfig) { - return PublicApiFp(this.configuration).orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. - * @summary Update an existing Automation Rule for an Environment. - * @param {PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PublicApi - */ - public orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(requestParameters: PublicApiOrgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPutRequest, options?: AxiosRequestConfig) { - return PublicApiFp(this.configuration).orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, requestParameters.automationRuleRequest, options).then((request) => request(this.axios, this.basePath)); - } - /** * A new Value Set Version is created on every modification of a Value inside the an Environment of an App. In case this environment has no overrides the response is the same as the App level endpoint. * @summary List Value Set Versions in an Environment of an App @@ -40894,6 +41889,18 @@ export class PublicApi extends BaseAPI { return PublicApiFp(this.configuration).restartPipelineRun(requestParameters.orgId, requestParameters.appId, requestParameters.pipelineId, requestParameters.runId, requestParameters.idempotencyKey, options).then((request) => request(this.axios, this.basePath)); } + /** + * Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`. + * @summary Update an existing Automation Rule for an Environment. + * @param {PublicApiUpdateAutomationRuleRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public updateAutomationRule(requestParameters: PublicApiUpdateAutomationRuleRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).updateAutomationRule(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.ruleId, requestParameters.automationRuleRequest, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Updates the extended profile of the current user. @@ -40954,6 +41961,18 @@ export class PublicApi extends BaseAPI { return PublicApiFp(this.configuration).updatePipeline(requestParameters.orgId, requestParameters.appId, requestParameters.pipelineId, requestParameters.body, requestParameters.ifMatch, requestParameters.dryRun, options).then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Update a resource class description. + * @param {PublicApiUpdateResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PublicApi + */ + public updateResourceClass(requestParameters: PublicApiUpdateResourceClassRequest, options?: AxiosRequestConfig) { + return PublicApiFp(this.configuration).updateResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, requestParameters.updateResourceClassRequest, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Update a Resource Definition. @@ -42717,6 +43736,561 @@ export class ResourceAccountApi extends BaseAPI { } +/** + * ResourceClassApi - axios parameter creator + * @export + */ +export const ResourceClassApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Creates a new resources class. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {ResourceClassRequest} resourceClassRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createResourceClass: async (orgId: string, typeId: string, resourceClassRequest: ResourceClassRequest, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('createResourceClass', 'orgId', orgId) + // verify required parameter 'typeId' is not null or undefined + assertParamExists('createResourceClass', 'typeId', typeId) + // verify required parameter 'resourceClassRequest' is not null or undefined + assertParamExists('createResourceClass', 'resourceClassRequest', resourceClassRequest) + const localVarPath = `/orgs/{orgId}/resources/types/{typeId}/classes` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"typeId"}}`, encodeURIComponent(String(typeId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(resourceClassRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Delete a resource class. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {string} classId The resource class id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteResourceClass: async (orgId: string, typeId: string, classId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('deleteResourceClass', 'orgId', orgId) + // verify required parameter 'typeId' is not null or undefined + assertParamExists('deleteResourceClass', 'typeId', typeId) + // verify required parameter 'classId' is not null or undefined + assertParamExists('deleteResourceClass', 'classId', classId) + const localVarPath = `/orgs/{orgId}/resources/types/{typeId}/classes/{classId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"typeId"}}`, encodeURIComponent(String(typeId))) + .replace(`{${"classId"}}`, encodeURIComponent(String(classId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Get resource class by ID. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {string} classId The resource class ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getResourceClass: async (orgId: string, typeId: string, classId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('getResourceClass', 'orgId', orgId) + // verify required parameter 'typeId' is not null or undefined + assertParamExists('getResourceClass', 'typeId', typeId) + // verify required parameter 'classId' is not null or undefined + assertParamExists('getResourceClass', 'classId', classId) + const localVarPath = `/orgs/{orgId}/resources/types/{typeId}/classes/{classId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"typeId"}}`, encodeURIComponent(String(typeId))) + .replace(`{${"classId"}}`, encodeURIComponent(String(classId))); + // 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}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary List resource classes. + * @param {string} orgId The organization ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listResourceClasses: async (orgId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('listResourceClasses', 'orgId', orgId) + const localVarPath = `/orgs/{orgId}/resources/classes` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))); + // 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}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Update a resource class description. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type ID. + * @param {string} classId The resource class ID. + * @param {UpdateResourceClassRequest} updateResourceClassRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateResourceClass: async (orgId: string, typeId: string, classId: string, updateResourceClassRequest: UpdateResourceClassRequest, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('updateResourceClass', 'orgId', orgId) + // verify required parameter 'typeId' is not null or undefined + assertParamExists('updateResourceClass', 'typeId', typeId) + // verify required parameter 'classId' is not null or undefined + assertParamExists('updateResourceClass', 'classId', classId) + // verify required parameter 'updateResourceClassRequest' is not null or undefined + assertParamExists('updateResourceClass', 'updateResourceClassRequest', updateResourceClassRequest) + const localVarPath = `/orgs/{orgId}/resources/types/{typeId}/classes/{classId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"typeId"}}`, encodeURIComponent(String(typeId))) + .replace(`{${"classId"}}`, encodeURIComponent(String(classId))); + // 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(updateResourceClassRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * ResourceClassApi - functional programming interface + * @export + */ +export const ResourceClassApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ResourceClassApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Creates a new resources class. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {ResourceClassRequest} resourceClassRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createResourceClass(orgId: string, typeId: string, resourceClassRequest: ResourceClassRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createResourceClass(orgId, typeId, resourceClassRequest, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Delete a resource class. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {string} classId The resource class id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteResourceClass(orgId: string, typeId: string, classId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteResourceClass(orgId, typeId, classId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Get resource class by ID. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type. + * @param {string} classId The resource class ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getResourceClass(orgId: string, typeId: string, classId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getResourceClass(orgId, typeId, classId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary List resource classes. + * @param {string} orgId The organization ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listResourceClasses(orgId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listResourceClasses(orgId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Update a resource class description. + * @param {string} orgId The organization ID. + * @param {string} typeId The resource type ID. + * @param {string} classId The resource class ID. + * @param {UpdateResourceClassRequest} updateResourceClassRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateResourceClass(orgId: string, typeId: string, classId: string, updateResourceClassRequest: UpdateResourceClassRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateResourceClass(orgId, typeId, classId, updateResourceClassRequest, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * ResourceClassApi - factory interface + * @export + */ +export const ResourceClassApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ResourceClassApiFp(configuration) + return { + /** + * + * @summary Creates a new resources class. + * @param {ResourceClassApiCreateResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createResourceClass(requestParameters: ResourceClassApiCreateResourceClassRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.createResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.resourceClassRequest, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Delete a resource class. + * @param {ResourceClassApiDeleteResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteResourceClass(requestParameters: ResourceClassApiDeleteResourceClassRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.deleteResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Get resource class by ID. + * @param {ResourceClassApiGetResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getResourceClass(requestParameters: ResourceClassApiGetResourceClassRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.getResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary List resource classes. + * @param {ResourceClassApiListResourceClassesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listResourceClasses(requestParameters: ResourceClassApiListResourceClassesRequest, options?: AxiosRequestConfig): AxiosPromise> { + return localVarFp.listResourceClasses(requestParameters.orgId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Update a resource class description. + * @param {ResourceClassApiUpdateResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateResourceClass(requestParameters: ResourceClassApiUpdateResourceClassRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.updateResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, requestParameters.updateResourceClassRequest, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createResourceClass operation in ResourceClassApi. + * @export + * @interface ResourceClassApiCreateResourceClassRequest + */ +export interface ResourceClassApiCreateResourceClassRequest { + /** + * The organization ID. + * @type {string} + * @memberof ResourceClassApiCreateResourceClass + */ + readonly orgId: string + + /** + * The resource type. + * @type {string} + * @memberof ResourceClassApiCreateResourceClass + */ + readonly typeId: string + + /** + * + * @type {ResourceClassRequest} + * @memberof ResourceClassApiCreateResourceClass + */ + readonly resourceClassRequest: ResourceClassRequest +} + +/** + * Request parameters for deleteResourceClass operation in ResourceClassApi. + * @export + * @interface ResourceClassApiDeleteResourceClassRequest + */ +export interface ResourceClassApiDeleteResourceClassRequest { + /** + * The organization ID. + * @type {string} + * @memberof ResourceClassApiDeleteResourceClass + */ + readonly orgId: string + + /** + * The resource type. + * @type {string} + * @memberof ResourceClassApiDeleteResourceClass + */ + readonly typeId: string + + /** + * The resource class id. + * @type {string} + * @memberof ResourceClassApiDeleteResourceClass + */ + readonly classId: string +} + +/** + * Request parameters for getResourceClass operation in ResourceClassApi. + * @export + * @interface ResourceClassApiGetResourceClassRequest + */ +export interface ResourceClassApiGetResourceClassRequest { + /** + * The organization ID. + * @type {string} + * @memberof ResourceClassApiGetResourceClass + */ + readonly orgId: string + + /** + * The resource type. + * @type {string} + * @memberof ResourceClassApiGetResourceClass + */ + readonly typeId: string + + /** + * The resource class ID. + * @type {string} + * @memberof ResourceClassApiGetResourceClass + */ + readonly classId: string +} + +/** + * Request parameters for listResourceClasses operation in ResourceClassApi. + * @export + * @interface ResourceClassApiListResourceClassesRequest + */ +export interface ResourceClassApiListResourceClassesRequest { + /** + * The organization ID. + * @type {string} + * @memberof ResourceClassApiListResourceClasses + */ + readonly orgId: string +} + +/** + * Request parameters for updateResourceClass operation in ResourceClassApi. + * @export + * @interface ResourceClassApiUpdateResourceClassRequest + */ +export interface ResourceClassApiUpdateResourceClassRequest { + /** + * The organization ID. + * @type {string} + * @memberof ResourceClassApiUpdateResourceClass + */ + readonly orgId: string + + /** + * The resource type ID. + * @type {string} + * @memberof ResourceClassApiUpdateResourceClass + */ + readonly typeId: string + + /** + * The resource class ID. + * @type {string} + * @memberof ResourceClassApiUpdateResourceClass + */ + readonly classId: string + + /** + * + * @type {UpdateResourceClassRequest} + * @memberof ResourceClassApiUpdateResourceClass + */ + readonly updateResourceClassRequest: UpdateResourceClassRequest +} + +/** + * ResourceClassApi - object-oriented interface + * @export + * @class ResourceClassApi + * @extends {BaseAPI} + */ +export class ResourceClassApi extends BaseAPI { + /** + * + * @summary Creates a new resources class. + * @param {ResourceClassApiCreateResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ResourceClassApi + */ + public createResourceClass(requestParameters: ResourceClassApiCreateResourceClassRequest, options?: AxiosRequestConfig) { + return ResourceClassApiFp(this.configuration).createResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.resourceClassRequest, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Delete a resource class. + * @param {ResourceClassApiDeleteResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ResourceClassApi + */ + public deleteResourceClass(requestParameters: ResourceClassApiDeleteResourceClassRequest, options?: AxiosRequestConfig) { + return ResourceClassApiFp(this.configuration).deleteResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Get resource class by ID. + * @param {ResourceClassApiGetResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ResourceClassApi + */ + public getResourceClass(requestParameters: ResourceClassApiGetResourceClassRequest, options?: AxiosRequestConfig) { + return ResourceClassApiFp(this.configuration).getResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary List resource classes. + * @param {ResourceClassApiListResourceClassesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ResourceClassApi + */ + public listResourceClasses(requestParameters: ResourceClassApiListResourceClassesRequest, options?: AxiosRequestConfig) { + return ResourceClassApiFp(this.configuration).listResourceClasses(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Update a resource class description. + * @param {ResourceClassApiUpdateResourceClassRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ResourceClassApi + */ + public updateResourceClass(requestParameters: ResourceClassApiUpdateResourceClassRequest, options?: AxiosRequestConfig) { + return ResourceClassApiFp(this.configuration).updateResourceClass(requestParameters.orgId, requestParameters.typeId, requestParameters.classId, requestParameters.updateResourceClassRequest, options).then((request) => request(this.axios, this.basePath)); + } +} + + /** * ResourceDefinitionApi - axios parameter creator * @export @@ -42808,7 +44382,7 @@ export const ResourceDefinitionApiAxiosParamCreator = function (configuration?: }; }, /** - * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is **marked as** pending deletion and will be deleted (purged) as soon as no existing Active Resources reference it. With the next deployment matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). The Resource Definition that has been marked for deletion cannot be used to provision new resources. + * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is deleted immediately even if there are Active Resources linked to it. The Resource Definition that has been marked for deletion cannot be used to provision new resources. With the next deployment, matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). * @summary Delete a Resource Definition. * @param {string} orgId The Organization ID. * @param {string} defId The Resource Definition ID. @@ -42899,13 +44473,14 @@ export const ResourceDefinitionApiAxiosParamCreator = function (configuration?: }, /** * - * @summary Get a specific Resource Definition. + * @summary Get a specific Resource Definition. If the resource is marked as deleted it is not shown in the response, unless specified via `deleted` query parameter. * @param {string} orgId The Organization ID. * @param {string} defId The Resource Definition ID. + * @param {boolean} [deleted] If returns the resource definition even if it has been deleted. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getResourceDefinition: async (orgId: string, defId: string, options: AxiosRequestConfig = {}): Promise => { + getResourceDefinition: async (orgId: string, defId: string, deleted?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined assertParamExists('getResourceDefinition', 'orgId', orgId) // verify required parameter 'defId' is not null or undefined @@ -42924,6 +44499,10 @@ export const ResourceDefinitionApiAxiosParamCreator = function (configuration?: const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (deleted !== undefined) { + localVarQueryParameter['deleted'] = deleted; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -42974,7 +44553,7 @@ export const ResourceDefinitionApiAxiosParamCreator = function (configuration?: }; }, /** - * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. + * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. Resources marked as deleted are not listed in the response, unless specified via `deleted` query parameter. * @summary List Resource Definitions. * @param {string} orgId The Organization ID. * @param {string} [app] (Optional) Filter Resource Definitions that may match a specific Application. @@ -42983,10 +44562,11 @@ export const ResourceDefinitionApiAxiosParamCreator = function (configuration?: * @param {string} [res] (Optional) Filter Resource Definitions that may match a specific Resource. * @param {string} [resType] (Optional) Filter Resource Definitions that may match a specific Resource Type. * @param {string} [_class] (Optional) Filter Resource Definitions that may match a specific Class. + * @param {boolean} [deleted] If returns also resource definitions which has been deleted. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listResourceDefinitions: async (orgId: string, app?: string, env?: string, envType?: string, res?: string, resType?: string, _class?: string, options: AxiosRequestConfig = {}): Promise => { + listResourceDefinitions: async (orgId: string, app?: string, env?: string, envType?: string, res?: string, resType?: string, _class?: string, deleted?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'orgId' is not null or undefined assertParamExists('listResourceDefinitions', 'orgId', orgId) const localVarPath = `/orgs/{orgId}/resources/defs` @@ -43026,6 +44606,10 @@ export const ResourceDefinitionApiAxiosParamCreator = function (configuration?: localVarQueryParameter['class'] = _class; } + if (deleted !== undefined) { + localVarQueryParameter['deleted'] = deleted; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -43205,7 +44789,7 @@ export const ResourceDefinitionApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is **marked as** pending deletion and will be deleted (purged) as soon as no existing Active Resources reference it. With the next deployment matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). The Resource Definition that has been marked for deletion cannot be used to provision new resources. + * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is deleted immediately even if there are Active Resources linked to it. The Resource Definition that has been marked for deletion cannot be used to provision new resources. With the next deployment, matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). * @summary Delete a Resource Definition. * @param {string} orgId The Organization ID. * @param {string} defId The Resource Definition ID. @@ -43233,14 +44817,15 @@ export const ResourceDefinitionApiFp = function(configuration?: Configuration) { }, /** * - * @summary Get a specific Resource Definition. + * @summary Get a specific Resource Definition. If the resource is marked as deleted it is not shown in the response, unless specified via `deleted` query parameter. * @param {string} orgId The Organization ID. * @param {string} defId The Resource Definition ID. + * @param {boolean} [deleted] If returns the resource definition even if it has been deleted. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getResourceDefinition(orgId: string, defId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getResourceDefinition(orgId, defId, options); + async getResourceDefinition(orgId: string, defId: string, deleted?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getResourceDefinition(orgId, defId, deleted, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -43256,7 +44841,7 @@ export const ResourceDefinitionApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. + * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. Resources marked as deleted are not listed in the response, unless specified via `deleted` query parameter. * @summary List Resource Definitions. * @param {string} orgId The Organization ID. * @param {string} [app] (Optional) Filter Resource Definitions that may match a specific Application. @@ -43265,11 +44850,12 @@ export const ResourceDefinitionApiFp = function(configuration?: Configuration) { * @param {string} [res] (Optional) Filter Resource Definitions that may match a specific Resource. * @param {string} [resType] (Optional) Filter Resource Definitions that may match a specific Resource Type. * @param {string} [_class] (Optional) Filter Resource Definitions that may match a specific Class. + * @param {boolean} [deleted] If returns also resource definitions which has been deleted. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async listResourceDefinitions(orgId: string, app?: string, env?: string, envType?: string, res?: string, resType?: string, _class?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listResourceDefinitions(orgId, app, env, envType, res, resType, _class, options); + async listResourceDefinitions(orgId: string, app?: string, env?: string, envType?: string, res?: string, resType?: string, _class?: string, deleted?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listResourceDefinitions(orgId, app, env, envType, res, resType, _class, deleted, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -43342,7 +44928,7 @@ export const ResourceDefinitionApiFactory = function (configuration?: Configurat return localVarFp.createResourceDefinitionCriteria(requestParameters.orgId, requestParameters.defId, requestParameters.matchingCriteriaRuleRequest, options).then((request) => request(axios, basePath)); }, /** - * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is **marked as** pending deletion and will be deleted (purged) as soon as no existing Active Resources reference it. With the next deployment matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). The Resource Definition that has been marked for deletion cannot be used to provision new resources. + * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is deleted immediately even if there are Active Resources linked to it. The Resource Definition that has been marked for deletion cannot be used to provision new resources. With the next deployment, matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). * @summary Delete a Resource Definition. * @param {ResourceDefinitionApiDeleteResourceDefinitionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -43363,13 +44949,13 @@ export const ResourceDefinitionApiFactory = function (configuration?: Configurat }, /** * - * @summary Get a specific Resource Definition. + * @summary Get a specific Resource Definition. If the resource is marked as deleted it is not shown in the response, unless specified via `deleted` query parameter. * @param {ResourceDefinitionApiGetResourceDefinitionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResourceDefinition(requestParameters: ResourceDefinitionApiGetResourceDefinitionRequest, options?: AxiosRequestConfig): AxiosPromise { - return localVarFp.getResourceDefinition(requestParameters.orgId, requestParameters.defId, options).then((request) => request(axios, basePath)); + return localVarFp.getResourceDefinition(requestParameters.orgId, requestParameters.defId, requestParameters.deleted, options).then((request) => request(axios, basePath)); }, /** * @@ -43382,14 +44968,14 @@ export const ResourceDefinitionApiFactory = function (configuration?: Configurat return localVarFp.listActiveResourceByDefinition(requestParameters.orgId, requestParameters.defId, options).then((request) => request(axios, basePath)); }, /** - * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. + * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. Resources marked as deleted are not listed in the response, unless specified via `deleted` query parameter. * @summary List Resource Definitions. * @param {ResourceDefinitionApiListResourceDefinitionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listResourceDefinitions(requestParameters: ResourceDefinitionApiListResourceDefinitionsRequest, options?: AxiosRequestConfig): AxiosPromise> { - return localVarFp.listResourceDefinitions(requestParameters.orgId, requestParameters.app, requestParameters.env, requestParameters.envType, requestParameters.res, requestParameters.resType, requestParameters._class, options).then((request) => request(axios, basePath)); + return localVarFp.listResourceDefinitions(requestParameters.orgId, requestParameters.app, requestParameters.env, requestParameters.envType, requestParameters.res, requestParameters.resType, requestParameters._class, requestParameters.deleted, options).then((request) => request(axios, basePath)); }, /** * @@ -43555,6 +45141,13 @@ export interface ResourceDefinitionApiGetResourceDefinitionRequest { * @memberof ResourceDefinitionApiGetResourceDefinition */ readonly defId: string + + /** + * If returns the resource definition even if it has been deleted. + * @type {boolean} + * @memberof ResourceDefinitionApiGetResourceDefinition + */ + readonly deleted?: boolean } /** @@ -43632,6 +45225,13 @@ export interface ResourceDefinitionApiListResourceDefinitionsRequest { * @memberof ResourceDefinitionApiListResourceDefinitions */ readonly _class?: string + + /** + * If returns also resource definitions which has been deleted. + * @type {boolean} + * @memberof ResourceDefinitionApiListResourceDefinitions + */ + readonly deleted?: boolean } /** @@ -43750,7 +45350,7 @@ export class ResourceDefinitionApi extends BaseAPI { } /** - * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is **marked as** pending deletion and will be deleted (purged) as soon as no existing Active Resources reference it. With the next deployment matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). The Resource Definition that has been marked for deletion cannot be used to provision new resources. + * If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately. If there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced. The request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is deleted immediately even if there are Active Resources linked to it. The Resource Definition that has been marked for deletion cannot be used to provision new resources. With the next deployment, matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available). * @summary Delete a Resource Definition. * @param {ResourceDefinitionApiDeleteResourceDefinitionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -43775,14 +45375,14 @@ export class ResourceDefinitionApi extends BaseAPI { /** * - * @summary Get a specific Resource Definition. + * @summary Get a specific Resource Definition. If the resource is marked as deleted it is not shown in the response, unless specified via `deleted` query parameter. * @param {ResourceDefinitionApiGetResourceDefinitionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ResourceDefinitionApi */ public getResourceDefinition(requestParameters: ResourceDefinitionApiGetResourceDefinitionRequest, options?: AxiosRequestConfig) { - return ResourceDefinitionApiFp(this.configuration).getResourceDefinition(requestParameters.orgId, requestParameters.defId, options).then((request) => request(this.axios, this.basePath)); + return ResourceDefinitionApiFp(this.configuration).getResourceDefinition(requestParameters.orgId, requestParameters.defId, requestParameters.deleted, options).then((request) => request(this.axios, this.basePath)); } /** @@ -43798,7 +45398,7 @@ export class ResourceDefinitionApi extends BaseAPI { } /** - * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. + * Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. Resources marked as deleted are not listed in the response, unless specified via `deleted` query parameter. * @summary List Resource Definitions. * @param {ResourceDefinitionApiListResourceDefinitionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. @@ -43806,7 +45406,7 @@ export class ResourceDefinitionApi extends BaseAPI { * @memberof ResourceDefinitionApi */ public listResourceDefinitions(requestParameters: ResourceDefinitionApiListResourceDefinitionsRequest, options?: AxiosRequestConfig) { - return ResourceDefinitionApiFp(this.configuration).listResourceDefinitions(requestParameters.orgId, requestParameters.app, requestParameters.env, requestParameters.envType, requestParameters.res, requestParameters.resType, requestParameters._class, options).then((request) => request(this.axios, this.basePath)); + return ResourceDefinitionApiFp(this.configuration).listResourceDefinitions(requestParameters.orgId, requestParameters.app, requestParameters.env, requestParameters.envType, requestParameters.res, requestParameters.resType, requestParameters._class, requestParameters.deleted, options).then((request) => request(this.axios, this.basePath)); } /** @@ -43847,6 +45447,281 @@ export class ResourceDefinitionApi extends BaseAPI { } +/** + * ResourceDefinitionVersionApi - axios parameter creator + * @export + */ +export const ResourceDefinitionVersionApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Get a Specific Resource Definition Version. + * @param {string} orgId The Organization ID + * @param {string} defId The Resource Definition ID. + * @param {string} defVersionId The Resource Definition Version ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getResourceDefinitionVersion: async (orgId: string, defId: string, defVersionId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('getResourceDefinitionVersion', 'orgId', orgId) + // verify required parameter 'defId' is not null or undefined + assertParamExists('getResourceDefinitionVersion', 'defId', defId) + // verify required parameter 'defVersionId' is not null or undefined + assertParamExists('getResourceDefinitionVersion', 'defVersionId', defVersionId) + const localVarPath = `/orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"defId"}}`, encodeURIComponent(String(defId))) + .replace(`{${"defVersionId"}}`, encodeURIComponent(String(defVersionId))); + // 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}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Get Resource Definition Versions of a specific Resource Definition. First 50 Versions are kept along with all the Versions referenced by an Active Resource. To obtain Versions of a deleted Resource Definition, the `deleted` parameter needs to be used. + * @param {string} orgId The Organization ID + * @param {string} defId The Resource Definition ID. + * @param {boolean} [deleted] If to show also deleted records in the response. + * @param {number} [perPage] The maximum number of items to return in a page of results + * @param {string} [page] The page token to request from + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listResourceDefinitionVersions: async (orgId: string, defId: string, deleted?: boolean, perPage?: number, page?: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'orgId' is not null or undefined + assertParamExists('listResourceDefinitionVersions', 'orgId', orgId) + // verify required parameter 'defId' is not null or undefined + assertParamExists('listResourceDefinitionVersions', 'defId', defId) + const localVarPath = `/orgs/{orgId}/resources/defs/{defId}/versions` + .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId))) + .replace(`{${"defId"}}`, encodeURIComponent(String(defId))); + // 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; + + if (deleted !== undefined) { + localVarQueryParameter['deleted'] = deleted; + } + + if (perPage !== undefined) { + localVarQueryParameter['per_page'] = perPage; + } + + if (page !== undefined) { + localVarQueryParameter['page'] = page; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * ResourceDefinitionVersionApi - functional programming interface + * @export + */ +export const ResourceDefinitionVersionApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ResourceDefinitionVersionApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Get a Specific Resource Definition Version. + * @param {string} orgId The Organization ID + * @param {string} defId The Resource Definition ID. + * @param {string} defVersionId The Resource Definition Version ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getResourceDefinitionVersion(orgId: string, defId: string, defVersionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getResourceDefinitionVersion(orgId, defId, defVersionId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Get Resource Definition Versions of a specific Resource Definition. First 50 Versions are kept along with all the Versions referenced by an Active Resource. To obtain Versions of a deleted Resource Definition, the `deleted` parameter needs to be used. + * @param {string} orgId The Organization ID + * @param {string} defId The Resource Definition ID. + * @param {boolean} [deleted] If to show also deleted records in the response. + * @param {number} [perPage] The maximum number of items to return in a page of results + * @param {string} [page] The page token to request from + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listResourceDefinitionVersions(orgId: string, defId: string, deleted?: boolean, perPage?: number, page?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listResourceDefinitionVersions(orgId, defId, deleted, perPage, page, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * ResourceDefinitionVersionApi - factory interface + * @export + */ +export const ResourceDefinitionVersionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ResourceDefinitionVersionApiFp(configuration) + return { + /** + * + * @summary Get a Specific Resource Definition Version. + * @param {ResourceDefinitionVersionApiGetResourceDefinitionVersionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getResourceDefinitionVersion(requestParameters: ResourceDefinitionVersionApiGetResourceDefinitionVersionRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.getResourceDefinitionVersion(requestParameters.orgId, requestParameters.defId, requestParameters.defVersionId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Get Resource Definition Versions of a specific Resource Definition. First 50 Versions are kept along with all the Versions referenced by an Active Resource. To obtain Versions of a deleted Resource Definition, the `deleted` parameter needs to be used. + * @param {ResourceDefinitionVersionApiListResourceDefinitionVersionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listResourceDefinitionVersions(requestParameters: ResourceDefinitionVersionApiListResourceDefinitionVersionsRequest, options?: AxiosRequestConfig): AxiosPromise> { + return localVarFp.listResourceDefinitionVersions(requestParameters.orgId, requestParameters.defId, requestParameters.deleted, requestParameters.perPage, requestParameters.page, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getResourceDefinitionVersion operation in ResourceDefinitionVersionApi. + * @export + * @interface ResourceDefinitionVersionApiGetResourceDefinitionVersionRequest + */ +export interface ResourceDefinitionVersionApiGetResourceDefinitionVersionRequest { + /** + * The Organization ID + * @type {string} + * @memberof ResourceDefinitionVersionApiGetResourceDefinitionVersion + */ + readonly orgId: string + + /** + * The Resource Definition ID. + * @type {string} + * @memberof ResourceDefinitionVersionApiGetResourceDefinitionVersion + */ + readonly defId: string + + /** + * The Resource Definition Version ID. + * @type {string} + * @memberof ResourceDefinitionVersionApiGetResourceDefinitionVersion + */ + readonly defVersionId: string +} + +/** + * Request parameters for listResourceDefinitionVersions operation in ResourceDefinitionVersionApi. + * @export + * @interface ResourceDefinitionVersionApiListResourceDefinitionVersionsRequest + */ +export interface ResourceDefinitionVersionApiListResourceDefinitionVersionsRequest { + /** + * The Organization ID + * @type {string} + * @memberof ResourceDefinitionVersionApiListResourceDefinitionVersions + */ + readonly orgId: string + + /** + * The Resource Definition ID. + * @type {string} + * @memberof ResourceDefinitionVersionApiListResourceDefinitionVersions + */ + readonly defId: string + + /** + * If to show also deleted records in the response. + * @type {boolean} + * @memberof ResourceDefinitionVersionApiListResourceDefinitionVersions + */ + readonly deleted?: boolean + + /** + * The maximum number of items to return in a page of results + * @type {number} + * @memberof ResourceDefinitionVersionApiListResourceDefinitionVersions + */ + readonly perPage?: number + + /** + * The page token to request from + * @type {string} + * @memberof ResourceDefinitionVersionApiListResourceDefinitionVersions + */ + readonly page?: string +} + +/** + * ResourceDefinitionVersionApi - object-oriented interface + * @export + * @class ResourceDefinitionVersionApi + * @extends {BaseAPI} + */ +export class ResourceDefinitionVersionApi extends BaseAPI { + /** + * + * @summary Get a Specific Resource Definition Version. + * @param {ResourceDefinitionVersionApiGetResourceDefinitionVersionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ResourceDefinitionVersionApi + */ + public getResourceDefinitionVersion(requestParameters: ResourceDefinitionVersionApiGetResourceDefinitionVersionRequest, options?: AxiosRequestConfig) { + return ResourceDefinitionVersionApiFp(this.configuration).getResourceDefinitionVersion(requestParameters.orgId, requestParameters.defId, requestParameters.defVersionId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Get Resource Definition Versions of a specific Resource Definition. First 50 Versions are kept along with all the Versions referenced by an Active Resource. To obtain Versions of a deleted Resource Definition, the `deleted` parameter needs to be used. + * @param {ResourceDefinitionVersionApiListResourceDefinitionVersionsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ResourceDefinitionVersionApi + */ + public listResourceDefinitionVersions(requestParameters: ResourceDefinitionVersionApiListResourceDefinitionVersionsRequest, options?: AxiosRequestConfig) { + return ResourceDefinitionVersionApiFp(this.configuration).listResourceDefinitionVersions(requestParameters.orgId, requestParameters.defId, requestParameters.deleted, requestParameters.perPage, requestParameters.page, options).then((request) => request(this.axios, this.basePath)); + } +} + + /** * ResourceProvisionApi - axios parameter creator * @export diff --git a/src/generated/base.ts b/src/generated/base.ts index 48319c6c..3d69e1ed 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.14 + * The version of the OpenAPI document: 0.25.17 * 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 80a19be0..0f69786c 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.14 + * The version of the OpenAPI document: 0.25.17 * 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 729f0a80..6ad26e6a 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.14 + * The version of the OpenAPI document: 0.25.17 * 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 ec397626..f90be76d 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.14 + * The version of the OpenAPI document: 0.25.17 * Contact: apiteam@humanitec.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).