pipedrive 17.1.4 → 17.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -8,6 +8,10 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
8
8
 
9
9
  ## [Unreleased]
10
10
 
11
+ ## 17.1.5
12
+ ### Changed
13
+ - Added and updated the descriptions of roles endpoints
14
+
11
15
  ## 17.1.4
12
16
  ### Changed
13
17
  - Changed the content type to `application/json` in the following endpoints:
@@ -140,6 +140,7 @@ var RolesApi = /*#__PURE__*/function () {
140
140
  }
141
141
  /**
142
142
  * Add a role
143
+ * Adds a new role.
143
144
  * @param {Object} opts Optional parameters
144
145
  * @param {module:model/AddRole} opts.addRole
145
146
  * @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 () {
181
182
  }
182
183
  /**
183
184
  * Add a role
185
+ * Adds a new role.
184
186
  * @param {Object} opts Optional parameters
185
187
  * @param {module:model/AddRole} opts.addRole
186
188
  * @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 () {
195
197
  }
196
198
  /**
197
199
  * Add role assignment
198
- * Adds assignment for a role.
200
+ * Assigns a user to a role.
199
201
  * @param {Number} id The ID of the role
200
202
  * @param {Object} opts Optional parameters
201
203
  * @param {module:model/AddRoleAssignmentRequest} opts.addRoleAssignmentRequest
@@ -244,7 +246,7 @@ var RolesApi = /*#__PURE__*/function () {
244
246
  }
245
247
  /**
246
248
  * Add role assignment
247
- * Adds assignment for a role.
249
+ * Assigns a user to a role.
248
250
  * @param {Number} id The ID of the role
249
251
  * @param {Object} opts Optional parameters
250
252
  * @param {module:model/AddRoleAssignmentRequest} opts.addRoleAssignmentRequest
@@ -260,6 +262,7 @@ var RolesApi = /*#__PURE__*/function () {
260
262
  }
261
263
  /**
262
264
  * Delete a role
265
+ * Marks a role as deleted.
263
266
  * @param {Number} id The ID of the role
264
267
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteRole} and HTTP response
265
268
  */
@@ -302,6 +305,7 @@ var RolesApi = /*#__PURE__*/function () {
302
305
  }
303
306
  /**
304
307
  * Delete a role
308
+ * Marks a role as deleted.
305
309
  * @param {Number} id The ID of the role
306
310
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteRole}
307
311
  */
@@ -315,7 +319,7 @@ var RolesApi = /*#__PURE__*/function () {
315
319
  }
316
320
  /**
317
321
  * Delete a role assignment
318
- * Deletes assignment from a role.
322
+ * Removes the assigned user from a role and adds to the default role.
319
323
  * @param {Number} id The ID of the role
320
324
  * @param {Object} opts Optional parameters
321
325
  * @param {module:model/DeleteRoleAssignmentRequest} opts.deleteRoleAssignmentRequest
@@ -364,7 +368,7 @@ var RolesApi = /*#__PURE__*/function () {
364
368
  }
365
369
  /**
366
370
  * Delete a role assignment
367
- * Deletes assignment from a role.
371
+ * Removes the assigned user from a role and adds to the default role.
368
372
  * @param {Number} id The ID of the role
369
373
  * @param {Object} opts Optional parameters
370
374
  * @param {module:model/DeleteRoleAssignmentRequest} opts.deleteRoleAssignmentRequest
@@ -380,6 +384,7 @@ var RolesApi = /*#__PURE__*/function () {
380
384
  }
381
385
  /**
382
386
  * Get one role
387
+ * Returns the details of a specific role.
383
388
  * @param {Number} id The ID of the role
384
389
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetRole} and HTTP response
385
390
  */
@@ -422,6 +427,7 @@ var RolesApi = /*#__PURE__*/function () {
422
427
  }
423
428
  /**
424
429
  * Get one role
430
+ * Returns the details of a specific role.
425
431
  * @param {Number} id The ID of the role
426
432
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetRole}
427
433
  */
@@ -435,7 +441,7 @@ var RolesApi = /*#__PURE__*/function () {
435
441
  }
436
442
  /**
437
443
  * List role assignments
438
- * Lists assignments for a role.
444
+ * Returns all users assigned to a role.
439
445
  * @param {Number} id The ID of the role
440
446
  * @param {Object} opts Optional parameters
441
447
  * @param {Number} opts.start Pagination start (default to 0)
@@ -484,7 +490,7 @@ var RolesApi = /*#__PURE__*/function () {
484
490
  }
485
491
  /**
486
492
  * List role assignments
487
- * Lists assignments for a role.
493
+ * Returns all users assigned to a role.
488
494
  * @param {Number} id The ID of the role
489
495
  * @param {Object} opts Optional parameters
490
496
  * @param {Number} opts.start Pagination start (default to 0)
@@ -501,6 +507,7 @@ var RolesApi = /*#__PURE__*/function () {
501
507
  }
502
508
  /**
503
509
  * List role settings
510
+ * Returns the visibility settings of a specific role.
504
511
  * @param {Number} id The ID of the role
505
512
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetRoleSettings} and HTTP response
506
513
  */
@@ -543,6 +550,7 @@ var RolesApi = /*#__PURE__*/function () {
543
550
  }
544
551
  /**
545
552
  * List role settings
553
+ * Returns the visibility settings of a specific role.
546
554
  * @param {Number} id The ID of the role
547
555
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetRoleSettings}
548
556
  */
@@ -556,6 +564,7 @@ var RolesApi = /*#__PURE__*/function () {
556
564
  }
557
565
  /**
558
566
  * List role sub-roles
567
+ * Returns the direct children of a specific role.
559
568
  * @param {Number} id The ID of the role
560
569
  * @param {Object} opts Optional parameters
561
570
  * @param {Number} opts.start Pagination start (default to 0)
@@ -604,6 +613,7 @@ var RolesApi = /*#__PURE__*/function () {
604
613
  }
605
614
  /**
606
615
  * List role sub-roles
616
+ * Returns the direct children of a specific role.
607
617
  * @param {Number} id The ID of the role
608
618
  * @param {Object} opts Optional parameters
609
619
  * @param {Number} opts.start Pagination start (default to 0)
@@ -620,6 +630,7 @@ var RolesApi = /*#__PURE__*/function () {
620
630
  }
621
631
  /**
622
632
  * Get all roles
633
+ * Returns all the roles within the company.
623
634
  * @param {Object} opts Optional parameters
624
635
  * @param {Number} opts.start Pagination start (default to 0)
625
636
  * @param {Number} opts.limit Items shown per page
@@ -660,6 +671,7 @@ var RolesApi = /*#__PURE__*/function () {
660
671
  }
661
672
  /**
662
673
  * Get all roles
674
+ * Returns all the roles within the company.
663
675
  * @param {Object} opts Optional parameters
664
676
  * @param {Number} opts.start Pagination start (default to 0)
665
677
  * @param {Number} opts.limit Items shown per page
@@ -675,6 +687,7 @@ var RolesApi = /*#__PURE__*/function () {
675
687
  }
676
688
  /**
677
689
  * Update role details
690
+ * Updates the parent role and/or the name of a specific role.
678
691
  * @param {Number} id The ID of the role
679
692
  * @param {Object} opts Optional parameters
680
693
  * @param {module:model/BaseRole} opts.baseRole
@@ -719,6 +732,7 @@ var RolesApi = /*#__PURE__*/function () {
719
732
  }
720
733
  /**
721
734
  * Update role details
735
+ * Updates the parent role and/or the name of a specific role.
722
736
  * @param {Number} id The ID of the role
723
737
  * @param {Object} opts Optional parameters
724
738
  * @param {module:model/BaseRole} opts.baseRole
@@ -68,16 +68,16 @@ var AddRole = /*#__PURE__*/function () {
68
68
  if (data) {
69
69
  obj = obj || new AddRole();
70
70
 
71
- if (data.hasOwnProperty('parent_role_id')) {
72
- obj['parent_role_id'] = _ApiClient["default"].convertToType(data['parent_role_id'], 'Number');
73
- delete data['parent_role_id'];
74
- }
75
-
76
71
  if (data.hasOwnProperty('name')) {
77
72
  obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
78
73
  delete data['name'];
79
74
  }
80
75
 
76
+ if (data.hasOwnProperty('parent_role_id')) {
77
+ obj['parent_role_id'] = _ApiClient["default"].convertToType(data['parent_role_id'], 'Number');
78
+ delete data['parent_role_id'];
79
+ }
80
+
81
81
  if (Object.keys(data).length > 0) {
82
82
  Object.assign(obj, data);
83
83
  }
@@ -89,17 +89,17 @@ var AddRole = /*#__PURE__*/function () {
89
89
  return AddRole;
90
90
  }();
91
91
  /**
92
- * The ID of the parent role
93
- * @member {Number} parent_role_id
92
+ * The name of the role
93
+ * @member {String} name
94
94
  */
95
95
 
96
96
 
97
- AddRole.prototype['parent_role_id'] = undefined;
97
+ AddRole.prototype['name'] = undefined;
98
98
  /**
99
- * The name of the role
100
- * @member {String} name
99
+ * The ID of the parent role
100
+ * @member {Number} parent_role_id
101
101
  */
102
102
 
103
- AddRole.prototype['name'] = undefined;
103
+ AddRole.prototype['parent_role_id'] = undefined;
104
104
  var _default = AddRole;
105
105
  exports["default"] = _default;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pipedrive",
3
- "version": "17.1.4",
3
+ "version": "17.1.5",
4
4
  "description": "Pipedrive REST client for NodeJS",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",