@gobodo/gobodo-api-promise 0.1.88 → 0.1.89

package/README.md

@@ -4,8 +4,8 @@ Gobodo - JavaScript client for @gobodo/gobodo-api-promise
 REST Interface for Gobodo API
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 0.1.88
-- Package version: 0.1.88
+- API version: 0.1.89
+- Package version: 0.1.89
 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
 
 ## Installation

package/dist/ApiClient.d.ts

@@ -0,0 +1,316 @@
+export default ApiClient;
+/**
+* @module ApiClient
+* @version 0.1.89
+*/
+/**
+* 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 https://test.api.gobodo.io
+     */
+    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: import("@types/superagent/lib/node/agent")<{
+        method: string;
+        url: string;
+        cookies: string;
+        req: import("http").ClientRequest | import("@types/superagent/lib/node/http2wrapper").Request;
+        res: import("http").IncomingMessage | (import("http2").IncomingHttpHeaders & import("http2").IncomingHttpStatusHeader);
+        attach(field: string, file: superagent.MultipartValueSingle, options?: string | {
+            filename?: string | undefined;
+            contentType?: string | undefined;
+        }): /*elided*/ any;
+        abort(): /*elided*/ any;
+        accept(type: string): /*elided*/ any;
+        agent(): import("@types/superagent/lib/node/agent") | import("http").Agent | import("https").Agent;
+        agent(agent: import("@types/superagent/lib/node/agent") | import("http").Agent | import("https").Agent): /*elided*/ any;
+        auth(token: string, options: {
+            type: "bearer";
+        }): /*elided*/ any;
+        auth(user: string, pass: string, options?: {
+            type: "basic" | "auto";
+            encoder?: (str: string) => string;
+        }): /*elided*/ any;
+        buffer(val?: boolean): /*elided*/ any;
+        ca(cert: string | string[] | Buffer | Buffer[]): /*elided*/ any;
+        catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<import("@types/superagent/lib/node/response") | TResult>;
+        cert(cert: string | string[] | Buffer | Buffer[]): /*elided*/ any;
+        clearTimeout(): /*elided*/ any;
+        connect(override: string | {
+            [hostname: string]: false | string | {
+                host: string;
+                port: number;
+            };
+        }): /*elided*/ any;
+        disableTLSCerts(): /*elided*/ any;
+        end(callback?: import("@types/superagent/types").CBHandler): void;
+        field(fields: {
+            [fieldName: string]: (string | number | boolean | import("buffer").Blob | Buffer | import("fs").ReadStream) | Array<string | number | boolean | import("buffer").Blob | Buffer | import("fs").ReadStream>;
+        }): /*elided*/ any;
+        field(name: string, val: (string | number | boolean | import("buffer").Blob | Buffer | import("fs").ReadStream) | Array<string | number | boolean | import("buffer").Blob | Buffer | import("fs").ReadStream>, options?: import("form-data").AppendOptions | string): /*elided*/ any;
+        finally(onfinally?: (() => void) | null): Promise<import("@types/superagent/lib/node/response")>;
+        get(header: string): string;
+        getHeader(header: string): string;
+        http2(enable?: boolean): /*elided*/ any;
+        key(cert: string | string[] | Buffer | Buffer[]): /*elided*/ any;
+        lookup(): import("net").LookupFunction;
+        lookup(lookup: import("net").LookupFunction): /*elided*/ any;
+        maxResponseSize(n: number): /*elided*/ any;
+        ok(callback: (res: import("@types/superagent/lib/node/response")) => boolean): /*elided*/ any;
+        parse(parser: ((str: string) => any) | ((res: import("@types/superagent/lib/node/response"), callback: (err: Error | null, body: any) => void) => void)): /*elided*/ any;
+        pfx(cert: string | string[] | Buffer | Buffer[] | {
+            pfx: string | Buffer;
+            passphrase: string;
+        }): /*elided*/ any;
+        query(val: Record<string, any> | string): /*elided*/ any;
+        redirects(n: number): /*elided*/ any;
+        responseType(type: string): /*elided*/ any;
+        retry(count?: number, callback?: import("@types/superagent/types").CBHandler): /*elided*/ any;
+        send(data?: string | object): /*elided*/ any;
+        serialize(serializer: (obj: any) => string): /*elided*/ any;
+        set(field: "Cookie", val: string[]): /*elided*/ any;
+        set(field: import("http").IncomingHttpHeaders): /*elided*/ any;
+        set(field: string, val: string): /*elided*/ any;
+        sortQuery(sort?: boolean | ((a: string, b: string) => number)): /*elided*/ any;
+        then<TResult1 = import("@types/superagent/lib/node/response"), TResult2 = never>(onfulfilled?: ((value: import("@types/superagent/lib/node/response")) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+        timeout(ms: number | {
+            deadline?: number;
+            response?: number;
+        }): /*elided*/ any;
+        toJSON(): {
+            method: string;
+            url: string;
+            data?: string | object;
+            headers: Array<string | string[]>;
+        };
+        trustLocalhost(enabled?: boolean): /*elided*/ any;
+        type(val: string): /*elided*/ any;
+        unset(field: string): /*elided*/ any;
+        use(fn: (req: /*elided*/ any) => void): /*elided*/ any;
+        withCredentials(on?: boolean): /*elided*/ any;
+        write(data: string | Buffer, encoding?: string): boolean;
+        [Symbol.toStringTag]: string;
+        pipe<T extends NodeJS.WritableStream>(destination: T, options?: {
+            end?: boolean | undefined;
+        }): T;
+        compose<T extends NodeJS.ReadableStream>(stream: T | ((source: any) => void) | Iterable<T> | AsyncIterable<T>, options?: {
+            signal: AbortSignal;
+        }): T;
+        [EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: string | symbol, ...args: any[]): void;
+        addListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+        on<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+        once<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+        removeListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+        off<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+        removeAllListeners(eventName?: string | symbol): /*elided*/ any;
+        setMaxListeners(n: number): /*elided*/ any;
+        getMaxListeners(): number;
+        listeners<K>(eventName: string | symbol): Function[];
+        rawListeners<K>(eventName: string | symbol): Function[];
+        emit<K>(eventName: string | symbol, ...args: any[]): boolean;
+        listenerCount<K>(eventName: string | symbol, listener?: Function): number;
+        prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+        prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+        eventNames(): (string | symbol)[];
+    }>;
+    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[];
+    /**
+    * 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;
+        variables: {
+            protocol: {
+                description: string;
+                default_value: string;
+                enum_values: string[];
+            };
+            site: {
+                description: string;
+                default_value: 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;
+}
+import superagent from "superagent";

package/dist/ApiClient.js

@@ -16,7 +16,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * gobodo-api
  * REST Interface for Gobodo API
  *
- * The version of the OpenAPI document: 0.1.88
+ * The version of the OpenAPI document: 0.1.89
  * Contact: info@gobodo.io
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,7 +26,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  */
 /**
 * @module ApiClient
-* @version 0.1.88
+* @version 0.1.89
 */
 /**
 * Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
@@ -74,7 +74,7 @@ var ApiClient = /*#__PURE__*/function () {
      * @default {}
      */
     this.defaultHeaders = {
-      'User-Agent': 'OpenAPI-Generator/0.1.88/Javascript'
+      'User-Agent': 'OpenAPI-Generator/0.1.89/Javascript'
     };
 
     /**

package/dist/api/ActionTypesApi.d.ts

@@ -0,0 +1,65 @@
+/**
+* ActionTypes service.
+* @module api/ActionTypesApi
+* @version 0.1.89
+*/
+export default class ActionTypesApi {
+    /**
+    * Constructs a new ActionTypesApi.
+    * @alias module:api/ActionTypesApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Get Actions By Type
+     * Get actions attached to an object by type
+     * @param {Number} id
+     * @param {Number} actiontypeid
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/GraphAction>} and HTTP response
+     */
+    getActionsByTypeWithHttpInfo(id: number, actiontypeid: number, opts: any): Promise<any>;
+    /**
+     * Get Actions By Type
+     * Get actions attached to an object by type
+     * @param {Number} id
+     * @param {Number} actiontypeid
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.zeusportalPostas The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/GraphAction>}
+     */
+    getActionsByType(id: number, actiontypeid: number, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+}

package/dist/api/ActionTypesApi.js

@@ -16,7 +16,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * gobodo-api
  * REST Interface for Gobodo API
  *
- * The version of the OpenAPI document: 0.1.88
+ * The version of the OpenAPI document: 0.1.89
  * Contact: info@gobodo.io
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,7 +27,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * ActionTypes service.
 * @module api/ActionTypesApi
-* @version 0.1.88
+* @version 0.1.89
 */
 var ActionTypesApi = exports["default"] = /*#__PURE__*/function () {
   /**