@devopness/sdk-js 1.97.0 → 1.100.0

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

@@ -9,6 +9,8 @@
  * 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
@@ -51,4 +53,16 @@ export interface HookIncomingUpdate {
      * @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.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 });

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

@@ -10,6 +10,8 @@
  * Do not edit the class manually.
  */
 import { ActionType } from './action-type';
+import { HookOutgoingSetting } from './hook-outgoing-setting';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
 import { ResourceType } from './resource-type';
 /**
  *
@@ -54,9 +56,15 @@ 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>;
+    /**
+     *
+     * @type {HookOutgoingSetting}
+     * @memberof HookOutgoingCreate
+     */
+    settings?: HookOutgoingSetting;
 }

package/dist/api/generated/models/hook-outgoing-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 { HookOutgoingSetting } from './hook-outgoing-setting';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
+/**
+ *
+ * @export
+ * @interface HookOutgoingParams
+ */
+export interface HookOutgoingParams {
+    /**
+     * The target URL on outgoing hooks where Devopness should trigger a request
+     * @type {string}
+     * @memberof HookOutgoingParams
+     */
+    target_url: string | null;
+    /**
+     * Conditions that must be met to trigger the hook.
+     * @type {Array<HookOutgoingTriggerWhenCondition>}
+     * @memberof HookOutgoingParams
+     */
+    trigger_when: Array<HookOutgoingTriggerWhenCondition>;
+    /**
+     *
+     * @type {HookOutgoingSetting}
+     * @memberof HookOutgoingParams
+     */
+    settings: HookOutgoingSetting;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * 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 HookOutgoingRequestHeader
+ */
+export interface HookOutgoingRequestHeader {
+    /**
+     * Name of the HTTP header.
+     * @type {string}
+     * @memberof HookOutgoingRequestHeader
+     */
+    name: string;
+    /**
+     * Value of the HTTP header.
+     * @type {string}
+     * @memberof HookOutgoingRequestHeader
+     */
+    value: string;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * 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 { HookOutgoingRequestHeader } from './hook-outgoing-request-header';
+/**
+ * Settings to an outgoing hook
+ * @export
+ * @interface HookOutgoingSetting
+ */
+export interface HookOutgoingSetting {
+    /**
+     * List of outgoing hook request headers
+     * @type {Array<HookOutgoingRequestHeader>}
+     * @memberof HookOutgoingSetting
+     */
+    request_headers?: Array<HookOutgoingRequestHeader>;
+    /**
+     * The request body that should be send to target URL
+     * @type {string | object | Array<object>}
+     * @memberof HookOutgoingSetting
+     */
+    request_body?: string | object | Array<object>;
+}

package/dist/api/generated/models/hook-outgoing-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-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,8 @@
  * Do not edit the class manually.
  */
 import { ActionType } from './action-type';
+import { HookOutgoingSetting } from './hook-outgoing-setting';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
 import { ResourceType } from './resource-type';
 /**
  *
@@ -60,9 +62,15 @@ 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>;
+    /**
+     *
+     * @type {HookOutgoingSetting}
+     * @memberof HookOutgoingUpdate
+     */
+    settings?: HookOutgoingSetting;
 }

package/dist/api/generated/models/hook-outgoing.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 { HookOutgoingParams } from './hook-outgoing-params';
+/**
+ * @type HookOutgoing
+ * @export
+ */
+export declare type HookOutgoing = Hook & HookOutgoingParams;

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

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 import { ActionType } from './action-type';
-import { HookSetting } from './hook-setting';
+import { HookIncomingSetting } from './hook-incoming-setting';
+import { HookIncomingTriggerWhenCondition } from './hook-incoming-trigger-when-condition';
+import { HookOutgoingSetting } from './hook-outgoing-setting';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
 import { HookType } from './hook-type';
 /**
  *
@@ -79,11 +82,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}
@@ -104,10 +107,10 @@ export interface HookRelation {
     active?: boolean;
     /**
      *
-     * @type {HookSetting}
+     * @type {HookIncomingSetting | HookOutgoingSetting}
      * @memberof HookRelation
      */
-    settings?: HookSetting;
+    settings?: HookIncomingSetting | HookOutgoingSetting;
     /**
      * The date and time when the record was created
      * @type {string}

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,7 +10,6 @@
  * Do not edit the class manually.
  */
 import { ActionType } from './action-type';
-import { HookSetting } from './hook-setting';
 import { HookType } from './hook-type';
 import { Resource } from './resource';
 import { UserRelation } from './user-relation';
@@ -38,18 +37,6 @@ export interface Hook {
      * @memberof Hook
      */
     type: HookType;
-    /**
-     * The URL where the incoming hook must be triggered with a POST request
-     * @type {string}
-     * @memberof Hook
-     */
-    url?: string | null;
-    /**
-     * The target URL on outgoing hooks where Devopness should trigger a request
-     * @type {string}
-     * @memberof Hook
-     */
-    target_url?: string | null;
     /**
      * 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}
@@ -80,12 +67,6 @@ export interface Hook {
      * @memberof Hook
      */
     verify_ssl: boolean;
-    /**
-     * A list of action status when the outgoing hook should be triggered by Devopness
-     * @type {Array<string>}
-     * @memberof Hook
-     */
-    trigger_when?: Array<string> | null;
     /**
      * Indicates if the record was auto_generated by `devopness` itself
      * @type {boolean}
@@ -115,13 +96,7 @@ export interface Hook {
      * @type {UserRelation}
      * @memberof Hook
      */
-    created_by_user: UserRelation;
-    /**
-     *
-     * @type {HookSetting}
-     * @memberof Hook
-     */
-    settings?: HookSetting;
+    created_by_user?: UserRelation;
     /**
      * The date and time when the record was created
      * @type {string}