@kestra-io/kestra-sdk 1.0.0 → 1.0.10

package/dist/ApiClient.d.ts

@@ -0,0 +1,203 @@
+export default ApiClient;
+/**
+* @module ApiClient
+*/
+/**
+* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
+* application to use this class directly - the *Api and model classes provide the public API for the service. The
+* contents of this file should be regarded as internal but are documented for completeness.
+* @alias module:ApiClient
+* @class
+*/
+declare class ApiClient {
+    /**
+    * Returns a boolean indicating if the parameter could be JSON.stringified
+    * @param param The actual parameter
+    * @returns {Boolean} Flag indicating if <code>param</code> can be JSON.stringified
+    */
+    static canBeJsonified(str: any): boolean;
+    /**
+    * Parses an ISO-8601 string representation or epoch representation of a date value.
+    * @param {String} str The date value as a string.
+    * @returns {Date} The parsed date object.
+    */
+    static parseDate(str: string): Date;
+    /**
+    * Converts a value to the specified type.
+    * @param {(String|Object)} data The data to convert, as a string or object.
+    * @param {(String|Array.<String>|Object.<String, Object>|Function)} type The type to return. Pass a string for simple types
+    * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
+    * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
+    * all properties on <code>data<code> will be converted to this type.
+    * @returns An instance of the specified type or null or undefined if data is null or undefined.
+    */
+    static convertToType(data: (string | any), type: (string | Array<string> | any | Function)): any;
+    /**
+    * Constructs a new map or array model from REST data.
+    * @param data {Object|Array} The REST data.
+    * @param obj {Object|Array} The target object or array.
+    */
+    static constructFromObject(data: any | any[], obj: any | any[], itemType: any): void;
+    /**
+     * The base URL against which to resolve every API call's (relative) path.
+     * Overrides the default value set in spec file if present
+     * @param {String} basePath
+     */
+    constructor(basePath?: string);
+    /**
+     * The base URL against which to resolve every API call's (relative) path.
+     * @type {String}
+     * @default http://localhost
+     */
+    basePath: string;
+    /**
+     * The authentication methods to be included for all API calls.
+     * @type {Array.<String>}
+     */
+    authentications: Array<string>;
+    /**
+         * The default HTTP headers to be included for all API calls.
+         * @type {Array.<String>}
+         * @default {}
+         */
+    defaultHeaders: Array<string>;
+    /**
+     * The default HTTP timeout for all API calls.
+     * @type {Number}
+     * @default 60000
+     */
+    timeout: number;
+    /**
+     * If set to false an additional timestamp parameter is added to all API GET calls to
+     * prevent browser caching
+     * @type {Boolean}
+     * @default true
+     */
+    cache: boolean;
+    /**
+         * If set to true, the client will save the cookies from each server
+         * response, and return them in the next request.
+         * @default false
+         */
+    enableCookies: boolean;
+    agent: any;
+    requestAgent: any;
+    plugins: any;
+    /**
+    * Returns a string representation for an actual parameter.
+    * @param param The actual parameter.
+    * @returns {String} The string representation of <code>param</code>.
+    */
+    paramToString(param: any): string;
+    /**
+     * Builds full URL by appending the given path to the base URL and replacing path parameter place-holders with parameter values.
+     * NOTE: query parameters are not handled here.
+     * @param {String} path The path to append to the base URL.
+     * @param {Object} pathParams The parameter values to append.
+     * @param {String} apiBasePath Base path defined in the path, operation level to override the default one
+     * @returns {String} The encoded path with parameter values substituted.
+     */
+    buildUrl(path: string, pathParams: any, apiBasePath: string): string;
+    /**
+    * Checks whether the given content type represents JSON.<br>
+    * JSON content type examples:<br>
+    * <ul>
+    * <li>application/json</li>
+    * <li>application/json; charset=UTF8</li>
+    * <li>APPLICATION/JSON</li>
+    * </ul>
+    * @param {String} contentType The MIME content type to check.
+    * @returns {Boolean} <code>true</code> if <code>contentType</code> represents JSON, otherwise <code>false</code>.
+    */
+    isJsonMime(contentType: string): boolean;
+    /**
+    * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
+    * @param {Array.<String>} contentTypes
+    * @returns {String} The chosen content type, preferring JSON.
+    */
+    jsonPreferredMime(contentTypes: Array<string>): string;
+    /**
+    * Checks whether the given parameter value represents file-like content.
+    * @param param The parameter to check.
+    * @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
+    */
+    isFileParam(param: any): boolean;
+    /**
+    * Normalizes parameter values:
+    * <ul>
+    * <li>remove nils</li>
+    * <li>keep files and arrays</li>
+    * <li>format to string with `paramToString` for other cases</li>
+    * </ul>
+    * @param {Object.<String, Object>} params The parameters as object properties.
+    * @returns {Object.<String, Object>} normalized parameters.
+    */
+    normalizeParams(params: any): any;
+    /**
+    * Builds a string representation of an array-type actual parameter, according to the given collection format.
+    * @param {Array} param An array parameter.
+    * @param {module:ApiClient.CollectionFormatEnum} collectionFormat The array element separator strategy.
+    * @returns {String|Array} A string representation of the supplied collection, using the specified delimiter. Returns
+    * <code>param</code> as is if <code>collectionFormat</code> is <code>multi</code>.
+    */
+    buildCollectionParam(param: any[], collectionFormat: any): string | any[];
+    buildAuthHeaders(authNames: any, headerParams?: {}): any;
+    /**
+    * Applies authentication headers to the request.
+    * @param {Object} request The request object created by a <code>superagent()</code> call.
+    * @param {Array.<String>} authNames An array of authentication method names.
+    */
+    applyAuthToRequest(request: any, authNames: Array<string>): void;
+    /**
+     * Deserializes an HTTP response body into a value of the specified type.
+     * @param {Object} response A SuperAgent response object.
+     * @param {(String|Array.<String>|Object.<String, Object>|Function)} returnType The type to return. Pass a string for simple types
+     * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
+     * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
+     * all properties on <code>data<code> will be converted to this type.
+     * @returns A value of the specified type.
+     */
+    deserialize(response: any, returnType: (string | Array<string> | any | Function)): any;
+    /**
+     * Invokes the REST service using the supplied settings and parameters.
+     * @param {String} path The base URL to invoke.
+     * @param {String} httpMethod The HTTP method to use.
+     * @param {Object.<String, String>} pathParams A map of path parameters and their values.
+     * @param {Object.<String, Object>} queryParams A map of query parameters and their values.
+     * @param {Object.<String, Object>} headerParams A map of header parameters and their values.
+     * @param {Object.<String, Object>} formParams A map of form parameters and their values.
+     * @param {Object} bodyParam The value to pass as the request body.
+     * @param {Array.<String>} authNames An array of authentication type names.
+     * @param {Array.<String>} contentTypes An array of request MIME types.
+     * @param {Array.<String>} accepts An array of acceptable response MIME types.
+     * @param {(String|Array|ObjectFunction)} returnType The required type to return; can be a string for simple types or the
+     * constructor for a complex type.
+     * @param {String} apiBasePath base path defined in the operation/path level to override the default one
+     * @returns {Promise} A {@link https://www.promisejs.org/|Promise} object.
+     */
+    callApi(path: string, httpMethod: string, pathParams: any, queryParams: any, headerParams: any, formParams: any, bodyParam: any, authNames: Array<string>, contentTypes: Array<string>, accepts: Array<string>, returnType: (string | any[] | ObjectFunction), apiBasePath: string): Promise<any>;
+    /**
+      * Gets an array of host settings
+      * @returns An array of host settings
+      */
+    hostSettings(): {
+        url: string;
+        description: string;
+    }[];
+    getBasePathFromSettings(index: any, variables?: {}): string;
+}
+declare namespace ApiClient {
+    namespace CollectionFormatEnum {
+        let CSV: string;
+        let SSV: string;
+        let TSV: string;
+        let PIPES: string;
+        let MULTI: string;
+    }
+    /**
+     * *
+     */
+    type CollectionFormatEnum = string;
+    let instance: any;
+}
+//# sourceMappingURL=ApiClient.d.ts.map

package/dist/ApiClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiClient.d.ts","sourceRoot":"","sources":["../src/ApiClient.js"],"names":[],"mappings":";AAeA;;EAEE;AAEF;;;;;;EAME;AACF;IA6FI;;;;MAIE;IACF,yCASC;IAudD;;;;MAIE;IACF,+BAFY,IAAI,CAOf;IAED;;;;;;;;MAQE;IACF,2BAPU,CAAC,YAAa,CAAC,QACf,CAAC,SAAO,KAAK,QAAS,iBAAiC,CAAC,OA+DjE;IA2CD;;;;MAIE;IACF,iCAHe,WAAY,OACb,WAAY,uBAczB;IA3sBD;;;;OAIG;IACH,+BAkEC;IAjEG;;;;OAIG;IACH,iBAA4C;IAE5C;;;OAGG;IACH,iBAFU,KAAK,QAAS,CAKvB;IAER;;;;WAIU;IACH,gBAHU,KAAK,QAAS,CAKvB;IAED;;;;OAIG;IACH,gBAAoB;IAEpB;;;;;OAKG;IACH,eAAiB;IAExB;;;;WAIU;IACH,uBAA0B;IAOxB,WAAmC;IAMpC,kBAAwB;IAKzB,aAAmB;IAIvB;;;;MAIE;IACF,kCAYC;IAkBF;;;;;;;OAOG;IACF,qEAwBC;IAED;;;;;;;;;;MAUE;IACF,yCAEC;IAED;;;;MAIE;IACF,gCAHU,KAAK,QAAS,UAWvB;IAED;;;;MAIE;IACF,iCA4BC;IAED;;;;;;;;;MASE;IACF,kCAcC;IAED;;;;;;MAME;IACF,qDAJU,GAAqC,GACnC,cAAY,CA4DvB;IAED,yDA4CC;IAED;;;;MAIE;IACF,4CAFU,KAAK,QAAS,QAgDvB;IAEF;;;;;;;;OAQG;IACF,uCANU,CAAC,SAAO,KAAK,QAAS,iBAAiC,CAAC,OAoBjE;IAGF;;;;;;;;;;;;;;;;OAgBG;IACF,4IARU,KAAK,QAAS,gBACd,KAAK,QAAS,WACd,KAAK,QAAS,cACd,CAAC,iBAAa,cAAc,CAAC,qCA2ItC;IAkFH;;;QAGI;IACF;;;QAOC;IAED,4DA0BC;CAoBJ;;;;;;;;;;;;;kBAyCQ,GAAgB"}

package/dist/KestraClient.d.ts

@@ -0,0 +1,33 @@
+export default KestraClient;
+declare class KestraClient {
+    /**
+     * Constructs a new KestraClient.
+     * @param {String} host The base path to the Kestra server.
+     * @param {String} accessToken The access token for bearer authentication.
+     * @param {String} username The username for basic authentication.
+     * @param {String} password The password for basic authentication.
+     */
+    constructor(host: string, accessToken: string, username: string, password: string);
+    apiClient: any;
+    executionsApi: ExecutionsApi;
+    flowsApi: FlowsApi;
+    groupsApi: GroupsApi;
+    kvApi: KVApi;
+    namespacesApi: NamespacesApi;
+    rolesApi: RolesApi;
+    serviceAccountApi: ServicesApi;
+    triggersApi: TriggersApi;
+    usersApi: UsersApi;
+    testSuitesApi: TestSuitesApi;
+}
+import ExecutionsApi from './api/ExecutionsApi';
+import FlowsApi from './api/FlowsApi';
+import GroupsApi from './api/GroupsApi';
+import KVApi from './api/KVApi';
+import NamespacesApi from './api/NamespacesApi';
+import RolesApi from './api/RolesApi';
+import ServicesApi from './api/ServiceAccountApi';
+import TriggersApi from './api/TriggersApi';
+import UsersApi from './api/UsersApi';
+import TestSuitesApi from "./api/TestSuitesApi";
+//# sourceMappingURL=KestraClient.d.ts.map

package/dist/KestraClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KestraClient.d.ts","sourceRoot":"","sources":["../src/KestraClient.js"],"names":[],"mappings":";AAeA;IAEI;;;;;;OAMG;IACH,mFA4BC;IA3BG,eAAmC;IAgBnC,6BAAsD;IACtD,mBAA4C;IAC5C,qBAA8C;IAC9C,aAAsC;IACtC,6BAAsD;IACtD,mBAA4C;IAC5C,+BAA8D;IAC9D,yBAAkD;IAClD,mBAA4C;IAC5C,6BAAsD;CAI7D;0BApDyB,qBAAqB;qBAC1B,gBAAgB;sBACf,iBAAiB;kBACrB,aAAa;0BACL,qBAAqB;qBAC1B,gBAAgB;wBACb,yBAAyB;wBACzB,mBAAmB;qBACtB,gBAAgB;0BAEX,qBAAqB"}