@devopness/sdk-js 2.0.1 → 2.3.0

package/dist/api/generated/models/environment-option-type.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface EnvironmentOptionType
+ */
+export interface EnvironmentOptionType {
+    /**
+     * The internal name of the environment
+     * @type {string}
+     * @memberof EnvironmentOptionType
+     */
+    value: string;
+    /**
+     * The formatted name to be displayed in user interfaces
+     * @type {string}
+     * @memberof EnvironmentOptionType
+     */
+    human_readable: string;
+    /**
+     * Text describing the environment purpose
+     * @type {string}
+     * @memberof EnvironmentOptionType
+     */
+    hint: string;
+}

package/dist/api/generated/models/environment-option-type.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/environment-options.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { EnvironmentOptionType } from './environment-option-type';
+/**
+ *
+ * @export
+ * @interface EnvironmentOptions
+ */
+export interface EnvironmentOptions {
+    /**
+     *
+     * @type {Array<EnvironmentOptionType>}
+     * @memberof EnvironmentOptions
+     */
+    types: Array<EnvironmentOptionType>;
+}

package/dist/api/generated/models/environment-options.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/environment-relation.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 { EnvironmentType } from './environment-type';
+/**
+ *
+ * @export
+ * @interface EnvironmentRelation
+ */
+export interface EnvironmentRelation {
+    /**
+     * Unique id of the given record
+     * @type {number}
+     * @memberof EnvironmentRelation
+     */
+    id: number;
+    /**
+     * Environment\'s name
+     * @type {string}
+     * @memberof EnvironmentRelation
+     */
+    name: string;
+    /**
+     *
+     * @type {EnvironmentType}
+     * @memberof EnvironmentRelation
+     */
+    type: EnvironmentType;
+    /**
+     * The human readable version of the type
+     * @type {string}
+     * @memberof EnvironmentRelation
+     */
+    type_human_readable: string;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof EnvironmentRelation
+     */
+    created_at?: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof EnvironmentRelation
+     */
+    updated_at?: string;
+}

package/dist/api/generated/models/environment-relation.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/environment-update.d.ts

@@ -21,7 +21,7 @@ export interface EnvironmentUpdate {
      * @type {number}
      * @memberof EnvironmentUpdate
      */
-    id?: number;
+    id: number;
     /**
      * The environment\'s name
      * @type {string}

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

@@ -9,8 +9,16 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ApplicationRelation } from './application-relation';
+import { CronJobRelation } from './cron-job-relation';
+import { DaemonRelation } from './daemon-relation';
 import { EnvironmentType } from './environment-type';
-import { Server } from './server';
+import { NetworkRuleRelation } from './network-rule-relation';
+import { ServerRelation } from './server-relation';
+import { ServiceRelation } from './service-relation';
+import { SshKeyRelation } from './ssh-key-relation';
+import { TeamRelation } from './team-relation';
+import { UserRelation } from './user-relation';
 /**
  *
  * @export
@@ -35,12 +43,66 @@ export interface Environment {
      * @memberof Environment
      */
     type: EnvironmentType;
+    /**
+     * The human readable version of the type
+     * @type {string}
+     * @memberof Environment
+     */
+    type_human_readable: string;
+    /**
+     *
+     * @type {Array<ServerRelation>}
+     * @memberof Environment
+     */
+    servers: Array<ServerRelation>;
+    /**
+     *
+     * @type {Array<CronJobRelation>}
+     * @memberof Environment
+     */
+    cron_jobs: Array<CronJobRelation>;
+    /**
+     *
+     * @type {Array<DaemonRelation>}
+     * @memberof Environment
+     */
+    daemons: Array<DaemonRelation>;
+    /**
+     *
+     * @type {Array<NetworkRuleRelation>}
+     * @memberof Environment
+     */
+    network_rules: Array<NetworkRuleRelation>;
+    /**
+     *
+     * @type {Array<ApplicationRelation>}
+     * @memberof Environment
+     */
+    applications: Array<ApplicationRelation>;
+    /**
+     *
+     * @type {Array<ServiceRelation>}
+     * @memberof Environment
+     */
+    services: Array<ServiceRelation>;
+    /**
+     *
+     * @type {Array<SshKeyRelation>}
+     * @memberof Environment
+     */
+    ssh_keys: Array<SshKeyRelation>;
+    /**
+     *
+     * @type {Array<TeamRelation>}
+     * @memberof Environment
+     */
+    teams: Array<TeamRelation>;
     /**
      *
-     * @type {Array<Server>}
+     * @type {UserRelation}
      * @memberof Environment
      */
-    servers?: Array<Server>;
+    created_by_user: UserRelation;
     /**
      * The date and time when the record was created
      * @type {string}

package/dist/api/generated/models/hook-incoming-create.d.ts

@@ -0,0 +1,82 @@
+/**
+ * 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 { ActionType } from './action-type';
+import { HookIncomingSetting } from './hook-incoming-setting';
+import { HookIncomingTriggerWhenCondition } from './hook-incoming-trigger-when-condition';
+import { ResourceType } from './resource-type';
+/**
+ *
+ * @export
+ * @interface HookIncomingCreate
+ */
+export interface HookIncomingCreate {
+    /**
+     * The name entered by the user (or auto-generated by `Devopness`) to uniquely identify the hook
+     * @type {string}
+     * @memberof HookIncomingCreate
+     */
+    name: string;
+    /**
+     *
+     * @type {ResourceType}
+     * @memberof HookIncomingCreate
+     */
+    resource_type: ResourceType;
+    /**
+     * The id of the resource that the outgoing hook belongs to
+     * @type {number}
+     * @memberof HookIncomingCreate
+     */
+    resource_id: number;
+    /**
+     *
+     * @type {ActionType}
+     * @memberof HookIncomingCreate
+     */
+    action_type: ActionType;
+    /**
+     * Determines if the hook is current active
+     * @type {boolean}
+     * @memberof HookIncomingCreate
+     */
+    active?: boolean;
+    /**
+     * Tells if requests to this hook must only be accepted when a HTTP header is sent with a message authentication code ([HMAC](https://en.wikipedia.org/wiki/HMAC)) generated based on the secret provided by Devopness and shared by user with external sources
+     * @type {boolean}
+     * @memberof HookIncomingCreate
+     */
+    requires_secret: boolean;
+    /**
+     * The cryptographic hash function to be used by Devopness when validating digitally signed incoming requests for hooks that require secret validation
+     * @type {string}
+     * @memberof HookIncomingCreate
+     */
+    secret_algorithm?: string;
+    /**
+     * The name of the HTTP request header from which the request digital signature should be extracted
+     * @type {string}
+     * @memberof HookIncomingCreate
+     */
+    secret_header_name?: string;
+    /**
+     * Conditions that must be met to trigger the hook.
+     * @type {Array<HookIncomingTriggerWhenCondition>}
+     * @memberof HookIncomingCreate
+     */
+    trigger_when?: Array<HookIncomingTriggerWhenCondition>;
+    /**
+     *
+     * @type {HookIncomingSetting}
+     * @memberof HookIncomingCreate
+     */
+    settings?: HookIncomingSetting;
+}

package/dist/api/generated/models/hook-incoming-create.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/hook-incoming-params.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { HookIncomingSetting } from './hook-incoming-setting';
+import { HookIncomingTriggerWhenCondition } from './hook-incoming-trigger-when-condition';
+/**
+ *
+ * @export
+ * @interface HookIncomingParams
+ */
+export interface HookIncomingParams {
+    /**
+     * The URL where the incoming hook must be triggered with a POST request
+     * @type {string}
+     * @memberof HookIncomingParams
+     */
+    url: string | null;
+    /**
+     * Conditions that must be met to trigger the hook.
+     * @type {Array<HookIncomingTriggerWhenCondition>}
+     * @memberof HookIncomingParams
+     */
+    trigger_when: Array<HookIncomingTriggerWhenCondition>;
+    /**
+     *
+     * @type {HookIncomingSetting}
+     * @memberof HookIncomingParams
+     */
+    settings: HookIncomingSetting;
+}

package/dist/api/generated/models/hook-incoming-params.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/hook-incoming-setting.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { HookVariable } from './hook-variable';
+/**
+ * Settings to an incoming hook
+ * @export
+ * @interface HookIncomingSetting
+ */
+export interface HookIncomingSetting {
+    /**
+     * List of variables to incoming hook
+     * @type {Array<HookVariable>}
+     * @memberof HookIncomingSetting
+     */
+    variables?: Array<HookVariable>;
+}

package/dist/api/generated/models/hook-incoming-setting.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/hook-incoming-trigger-when-condition-type.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+/**
+ * Type of the incoming hook condition. * `request_body` - Validate request body for incoming hooks.
+ * @export
+ * @enum {string}
+ */
+export declare enum HookIncomingTriggerWhenConditionType {
+    RequestBody = "request_body"
+}

package/dist/api/generated/models/hook-incoming-trigger-when-condition-type.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.HookIncomingTriggerWhenConditionType = void 0;
+/**
+ * Type of the incoming hook condition. * `request_body` - Validate request body for incoming hooks.
+ * @export
+ * @enum {string}
+ */
+var HookIncomingTriggerWhenConditionType;
+(function (HookIncomingTriggerWhenConditionType) {
+    HookIncomingTriggerWhenConditionType["RequestBody"] = "request_body";
+})(HookIncomingTriggerWhenConditionType = exports.HookIncomingTriggerWhenConditionType || (exports.HookIncomingTriggerWhenConditionType = {}));

package/dist/api/generated/models/hook-incoming-trigger-when-condition.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 { HookIncomingTriggerWhenConditionType } from './hook-incoming-trigger-when-condition-type';
+/**
+ *
+ * @export
+ * @interface HookIncomingTriggerWhenCondition
+ */
+export interface HookIncomingTriggerWhenCondition {
+    /**
+     * Name of the condition
+     * @type {string}
+     * @memberof HookIncomingTriggerWhenCondition
+     */
+    name?: string;
+    /**
+     *
+     * @type {HookIncomingTriggerWhenConditionType}
+     * @memberof HookIncomingTriggerWhenCondition
+     */
+    type: HookIncomingTriggerWhenConditionType;
+    /**
+     * A dot-notation path of the request body where the value will be checked.
+     * @type {string}
+     * @memberof HookIncomingTriggerWhenCondition
+     */
+    path: string;
+    /**
+     * An list of accepted values to checked field.
+     * @type {Array<boolean | number | string>}
+     * @memberof HookIncomingTriggerWhenCondition
+     */
+    accepted_values: Array<boolean | number | string>;
+}

package/dist/api/generated/models/hook-incoming-trigger-when-condition.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/hook-incoming-update.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 { HookIncomingSetting } from './hook-incoming-setting';
+import { HookIncomingTriggerWhenCondition } from './hook-incoming-trigger-when-condition';
+/**
+ *
+ * @export
+ * @interface HookIncomingUpdate
+ */
+export interface HookIncomingUpdate {
+    /**
+     * Unique ID of the hook to be updated
+     * @type {string}
+     * @memberof HookIncomingUpdate
+     */
+    id: string;
+    /**
+     * The name given to incoming hook
+     * @type {string}
+     * @memberof HookIncomingUpdate
+     */
+    name: string;
+    /**
+     * Determines if the hook requires a secret to be triggered
+     * @type {boolean}
+     * @memberof HookIncomingUpdate
+     */
+    requires_secret: boolean;
+    /**
+     * The hash algorithm used to check payload integrity of the request
+     * @type {string}
+     * @memberof HookIncomingUpdate
+     */
+    secret_algorithm?: string;
+    /**
+     * The request header used to give the secret to Devopness
+     * @type {string}
+     * @memberof HookIncomingUpdate
+     */
+    secret_header_name?: string;
+    /**
+     * Determines if the hook is current active
+     * @type {boolean}
+     * @memberof HookIncomingUpdate
+     */
+    active?: boolean;
+    /**
+     * Conditions that must be met to trigger the hook.
+     * @type {Array<HookIncomingTriggerWhenCondition>}
+     * @memberof HookIncomingUpdate
+     */
+    trigger_when?: Array<HookIncomingTriggerWhenCondition>;
+    /**
+     *
+     * @type {HookIncomingSetting}
+     * @memberof HookIncomingUpdate
+     */
+    settings?: HookIncomingSetting;
+}

package/dist/api/generated/models/hook-incoming-update.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/hook-incoming.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { Hook } from './hook';
+import { HookIncomingParams } from './hook-incoming-params';
+/**
+ * @type HookIncoming
+ * @export
+ */
+export declare type HookIncoming = Hook & HookIncomingParams;

package/dist/api/generated/models/hook-incoming.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 });