@devopness/sdk-js 2.0.1 → 2.3.0

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

@@ -0,0 +1,72 @@
+/**
+ * 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 HookRequestRelation
+ */
+export interface HookRequestRelation {
+    /**
+     * The unique UUID of the hook request
+     * @type {string}
+     * @memberof HookRequestRelation
+     */
+    id: string;
+    /**
+     * The UUID of the hook that the request belongs to
+     * @type {string}
+     * @memberof HookRequestRelation
+     */
+    hook_id: string;
+    /**
+     * The id of the action that the request belongs to
+     * @type {number}
+     * @memberof HookRequestRelation
+     */
+    action_id: number | null;
+    /**
+     * The UUID of the request that this request is a retry of
+     * @type {string}
+     * @memberof HookRequestRelation
+     */
+    retry_of: string | null;
+    /**
+     * The IP address of the source that triggered the hook
+     * @type {string}
+     * @memberof HookRequestRelation
+     */
+    ip_address: string;
+    /**
+     * Original URL used on the request
+     * @type {string}
+     * @memberof HookRequestRelation
+     */
+    url?: string;
+    /**
+     * The response status code
+     * @type {number}
+     * @memberof HookRequestRelation
+     */
+    response_status_code?: number;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof HookRequestRelation
+     */
+    created_at?: string | null;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof HookRequestRelation
+     */
+    updated_at?: string | null;
+}

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

@@ -0,0 +1,103 @@
+/**
+ * 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 { HookRelation } from './hook-relation';
+/**
+ *
+ * @export
+ * @interface HookRequest
+ */
+export interface HookRequest {
+    /**
+     * The unique UUID of the hook request
+     * @type {string}
+     * @memberof HookRequest
+     */
+    id: string;
+    /**
+     * The UUID of the hook that the request belongs to
+     * @type {string}
+     * @memberof HookRequest
+     */
+    hook_id: string;
+    /**
+     * The id of the action that the request belongs to
+     * @type {number}
+     * @memberof HookRequest
+     */
+    action_id: number | null;
+    /**
+     * The UUID of the request that this request is a retry of
+     * @type {string}
+     * @memberof HookRequest
+     */
+    retry_of: string | null;
+    /**
+     * The IP address of the source that triggered the hook
+     * @type {string}
+     * @memberof HookRequest
+     */
+    ip_address: string;
+    /**
+     * Original URL used on the request
+     * @type {string}
+     * @memberof HookRequest
+     */
+    url?: string;
+    /**
+     * The headers of the request
+     * @type {object}
+     * @memberof HookRequest
+     */
+    request_headers?: object | null;
+    /**
+     * The body of the request
+     * @type {object}
+     * @memberof HookRequest
+     */
+    request_body?: object | null;
+    /**
+     * The response status code
+     * @type {number}
+     * @memberof HookRequest
+     */
+    response_status_code?: number;
+    /**
+     * The headers of the response
+     * @type {object}
+     * @memberof HookRequest
+     */
+    response_headers?: object | null;
+    /**
+     * The body of the response
+     * @type {object}
+     * @memberof HookRequest
+     */
+    response_body?: object | null;
+    /**
+     *
+     * @type {HookRelation}
+     * @memberof HookRequest
+     */
+    hook?: HookRelation;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof HookRequest
+     */
+    created_at?: string | null;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof HookRequest
+     */
+    updated_at?: string | null;
+}

package/dist/api/generated/models/hook-request.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-type.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.
+ */
+/**
+ * The type of hook (incoming or outgoing)
+ * @export
+ * @enum {string}
+ */
+export declare enum HookType {
+    In = "in",
+    Out = "out"
+}

package/dist/api/generated/models/hook-type.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.HookType = void 0;
+/**
+ * The type of hook (incoming or outgoing)
+ * @export
+ * @enum {string}
+ */
+var HookType;
+(function (HookType) {
+    HookType["In"] = "in";
+    HookType["Out"] = "out";
+})(HookType = exports.HookType || (exports.HookType = {}));

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

@@ -0,0 +1,22 @@
+/**
+ * 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 variable type
+ * @export
+ * @enum {string}
+ */
+export declare enum HookVariableType {
+    String = "string",
+    Integer = "integer",
+    Array = "array",
+    Boolean = "boolean"
+}

package/dist/api/generated/models/hook-variable-type.js

@@ -0,0 +1,27 @@
+"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.HookVariableType = void 0;
+/**
+ * The variable type
+ * @export
+ * @enum {string}
+ */
+var HookVariableType;
+(function (HookVariableType) {
+    HookVariableType["String"] = "string";
+    HookVariableType["Integer"] = "integer";
+    HookVariableType["Array"] = "array";
+    HookVariableType["Boolean"] = "boolean";
+})(HookVariableType = exports.HookVariableType || (exports.HookVariableType = {}));

package/dist/api/generated/models/hook-variable.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 { HookVariableType } from './hook-variable-type';
+/**
+ * Variable that can be defined on trigger a incoming hook
+ * @export
+ * @interface HookVariable
+ */
+export interface HookVariable {
+    /**
+     * The name of the variable
+     * @type {string}
+     * @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}
+     * @memberof HookVariable
+     */
+    type: HookVariableType;
+    /**
+     * Defines if the variable is required
+     * @type {boolean}
+     * @memberof HookVariable
+     */
+    required: boolean;
+    /**
+     * Optional variable assumes the default value if it\'s not given on the request to trigger the hook
+     * @type {string | number | boolean | Array<string | number | boolean | object>}
+     * @memberof HookVariable
+     */
+    default_value?: string | number | boolean | Array<string | number | boolean | object> | null;
+}

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

@@ -0,0 +1,112 @@
+/**
+ * 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 { HookType } from './hook-type';
+import { Resource } from './resource';
+import { UserRelation } from './user-relation';
+/**
+ *
+ * @export
+ * @interface Hook
+ */
+export interface Hook {
+    /**
+     * The Id of the given hook
+     * @type {string}
+     * @memberof Hook
+     */
+    id: string;
+    /**
+     * The name entered by the user (or auto-generated by `Devopness`) to uniquely identify the hook
+     * @type {string}
+     * @memberof Hook
+     */
+    name: string;
+    /**
+     *
+     * @type {HookType}
+     * @memberof Hook
+     */
+    type: HookType;
+    /**
+     * 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 Hook
+     */
+    requires_secret?: boolean;
+    /**
+     * The secret generated by Devopness to be used to digitally sign incoming requests
+     * @type {string}
+     * @memberof Hook
+     */
+    secret: string;
+    /**
+     * The name of the HTTP request header from which the request digital signature should be extracted
+     * @type {string}
+     * @memberof Hook
+     */
+    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 Hook
+     */
+    secret_algorithm?: string | null;
+    /**
+     * Indicates if the Devopness must be verify the SSL certificate of the request
+     * @type {boolean}
+     * @memberof Hook
+     */
+    verify_ssl: boolean;
+    /**
+     * Indicates if the record was auto_generated by `devopness` itself
+     * @type {boolean}
+     * @memberof Hook
+     */
+    auto_generated?: boolean;
+    /**
+     *
+     * @type {ActionType}
+     * @memberof Hook
+     */
+    action_type: ActionType;
+    /**
+     * Determines if the hook is current active
+     * @type {boolean}
+     * @memberof Hook
+     */
+    active?: boolean;
+    /**
+     *
+     * @type {Resource}
+     * @memberof Hook
+     */
+    resource: Resource;
+    /**
+     *
+     * @type {UserRelation}
+     * @memberof Hook
+     */
+    created_by_user?: UserRelation;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof Hook
+     */
+    created_at: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof Hook
+     */
+    updated_at: string;
+}

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