pipedrive 21.0.0 → 21.2.0

Sign up to get free protection for your applications and to get access to all the features.
package/README.md CHANGED
@@ -484,6 +484,7 @@ Class | Method | HTTP request | Description
484
484
  *Pipedrive.OrganizationsApi* | [**getOrganizationUpdates**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationUpdates) | **GET** /organizations/{id}/flow | List updates about an organization
485
485
  *Pipedrive.OrganizationsApi* | [**getOrganizationUsers**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationUsers) | **GET** /organizations/{id}/permittedUsers | List permitted users
486
486
  *Pipedrive.OrganizationsApi* | [**getOrganizations**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizations) | **GET** /organizations | Get all organizations
487
+ *Pipedrive.OrganizationsApi* | [**getOrganizationsCollection**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationsCollection) | **GET** /organizations/collection | Get all organizations (BETA)
487
488
  *Pipedrive.OrganizationsApi* | [**mergeOrganizations**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#mergeOrganizations) | **PUT** /organizations/{id}/merge | Merge two organizations
488
489
  *Pipedrive.OrganizationsApi* | [**searchOrganization**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#searchOrganization) | **GET** /organizations/search | Search organizations
489
490
  *Pipedrive.OrganizationsApi* | [**updateOrganization**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#updateOrganization) | **PUT** /organizations/{id} | Update an organization
@@ -513,6 +514,7 @@ Class | Method | HTTP request | Description
513
514
  *Pipedrive.PersonsApi* | [**getPersonUpdates**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonUpdates) | **GET** /persons/{id}/flow | List updates about a person
514
515
  *Pipedrive.PersonsApi* | [**getPersonUsers**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonUsers) | **GET** /persons/{id}/permittedUsers | List permitted users
515
516
  *Pipedrive.PersonsApi* | [**getPersons**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersons) | **GET** /persons | Get all persons
517
+ *Pipedrive.PersonsApi* | [**getPersonsCollection**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonsCollection) | **GET** /persons/collection | Get all persons (BETA)
516
518
  *Pipedrive.PersonsApi* | [**mergePersons**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#mergePersons) | **PUT** /persons/{id}/merge | Merge two persons
517
519
  *Pipedrive.PersonsApi* | [**searchPersons**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#searchPersons) | **GET** /persons/search | Search persons
518
520
  *Pipedrive.PersonsApi* | [**updatePerson**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#updatePerson) | **PUT** /persons/{id} | Update a person
@@ -954,6 +956,8 @@ Class | Method | HTTP request | Description
954
956
  - [Pipedrive.GoalsResponseComponent](https://github.com/pipedrive/client-nodejs/blob/master/docs/GoalsResponseComponent.md)
955
957
  - [Pipedrive.IconKey](https://github.com/pipedrive/client-nodejs/blob/master/docs/IconKey.md)
956
958
  - [Pipedrive.InlineResponse200](https://github.com/pipedrive/client-nodejs/blob/master/docs/InlineResponse200.md)
959
+ - [Pipedrive.InlineResponse2001](https://github.com/pipedrive/client-nodejs/blob/master/docs/InlineResponse2001.md)
960
+ - [Pipedrive.InlineResponse2002](https://github.com/pipedrive/client-nodejs/blob/master/docs/InlineResponse2002.md)
957
961
  - [Pipedrive.InlineResponse400](https://github.com/pipedrive/client-nodejs/blob/master/docs/InlineResponse400.md)
958
962
  - [Pipedrive.InlineResponse4001](https://github.com/pipedrive/client-nodejs/blob/master/docs/InlineResponse4001.md)
959
963
  - [Pipedrive.InlineResponse4001AdditionalData](https://github.com/pipedrive/client-nodejs/blob/master/docs/InlineResponse4001AdditionalData.md)
@@ -1055,7 +1059,7 @@ Class | Method | HTTP request | Description
1055
1059
  - [Pipedrive.MessageObject](https://github.com/pipedrive/client-nodejs/blob/master/docs/MessageObject.md)
1056
1060
  - [Pipedrive.MessageObjectAttachments](https://github.com/pipedrive/client-nodejs/blob/master/docs/MessageObjectAttachments.md)
1057
1061
  - [Pipedrive.NewDeal](https://github.com/pipedrive/client-nodejs/blob/master/docs/NewDeal.md)
1058
- - [Pipedrive.NewDealAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/NewDealAllOf.md)
1062
+ - [Pipedrive.NewDealParameters](https://github.com/pipedrive/client-nodejs/blob/master/docs/NewDealParameters.md)
1059
1063
  - [Pipedrive.NewDealProduct](https://github.com/pipedrive/client-nodejs/blob/master/docs/NewDealProduct.md)
1060
1064
  - [Pipedrive.NewFollowerResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/NewFollowerResponse.md)
1061
1065
  - [Pipedrive.NewFollowerResponseData](https://github.com/pipedrive/client-nodejs/blob/master/docs/NewFollowerResponseData.md)
@@ -1126,6 +1130,8 @@ Class | Method | HTTP request | Description
1126
1130
  - [Pipedrive.OrganizationSearchResponseAllOfData](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationSearchResponseAllOfData.md)
1127
1131
  - [Pipedrive.OrganizationUpdateResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationUpdateResponse.md)
1128
1132
  - [Pipedrive.OrganizationUpdateResponseAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationUpdateResponseAllOf.md)
1133
+ - [Pipedrive.OrganizationsCollectionResponseObject](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsCollectionResponseObject.md)
1134
+ - [Pipedrive.OrganizationsCollectionResponseObjectAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsCollectionResponseObjectAllOf.md)
1129
1135
  - [Pipedrive.OrganizationsDeleteResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsDeleteResponse.md)
1130
1136
  - [Pipedrive.OrganizationsDeleteResponseData](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsDeleteResponseData.md)
1131
1137
  - [Pipedrive.OrganizationsMergeResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsMergeResponse.md)
@@ -1166,6 +1172,7 @@ Class | Method | HTTP request | Description
1166
1172
  - [Pipedrive.PersonSearchResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonSearchResponse.md)
1167
1173
  - [Pipedrive.PersonSearchResponseAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonSearchResponseAllOf.md)
1168
1174
  - [Pipedrive.PersonSearchResponseAllOfData](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonSearchResponseAllOfData.md)
1175
+ - [Pipedrive.PersonsCollectionResponseObject](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsCollectionResponseObject.md)
1169
1176
  - [Pipedrive.PictureData](https://github.com/pipedrive/client-nodejs/blob/master/docs/PictureData.md)
1170
1177
  - [Pipedrive.PictureDataPictures](https://github.com/pipedrive/client-nodejs/blob/master/docs/PictureDataPictures.md)
1171
1178
  - [Pipedrive.PictureDataWithID](https://github.com/pipedrive/client-nodejs/blob/master/docs/PictureDataWithID.md)
@@ -1271,6 +1278,7 @@ Class | Method | HTTP request | Description
1271
1278
  - [Pipedrive.TeamsAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/TeamsAllOf.md)
1272
1279
  - [Pipedrive.Unauthorized](https://github.com/pipedrive/client-nodejs/blob/master/docs/Unauthorized.md)
1273
1280
  - [Pipedrive.UpdateActivityResponse200](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateActivityResponse200.md)
1281
+ - [Pipedrive.UpdateDealParameters](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateDealParameters.md)
1274
1282
  - [Pipedrive.UpdateDealProduct](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateDealProduct.md)
1275
1283
  - [Pipedrive.UpdateDealRequest](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateDealRequest.md)
1276
1284
  - [Pipedrive.UpdateFile](https://github.com/pipedrive/client-nodejs/blob/master/docs/UpdateFile.md)
@@ -282,7 +282,7 @@ var ActivitiesApi = /*#__PURE__*/function () {
282
282
  * @param {String} opts.since The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
283
283
  * @param {String} opts.until The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
284
284
  * @param {Number} opts.userId The ID of the user whose activities will be fetched. If omitted, all activities are returned.
285
- * @param {module:model/NumberBoolean} opts.done Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both done and not done activities.
285
+ * @param {Boolean} opts.done Whether the activity is done or not. `false` = Not done, `true` = Done. If omitted, returns both done and not done activities.
286
286
  * @param {String} opts.type The type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the `key_string` parameter of ActivityTypes.
287
287
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetActivitiesCollectionResponse200} and HTTP response
288
288
  */
@@ -331,7 +331,7 @@ var ActivitiesApi = /*#__PURE__*/function () {
331
331
  * @param {String} opts.since The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
332
332
  * @param {String} opts.until The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
333
333
  * @param {Number} opts.userId The ID of the user whose activities will be fetched. If omitted, all activities are returned.
334
- * @param {module:model/NumberBoolean} opts.done Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both done and not done activities.
334
+ * @param {Boolean} opts.done Whether the activity is done or not. `false` = Not done, `true` = Done. If omitted, returns both done and not done activities.
335
335
  * @param {String} opts.type The type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the `key_string` parameter of ActivityTypes.
336
336
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetActivitiesCollectionResponse200}
337
337
  */
@@ -11,6 +11,8 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
11
11
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
12
12
  var _AddOrganizationFollowerRequest = _interopRequireDefault(require("../model/AddOrganizationFollowerRequest"));
13
13
  var _AllOrganizationsGetResponse = _interopRequireDefault(require("../model/AllOrganizationsGetResponse"));
14
+ var _FailResponse = _interopRequireDefault(require("../model/FailResponse"));
15
+ var _InlineResponse = _interopRequireDefault(require("../model/InlineResponse2001"));
14
16
  var _ListActivitiesResponse = _interopRequireDefault(require("../model/ListActivitiesResponse"));
15
17
  var _ListDealsResponse = _interopRequireDefault(require("../model/ListDealsResponse"));
16
18
  var _ListFilesResponse = _interopRequireDefault(require("../model/ListFilesResponse"));
@@ -916,7 +918,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
916
918
  * @param {Object} opts Optional parameters
917
919
  * @param {Number} opts.userId If supplied, only organizations owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied.
918
920
  * @param {Number} opts.filterId The ID of the filter to use
919
- * @param {String} opts.firstChar If supplied, only organizations whose name starts with the specified letter will be returned (case insensitive)
921
+ * @param {String} opts.firstChar If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
920
922
  * @param {Number} opts.start Pagination start (default to 0)
921
923
  * @param {Number} opts.limit Items shown per page
922
924
  * @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
@@ -963,7 +965,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
963
965
  * @param {Object} opts Optional parameters
964
966
  * @param {Number} opts.userId If supplied, only organizations owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied.
965
967
  * @param {Number} opts.filterId The ID of the filter to use
966
- * @param {String} opts.firstChar If supplied, only organizations whose name starts with the specified letter will be returned (case insensitive)
968
+ * @param {String} opts.firstChar If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
967
969
  * @param {Number} opts.start Pagination start (default to 0)
968
970
  * @param {Number} opts.limit Items shown per page
969
971
  * @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
@@ -977,6 +979,73 @@ var OrganizationsApi = /*#__PURE__*/function () {
977
979
  });
978
980
  }
979
981
 
982
+ /**
983
+ * Get all organizations (BETA)
984
+ * Returns all organizations. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
985
+ * @param {Object} opts Optional parameters
986
+ * @param {String} opts.cursor For pagination, the marker (an opaque string value) representing the first item on the next page
987
+ * @param {Number} opts.limit For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
988
+ * @param {String} opts.since The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
989
+ * @param {String} opts.until The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
990
+ * @param {Number} opts.ownerId If supplied, only organizations owned by the given user will be returned
991
+ * @param {String} opts.firstChar If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
992
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2001} and HTTP response
993
+ */
994
+ }, {
995
+ key: "getOrganizationsCollectionWithHttpInfo",
996
+ value: function getOrganizationsCollectionWithHttpInfo(opts) {
997
+ opts = opts || {};
998
+ var postBody = null;
999
+ var pathParams = {};
1000
+ var queryParams = {
1001
+ 'cursor': opts['cursor'] === undefined ? opts['cursor'] : opts['cursor'],
1002
+ 'limit': opts['limit'] === undefined ? opts['limit'] : opts['limit'],
1003
+ 'since': opts['since'] === undefined ? opts['since'] : opts['since'],
1004
+ 'until': opts['until'] === undefined ? opts['until'] : opts['until'],
1005
+ 'owner_id': opts['owner_id'] === undefined ? opts['ownerId'] : opts['owner_id'],
1006
+ 'first_char': opts['first_char'] === undefined ? opts['firstChar'] : opts['first_char']
1007
+ };
1008
+ var headerParams = {};
1009
+ var formParams = {};
1010
+ var formParamArray = [];
1011
+ var contentTypes = [];
1012
+ var isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
1013
+ var isJSON = contentTypes.includes('application/json');
1014
+ if (isJSON) {
1015
+ postBody = _objectSpread(_objectSpread({}, postBody), opts);
1016
+ } else if (isURLEncoded) {
1017
+ for (var key in opts) {
1018
+ if (opts.hasOwnProperty(key) && !formParamArray.includes(key)) {
1019
+ formParams[key] = opts[key];
1020
+ }
1021
+ }
1022
+ }
1023
+ var authNames = ['api_key', 'oauth2'];
1024
+ var accepts = ['application/json'];
1025
+ var returnType = _InlineResponse["default"];
1026
+ return this.apiClient.callApi('/organizations/collection', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
1027
+ }
1028
+
1029
+ /**
1030
+ * Get all organizations (BETA)
1031
+ * Returns all organizations. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
1032
+ * @param {Object} opts Optional parameters
1033
+ * @param {String} opts.cursor For pagination, the marker (an opaque string value) representing the first item on the next page
1034
+ * @param {Number} opts.limit For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
1035
+ * @param {String} opts.since The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
1036
+ * @param {String} opts.until The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
1037
+ * @param {Number} opts.ownerId If supplied, only organizations owned by the given user will be returned
1038
+ * @param {String} opts.firstChar If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
1039
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2001}
1040
+ */
1041
+ }, {
1042
+ key: "getOrganizationsCollection",
1043
+ value: function getOrganizationsCollection(opts) {
1044
+ return this.getOrganizationsCollectionWithHttpInfo(opts).then(function (response_and_data) {
1045
+ return response_and_data;
1046
+ });
1047
+ }
1048
+
980
1049
  /**
981
1050
  * Merge two organizations
982
1051
  * Merges an organization with another organization. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-organizations\" target=\"_blank\" rel=\"noopener noreferrer\">merging two organizations</a>.
@@ -15,8 +15,10 @@ var _AddPersonPictureResponse = _interopRequireDefault(require("../model/AddPers
15
15
  var _AddPersonResponse = _interopRequireDefault(require("../model/AddPersonResponse"));
16
16
  var _DeletePersonResponse = _interopRequireDefault(require("../model/DeletePersonResponse"));
17
17
  var _DeletePersonsInBulkResponse = _interopRequireDefault(require("../model/DeletePersonsInBulkResponse"));
18
+ var _FailResponse = _interopRequireDefault(require("../model/FailResponse"));
18
19
  var _GetAllPersonsResponse = _interopRequireDefault(require("../model/GetAllPersonsResponse"));
19
20
  var _GetPersonDetailsResponse = _interopRequireDefault(require("../model/GetPersonDetailsResponse"));
21
+ var _InlineResponse = _interopRequireDefault(require("../model/InlineResponse2002"));
20
22
  var _ListActivitiesResponse = _interopRequireDefault(require("../model/ListActivitiesResponse"));
21
23
  var _ListDealsResponse = _interopRequireDefault(require("../model/ListDealsResponse"));
22
24
  var _ListFilesResponse = _interopRequireDefault(require("../model/ListFilesResponse"));
@@ -1046,7 +1048,7 @@ var PersonsApi = /*#__PURE__*/function () {
1046
1048
  * @param {Object} opts Optional parameters
1047
1049
  * @param {Number} opts.userId If supplied, only persons owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied.
1048
1050
  * @param {Number} opts.filterId The ID of the filter to use
1049
- * @param {String} opts.firstChar If supplied, only persons whose name starts with the specified letter will be returned (case insensitive)
1051
+ * @param {String} opts.firstChar If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
1050
1052
  * @param {Number} opts.start Pagination start (default to 0)
1051
1053
  * @param {Number} opts.limit Items shown per page
1052
1054
  * @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
@@ -1093,7 +1095,7 @@ var PersonsApi = /*#__PURE__*/function () {
1093
1095
  * @param {Object} opts Optional parameters
1094
1096
  * @param {Number} opts.userId If supplied, only persons owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied.
1095
1097
  * @param {Number} opts.filterId The ID of the filter to use
1096
- * @param {String} opts.firstChar If supplied, only persons whose name starts with the specified letter will be returned (case insensitive)
1098
+ * @param {String} opts.firstChar If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
1097
1099
  * @param {Number} opts.start Pagination start (default to 0)
1098
1100
  * @param {Number} opts.limit Items shown per page
1099
1101
  * @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
@@ -1107,6 +1109,73 @@ var PersonsApi = /*#__PURE__*/function () {
1107
1109
  });
1108
1110
  }
1109
1111
 
1112
+ /**
1113
+ * Get all persons (BETA)
1114
+ * Returns all persons. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
1115
+ * @param {Object} opts Optional parameters
1116
+ * @param {String} opts.cursor For pagination, the marker (an opaque string value) representing the first item on the next page
1117
+ * @param {Number} opts.limit For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
1118
+ * @param {String} opts.since The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
1119
+ * @param {String} opts.until The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
1120
+ * @param {Number} opts.ownerId If supplied, only persons owned by the given user will be returned
1121
+ * @param {String} opts.firstChar If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
1122
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InlineResponse2002} and HTTP response
1123
+ */
1124
+ }, {
1125
+ key: "getPersonsCollectionWithHttpInfo",
1126
+ value: function getPersonsCollectionWithHttpInfo(opts) {
1127
+ opts = opts || {};
1128
+ var postBody = null;
1129
+ var pathParams = {};
1130
+ var queryParams = {
1131
+ 'cursor': opts['cursor'] === undefined ? opts['cursor'] : opts['cursor'],
1132
+ 'limit': opts['limit'] === undefined ? opts['limit'] : opts['limit'],
1133
+ 'since': opts['since'] === undefined ? opts['since'] : opts['since'],
1134
+ 'until': opts['until'] === undefined ? opts['until'] : opts['until'],
1135
+ 'owner_id': opts['owner_id'] === undefined ? opts['ownerId'] : opts['owner_id'],
1136
+ 'first_char': opts['first_char'] === undefined ? opts['firstChar'] : opts['first_char']
1137
+ };
1138
+ var headerParams = {};
1139
+ var formParams = {};
1140
+ var formParamArray = [];
1141
+ var contentTypes = [];
1142
+ var isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
1143
+ var isJSON = contentTypes.includes('application/json');
1144
+ if (isJSON) {
1145
+ postBody = _objectSpread(_objectSpread({}, postBody), opts);
1146
+ } else if (isURLEncoded) {
1147
+ for (var key in opts) {
1148
+ if (opts.hasOwnProperty(key) && !formParamArray.includes(key)) {
1149
+ formParams[key] = opts[key];
1150
+ }
1151
+ }
1152
+ }
1153
+ var authNames = ['api_key', 'oauth2'];
1154
+ var accepts = ['application/json'];
1155
+ var returnType = _InlineResponse["default"];
1156
+ return this.apiClient.callApi('/persons/collection', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
1157
+ }
1158
+
1159
+ /**
1160
+ * Get all persons (BETA)
1161
+ * Returns all persons. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
1162
+ * @param {Object} opts Optional parameters
1163
+ * @param {String} opts.cursor For pagination, the marker (an opaque string value) representing the first item on the next page
1164
+ * @param {Number} opts.limit For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
1165
+ * @param {String} opts.since The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
1166
+ * @param {String} opts.until The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
1167
+ * @param {Number} opts.ownerId If supplied, only persons owned by the given user will be returned
1168
+ * @param {String} opts.firstChar If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
1169
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InlineResponse2002}
1170
+ */
1171
+ }, {
1172
+ key: "getPersonsCollection",
1173
+ value: function getPersonsCollection(opts) {
1174
+ return this.getPersonsCollectionWithHttpInfo(opts).then(function (response_and_data) {
1175
+ return response_and_data;
1176
+ });
1177
+ }
1178
+
1110
1179
  /**
1111
1180
  * Merge two persons
1112
1181
  * Merges a person with another person. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-persons\" target=\"_blank\" rel=\"noopener noreferrer\">merging two persons</a>.
@@ -588,7 +588,7 @@ var ProductsApi = /*#__PURE__*/function () {
588
588
  * @param {Number} opts.userId If supplied, only products owned by the given user will be returned
589
589
  * @param {Number} opts.filterId The ID of the filter to use
590
590
  * @param {Array.<Number>} opts.ids An array of integers with the IDs of the products that should be returned in the response
591
- * @param {String} opts.firstChar If supplied, only products whose name starts with the specified letter will be returned (case insensitive)
591
+ * @param {String} opts.firstChar If supplied, only products whose name starts with the specified letter will be returned (case-insensitive)
592
592
  * @param {Boolean} opts.getSummary If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property
593
593
  * @param {Number} opts.start Pagination start (default to 0)
594
594
  * @param {Number} opts.limit Items shown per page
@@ -637,7 +637,7 @@ var ProductsApi = /*#__PURE__*/function () {
637
637
  * @param {Number} opts.userId If supplied, only products owned by the given user will be returned
638
638
  * @param {Number} opts.filterId The ID of the filter to use
639
639
  * @param {Array.<Number>} opts.ids An array of integers with the IDs of the products that should be returned in the response
640
- * @param {String} opts.firstChar If supplied, only products whose name starts with the specified letter will be returned (case insensitive)
640
+ * @param {String} opts.firstChar If supplied, only products whose name starts with the specified letter will be returned (case-insensitive)
641
641
  * @param {Boolean} opts.getSummary If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property
642
642
  * @param {Number} opts.start Pagination start (default to 0)
643
643
  * @param {Number} opts.limit Items shown per page
package/dist/index.js CHANGED
@@ -2266,18 +2266,30 @@ Object.defineProperty(exports, "InlineResponse200", {
2266
2266
  return _InlineResponse["default"];
2267
2267
  }
2268
2268
  });
2269
- Object.defineProperty(exports, "InlineResponse400", {
2269
+ Object.defineProperty(exports, "InlineResponse2001", {
2270
2270
  enumerable: true,
2271
2271
  get: function get() {
2272
2272
  return _InlineResponse2["default"];
2273
2273
  }
2274
2274
  });
2275
- Object.defineProperty(exports, "InlineResponse4001", {
2275
+ Object.defineProperty(exports, "InlineResponse2002", {
2276
2276
  enumerable: true,
2277
2277
  get: function get() {
2278
2278
  return _InlineResponse3["default"];
2279
2279
  }
2280
2280
  });
2281
+ Object.defineProperty(exports, "InlineResponse400", {
2282
+ enumerable: true,
2283
+ get: function get() {
2284
+ return _InlineResponse4["default"];
2285
+ }
2286
+ });
2287
+ Object.defineProperty(exports, "InlineResponse4001", {
2288
+ enumerable: true,
2289
+ get: function get() {
2290
+ return _InlineResponse5["default"];
2291
+ }
2292
+ });
2281
2293
  Object.defineProperty(exports, "InlineResponse4001AdditionalData", {
2282
2294
  enumerable: true,
2283
2295
  get: function get() {
@@ -2293,13 +2305,13 @@ Object.defineProperty(exports, "InlineResponse400AdditionalData", {
2293
2305
  Object.defineProperty(exports, "InlineResponse403", {
2294
2306
  enumerable: true,
2295
2307
  get: function get() {
2296
- return _InlineResponse4["default"];
2308
+ return _InlineResponse6["default"];
2297
2309
  }
2298
2310
  });
2299
2311
  Object.defineProperty(exports, "InlineResponse4031", {
2300
2312
  enumerable: true,
2301
2313
  get: function get() {
2302
- return _InlineResponse5["default"];
2314
+ return _InlineResponse7["default"];
2303
2315
  }
2304
2316
  });
2305
2317
  Object.defineProperty(exports, "InlineResponse4031AdditionalData", {
@@ -2317,7 +2329,7 @@ Object.defineProperty(exports, "InlineResponse403AdditionalData", {
2317
2329
  Object.defineProperty(exports, "InlineResponse404", {
2318
2330
  enumerable: true,
2319
2331
  get: function get() {
2320
- return _InlineResponse6["default"];
2332
+ return _InlineResponse8["default"];
2321
2333
  }
2322
2334
  });
2323
2335
  Object.defineProperty(exports, "InlineResponse404AdditionalData", {
@@ -2908,10 +2920,10 @@ Object.defineProperty(exports, "NewDeal", {
2908
2920
  return _NewDeal["default"];
2909
2921
  }
2910
2922
  });
2911
- Object.defineProperty(exports, "NewDealAllOf", {
2923
+ Object.defineProperty(exports, "NewDealParameters", {
2912
2924
  enumerable: true,
2913
2925
  get: function get() {
2914
- return _NewDealAllOf["default"];
2926
+ return _NewDealParameters["default"];
2915
2927
  }
2916
2928
  });
2917
2929
  Object.defineProperty(exports, "NewDealProduct", {
@@ -3364,6 +3376,18 @@ Object.defineProperty(exports, "OrganizationsApi", {
3364
3376
  return _OrganizationsApi["default"];
3365
3377
  }
3366
3378
  });
3379
+ Object.defineProperty(exports, "OrganizationsCollectionResponseObject", {
3380
+ enumerable: true,
3381
+ get: function get() {
3382
+ return _OrganizationsCollectionResponseObject["default"];
3383
+ }
3384
+ });
3385
+ Object.defineProperty(exports, "OrganizationsCollectionResponseObjectAllOf", {
3386
+ enumerable: true,
3387
+ get: function get() {
3388
+ return _OrganizationsCollectionResponseObjectAllOf["default"];
3389
+ }
3390
+ });
3367
3391
  Object.defineProperty(exports, "OrganizationsDeleteResponse", {
3368
3392
  enumerable: true,
3369
3393
  get: function get() {
@@ -3622,6 +3646,12 @@ Object.defineProperty(exports, "PersonsApi", {
3622
3646
  return _PersonsApi["default"];
3623
3647
  }
3624
3648
  });
3649
+ Object.defineProperty(exports, "PersonsCollectionResponseObject", {
3650
+ enumerable: true,
3651
+ get: function get() {
3652
+ return _PersonsCollectionResponseObject["default"];
3653
+ }
3654
+ });
3625
3655
  Object.defineProperty(exports, "PictureData", {
3626
3656
  enumerable: true,
3627
3657
  get: function get() {
@@ -4294,6 +4324,12 @@ Object.defineProperty(exports, "UpdateActivityResponse200", {
4294
4324
  return _UpdateActivityResponse["default"];
4295
4325
  }
4296
4326
  });
4327
+ Object.defineProperty(exports, "UpdateDealParameters", {
4328
+ enumerable: true,
4329
+ get: function get() {
4330
+ return _UpdateDealParameters["default"];
4331
+ }
4332
+ });
4297
4333
  Object.defineProperty(exports, "UpdateDealProduct", {
4298
4334
  enumerable: true,
4299
4335
  get: function get() {
@@ -4995,15 +5031,17 @@ var _GoalType = _interopRequireDefault(require("./model/GoalType"));
4995
5031
  var _GoalsResponseComponent = _interopRequireDefault(require("./model/GoalsResponseComponent"));
4996
5032
  var _IconKey = _interopRequireDefault(require("./model/IconKey"));
4997
5033
  var _InlineResponse = _interopRequireDefault(require("./model/InlineResponse200"));
4998
- var _InlineResponse2 = _interopRequireDefault(require("./model/InlineResponse400"));
4999
- var _InlineResponse3 = _interopRequireDefault(require("./model/InlineResponse4001"));
5034
+ var _InlineResponse2 = _interopRequireDefault(require("./model/InlineResponse2001"));
5035
+ var _InlineResponse3 = _interopRequireDefault(require("./model/InlineResponse2002"));
5036
+ var _InlineResponse4 = _interopRequireDefault(require("./model/InlineResponse400"));
5037
+ var _InlineResponse5 = _interopRequireDefault(require("./model/InlineResponse4001"));
5000
5038
  var _InlineResponse4001AdditionalData = _interopRequireDefault(require("./model/InlineResponse4001AdditionalData"));
5001
5039
  var _InlineResponse400AdditionalData = _interopRequireDefault(require("./model/InlineResponse400AdditionalData"));
5002
- var _InlineResponse4 = _interopRequireDefault(require("./model/InlineResponse403"));
5003
- var _InlineResponse5 = _interopRequireDefault(require("./model/InlineResponse4031"));
5040
+ var _InlineResponse6 = _interopRequireDefault(require("./model/InlineResponse403"));
5041
+ var _InlineResponse7 = _interopRequireDefault(require("./model/InlineResponse4031"));
5004
5042
  var _InlineResponse4031AdditionalData = _interopRequireDefault(require("./model/InlineResponse4031AdditionalData"));
5005
5043
  var _InlineResponse403AdditionalData = _interopRequireDefault(require("./model/InlineResponse403AdditionalData"));
5006
- var _InlineResponse6 = _interopRequireDefault(require("./model/InlineResponse404"));
5044
+ var _InlineResponse8 = _interopRequireDefault(require("./model/InlineResponse404"));
5007
5045
  var _InlineResponse404AdditionalData = _interopRequireDefault(require("./model/InlineResponse404AdditionalData"));
5008
5046
  var _ItemSearchAdditionalData = _interopRequireDefault(require("./model/ItemSearchAdditionalData"));
5009
5047
  var _ItemSearchAdditionalDataPagination = _interopRequireDefault(require("./model/ItemSearchAdditionalDataPagination"));
@@ -5096,7 +5134,7 @@ var _MergePersonsResponseAllOf = _interopRequireDefault(require("./model/MergePe
5096
5134
  var _MessageObject = _interopRequireDefault(require("./model/MessageObject"));
5097
5135
  var _MessageObjectAttachments = _interopRequireDefault(require("./model/MessageObjectAttachments"));
5098
5136
  var _NewDeal = _interopRequireDefault(require("./model/NewDeal"));
5099
- var _NewDealAllOf = _interopRequireDefault(require("./model/NewDealAllOf"));
5137
+ var _NewDealParameters = _interopRequireDefault(require("./model/NewDealParameters"));
5100
5138
  var _NewDealProduct = _interopRequireDefault(require("./model/NewDealProduct"));
5101
5139
  var _NewFollowerResponse = _interopRequireDefault(require("./model/NewFollowerResponse"));
5102
5140
  var _NewFollowerResponseData = _interopRequireDefault(require("./model/NewFollowerResponseData"));
@@ -5167,6 +5205,8 @@ var _OrganizationSearchResponseAllOf = _interopRequireDefault(require("./model/O
5167
5205
  var _OrganizationSearchResponseAllOfData = _interopRequireDefault(require("./model/OrganizationSearchResponseAllOfData"));
5168
5206
  var _OrganizationUpdateResponse = _interopRequireDefault(require("./model/OrganizationUpdateResponse"));
5169
5207
  var _OrganizationUpdateResponseAllOf = _interopRequireDefault(require("./model/OrganizationUpdateResponseAllOf"));
5208
+ var _OrganizationsCollectionResponseObject = _interopRequireDefault(require("./model/OrganizationsCollectionResponseObject"));
5209
+ var _OrganizationsCollectionResponseObjectAllOf = _interopRequireDefault(require("./model/OrganizationsCollectionResponseObjectAllOf"));
5170
5210
  var _OrganizationsDeleteResponse = _interopRequireDefault(require("./model/OrganizationsDeleteResponse"));
5171
5211
  var _OrganizationsDeleteResponseData = _interopRequireDefault(require("./model/OrganizationsDeleteResponseData"));
5172
5212
  var _OrganizationsMergeResponse = _interopRequireDefault(require("./model/OrganizationsMergeResponse"));
@@ -5207,6 +5247,7 @@ var _PersonSearchItemItemOwner = _interopRequireDefault(require("./model/PersonS
5207
5247
  var _PersonSearchResponse = _interopRequireDefault(require("./model/PersonSearchResponse"));
5208
5248
  var _PersonSearchResponseAllOf = _interopRequireDefault(require("./model/PersonSearchResponseAllOf"));
5209
5249
  var _PersonSearchResponseAllOfData = _interopRequireDefault(require("./model/PersonSearchResponseAllOfData"));
5250
+ var _PersonsCollectionResponseObject = _interopRequireDefault(require("./model/PersonsCollectionResponseObject"));
5210
5251
  var _PictureData = _interopRequireDefault(require("./model/PictureData"));
5211
5252
  var _PictureDataPictures = _interopRequireDefault(require("./model/PictureDataPictures"));
5212
5253
  var _PictureDataWithID = _interopRequireDefault(require("./model/PictureDataWithID"));
@@ -5312,6 +5353,7 @@ var _Teams = _interopRequireDefault(require("./model/Teams"));
5312
5353
  var _TeamsAllOf = _interopRequireDefault(require("./model/TeamsAllOf"));
5313
5354
  var _Unauthorized = _interopRequireDefault(require("./model/Unauthorized"));
5314
5355
  var _UpdateActivityResponse = _interopRequireDefault(require("./model/UpdateActivityResponse200"));
5356
+ var _UpdateDealParameters = _interopRequireDefault(require("./model/UpdateDealParameters"));
5315
5357
  var _UpdateDealProduct = _interopRequireDefault(require("./model/UpdateDealProduct"));
5316
5358
  var _UpdateDealRequest = _interopRequireDefault(require("./model/UpdateDealRequest"));
5317
5359
  var _UpdateFile = _interopRequireDefault(require("./model/UpdateFile"));
@@ -324,7 +324,7 @@ BaseOrganizationItem.prototype['update_time'] = undefined;
324
324
  BaseOrganizationItem.prototype['visible_to'] = undefined;
325
325
 
326
326
  /**
327
- * The ID of the label
327
+ * The label assigned to the organization
328
328
  * @member {Number} label
329
329
  */
330
330
  BaseOrganizationItem.prototype['label'] = undefined;
@@ -336,7 +336,7 @@ BaseOrganizationItem.prototype['label'] = undefined;
336
336
  BaseOrganizationItem.prototype['owner_name'] = undefined;
337
337
 
338
338
  /**
339
- * The BCC email of the organization
339
+ * The BCC email associated with the organization
340
340
  * @member {String} cc_email
341
341
  */
342
342
  BaseOrganizationItem.prototype['cc_email'] = undefined;
@@ -588,7 +588,7 @@ _BaseOrganizationItemFields["default"].prototype['update_time'] = undefined;
588
588
  */
589
589
  _BaseOrganizationItemFields["default"].prototype['visible_to'] = undefined;
590
590
  /**
591
- * The ID of the label
591
+ * The label assigned to the organization
592
592
  * @member {Number} label
593
593
  */
594
594
  _BaseOrganizationItemFields["default"].prototype['label'] = undefined;
@@ -598,7 +598,7 @@ _BaseOrganizationItemFields["default"].prototype['label'] = undefined;
598
598
  */
599
599
  _BaseOrganizationItemFields["default"].prototype['owner_name'] = undefined;
600
600
  /**
601
- * The BCC email of the organization
601
+ * The BCC email associated with the organization
602
602
  * @member {String} cc_email
603
603
  */
604
604
  _BaseOrganizationItemFields["default"].prototype['cc_email'] = undefined;
@@ -188,7 +188,7 @@ BaseOrganizationItemFields.prototype['update_time'] = undefined;
188
188
  BaseOrganizationItemFields.prototype['visible_to'] = undefined;
189
189
 
190
190
  /**
191
- * The ID of the label
191
+ * The label assigned to the organization
192
192
  * @member {Number} label
193
193
  */
194
194
  BaseOrganizationItemFields.prototype['label'] = undefined;
@@ -200,7 +200,7 @@ BaseOrganizationItemFields.prototype['label'] = undefined;
200
200
  BaseOrganizationItemFields.prototype['owner_name'] = undefined;
201
201
 
202
202
  /**
203
- * The BCC email of the organization
203
+ * The BCC email associated with the organization
204
204
  * @member {String} cc_email
205
205
  */
206
206
  BaseOrganizationItemFields.prototype['cc_email'] = undefined;
@@ -328,7 +328,7 @@ BaseOrganizationItemWithEditNameFlag.prototype['update_time'] = undefined;
328
328
  BaseOrganizationItemWithEditNameFlag.prototype['visible_to'] = undefined;
329
329
 
330
330
  /**
331
- * The ID of the label
331
+ * The label assigned to the organization
332
332
  * @member {Number} label
333
333
  */
334
334
  BaseOrganizationItemWithEditNameFlag.prototype['label'] = undefined;
@@ -340,7 +340,7 @@ BaseOrganizationItemWithEditNameFlag.prototype['label'] = undefined;
340
340
  BaseOrganizationItemWithEditNameFlag.prototype['owner_name'] = undefined;
341
341
 
342
342
  /**
343
- * The BCC email of the organization
343
+ * The BCC email associated with the organization
344
344
  * @member {String} cc_email
345
345
  */
346
346
  BaseOrganizationItemWithEditNameFlag.prototype['cc_email'] = undefined;
@@ -598,7 +598,7 @@ _BaseOrganizationItem["default"].prototype['update_time'] = undefined;
598
598
  */
599
599
  _BaseOrganizationItem["default"].prototype['visible_to'] = undefined;
600
600
  /**
601
- * The ID of the label
601
+ * The label assigned to the organization
602
602
  * @member {Number} label
603
603
  */
604
604
  _BaseOrganizationItem["default"].prototype['label'] = undefined;
@@ -608,7 +608,7 @@ _BaseOrganizationItem["default"].prototype['label'] = undefined;
608
608
  */
609
609
  _BaseOrganizationItem["default"].prototype['owner_name'] = undefined;
610
610
  /**
611
- * The BCC email of the organization
611
+ * The BCC email associated with the organization
612
612
  * @member {String} cc_email
613
613
  */
614
614
  _BaseOrganizationItem["default"].prototype['cc_email'] = undefined;