@devopness/sdk-js 2.142.0 → 2.142.2

package/dist/api/generated/apis/environments-credentials-api.d.ts

@@ -39,8 +39,8 @@ export declare class EnvironmentsCredentialsApiService extends ApiBaseService {
      * @param {number} environmentId The ID of the environment.
      * @param {number} [page] Number of the page to be retrieved
      * @param {number} [perPage] Number of items returned per page
-     * @param {string} [provider] Filter by credential provider.
-     * @param {string} [type] Filter by credential type.
+     * @param {string} [providerCode] Filter credentials by provider code.
+     * @param {string} [providerType] Filter credentials by provider type.
      */
-    listEnvironmentCredentials(environmentId: number, page?: number, perPage?: number, provider?: string, type?: string): Promise<ApiResponse<Array<CredentialRelation>>>;
+    listEnvironmentCredentials(environmentId: number, page?: number, perPage?: number, providerCode?: string, providerType?: string): Promise<ApiResponse<Array<CredentialRelation>>>;
 }

package/dist/api/generated/apis/environments-credentials-api.js

@@ -75,16 +75,16 @@ class EnvironmentsCredentialsApiService extends ApiBaseService_1.ApiBaseService
      * @param {number} environmentId The ID of the environment.
      * @param {number} [page] Number of the page to be retrieved
      * @param {number} [perPage] Number of items returned per page
-     * @param {string} [provider] Filter by credential provider.
-     * @param {string} [type] Filter by credential type.
+     * @param {string} [providerCode] Filter credentials by provider code.
+     * @param {string} [providerType] Filter credentials by provider type.
      */
-    listEnvironmentCredentials(environmentId, page, perPage, provider, type) {
+    listEnvironmentCredentials(environmentId, page, perPage, providerCode, providerType) {
         return __awaiter(this, void 0, void 0, function* () {
             if (environmentId === null || environmentId === undefined) {
                 throw new Exceptions_1.ArgumentNullException('environmentId', 'listEnvironmentCredentials');
             }
             let queryString = '';
-            const queryParams = { page: page, per_page: perPage, provider: provider, type: type, };
+            const queryParams = { page: page, per_page: perPage, provider_code: providerCode, provider_type: providerType, };
             for (const key in queryParams) {
                 if (queryParams[key] === undefined || queryParams[key] === null) {
                     continue;

package/dist/api/generated/apis/networks-api.d.ts

@@ -29,6 +29,12 @@ export declare class NetworksApiService extends ApiBaseService {
      * @param {number} networkId The ID of the network.
      */
     getNetwork(networkId: number): Promise<ApiResponse<Network>>;
+    /**
+     *
+     * @summary Get current status of a network
+     * @param {number} networkId The ID of the network.
+     */
+    getStatusNetwork(networkId: number): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Update an existing Network

package/dist/api/generated/apis/networks-api.js

@@ -61,6 +61,22 @@ class NetworksApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Get current status of a network
+     * @param {number} networkId The ID of the network.
+     */
+    getStatusNetwork(networkId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (networkId === null || networkId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('networkId', 'getStatusNetwork');
+            }
+            let queryString = '';
+            const requestUrl = '/networks/{network_id}/get-status' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"network_id"}}`, encodeURIComponent(String(networkId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Update an existing Network

package/dist/api/generated/models/archived-environment-relation.d.ts

@@ -23,12 +23,6 @@ export interface ArchivedEnvironmentRelation {
      * @memberof ArchivedEnvironmentRelation
      */
     id: number;
-    /**
-     * Environment\'s name
-     * @type {string}
-     * @memberof ArchivedEnvironmentRelation
-     */
-    name: string;
     /**
      *
      * @type {EnvironmentType}
@@ -41,6 +35,18 @@ export interface ArchivedEnvironmentRelation {
      * @memberof ArchivedEnvironmentRelation
      */
     type_human_readable: string;
+    /**
+     * Environment\'s name
+     * @type {string}
+     * @memberof ArchivedEnvironmentRelation
+     */
+    name: string;
+    /**
+     * Environment\'s description
+     * @type {string}
+     * @memberof ArchivedEnvironmentRelation
+     */
+    description: string | null;
     /**
      * Number of credits used in the current monthly billing cycle by actions of resources in the environment.
      * @type {number}

package/dist/api/generated/models/credential-environment-create.d.ts

@@ -33,7 +33,7 @@ export interface CredentialEnvironmentCreate {
      * @type {string}
      * @memberof CredentialEnvironmentCreate
      */
-    type: string;
+    provider_type: string;
     /**
      * If this credential is active or not.
      * @type {boolean}

package/dist/api/generated/models/credential-input-settings.d.ts

@@ -9,41 +9,20 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { CredentialInputSettingsValidation } from './credential-input-settings-validation';
+import { CredentialAws } from './credential-aws';
+import { CredentialDigitalOcean } from './credential-digital-ocean';
+import { CredentialGoogleCloud } from './credential-google-cloud';
+import { CredentialSourceProvider } from './credential-source-provider';
 /**
- * A input setting for credential cloud provider
+ *
  * @export
  * @interface CredentialInputSettings
  */
 export interface CredentialInputSettings {
     /**
-     * The name of the input setting
-     * @type {string}
-     * @memberof CredentialInputSettings
-     */
-    name: string;
-    /**
-     * The human readable version of the input setting name
-     * @type {string}
-     * @memberof CredentialInputSettings
-     */
-    name_human_readable: string;
-    /**
-     *
-     * @type {CredentialInputSettingsValidation}
-     * @memberof CredentialInputSettings
-     */
-    validation: CredentialInputSettingsValidation;
-    /**
-     * The default value of the input setting
-     * @type {string}
-     * @memberof CredentialInputSettings
-     */
-    default_value: string | null;
-    /**
-     * Defines if the input setting data is a sensitive content
-     * @type {boolean}
+     * Cloud provider credential
+     * @type {CredentialAws | CredentialDigitalOcean | CredentialGoogleCloud | CredentialSourceProvider}
      * @memberof CredentialInputSettings
      */
-    sensitive: boolean;
+    credential: CredentialAws | CredentialDigitalOcean | CredentialGoogleCloud | CredentialSourceProvider;
 }

package/dist/api/generated/models/credential-options.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { CredentialProvider } from './credential-provider';
 import { CredentialProviderType } from './credential-provider-type';
 /**
  *
@@ -17,15 +18,15 @@ import { CredentialProviderType } from './credential-provider-type';
  */
 export interface CredentialOptions {
     /**
-     * The list of supported provider types
-     * @type {Array<object>}
+     * The list of credential provider types
+     * @type {Array<CredentialProviderType>}
      * @memberof CredentialOptions
      */
-    provider_types: Array<object>;
+    provider_types: Array<CredentialProviderType>;
     /**
-     * The list of supported providers
-     * @type {Array<CredentialProviderType>}
+     * The list of supported credential providers
+     * @type {Array<CredentialProvider>}
      * @memberof CredentialOptions
      */
-    supported_providers: Array<CredentialProviderType>;
+    supported_providers: Array<CredentialProvider>;
 }

package/dist/api/generated/models/credential-provider-type.d.ts

@@ -10,29 +10,11 @@
  * Do not edit the class manually.
  */
 /**
- * A cloud provider for credential cloud service
+ * The type of the provider on which a credential was issued and belongs to
  * @export
  * @interface CredentialProviderType
  */
 export interface CredentialProviderType {
-    /**
-     * The code of the cloud provider
-     * @type {string}
-     * @memberof CredentialProviderType
-     */
-    code: string;
-    /**
-     * The name of the cloud provider
-     * @type {string}
-     * @memberof CredentialProviderType
-     */
-    name: string;
-    /**
-     * Text describing the cloud provider
-     * @type {string}
-     * @memberof CredentialProviderType
-     */
-    hint: string;
     /**
      * Type of provider.
      * @type {string}

package/dist/api/generated/models/credential-provider.d.ts

@@ -0,0 +1,56 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The provider on which a credential was issued and belongs to
+ * @export
+ * @interface CredentialProvider
+ */
+export interface CredentialProvider {
+    /**
+     * The provider code
+     * @type {string}
+     * @memberof CredentialProvider
+     */
+    code: string;
+    /**
+     * The provider name
+     * @type {string}
+     * @memberof CredentialProvider
+     */
+    name: string;
+    /**
+     * Descriptive text to help users to know what data is stored in the field and optional extra information on how to enter data to the field
+     * @type {string}
+     * @memberof CredentialProvider
+     */
+    hint: string;
+    /**
+     * Type of provider.
+     * @type {string}
+     * @memberof CredentialProvider
+     */
+    type: CredentialProviderTypeEnum;
+    /**
+     * Human readable version of provider type
+     * @type {string}
+     * @memberof CredentialProvider
+     */
+    type_human_readable: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum CredentialProviderTypeEnum {
+    CloudProvider = "cloud_provider",
+    SourceProvider = "source_provider"
+}

package/dist/api/generated/models/credential-provider.js

@@ -0,0 +1,24 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CredentialProviderTypeEnum = void 0;
+/**
+    * @export
+    * @enum {string}
+    */
+var CredentialProviderTypeEnum;
+(function (CredentialProviderTypeEnum) {
+    CredentialProviderTypeEnum["CloudProvider"] = "cloud_provider";
+    CredentialProviderTypeEnum["SourceProvider"] = "source_provider";
+})(CredentialProviderTypeEnum || (exports.CredentialProviderTypeEnum = CredentialProviderTypeEnum = {}));

package/dist/api/generated/models/credential-relation.d.ts

@@ -41,13 +41,13 @@ export interface CredentialRelation {
      * @type {ProviderType}
      * @memberof CredentialRelation
      */
-    type: ProviderType;
+    provider_type: ProviderType;
     /**
      * The human readable version of the type of the credential
      * @type {string}
      * @memberof CredentialRelation
      */
-    type_human_readable: string;
+    provider_type_human_readable: string;
     /**
      * If this credential is active or not
      * @type {boolean}

package/dist/api/generated/models/credential.d.ts

@@ -40,13 +40,13 @@ export interface Credential {
      * @type {string}
      * @memberof Credential
      */
-    type: string;
+    provider_type: string;
     /**
      * The human readable version of the type of the credential
      * @type {string}
      * @memberof Credential
      */
-    type_human_readable: string;
+    provider_type_human_readable: string;
     /**
      * If this credential is active or not
      * @type {boolean}

package/dist/api/generated/models/environment-project-create.d.ts

@@ -28,4 +28,10 @@ export interface EnvironmentProjectCreate {
      * @memberof EnvironmentProjectCreate
      */
     name: string;
+    /**
+     * The environment\'s description. Must not be greater than 255 characters.
+     * @type {string}
+     * @memberof EnvironmentProjectCreate
+     */
+    description?: string;
 }

package/dist/api/generated/models/environment-relation.d.ts

@@ -23,12 +23,6 @@ export interface EnvironmentRelation {
      * @memberof EnvironmentRelation
      */
     id: number;
-    /**
-     * Environment\'s name
-     * @type {string}
-     * @memberof EnvironmentRelation
-     */
-    name: string;
     /**
      *
      * @type {EnvironmentType}
@@ -41,6 +35,18 @@ export interface EnvironmentRelation {
      * @memberof EnvironmentRelation
      */
     type_human_readable: string;
+    /**
+     * Environment\'s name
+     * @type {string}
+     * @memberof EnvironmentRelation
+     */
+    name: string;
+    /**
+     * Environment\'s description
+     * @type {string}
+     * @memberof EnvironmentRelation
+     */
+    description: string | null;
     /**
      * Number of credits used in the current monthly billing cycle by actions of resources in the environment.
      * @type {number}

package/dist/api/generated/models/environment-update.d.ts

@@ -34,4 +34,10 @@ export interface EnvironmentUpdate {
      * @memberof EnvironmentUpdate
      */
     name: string;
+    /**
+     * The environment\'s description. Must not be greater than 255 characters.
+     * @type {string}
+     * @memberof EnvironmentUpdate
+     */
+    description?: string;
 }

package/dist/api/generated/models/environment.d.ts

@@ -35,12 +35,6 @@ export interface Environment {
      * @memberof Environment
      */
     id: number;
-    /**
-     * Environment\'s name
-     * @type {string}
-     * @memberof Environment
-     */
-    name: string;
     /**
      *
      * @type {EnvironmentType}
@@ -53,6 +47,18 @@ export interface Environment {
      * @memberof Environment
      */
     type_human_readable: string;
+    /**
+     * Environment\'s name
+     * @type {string}
+     * @memberof Environment
+     */
+    name: string;
+    /**
+     * Environment\'s description
+     * @type {string}
+     * @memberof Environment
+     */
+    description: string | null;
     /**
      * Indicates whether the record was archived
      * @type {boolean}

package/dist/api/generated/models/index.d.ts

@@ -58,8 +58,8 @@ export * from './credential-digital-ocean';
 export * from './credential-environment-create';
 export * from './credential-google-cloud';
 export * from './credential-input-settings';
-export * from './credential-input-settings-validation';
 export * from './credential-options';
+export * from './credential-provider';
 export * from './credential-provider-type';
 export * from './credential-relation';
 export * from './credential-setting';
@@ -156,6 +156,8 @@ export * from './project-create';
 export * from './project-relation';
 export * from './project-update';
 export * from './provider-code';
+export * from './provider-input-settings';
+export * from './provider-input-settings-validation';
 export * from './provider-relation';
 export * from './provider-settings';
 export * from './provider-type';

package/dist/api/generated/models/index.js

@@ -74,8 +74,8 @@ __exportStar(require("./credential-digital-ocean"), exports);
 __exportStar(require("./credential-environment-create"), exports);
 __exportStar(require("./credential-google-cloud"), exports);
 __exportStar(require("./credential-input-settings"), exports);
-__exportStar(require("./credential-input-settings-validation"), exports);
 __exportStar(require("./credential-options"), exports);
+__exportStar(require("./credential-provider"), exports);
 __exportStar(require("./credential-provider-type"), exports);
 __exportStar(require("./credential-relation"), exports);
 __exportStar(require("./credential-setting"), exports);
@@ -172,6 +172,8 @@ __exportStar(require("./project-create"), exports);
 __exportStar(require("./project-relation"), exports);
 __exportStar(require("./project-update"), exports);
 __exportStar(require("./provider-code"), exports);
+__exportStar(require("./provider-input-settings"), exports);
+__exportStar(require("./provider-input-settings-validation"), exports);
 __exportStar(require("./provider-relation"), exports);
 __exportStar(require("./provider-settings"), exports);
 __exportStar(require("./provider-type"), exports);

package/dist/api/generated/models/{credential-input-settings-validation.d.ts → provider-input-settings-validation.d.ts}

@@ -10,39 +10,39 @@
  * Do not edit the class manually.
  */
 /**
- * The validation of the input setting
+ * The validation rules that apply for the input field
  * @export
- * @interface CredentialInputSettingsValidation
+ * @interface ProviderInputSettingsValidation
  */
-export interface CredentialInputSettingsValidation {
+export interface ProviderInputSettingsValidation {
     /**
      *
      * @type {boolean}
-     * @memberof CredentialInputSettingsValidation
+     * @memberof ProviderInputSettingsValidation
      */
     required?: boolean;
     /**
      *
      * @type {string}
-     * @memberof CredentialInputSettingsValidation
+     * @memberof ProviderInputSettingsValidation
      */
     type?: string;
     /**
      *
      * @type {number}
-     * @memberof CredentialInputSettingsValidation
+     * @memberof ProviderInputSettingsValidation
      */
     min?: number;
     /**
      *
      * @type {number}
-     * @memberof CredentialInputSettingsValidation
+     * @memberof ProviderInputSettingsValidation
      */
     max?: number;
     /**
      *
      * @type {Array<string>}
-     * @memberof CredentialInputSettingsValidation
+     * @memberof ProviderInputSettingsValidation
      */
     allowed_values?: Array<string>;
 }

package/dist/api/generated/models/provider-input-settings.d.ts

@@ -0,0 +1,49 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ProviderInputSettingsValidation } from './provider-input-settings-validation';
+/**
+ * Input settings for credentials of specific provider
+ * @export
+ * @interface ProviderInputSettings
+ */
+export interface ProviderInputSettings {
+    /**
+     * The name of a credential input field
+     * @type {string}
+     * @memberof ProviderInputSettings
+     */
+    name: string;
+    /**
+     * The human readable version of the input field name
+     * @type {string}
+     * @memberof ProviderInputSettings
+     */
+    name_human_readable: string;
+    /**
+     *
+     * @type {ProviderInputSettingsValidation}
+     * @memberof ProviderInputSettings
+     */
+    validation: ProviderInputSettingsValidation;
+    /**
+     * The default value of the input field
+     * @type {string}
+     * @memberof ProviderInputSettings
+     */
+    default_value: string | null;
+    /**
+     * Defines if the input field data is a sensitive content
+     * @type {boolean}
+     * @memberof ProviderInputSettings
+     */
+    sensitive: boolean;
+}

package/dist/api/generated/models/provider-input-settings.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/provider-settings.d.ts

@@ -10,25 +10,25 @@
  * Do not edit the class manually.
  */
 import { CloudProviderService } from './cloud-provider-service';
-import { CredentialInputSettings } from './credential-input-settings';
+import { ProviderInputSettings } from './provider-input-settings';
 /**
- * Settings of supported provider
+ * Settings related to a supported provider
  * @export
  * @interface ProviderSettings
  */
 export interface ProviderSettings {
     /**
-     * The URL to connect to the source provider
+     * The URL used to connect Devopness to a credential provider of type `source_provider`
      * @type {string}
      * @memberof ProviderSettings
      */
     connect_url?: string;
     /**
-     * The list of input settings for credential cloud provider
-     * @type {Array<CredentialInputSettings>}
+     * The list of input settings for credentials of specific provider
+     * @type {Array<ProviderInputSettings>}
      * @memberof ProviderSettings
      */
-    input_settings: Array<CredentialInputSettings>;
+    input_settings: Array<ProviderInputSettings>;
     /**
      *
      * @type {Array<CloudProviderService>}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devopness/sdk-js",
-  "version": "2.142.0",
+  "version": "2.142.2",
   "publishConfig": {
     "access": "public"
   },