@devopness/sdk-js 1.97.0 → 1.98.0

package/README.md

@@ -84,3 +84,24 @@ This package includes TypeScript declarations for every method.
 TypeScript versions `>= 3.8` are supported.
 
 Some methods in `Devopness SDK JavaScript` accept and return objects from the Devopness API. The type declarations for these objects will always track the latest version of the API. Therefore, if you'e using the latest version of this package you can rely on the Devopness API documentation for checking the input and return types of each API endpoint.
+
+## Building and testing
+To build and test the SDK locally, follow these steps:
+1. Clone de repository
+```
+git clone https://github.com/devopness/devopness-sdk-js.git
+```
+2. Install missing dependencies
+
+This command will install all modules listed as dependencies in [package.json](package.json). A working Java Runtime Environment is also required. Please, check out the installation instructions for your operating system.
+```
+npm install
+```
+3. Build
+```
+npm run build-api-models
+```
+4. Run tests
+```
+npm run test
+```

package/dist/api/generated/models/deployment-origin.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+/**
+ * Source/channel from which the deployment has been triggered
+ * @export
+ * @enum {string}
+ */
+export declare enum DeploymentOrigin {
+    Hook = "hook",
+    Manual = "manual"
+}

package/dist/api/generated/models/deployment-origin.js

@@ -0,0 +1,25 @@
+"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.DeploymentOrigin = void 0;
+/**
+ * Source/channel from which the deployment has been triggered
+ * @export
+ * @enum {string}
+ */
+var DeploymentOrigin;
+(function (DeploymentOrigin) {
+    DeploymentOrigin["Hook"] = "hook";
+    DeploymentOrigin["Manual"] = "manual";
+})(DeploymentOrigin = exports.DeploymentOrigin || (exports.DeploymentOrigin = {}));

package/dist/api/generated/models/deployment-source.d.ts

@@ -9,13 +9,41 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { DeploymentOrigin } from './deployment-origin';
 /**
- * Source/channel from which the deployment has been triggered
+ * Deployment source information
  * @export
- * @enum {string}
+ * @interface DeploymentSource
  */
-export declare enum DeploymentSource {
-    Manual = "manual",
-    GitPush = "git-push",
-    Scheduled = "scheduled"
+export interface DeploymentSource {
+    /**
+     *
+     * @type {DeploymentOrigin}
+     * @memberof DeploymentSource
+     */
+    origin: DeploymentOrigin;
+    /**
+     * The IP address from the deployment has been triggered
+     * @type {string}
+     * @memberof DeploymentSource
+     */
+    ip_address: string | null;
+    /**
+     * The hook that has been triggered the deployment
+     * @type {number}
+     * @memberof DeploymentSource
+     */
+    hook_id: number | null;
+    /**
+     * The hook request\'s ID that have triggered the deployment
+     * @type {number}
+     * @memberof DeploymentSource
+     */
+    hook_request_id: number | null;
+    /**
+     * The pull request that have triggered the deployment
+     * @type {number}
+     * @memberof DeploymentSource
+     */
+    pull_request_id: number | null;
 }

package/dist/api/generated/models/deployment-source.js

@@ -12,15 +12,3 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeploymentSource = void 0;
-/**
- * Source/channel from which the deployment has been triggered
- * @export
- * @enum {string}
- */
-var DeploymentSource;
-(function (DeploymentSource) {
-    DeploymentSource["Manual"] = "manual";
-    DeploymentSource["GitPush"] = "git-push";
-    DeploymentSource["Scheduled"] = "scheduled";
-})(DeploymentSource = exports.DeploymentSource || (exports.DeploymentSource = {}));

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { ActionType } from './action-type';
+import { HookIncomingTriggerWhenCondition } from './hook-incoming-trigger-when-condition';
 import { HookSetting } from './hook-setting';
 import { ResourceType } from './resource-type';
 /**
@@ -66,6 +67,12 @@ export interface HookIncomingCreate {
      * @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 {HookSetting}

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-outgoing-create.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { ActionType } from './action-type';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
 import { ResourceType } from './resource-type';
 /**
  *
@@ -54,9 +55,9 @@ export interface HookOutgoingCreate {
      */
     target_url: string;
     /**
-     * The list of action status when the hook must be triggered
-     * @type {Array<string>}
+     * Conditions that must be met to trigger the hook.
+     * @type {Array<HookOutgoingTriggerWhenCondition>}
      * @memberof HookOutgoingCreate
      */
-    trigger_when: Array<string>;
+    trigger_when: Array<HookOutgoingTriggerWhenCondition>;
 }

package/dist/api/generated/models/hook-outgoing-trigger-when-action-status.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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
+ * @enum {string}
+ */
+export declare enum HookOutgoingTriggerWhenActionStatus {
+    InProgress = "in-progress",
+    Completed = "completed",
+    Failed = "failed"
+}

package/dist/api/generated/models/hook-outgoing-trigger-when-action-status.js

@@ -0,0 +1,26 @@
+"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.HookOutgoingTriggerWhenActionStatus = void 0;
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+var HookOutgoingTriggerWhenActionStatus;
+(function (HookOutgoingTriggerWhenActionStatus) {
+    HookOutgoingTriggerWhenActionStatus["InProgress"] = "in-progress";
+    HookOutgoingTriggerWhenActionStatus["Completed"] = "completed";
+    HookOutgoingTriggerWhenActionStatus["Failed"] = "failed";
+})(HookOutgoingTriggerWhenActionStatus = exports.HookOutgoingTriggerWhenActionStatus || (exports.HookOutgoingTriggerWhenActionStatus = {}));

package/dist/api/generated/models/hook-outgoing-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 outgoing hook condition. * `action_status` - Validate action status for outgoing hooks.
+ * @export
+ * @enum {string}
+ */
+export declare enum HookOutgoingTriggerWhenConditionType {
+    ActionStatus = "action_status"
+}

package/dist/api/generated/models/hook-outgoing-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.HookOutgoingTriggerWhenConditionType = void 0;
+/**
+ * Type of the outgoing hook condition. * `action_status` - Validate action status for outgoing hooks.
+ * @export
+ * @enum {string}
+ */
+var HookOutgoingTriggerWhenConditionType;
+(function (HookOutgoingTriggerWhenConditionType) {
+    HookOutgoingTriggerWhenConditionType["ActionStatus"] = "action_status";
+})(HookOutgoingTriggerWhenConditionType = exports.HookOutgoingTriggerWhenConditionType || (exports.HookOutgoingTriggerWhenConditionType = {}));

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

@@ -0,0 +1,32 @@
+/**
+ * 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 { HookOutgoingTriggerWhenActionStatus } from './hook-outgoing-trigger-when-action-status';
+import { HookOutgoingTriggerWhenConditionType } from './hook-outgoing-trigger-when-condition-type';
+/**
+ *
+ * @export
+ * @interface HookOutgoingTriggerWhenCondition
+ */
+export interface HookOutgoingTriggerWhenCondition {
+    /**
+     *
+     * @type {HookOutgoingTriggerWhenConditionType}
+     * @memberof HookOutgoingTriggerWhenCondition
+     */
+    type: HookOutgoingTriggerWhenConditionType;
+    /**
+     * An list of accepted values to checked field.
+     * @type {Array<HookOutgoingTriggerWhenActionStatus>}
+     * @memberof HookOutgoingTriggerWhenCondition
+     */
+    accepted_values: Array<HookOutgoingTriggerWhenActionStatus>;
+}

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { ActionType } from './action-type';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
 import { ResourceType } from './resource-type';
 /**
  *
@@ -60,9 +61,9 @@ export interface HookOutgoingUpdate {
      */
     target_url: string;
     /**
-     * The list of action status when the hook must be triggered
-     * @type {Array<string>}
+     * Conditions that must be met to trigger the hook.
+     * @type {Array<HookOutgoingTriggerWhenCondition>}
      * @memberof HookOutgoingUpdate
      */
-    trigger_when: Array<string>;
+    trigger_when: Array<HookOutgoingTriggerWhenCondition>;
 }

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

@@ -10,6 +10,8 @@
  * Do not edit the class manually.
  */
 import { ActionType } from './action-type';
+import { HookIncomingTriggerWhenCondition } from './hook-incoming-trigger-when-condition';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
 import { HookSetting } from './hook-setting';
 import { HookType } from './hook-type';
 /**
@@ -79,11 +81,11 @@ export interface HookRelation {
      */
     verify_ssl: boolean;
     /**
-     * A list of action status when the outgoing hook should be triggered by Devopness
-     * @type {Array<string>}
+     * Conditions that must be met to trigger the hook.
+     * @type {Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>}
      * @memberof HookRelation
      */
-    trigger_when?: Array<string> | null;
+    trigger_when?: Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>;
     /**
      * Indicates if the record was auto_generated by `devopness` itself
      * @type {boolean}

package/dist/api/generated/models/hook-variable.d.ts

@@ -22,6 +22,12 @@ export interface HookVariable {
      * @memberof HookVariable
      */
     name: string;
+    /**
+     * A `dot-notation` path used to retrieve the variable\'s value. If not defined the `name` will be used instead.
+     * @type {string}
+     * @memberof HookVariable
+     */
+    path?: string;
     /**
      *
      * @type {HookVariableType}

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

@@ -10,6 +10,8 @@
  * Do not edit the class manually.
  */
 import { ActionType } from './action-type';
+import { HookIncomingTriggerWhenCondition } from './hook-incoming-trigger-when-condition';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
 import { HookSetting } from './hook-setting';
 import { HookType } from './hook-type';
 import { Resource } from './resource';
@@ -81,11 +83,11 @@ export interface Hook {
      */
     verify_ssl: boolean;
     /**
-     * A list of action status when the outgoing hook should be triggered by Devopness
-     * @type {Array<string>}
+     * Conditions that must be met to trigger the hook.
+     * @type {Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>}
      * @memberof Hook
      */
-    trigger_when?: Array<string> | null;
+    trigger_when?: Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>;
     /**
      * Indicates if the record was auto_generated by `devopness` itself
      * @type {boolean}

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

@@ -55,6 +55,7 @@ export * from './deployment-create';
 export * from './deployment-create-application';
 export * from './deployment-create-server';
 export * from './deployment-default-step';
+export * from './deployment-origin';
 export * from './deployment-relation';
 export * from './deployment-source';
 export * from './deployment-step';
@@ -71,8 +72,13 @@ export * from './environment-type';
 export * from './environment-update';
 export * from './hook';
 export * from './hook-incoming-create';
+export * from './hook-incoming-trigger-when-condition';
+export * from './hook-incoming-trigger-when-condition-type';
 export * from './hook-incoming-update';
 export * from './hook-outgoing-create';
+export * from './hook-outgoing-trigger-when-action-status';
+export * from './hook-outgoing-trigger-when-condition';
+export * from './hook-outgoing-trigger-when-condition-type';
 export * from './hook-outgoing-update';
 export * from './hook-relation';
 export * from './hook-request';

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

@@ -71,6 +71,7 @@ __exportStar(require("./deployment-create"), exports);
 __exportStar(require("./deployment-create-application"), exports);
 __exportStar(require("./deployment-create-server"), exports);
 __exportStar(require("./deployment-default-step"), exports);
+__exportStar(require("./deployment-origin"), exports);
 __exportStar(require("./deployment-relation"), exports);
 __exportStar(require("./deployment-source"), exports);
 __exportStar(require("./deployment-step"), exports);
@@ -87,8 +88,13 @@ __exportStar(require("./environment-type"), exports);
 __exportStar(require("./environment-update"), exports);
 __exportStar(require("./hook"), exports);
 __exportStar(require("./hook-incoming-create"), exports);
+__exportStar(require("./hook-incoming-trigger-when-condition"), exports);
+__exportStar(require("./hook-incoming-trigger-when-condition-type"), exports);
 __exportStar(require("./hook-incoming-update"), exports);
 __exportStar(require("./hook-outgoing-create"), exports);
+__exportStar(require("./hook-outgoing-trigger-when-action-status"), exports);
+__exportStar(require("./hook-outgoing-trigger-when-condition"), exports);
+__exportStar(require("./hook-outgoing-trigger-when-condition-type"), exports);
 __exportStar(require("./hook-outgoing-update"), exports);
 __exportStar(require("./hook-relation"), exports);
 __exportStar(require("./hook-request"), exports);

package/package.json

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