@devopness/sdk-js/dist/api/generated/models/hook-variable.d.ts

Devopness API JS/TS SDK - Painless essential DevOps to everyone

/**
 * 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 of the variable to be used as the value to evaluate this condition. 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;
}