@devopness/sdk-js 2.0.1 → 2.3.0

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

@@ -0,0 +1,70 @@
+/**
+ * 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 { HookOutgoingSetting } from './hook-outgoing-setting';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
+import { ResourceType } from './resource-type';
+/**
+ *
+ * @export
+ * @interface HookOutgoingCreate
+ */
+export interface HookOutgoingCreate {
+    /**
+     * The name to uniquely identify the outgoing hook
+     * @type {string}
+     * @memberof HookOutgoingCreate
+     */
+    name: string;
+    /**
+     *
+     * @type {ActionType}
+     * @memberof HookOutgoingCreate
+     */
+    action_type: ActionType;
+    /**
+     * Determines if the hook is current active
+     * @type {boolean}
+     * @memberof HookOutgoingCreate
+     */
+    active?: boolean;
+    /**
+     *
+     * @type {ResourceType}
+     * @memberof HookOutgoingCreate
+     */
+    resource_type: ResourceType;
+    /**
+     * The id of the resource that the outgoing hook belongs to
+     * @type {number}
+     * @memberof HookOutgoingCreate
+     */
+    resource_id: number;
+    /**
+     * The URL that Devopness should send a request when the outgoing hook is triggered
+     * @type {string}
+     * @memberof HookOutgoingCreate
+     */
+    target_url: string;
+    /**
+     * Conditions that must be met to trigger the hook.
+     * @type {Array<HookOutgoingTriggerWhenCondition>}
+     * @memberof HookOutgoingCreate
+     */
+    trigger_when: Array<HookOutgoingTriggerWhenCondition>;
+    /**
+     *
+     * @type {HookOutgoingSetting}
+     * @memberof HookOutgoingCreate
+     */
+    settings?: HookOutgoingSetting;
+}

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

@@ -0,0 +1,76 @@
+/**
+ * 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 { HookOutgoingSetting } from './hook-outgoing-setting';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
+import { ResourceType } from './resource-type';
+/**
+ *
+ * @export
+ * @interface HookOutgoingUpdate
+ */
+export interface HookOutgoingUpdate {
+    /**
+     * Unique ID of the outgoing hook to be updated
+     * @type {string}
+     * @memberof HookOutgoingUpdate
+     */
+    id: string;
+    /**
+     * The name to uniquely identify the outgoing hook
+     * @type {string}
+     * @memberof HookOutgoingUpdate
+     */
+    name: string;
+    /**
+     *
+     * @type {ActionType}
+     * @memberof HookOutgoingUpdate
+     */
+    action_type: ActionType;
+    /**
+     * Determines if the hook is current active
+     * @type {boolean}
+     * @memberof HookOutgoingUpdate
+     */
+    active?: boolean;
+    /**
+     *
+     * @type {ResourceType}
+     * @memberof HookOutgoingUpdate
+     */
+    resource_type: ResourceType;
+    /**
+     * The id of the resource that the outgoing hook belongs to
+     * @type {number}
+     * @memberof HookOutgoingUpdate
+     */
+    resource_id: number;
+    /**
+     * The URL that Devopness should send a request when the outgoing hook is triggered
+     * @type {string}
+     * @memberof HookOutgoingUpdate
+     */
+    target_url: string;
+    /**
+     * Conditions that must be met to trigger the hook.
+     * @type {Array<HookOutgoingTriggerWhenCondition>}
+     * @memberof HookOutgoingUpdate
+     */
+    trigger_when: Array<HookOutgoingTriggerWhenCondition>;
+    /**
+     *
+     * @type {HookOutgoingSetting}
+     * @memberof HookOutgoingUpdate
+     */
+    settings?: HookOutgoingSetting;
+}

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

@@ -0,0 +1,126 @@
+/**
+ * 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 { HookOutgoingSetting } from './hook-outgoing-setting';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
+import { HookType } from './hook-type';
+/**
+ *
+ * @export
+ * @interface HookRelation
+ */
+export interface HookRelation {
+    /**
+     * The Id of the given hook
+     * @type {string}
+     * @memberof HookRelation
+     */
+    id: string;
+    /**
+     * The name entered by the user (or auto-generated by `Devopness`) to uniquely identify the hook
+     * @type {string}
+     * @memberof HookRelation
+     */
+    name: string;
+    /**
+     *
+     * @type {HookType}
+     * @memberof HookRelation
+     */
+    type: HookType;
+    /**
+     * The URL where the incoming hook must be triggered with a POST request
+     * @type {string}
+     * @memberof HookRelation
+     */
+    url?: string | null;
+    /**
+     * The target URL on outgoing hooks where Devopness should trigger a request
+     * @type {string}
+     * @memberof HookRelation
+     */
+    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}
+     * @memberof HookRelation
+     */
+    requires_secret?: boolean;
+    /**
+     * The secret generated by Devopness to be used to digitally sign incoming requests
+     * @type {string}
+     * @memberof HookRelation
+     */
+    secret: string;
+    /**
+     * The name of the HTTP request header from which the request digital signature should be extracted
+     * @type {string}
+     * @memberof HookRelation
+     */
+    secret_header_name?: string | null;
+    /**
+     * The cryptographic hash function to be used by Devopness when validating digitally signed incoming requests for hooks that require secret validation
+     * @type {string}
+     * @memberof HookRelation
+     */
+    secret_algorithm?: string | null;
+    /**
+     * Indicates if the Devopness must be verify the SSL certificate of the request
+     * @type {boolean}
+     * @memberof HookRelation
+     */
+    verify_ssl: boolean;
+    /**
+     * Conditions that must be met to trigger the hook.
+     * @type {Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>}
+     * @memberof HookRelation
+     */
+    trigger_when?: Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>;
+    /**
+     * Indicates if the record was auto_generated by `devopness` itself
+     * @type {boolean}
+     * @memberof HookRelation
+     */
+    auto_generated?: boolean;
+    /**
+     *
+     * @type {ActionType}
+     * @memberof HookRelation
+     */
+    action_type: ActionType;
+    /**
+     * Determines if the hook is current active
+     * @type {boolean}
+     * @memberof HookRelation
+     */
+    active?: boolean;
+    /**
+     *
+     * @type {HookIncomingSetting | HookOutgoingSetting}
+     * @memberof HookRelation
+     */
+    settings?: HookIncomingSetting | HookOutgoingSetting;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof HookRelation
+     */
+    created_at: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof HookRelation
+     */
+    updated_at: string;
+}

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