asana 1.0.2 → 2.0.0

package/codegen/templates/ApiClient.mustache

@@ -0,0 +1,618 @@
+{{>licenseInfo}}
+import superagent from "superagent";
+import querystring from "querystring";
+
+{{#emitJSDoc}}/**
+* @module {{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient
+* @version {{projectVersion}}
+*/
+
+/**
+* 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:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient
+* @class
+*/{{/emitJSDoc}}
+export class ApiClient {
+    constructor() {
+        {{#emitJSDoc}}/**
+         * The base URL against which to resolve every API call's (relative) path.
+         * @type {String}
+         * @default {{{basePath}}}
+         */{{/emitJSDoc}}
+        this.basePath = '{{{basePath}}}'.replace(/\/+$/, '');
+
+        {{#emitJSDoc}}/**
+         * The authentication methods to be included for all API calls.
+         * @type {Array.<String>}
+         */{{/emitJSDoc}}
+        this.authentications = {
+{{#authMethods}}
+{{#isBasic}}
+            '{{name}}': {{braces "left"}}type: 'basic'{{braces "right"}}{{^@last}},{{/@last}}
+{{/isBasic}}
+{{#isApiKey}}
+            '{{name}}': {{braces "left"}}type: 'apiKey', 'in': {{#isKeyInHeader}}'header'{{/isKeyInHeader}}{{^isKeyInHeader}}'query'{{/isKeyInHeader}}, name: '{{keyParamName}}'{{braces "right"}}{{^@last}},{{/@last}}
+{{/isApiKey}}
+{{#isOAuth}}
+            '{{name}}': {{braces "left"}}type: 'oauth2'{{braces "right"}}{{^@last}},{{/@last}}
+{{/isOAuth}}
+{{/authMethods}}
+        }
+
+        {{#emitJSDoc}}/**
+         * The default HTTP headers to be included for all API calls.
+         * @type {Array.<String>}
+         * @default {}
+         */{{/emitJSDoc}}
+        this.defaultHeaders = {};
+
+        /**
+         * The default HTTP timeout for all API calls.
+         * @type {Number}
+         * @default 60000
+         */
+        this.timeout = 60000;
+
+        /**
+         * If set to false an additional timestamp parameter is added to all API GET calls to
+         * prevent browser caching
+         * @type {Boolean}
+         * @default true
+         */
+        this.cache = true;
+
+        {{#emitJSDoc}}/**
+         * If set to true, the client will save the cookies from each server
+         * response, and return them in the next request.
+         * @default false
+         */{{/emitJSDoc}}
+        this.enableCookies = false;
+
+        /*
+         * Used to save and return cookies in a node.js (non-browser) setting,
+         * if this.enableCookies is set to true.
+         */
+        if (typeof window === 'undefined') {
+          this.agent = new superagent.agent();
+        }
+
+        /*
+         * Allow user to override superagent agent
+         */
+         this.requestAgent = null;
+
+    }
+
+    {{#emitJSDoc}}/**
+    * Returns a string representation for an actual parameter.
+    * @param param The actual parameter.
+    * @returns {String} The string representation of <code>param</code>.
+    */{{/emitJSDoc}}
+    paramToString(param) {
+        if (param == undefined || param == null) {
+            return '';
+        }
+        if (param instanceof Date) {
+            return param.toJSON();
+        }
+
+        return param.toString();
+    }
+
+    {{#emitJSDoc}}/**
+    * 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.
+    * @returns {String} The encoded path with parameter values substituted.
+    */{{/emitJSDoc}}
+    buildUrl(path, pathParams) {
+        if (!path.match(/^\//)) {
+            path = '/' + path;
+        }
+
+        var url = this.basePath + path;
+        url = url.replace(/\{([\w-]+)\}/g, (fullMatch, key) => {
+            var value;
+            if (pathParams.hasOwnProperty(key)) {
+                value = this.paramToString(pathParams[key]);
+            } else {
+                value = fullMatch;
+            }
+
+            return encodeURIComponent(value);
+        });
+
+        return url;
+    }
+
+    {{#emitJSDoc}}/**
+    * 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>.
+    */{{/emitJSDoc}}
+    isJsonMime(contentType) {
+        return Boolean(contentType != null && contentType.match(/^application\/json(;.*)?$/i));
+    }
+
+    {{#emitJSDoc}}/**
+    * 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.
+    */{{/emitJSDoc}}
+    jsonPreferredMime(contentTypes) {
+        for (var i = 0; i < contentTypes.length; i++) {
+            if (this.isJsonMime(contentTypes[i])) {
+                return contentTypes[i];
+            }
+        }
+
+        return contentTypes[0];
+    }
+
+    {{#emitJSDoc}}/**
+    * 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.
+    */
+    {{/emitJSDoc}}
+    isFileParam(param) {
+        // fs.ReadStream in Node.js and Electron (but not in runtime like browserify)
+        if (typeof require === 'function') {
+            let fs;
+            try {
+                fs = require('fs');
+            } catch (err) {}
+            if (fs && fs.ReadStream && param instanceof fs.ReadStream) {
+                return true;
+            }
+        }
+
+        // Buffer in Node.js
+        if (typeof Buffer === 'function' && param instanceof Buffer) {
+            return true;
+        }
+
+        // Blob in browser
+        if (typeof Blob === 'function' && param instanceof Blob) {
+            return true;
+        }
+
+        // File in browser (it seems File object is also instance of Blob, but keep this for safe)
+        if (typeof File === 'function' && param instanceof File) {
+            return true;
+        }
+
+        return false;
+    }
+
+    {{#emitJSDoc}}/**
+    * 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.
+    */{{/emitJSDoc}}
+    normalizeParams(params) {
+        var newParams = {};
+        for (var key in params) {
+            if (params.hasOwnProperty(key) && params[key] != undefined && params[key] != null) {
+                var value = params[key];
+                if (this.isFileParam(value) || Array.isArray(value)) {
+                    newParams[key] = value;
+                } else {
+                    newParams[key] = this.paramToString(value);
+                }
+            }
+        }
+
+        return newParams;
+    }
+
+    {{#emitJSDoc}}/**
+    * Enumeration of collection format separator strategies.
+    * @enum {String}
+    * @readonly
+    */{{/emitJSDoc}}
+    static CollectionFormatEnum = {
+        {{#emitJSDoc}}/**
+         * Comma-separated values. Value: <code>csv</code>
+         * @const
+         */{{/emitJSDoc}}
+        CSV: ',',
+
+        {{#emitJSDoc}}/**
+         * Space-separated values. Value: <code>ssv</code>
+         * @const
+         */{{/emitJSDoc}}
+        SSV: ' ',
+
+        {{#emitJSDoc}}/**
+         * Tab-separated values. Value: <code>tsv</code>
+         * @const
+         */{{/emitJSDoc}}
+        TSV: '\t',
+
+        {{#emitJSDoc}}/**
+         * Pipe(|)-separated values. Value: <code>pipes</code>
+         * @const
+         */{{/emitJSDoc}}
+        PIPES: '|',
+
+        {{#emitJSDoc}}/**
+         * Native array. Value: <code>multi</code>
+         * @const
+         */{{/emitJSDoc}}
+        MULTI: 'multi'
+    };
+
+    {{#emitJSDoc}}/**
+    * Builds a string representation of an array-type actual parameter, according to the given collection format.
+    * @param {Array} param An array parameter.
+    * @param {module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}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>.
+    */{{/emitJSDoc}}
+    buildCollectionParam(param, collectionFormat) {
+        if (param == null) {
+            return null;
+        }
+        switch (collectionFormat) {
+            case 'csv':
+                return param.map(this.paramToString).join(',');
+            case 'ssv':
+                return param.map(this.paramToString).join(' ');
+            case 'tsv':
+                return param.map(this.paramToString).join('\t');
+            case 'pipes':
+                return param.map(this.paramToString).join('|');
+            case 'multi':
+                //return the array directly as SuperAgent will handle it as expected
+                return param.map(this.paramToString);
+            default:
+                throw new Error('Unknown collection format: ' + collectionFormat);
+        }
+    }
+
+    {{#emitJSDoc}}/**
+    * 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.
+    */{{/emitJSDoc}}
+    applyAuthToRequest(request, authNames) {
+        authNames.forEach((authName) => {
+            var auth = this.authentications[authName];
+            switch (auth.type) {
+                case 'basic':
+                    if (auth.username || auth.password) {
+                        request.auth(auth.username || '', auth.password || '');
+                    }
+
+                    break;
+                case 'apiKey':
+                    if (auth.apiKey) {
+                        var data = {};
+                        if (auth.apiKeyPrefix) {
+                            data[auth.name] = auth.apiKeyPrefix + ' ' + auth.apiKey;
+                        } else {
+                            data[auth.name] = auth.apiKey;
+                        }
+
+                        if (auth['in'] === 'header') {
+                            request.set(data);
+                        } else {
+                            request.query(data);
+                        }
+                    }
+
+                    break;
+                case 'oauth2':
+                    if (auth.accessToken) {
+                        request.set({'Authorization': 'Bearer ' + auth.accessToken});
+                    }
+
+                    break;
+                default:
+                    throw new Error('Unknown authentication type: ' + auth.type);
+            }
+        });
+    }
+
+    {{#emitJSDoc}}/**
+    * 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.
+    */
+    {{/emitJSDoc}}
+    deserialize(response, returnType) {
+        if (response == null || returnType == null || response.status == 204) {
+            return null;
+        }
+
+        // Rely on SuperAgent for parsing response body.
+        // See http://visionmedia.github.io/superagent/#parsing-response-bodies
+        var data = response.body;
+        if (data == null || (typeof data === 'object' && typeof data.length === 'undefined' && !Object.keys(data).length)) {
+            // SuperAgent does not always produce a body; use the unparsed response as a fallback
+            data = response.text;
+        }
+
+        return ApiClient.convertToType(data, returnType);
+    }
+
+    {{#emitJSDoc}}{{^usePromises}}/**
+    * Callback function to receive the result of the operation.
+    * @callback module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient~callApiCallback
+    * @param {String} error Error message, if any.
+    * @param data The data returned by the service call.
+    * @param {String} response The complete HTTP response.
+    */{{/usePromises}}{{/emitJSDoc}}
+
+    {{#emitJSDoc}}/**
+    * 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.{{^usePromises}}
+    * @param {module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient~callApiCallback} callback The callback function.{{/usePromises}}
+    * @returns {{#usePromises}}{Promise} A {@link https://www.promisejs.org/|Promise} object{{/usePromises}}{{^usePromises}}{Object} The SuperAgent request object{{/usePromises}}.
+    */
+    {{/emitJSDoc}}
+    callApi(path, httpMethod, pathParams,
+        queryParams, headerParams, formParams, bodyParam, authNames, contentTypes, accepts,
+        returnType{{^usePromises}}, callback{{/usePromises}}) {
+
+        var url = this.buildUrl(path, pathParams);
+        var request = superagent(httpMethod, url);
+
+        // apply authentications
+        this.applyAuthToRequest(request, authNames);
+
+        // set query parameters
+        if (httpMethod.toUpperCase() === 'GET' && this.cache === false) {
+            queryParams['_'] = new Date().getTime();
+        }
+
+        request.query(this.normalizeParams(queryParams));
+
+        // set header parameters
+        headerParams['X-Asana-Client-Lib'] = querystring.stringify(
+            {
+                'version': "{{projectVersion}}",
+                'language': 'NodeJS',
+                'language_version': process.version,
+                'os': process.platform
+            }
+        );
+        request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
+
+        // set requestAgent if it is set by user
+        if (this.requestAgent) {
+          request.agent(this.requestAgent);
+        }
+
+        // set request timeout
+        request.timeout(this.timeout);
+
+        var contentType = this.jsonPreferredMime(contentTypes);
+        if (contentType) {
+            // Issue with superagent and multipart/form-data (https://github.com/visionmedia/superagent/issues/746)
+            if(contentType != 'multipart/form-data') {
+                request.type(contentType);
+            }
+        } else if (!request.header['Content-Type']) {
+            request.type('application/json');
+        }
+
+        if (contentType === 'application/x-www-form-urlencoded') {
+            request.send(querystring.stringify(this.normalizeParams(formParams)));
+        } else if (contentType == 'multipart/form-data') {
+            var _formParams = this.normalizeParams(formParams);
+            for (var key in _formParams) {
+                if (_formParams.hasOwnProperty(key)) {
+                    if (this.isFileParam(_formParams[key])) {
+                        // file field
+                        request.attach(key, _formParams[key]);
+                    } else {
+                        request.field(key, _formParams[key]);
+                    }
+                }
+            }
+        } else if (bodyParam) {
+            // Some Asana resources (EX: Projects, ProjectTemplates) contain a "public" property which is a JavaScript reserved word.
+            // Because of this, the generator adds a "_" prefix to properties that is in the reserved words list: https://github.com/swagger-api/swagger-codegen-generators/blob/v1.0.42/src/main/java/io/swagger/codegen/v3/generators/javascript/JavaScriptClientCodegen.java#L134-L153
+            // We need to remove this "_prefix" before sending the request to the Asana API because it will not throw an error for "_public" property in the request body.
+            if (bodyParam.data.hasOwnProperty("_public")) {
+                bodyParam.data['public'] = bodyParam.data['_public'];
+                delete bodyParam.data['_public'];
+            }
+            request.send(bodyParam);
+        }
+
+        var accept = this.jsonPreferredMime(accepts);
+        if (accept) {
+            request.accept(accept);
+        }
+
+        if (returnType === 'Blob') {
+          request.responseType('blob');
+        } else if (returnType === 'String') {
+          request.responseType('string');
+        }
+
+        // Attach previously saved cookies, if enabled
+        if (this.enableCookies){
+            if (typeof window === 'undefined') {
+                this.agent.attachCookies(request);
+            }
+            else {
+                request.withCredentials();
+            }
+        }
+
+        {{#usePromises}}return new Promise((resolve, reject) => {
+            request.end((error, response) => {
+                if (error) {
+                    reject(error);
+                } else {
+                    try {
+                        var data = this.deserialize(response, returnType);
+                        if (this.enableCookies && typeof window === 'undefined'){
+                            this.agent.saveCookies(response);
+                        }
+
+                        resolve({data, response});
+                    } catch (err) {
+                        reject(err);
+                    }
+                }
+            });
+        });{{/usePromises}}
+
+        {{^usePromises}}request.end((error, response) => {
+            if (callback) {
+                var data = null;
+                if (!error) {
+                    try {
+                        data = this.deserialize(response, returnType);
+                        if (this.enableCookies && typeof window === 'undefined'){
+                            this.agent.saveCookies(response);
+                        }
+                    } catch (err) {
+                        error = err;
+                    }
+                }
+
+                callback(error, data, response);
+            }
+        });
+
+        return request;{{/usePromises}}
+    }
+
+    {{#emitJSDoc}}/**
+    * Parses an ISO-8601 string representation of a date value.
+    * @param {String} str The date value as a string.
+    * @returns {Date} The parsed date object.
+    */{{/emitJSDoc}}
+    static parseDate(str) {
+        return new Date(str);
+    }
+
+    {{#emitJSDoc}}/**
+    * 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.
+    */
+    {{/emitJSDoc}}
+    static convertToType(data, type) {
+        if (data === null || data === undefined)
+            return data
+
+        switch (type) {
+            case 'Boolean':
+                return Boolean(data);
+            case 'Integer':
+                return parseInt(data, 10);
+            case 'Number':
+                return parseFloat(data);
+            case 'String':
+                return String(data);
+            case 'Date':
+                return ApiClient.parseDate(String(data));
+            case 'Blob':
+                return data;
+            default:
+                if (type === Object) {
+                    // generic object, return directly
+                    return data;
+                } else if (typeof type === 'function') {
+                    // for model type like: User
+                    return type.constructFromObject(data);
+                } else if (Array.isArray(type)) {
+                    // for array type like: ['String']
+                    var itemType = type[0];
+
+                    return data.map((item) => {
+                        return ApiClient.convertToType(item, itemType);
+                    });
+                } else if (typeof type === 'object') {
+                    // for plain object type like: {'String': 'Integer'}
+                    var keyType, valueType;
+                    for (var k in type) {
+                        if (type.hasOwnProperty(k)) {
+                            keyType = k;
+                            valueType = type[k];
+                            break;
+                        }
+                    }
+
+                    var result = {};
+                    for (var k in data) {
+                        if (data.hasOwnProperty(k)) {
+                            var key = ApiClient.convertToType(k, keyType);
+                            var value = ApiClient.convertToType(data[k], valueType);
+                            result[key] = value;
+                        }
+                    }
+
+                    return result;
+                } else {
+                    // for unknown type, return the data directly
+                    return data;
+                }
+        }
+    }
+
+    {{#emitJSDoc}}/**
+    * 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.
+    */{{/emitJSDoc}}
+    static constructFromObject(data, obj, itemType) {
+        if (Array.isArray(data)) {
+            for (var i = 0; i < data.length; i++) {
+                if (data.hasOwnProperty(i))
+                    obj[i] = ApiClient.convertToType(data[i], itemType);
+            }
+        } else {
+            for (var k in data) {
+                if (data.hasOwnProperty(k))
+                    obj[k] = ApiClient.convertToType(data[k], itemType);
+            }
+        }
+    };
+}
+
+{{#emitJSDoc}}/**
+* The default API client implementation.
+* @type {module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient}
+*/{{/emitJSDoc}}
+ApiClient.instance = new ApiClient();