pipedrive 17.1.4 → 17.1.5

package/CHANGELOG.md

@@ -8,6 +8,10 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
 
 ## [Unreleased]
 
+## 17.1.5
+### Changed
+- Added and updated the descriptions of roles endpoints
+
 ## 17.1.4
 ### Changed
 - Changed the content type to `application/json` in the following endpoints:

package/dist/api/RolesApi.js

@@ -140,6 +140,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Add a role
+     * Adds a new role.
      * @param {Object} opts Optional parameters
      * @param {module:model/AddRole} opts.addRole 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostRoles} and HTTP response
@@ -181,6 +182,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Add a role
+     * Adds a new role.
      * @param {Object} opts Optional parameters
      * @param {module:model/AddRole} opts.addRole 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostRoles}
@@ -195,7 +197,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Add role assignment
-     * Adds assignment for a role.
+     * Assigns a user to a role.
      * @param {Number} id The ID of the role
      * @param {Object} opts Optional parameters
      * @param {module:model/AddRoleAssignmentRequest} opts.addRoleAssignmentRequest 
@@ -244,7 +246,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Add role assignment
-     * Adds assignment for a role.
+     * Assigns a user to a role.
      * @param {Number} id The ID of the role
      * @param {Object} opts Optional parameters
      * @param {module:model/AddRoleAssignmentRequest} opts.addRoleAssignmentRequest 
@@ -260,6 +262,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a role
+     * Marks a role as deleted.
      * @param {Number} id The ID of the role
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteRole} and HTTP response
      */
@@ -302,6 +305,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a role
+     * Marks a role as deleted.
      * @param {Number} id The ID of the role
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteRole}
      */
@@ -315,7 +319,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a role assignment
-     * Deletes assignment from a role.
+     * Removes the assigned user from a role and adds to the default role.
      * @param {Number} id The ID of the role
      * @param {Object} opts Optional parameters
      * @param {module:model/DeleteRoleAssignmentRequest} opts.deleteRoleAssignmentRequest 
@@ -364,7 +368,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a role assignment
-     * Deletes assignment from a role.
+     * Removes the assigned user from a role and adds to the default role.
      * @param {Number} id The ID of the role
      * @param {Object} opts Optional parameters
      * @param {module:model/DeleteRoleAssignmentRequest} opts.deleteRoleAssignmentRequest 
@@ -380,6 +384,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Get one role
+     * Returns the details of a specific role.
      * @param {Number} id The ID of the role
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetRole} and HTTP response
      */
@@ -422,6 +427,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Get one role
+     * Returns the details of a specific role.
      * @param {Number} id The ID of the role
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetRole}
      */
@@ -435,7 +441,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * List role assignments
-     * Lists assignments for a role.
+     * Returns all users assigned to a role.
      * @param {Number} id The ID of the role
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
@@ -484,7 +490,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * List role assignments
-     * Lists assignments for a role.
+     * Returns all users assigned to a role.
      * @param {Number} id The ID of the role
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
@@ -501,6 +507,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * List role settings
+     * Returns the visibility settings of a specific role.
      * @param {Number} id The ID of the role
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetRoleSettings} and HTTP response
      */
@@ -543,6 +550,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * List role settings
+     * Returns the visibility settings of a specific role.
      * @param {Number} id The ID of the role
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetRoleSettings}
      */
@@ -556,6 +564,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * List role sub-roles
+     * Returns the direct children of a specific role.
      * @param {Number} id The ID of the role
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
@@ -604,6 +613,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * List role sub-roles
+     * Returns the direct children of a specific role.
      * @param {Number} id The ID of the role
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
@@ -620,6 +630,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Get all roles
+     * Returns all the roles within the company.
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
@@ -660,6 +671,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Get all roles
+     * Returns all the roles within the company.
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
@@ -675,6 +687,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Update role details
+     * Updates the parent role and/or the name of a specific role.
      * @param {Number} id The ID of the role
      * @param {Object} opts Optional parameters
      * @param {module:model/BaseRole} opts.baseRole 
@@ -719,6 +732,7 @@ var RolesApi = /*#__PURE__*/function () {
     }
     /**
      * Update role details
+     * Updates the parent role and/or the name of a specific role.
      * @param {Number} id The ID of the role
      * @param {Object} opts Optional parameters
      * @param {module:model/BaseRole} opts.baseRole 

package/dist/model/AddRole.js

@@ -68,16 +68,16 @@ var AddRole = /*#__PURE__*/function () {
       if (data) {
         obj = obj || new AddRole();
 
-        if (data.hasOwnProperty('parent_role_id')) {
-          obj['parent_role_id'] = _ApiClient["default"].convertToType(data['parent_role_id'], 'Number');
-          delete data['parent_role_id'];
-        }
-
         if (data.hasOwnProperty('name')) {
           obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
           delete data['name'];
         }
 
+        if (data.hasOwnProperty('parent_role_id')) {
+          obj['parent_role_id'] = _ApiClient["default"].convertToType(data['parent_role_id'], 'Number');
+          delete data['parent_role_id'];
+        }
+
         if (Object.keys(data).length > 0) {
           Object.assign(obj, data);
         }
@@ -89,17 +89,17 @@ var AddRole = /*#__PURE__*/function () {
   return AddRole;
 }();
 /**
- * The ID of the parent role
- * @member {Number} parent_role_id
+ * The name of the role
+ * @member {String} name
  */
 
 
-AddRole.prototype['parent_role_id'] = undefined;
+AddRole.prototype['name'] = undefined;
 /**
- * The name of the role
- * @member {String} name
+ * The ID of the parent role
+ * @member {Number} parent_role_id
  */
 
-AddRole.prototype['name'] = undefined;
+AddRole.prototype['parent_role_id'] = undefined;
 var _default = AddRole;
 exports["default"] = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pipedrive",
-  "version": "17.1.4",
+  "version": "17.1.5",
   "description": "Pipedrive REST client for NodeJS",
   "license": "MIT",
   "main": "dist/index.js",