@devopness/sdk-js 2.22.1 → 2.24.0

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

@@ -67,7 +67,7 @@ export interface Daemon {
      * @type {ProjectRelation}
      * @memberof Daemon
      */
-    project: ProjectRelation;
+    project: ProjectRelation | null;
     /**
      *
      * @type {ActionRelation}

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

@@ -108,17 +108,17 @@ export interface Environment {
      * @type {Array<string>}
      * @memberof Environment
      */
-    current_user_permissions?: Array<string>;
+    current_user_permissions: Array<string>;
     /**
      * The date and time when the record was created
      * @type {string}
      * @memberof Environment
      */
-    created_at?: string;
+    created_at: string;
     /**
      * The date and time when the record was last updated
      * @type {string}
      * @memberof Environment
      */
-    updated_at?: string;
+    updated_at: string;
 }

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

@@ -0,0 +1,84 @@
+/**
+ * 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 { HookIncomingSettings } from './hook-incoming-settings';
+import { HookIncomingTriggerWhenCondition } from './hook-incoming-trigger-when-condition';
+import { HookOutgoingSettings } from './hook-outgoing-settings';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
+import { ResourceType } from './resource-type';
+/**
+ *
+ * @export
+ * @interface HookCreate
+ */
+export interface HookCreate {
+    /**
+     * The name of the outgoing hook. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof HookCreate
+     */
+    name: string;
+    /**
+     *
+     * @type {ResourceType}
+     * @memberof HookCreate
+     */
+    resource_type: ResourceType;
+    /**
+     * The hooks\' resource ID.
+     * @type {number}
+     * @memberof HookCreate
+     */
+    resource_id: number;
+    /**
+     *
+     * @type {ActionType}
+     * @memberof HookCreate
+     */
+    action_type: ActionType;
+    /**
+     * Determines if the hook is currently active.
+     * @type {boolean}
+     * @memberof HookCreate
+     */
+    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. This field is required when <code>type</code> is <code>in</code>.
+     * @type {boolean}
+     * @memberof HookCreate
+     */
+    requires_secret?: boolean;
+    /**
+     * The cryptographic hash function to be used by Devopness when validating digitally signed incoming requests for hooks that require secret validation. This field is required when <code>requires_secret</code> is <code>true</code>.  Must be one of <code>sha256</code> Must not be greater than 20 characters.
+     * @type {string}
+     * @memberof HookCreate
+     */
+    secret_algorithm?: string;
+    /**
+     * The name of the HTTP request header from which the request digital signature should be extracted. This field is required when <code>requires_secret</code> is <code>true</code>. Must not be greater than 64 characters.
+     * @type {string}
+     * @memberof HookCreate
+     */
+    secret_header_name?: string;
+    /**
+     * Conditions that must be met to trigger the hook
+     * @type {Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>}
+     * @memberof HookCreate
+     */
+    trigger_when?: Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>;
+    /**
+     *
+     * @type {HookIncomingSettings | HookOutgoingSettings}
+     * @memberof HookCreate
+     */
+    settings?: HookIncomingSettings | HookOutgoingSettings;
+}

package/dist/api/generated/models/{hook-incoming-setting.d.ts → hook-incoming-settings.d.ts}

@@ -13,13 +13,13 @@ import { HookVariable } from './hook-variable';
 /**
  * Settings to an incoming hook
  * @export
- * @interface HookIncomingSetting
+ * @interface HookIncomingSettings
  */
-export interface HookIncomingSetting {
+export interface HookIncomingSettings {
     /**
      * List of variables to incoming hook
      * @type {Array<HookVariable>}
-     * @memberof HookIncomingSetting
+     * @memberof HookIncomingSettings
      */
     variables?: Array<HookVariable>;
 }

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * Type of the incoming hook condition. * `request_body` - Validate request body for incoming hooks.
+ * Type of the incoming hook condition.\\n* `request_body` - Validate request body for incoming hooks.
  * @export
  * @enum {string}
  */

package/dist/api/generated/models/hook-incoming-trigger-when-condition-type.js

@@ -14,7 +14,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HookIncomingTriggerWhenConditionType = void 0;
 /**
- * Type of the incoming hook condition. * `request_body` - Validate request body for incoming hooks.
+ * Type of the incoming hook condition.\\n* `request_body` - Validate request body for incoming hooks.
  * @export
  * @enum {string}
  */

package/dist/api/generated/models/{hook-outgoing-setting.d.ts → hook-outgoing-settings.d.ts}

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

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * Type of the outgoing hook condition. * `action_status` - Validate action status for outgoing hooks.
+ * Type of the outgoing hook condition.\\n* `action_status` - Validate action status for outgoing hooks.
  * @export
  * @enum {string}
  */

package/dist/api/generated/models/hook-outgoing-trigger-when-condition-type.js

@@ -14,7 +14,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HookOutgoingTriggerWhenConditionType = void 0;
 /**
- * Type of the outgoing hook condition. * `action_status` - Validate action status for outgoing hooks.
+ * Type of the outgoing hook condition.\\n* `action_status` - Validate action status for outgoing hooks.
  * @export
  * @enum {string}
  */

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

@@ -24,7 +24,7 @@ export interface HookOutgoingTriggerWhenCondition {
      */
     type: HookOutgoingTriggerWhenConditionType;
     /**
-     * An list of accepted values to checked field.
+     * A list of accepted values to checked field.
      * @type {Array<HookOutgoingTriggerWhenActionStatus>}
      * @memberof HookOutgoingTriggerWhenCondition
      */

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

@@ -10,11 +10,12 @@
  * Do not edit the class manually.
  */
 import { ActionType } from './action-type';
-import { HookIncomingSetting } from './hook-incoming-setting';
+import { HookIncomingSettings } from './hook-incoming-settings';
 import { HookIncomingTriggerWhenCondition } from './hook-incoming-trigger-when-condition';
-import { HookOutgoingSetting } from './hook-outgoing-setting';
+import { HookOutgoingSettings } from './hook-outgoing-settings';
 import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
 import { HookType } from './hook-type';
+import { ResourceType } from './resource-type';
 /**
  *
  * @export
@@ -22,7 +23,7 @@ import { HookType } from './hook-type';
  */
 export interface HookRelation {
     /**
-     * The Id of the given hook
+     * The UUID of the given hook
      * @type {string}
      * @memberof HookRelation
      */
@@ -40,41 +41,35 @@ export interface HookRelation {
      */
     type: HookType;
     /**
-     * The URL where the incoming hook must be triggered with a POST request
-     * @type {string}
+     *
+     * @type {ActionType}
      * @memberof HookRelation
      */
-    url?: string | null;
+    action_type: ActionType;
     /**
-     * The target URL on outgoing hooks where Devopness should trigger a request
+     * URL that triggers incoming hooks
      * @type {string}
      * @memberof HookRelation
      */
-    target_url?: string | null;
+    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
+     * URL that outgoing hooks make a request to
      * @type {string}
      * @memberof HookRelation
      */
-    secret: string;
+    target_url: string | null;
     /**
-     * The name of the HTTP request header from which the request digital signature should be extracted
-     * @type {string}
+     * Indicates if the record was auto_generated by `devopness` itself
+     * @type {boolean}
      * @memberof HookRelation
      */
-    secret_header_name?: string | null;
+    auto_generated: boolean;
     /**
-     * The cryptographic hash function to be used by Devopness when validating digitally signed incoming requests for hooks that require secret validation
-     * @type {string}
+     * 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
      */
-    secret_algorithm?: string | null;
+    requires_secret: boolean;
     /**
      * Indicates if the Devopness must be verify the SSL certificate of the request
      * @type {boolean}
@@ -82,35 +77,47 @@ export interface HookRelation {
      */
     verify_ssl: boolean;
     /**
-     * Conditions that must be met to trigger the hook.
-     * @type {Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>}
+     * Determines if the hook is currently active
+     * @type {boolean}
      * @memberof HookRelation
      */
-    trigger_when?: Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>;
+    active: boolean;
     /**
-     * Indicates if the record was auto_generated by `devopness` itself
-     * @type {boolean}
+     * The ID of the project
+     * @type {number}
+     * @memberof HookRelation
+     */
+    project_id: number;
+    /**
+     * The ID of the environment
+     * @type {number}
      * @memberof HookRelation
      */
-    auto_generated?: boolean;
+    environment_id: number;
     /**
      *
-     * @type {ActionType}
+     * @type {ResourceType}
      * @memberof HookRelation
      */
-    action_type: ActionType;
+    resource_type: ResourceType;
     /**
-     * Determines if the hook is current active
-     * @type {boolean}
+     * The hooks\' resource ID
+     * @type {number}
      * @memberof HookRelation
      */
-    active?: boolean;
+    resource_id: number;
     /**
      *
-     * @type {HookIncomingSetting | HookOutgoingSetting}
+     * @type {HookIncomingSettings | HookOutgoingSettings}
+     * @memberof HookRelation
+     */
+    settings: HookIncomingSettings | HookOutgoingSettings | null;
+    /**
+     * Conditions that must be met to trigger the hook
+     * @type {Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>}
      * @memberof HookRelation
      */
-    settings?: HookIncomingSetting | HookOutgoingSetting;
+    trigger_when: Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>;
     /**
      * The date and time when the record was created
      * @type {string}

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

@@ -29,7 +29,7 @@ export interface HookRequest {
      */
     hook_id: string;
     /**
-     * The id of the action that the request belongs to
+     * The ID of the action that the request belongs to
      * @type {number}
      * @memberof HookRequest
      */
@@ -51,53 +51,53 @@ export interface HookRequest {
      * @type {string}
      * @memberof HookRequest
      */
-    url?: string;
+    url: string;
     /**
      * The headers of the request
      * @type {object}
      * @memberof HookRequest
      */
-    request_headers?: object | null;
+    request_headers: object;
     /**
      * The body of the request
      * @type {object}
      * @memberof HookRequest
      */
-    request_body?: object | null;
+    request_body: object;
     /**
      * The response status code
      * @type {number}
      * @memberof HookRequest
      */
-    response_status_code?: number;
+    response_status_code: number;
     /**
      * The headers of the response
      * @type {object}
      * @memberof HookRequest
      */
-    response_headers?: object | null;
+    response_headers: object;
     /**
      * The body of the response
      * @type {object}
      * @memberof HookRequest
      */
-    response_body?: object | null;
+    response_body: object;
     /**
      *
      * @type {HookRelation}
      * @memberof HookRequest
      */
-    hook?: HookRelation;
+    hook: HookRelation | null;
     /**
      * The date and time when the record was created
      * @type {string}
      * @memberof HookRequest
      */
-    created_at?: string | null;
+    created_at: string;
     /**
      * The date and time when the record was last updated
      * @type {string}
      * @memberof HookRequest
      */
-    updated_at?: string | null;
+    updated_at: string;
 }

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

@@ -0,0 +1,84 @@
+/**
+ * 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 { HookIncomingSettings } from './hook-incoming-settings';
+import { HookIncomingTriggerWhenCondition } from './hook-incoming-trigger-when-condition';
+import { HookOutgoingSettings } from './hook-outgoing-settings';
+import { HookOutgoingTriggerWhenCondition } from './hook-outgoing-trigger-when-condition';
+import { ResourceType } from './resource-type';
+/**
+ *
+ * @export
+ * @interface HookUpdate
+ */
+export interface HookUpdate {
+    /**
+     * The name of the outgoing hook. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof HookUpdate
+     */
+    name: string;
+    /**
+     *
+     * @type {ResourceType}
+     * @memberof HookUpdate
+     */
+    resource_type?: ResourceType;
+    /**
+     * The hooks\' resource ID.
+     * @type {number}
+     * @memberof HookUpdate
+     */
+    resource_id?: number;
+    /**
+     *
+     * @type {ActionType}
+     * @memberof HookUpdate
+     */
+    action_type?: ActionType;
+    /**
+     * Determines if the hook is currently active.
+     * @type {boolean}
+     * @memberof HookUpdate
+     */
+    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 HookUpdate
+     */
+    requires_secret?: boolean;
+    /**
+     * The cryptographic hash function to be used by Devopness when validating digitally signed incoming requests for hooks that require secret validation. This field is required when <code>requires_secret</code> is <code>true</code>.  Must be one of <code>sha256</code> Must not be greater than 20 characters.
+     * @type {string}
+     * @memberof HookUpdate
+     */
+    secret_algorithm?: string;
+    /**
+     * The name of the HTTP request header from which the request digital signature should be extracted. This field is required when <code>requires_secret</code> is <code>true</code>. Must not be greater than 64 characters.
+     * @type {string}
+     * @memberof HookUpdate
+     */
+    secret_header_name?: string;
+    /**
+     * Conditions that must be met to trigger the hook
+     * @type {Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>}
+     * @memberof HookUpdate
+     */
+    trigger_when?: Array<HookIncomingTriggerWhenCondition | HookOutgoingTriggerWhenCondition>;
+    /**
+     *
+     * @type {HookIncomingSettings | HookOutgoingSettings}
+     * @memberof HookUpdate
+     */
+    settings?: HookIncomingSettings | HookOutgoingSettings;
+}

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

@@ -21,7 +21,7 @@ export interface HookVariable {
      * @type {string}
      * @memberof HookVariable
      */
-    name: string;
+    name?: string;
     /**
      * A `dot-notation` path used to retrieve the variable\'s value. If not defined the `name` will be used instead.
      * @type {string}
@@ -33,13 +33,13 @@ export interface HookVariable {
      * @type {HookVariableType}
      * @memberof HookVariable
      */
-    type: HookVariableType;
+    type?: HookVariableType;
     /**
      * Defines if the variable is required
      * @type {boolean}
      * @memberof HookVariable
      */
-    required: boolean;
+    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>}