asana 1.0.2 → 2.0.0

package/src/api/GoalRelationshipsApi.js

@@ -0,0 +1,305 @@
+/*
+ * Asana
+ * This is the interface for interacting with the [Asana Platform](https://developers.asana.com). Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/openapi/master/defs/asana_oas.yaml).
+ *
+ * OpenAPI spec version: 1.0
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 3.0.46
+ *
+ * Do not edit the class manually.
+ *
+ */
+import {ApiClient} from "../ApiClient";
+import {EmptyResponseData} from '../model/EmptyResponseData';
+import {ErrorResponse} from '../model/ErrorResponse';
+import {GoalGidAddSupportingRelationshipBody} from '../model/GoalGidAddSupportingRelationshipBody';
+import {GoalGidRemoveSupportingRelationshipBody} from '../model/GoalGidRemoveSupportingRelationshipBody';
+import {GoalRelationshipResponseArray} from '../model/GoalRelationshipResponseArray';
+import {GoalRelationshipResponseData} from '../model/GoalRelationshipResponseData';
+import {GoalRelationshipsGoalRelationshipGidBody} from '../model/GoalRelationshipsGoalRelationshipGidBody';
+
+/**
+* GoalRelationships service.
+* @module api/GoalRelationshipsApi
+* @version 2.0.0
+*/
+export class GoalRelationshipsApi {
+
+    /**
+    * Constructs a new GoalRelationshipsApi. 
+    * @alias module:api/GoalRelationshipsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instanc
+    e} if unspecified.
+    */
+    constructor(apiClient) {
+        this.apiClient = apiClient || ApiClient.instance;
+    }
+
+    /**
+     * Callback function to receive the result of the addSupportingRelationship operation.
+     * @callback moduleapi/GoalRelationshipsApi~addSupportingRelationshipCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/GoalRelationshipResponseData{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Add a supporting goal relationship
+     * Creates a goal relationship by adding a supporting resource to a given goal.  Returns the newly created goal relationship record.
+     * @param {module:model/GoalGidAddSupportingRelationshipBody} body The supporting resource to be added to the goal
+     * @param {String} goal_gid Globally unique identifier for the goal.
+     * @param {Object} opts Optional parameters
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
+     * @param {module:api/GoalRelationshipsApi~addSupportingRelationshipCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    addSupportingRelationship(body, goal_gid, opts, callback) {
+      opts = opts || {};
+      let postBody = body;
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling addSupportingRelationship");
+      }
+      // verify the required parameter 'goal_gid' is set
+      if (goal_gid === undefined || goal_gid === null) {
+        throw new Error("Missing the required parameter 'goal_gid' when calling addSupportingRelationship");
+      }
+
+      let pathParams = {
+        'goal_gid': goal_gid
+      };
+      let queryParams = {
+        'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = ['application/json; charset=UTF-8'];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = GoalRelationshipResponseData;
+
+      return this.apiClient.callApi(
+        '/goals/{goal_gid}/addSupportingRelationship', 'POST',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+    /**
+     * Callback function to receive the result of the getGoalRelationship operation.
+     * @callback moduleapi/GoalRelationshipsApi~getGoalRelationshipCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/GoalRelationshipResponseData{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get a goal relationship
+     * Returns the complete updated goal relationship record for a single goal relationship.
+     * @param {String} goal_relationship_gid Globally unique identifier for the goal relationship.
+     * @param {Object} opts Optional parameters
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
+     * @param {module:api/GoalRelationshipsApi~getGoalRelationshipCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    getGoalRelationship(goal_relationship_gid, opts, callback) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'goal_relationship_gid' is set
+      if (goal_relationship_gid === undefined || goal_relationship_gid === null) {
+        throw new Error("Missing the required parameter 'goal_relationship_gid' when calling getGoalRelationship");
+      }
+
+      let pathParams = {
+        'goal_relationship_gid': goal_relationship_gid
+      };
+      let queryParams = {
+        'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = [];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = GoalRelationshipResponseData;
+
+      return this.apiClient.callApi(
+        '/goal_relationships/{goal_relationship_gid}', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+    /**
+     * Callback function to receive the result of the getGoalRelationships operation.
+     * @callback moduleapi/GoalRelationshipsApi~getGoalRelationshipsCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/GoalRelationshipResponseArray{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get goal relationships
+     * Returns compact goal relationship records.
+     * @param {String} supported_goal Globally unique identifier for the supported goal in the goal relationship.
+     * @param {Object} opts Optional parameters
+     * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
+     * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. &#x27;Note: You can only pass in an offset that was returned to you via a previously paginated request.&#x27;
+     * @param {String} opts.resource_subtype If provided, filter to goal relationships with a given resource_subtype.
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
+     * @param {module:api/GoalRelationshipsApi~getGoalRelationshipsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    getGoalRelationships(supported_goal, opts, callback) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'supported_goal' is set
+      if (supported_goal === undefined || supported_goal === null) {
+        throw new Error("Missing the required parameter 'supported_goal' when calling getGoalRelationships");
+      }
+
+      let pathParams = {
+        
+      };
+      let queryParams = {
+        'limit': opts['limit'],'offset': opts['offset'],'supported_goal': supported_goal,'resource_subtype': opts['resource_subtype'],'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = [];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = GoalRelationshipResponseArray;
+
+      return this.apiClient.callApi(
+        '/goal_relationships', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+    /**
+     * Callback function to receive the result of the removeSupportingRelationship operation.
+     * @callback moduleapi/GoalRelationshipsApi~removeSupportingRelationshipCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/EmptyResponseData{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Removes a supporting goal relationship
+     * Removes a goal relationship for a given parent goal.
+     * @param {module:model/GoalGidRemoveSupportingRelationshipBody} body The supporting resource to be removed from the goal
+     * @param {String} goal_gid Globally unique identifier for the goal.
+     * @param {module:api/GoalRelationshipsApi~removeSupportingRelationshipCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    removeSupportingRelationship(body, goal_gid, callback) {
+      
+      let postBody = body;
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling removeSupportingRelationship");
+      }
+      // verify the required parameter 'goal_gid' is set
+      if (goal_gid === undefined || goal_gid === null) {
+        throw new Error("Missing the required parameter 'goal_gid' when calling removeSupportingRelationship");
+      }
+
+      let pathParams = {
+        'goal_gid': goal_gid
+      };
+      let queryParams = {
+        
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = ['application/json; charset=UTF-8'];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = EmptyResponseData;
+
+      return this.apiClient.callApi(
+        '/goals/{goal_gid}/removeSupportingRelationship', 'POST',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+    /**
+     * Callback function to receive the result of the updateGoalRelationship operation.
+     * @callback moduleapi/GoalRelationshipsApi~updateGoalRelationshipCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/GoalRelationshipResponseData{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Update a goal relationship
+     * An existing goal relationship can be updated by making a PUT request on the URL for that goal relationship. Only the fields provided in the &#x60;data&#x60; block will be updated; any unspecified fields will remain unchanged.  Returns the complete updated goal relationship record.
+     * @param {module:model/GoalRelationshipsGoalRelationshipGidBody} body The updated fields for the goal relationship.
+     * @param {String} goal_relationship_gid Globally unique identifier for the goal relationship.
+     * @param {Object} opts Optional parameters
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
+     * @param {module:api/GoalRelationshipsApi~updateGoalRelationshipCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    updateGoalRelationship(body, goal_relationship_gid, opts, callback) {
+      opts = opts || {};
+      let postBody = body;
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling updateGoalRelationship");
+      }
+      // verify the required parameter 'goal_relationship_gid' is set
+      if (goal_relationship_gid === undefined || goal_relationship_gid === null) {
+        throw new Error("Missing the required parameter 'goal_relationship_gid' when calling updateGoalRelationship");
+      }
+
+      let pathParams = {
+        'goal_relationship_gid': goal_relationship_gid
+      };
+      let queryParams = {
+        'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = ['application/json; charset=UTF-8'];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = GoalRelationshipResponseData;
+
+      return this.apiClient.callApi(
+        '/goal_relationships/{goal_relationship_gid}', 'PUT',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+
+}