pipedrive 22.3.1-rc.3 → 22.3.1-rc.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (46) hide show
  1. package/CHANGELOG.md +29 -3
  2. package/README.md +29 -24
  3. package/base.ts +26 -21
  4. package/configuration.ts +17 -5
  5. package/dist/base.d.ts +5 -2
  6. package/dist/base.js +22 -17
  7. package/dist/configuration.d.ts +1 -0
  8. package/dist/configuration.js +14 -4
  9. package/dist/esm/base.d.ts +5 -2
  10. package/dist/esm/base.js +19 -17
  11. package/dist/esm/configuration.d.ts +1 -0
  12. package/dist/esm/configuration.js +15 -5
  13. package/docs/ActivityTypeObjectResponse.md +2 -2
  14. package/docs/AddWebhookRequest.md +1 -1
  15. package/docs/BaseUser.md +1 -0
  16. package/docs/BaseUserMe.md +1 -0
  17. package/docs/BasicDeal.md +3 -0
  18. package/docs/ChangelogResponse.md +11 -0
  19. package/docs/ChangelogResponseAllOf.md +10 -0
  20. package/docs/ChangelogResponseAllOfData.md +16 -0
  21. package/docs/DealParticipantsChangelog.md +12 -0
  22. package/docs/DealsApi.md +120 -0
  23. package/docs/Field.md +3 -2
  24. package/docs/ListPermittedUsersResponse.md +0 -1
  25. package/docs/NewDeal.md +3 -0
  26. package/docs/OrganizationsApi.md +60 -0
  27. package/docs/ParticipantsChangelog.md +11 -0
  28. package/docs/ParticipantsChangelogItem.md +12 -0
  29. package/docs/PaymentItem.md +2 -2
  30. package/docs/PersonsApi.md +60 -0
  31. package/docs/ProductField.md +1 -0
  32. package/docs/ProductFieldAllOf.md +1 -0
  33. package/docs/SubscriptionItem.md +2 -2
  34. package/docs/UpdateDealRequest.md +3 -0
  35. package/migration.md +309 -0
  36. package/package.json +1 -1
  37. package/test/functional/authorisation.test.js +22 -31
  38. package/test/functional/automatic-token-refresh.test.js +7 -6
  39. package/test/functional/utils.js +0 -1
  40. package/src/api/MeetingsApi.js +0 -181
  41. package/src/model/GetDealRelatedObjects.js +0 -101
  42. package/src/model/PostDealParticipantsRelatedObjects.js +0 -90
  43. package/src/model/UserProviderLinkCreateRequest.js +0 -120
  44. package/src/model/UserProviderLinkErrorResponse.js +0 -90
  45. package/src/model/UserProviderLinkSuccessResponse.js +0 -90
  46. package/src/model/UserProviderLinkSuccessResponseData.js +0 -79
package/docs/BaseUser.md CHANGED
@@ -23,5 +23,6 @@ Name | Type | Description | Notes
23
23
  **roleId** | **Number** | The ID of the user role | [optional]
24
24
  **iconUrl** | **String** | The user icon URL | [optional]
25
25
  **isYou** | **Boolean** | Boolean that indicates if the requested user is the same which is logged in (in this case, always true) | [optional]
26
+ **isDeleted** | **Boolean** | Boolean that indicates whether the user is deleted from the company | [optional]
26
27
 
27
28
 
@@ -23,6 +23,7 @@ Name | Type | Description | Notes
23
23
  **roleId** | **Number** | The ID of the user role | [optional]
24
24
  **iconUrl** | **String** | The user icon URL | [optional]
25
25
  **isYou** | **Boolean** | Boolean that indicates if the requested user is the same which is logged in (in this case, always true) | [optional]
26
+ **isDeleted** | **Boolean** | Boolean that indicates whether the user is deleted from the company | [optional]
26
27
  **companyId** | **Number** | The user company ID | [optional]
27
28
  **companyName** | **String** | The user company name | [optional]
28
29
  **companyDomain** | **String** | The user company domain | [optional]
package/docs/BasicDeal.md CHANGED
@@ -4,6 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
+ **wonTime** | **String** | The optional date and time of changing the deal status as won in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Won. Can not be used together with `lost_time`. | [optional]
8
+ **lostTime** | **String** | The optional date and time of changing the deal status as lost in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Lost. Can not be used together with `won_time`. | [optional]
9
+ **closeTime** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional]
7
10
  **expectedCloseDate** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional]
8
11
  **probability** | **Number** | The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled. | [optional]
9
12
  **lostReason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional]
@@ -0,0 +1,11 @@
1
+ # Pipedrive.ChangelogResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **success** | **Boolean** | If the response is successful or not | [optional]
8
+ **data** | [**[ChangelogResponseAllOfData]**](ChangelogResponseAllOfData.md) | | [optional]
9
+ **additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # Pipedrive.ChangelogResponseAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **data** | [**[ChangelogResponseAllOfData]**](ChangelogResponseAllOfData.md) | | [optional]
8
+ **additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional]
9
+
10
+
@@ -0,0 +1,16 @@
1
+ # Pipedrive.ChangelogResponseAllOfData
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **fieldKey** | **String** | The key of the field that was changed | [optional]
8
+ **oldValue** | **String** | The value of the field before the change | [optional]
9
+ **newValue** | **String** | The value of the field after the change | [optional]
10
+ **actorUserId** | **Number** | The ID of the user who made the change | [optional]
11
+ **time** | **String** | The date and time of the change | [optional]
12
+ **changeSource** | **String** | The source of change, for example 'app', 'mobile', 'api', etc. | [optional]
13
+ **changeSourceUserAgent** | **String** | The user agent from which the change was made | [optional]
14
+ **isBulkUpdateFlag** | **Boolean** | Whether the change was made as part of a bulk update | [optional]
15
+
16
+
@@ -0,0 +1,12 @@
1
+ # Pipedrive.DealParticipantsChangelog
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **actorUserId** | **Number** | The ID of the user | [optional]
8
+ **personId** | **Number** | The ID of the person | [optional]
9
+ **action** | **String** | Deal participant action type | [optional]
10
+ **time** | **String** | The deal participant action log time | [optional]
11
+
12
+
package/docs/DealsApi.md CHANGED
@@ -16,10 +16,12 @@ Method | HTTP request | Description
16
16
  [**duplicateDeal**](DealsApi.md#duplicateDeal) | **POST** /deals/{id}/duplicate | Duplicate deal
17
17
  [**getDeal**](DealsApi.md#getDeal) | **GET** /deals/{id} | Get details of a deal
18
18
  [**getDealActivities**](DealsApi.md#getDealActivities) | **GET** /deals/{id}/activities | List activities associated with a deal
19
+ [**getDealChangelog**](DealsApi.md#getDealChangelog) | **GET** /deals/{id}/changelog | List updates about deal field values
19
20
  [**getDealFiles**](DealsApi.md#getDealFiles) | **GET** /deals/{id}/files | List files attached to a deal
20
21
  [**getDealFollowers**](DealsApi.md#getDealFollowers) | **GET** /deals/{id}/followers | List followers of a deal
21
22
  [**getDealMailMessages**](DealsApi.md#getDealMailMessages) | **GET** /deals/{id}/mailMessages | List mail messages associated with a deal
22
23
  [**getDealParticipants**](DealsApi.md#getDealParticipants) | **GET** /deals/{id}/participants | List participants of a deal
24
+ [**getDealParticipantsChangelog**](DealsApi.md#getDealParticipantsChangelog) | **GET** /deals/{id}/participantsChangelog | List updates about participants of a deal
23
25
  [**getDealPersons**](DealsApi.md#getDealPersons) | **GET** /deals/{id}/persons | List all persons associated with a deal
24
26
  [**getDealProducts**](DealsApi.md#getDealProducts) | **GET** /deals/{id}/products | List products attached to a deal
25
27
  [**getDealUpdates**](DealsApi.md#getDealUpdates) | **GET** /deals/{id}/flow | List updates about a deal
@@ -701,6 +703,65 @@ Name | Type | Description | Notes
701
703
  - **Accept**: application/json
702
704
 
703
705
 
706
+ ## getDealChangelog
707
+
708
+ > ChangelogResponse getDealChangelog(id, opts)
709
+
710
+ List updates about deal field values
711
+
712
+ Lists updates about field values of a deal.
713
+
714
+ ### Example
715
+
716
+ ```javascript
717
+ import Pipedrive from 'pipedrive';
718
+ let apiClient = new Pipedrive.ApiClient();
719
+ // Configure API key authorization: api_key
720
+ let api_key = apiClient.authentications['api_key'];
721
+ api_key.apiKey = 'YOUR API KEY';
722
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
723
+ //api_key.apiKeyPrefix = 'Token';
724
+ // Configure OAuth2 access token for authorization: oauth2
725
+ let oauth2 = apiClient.authentications['oauth2'];
726
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
727
+
728
+ let apiInstance = new Pipedrive.DealsApi(apiClient);
729
+ let id = 56; // Number | The ID of the deal
730
+ let opts = {
731
+ 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page
732
+ 'limit': 56 // Number | Items shown per page
733
+ };
734
+ apiInstance.getDealChangelog(id, opts).then((data) => {
735
+ console.log('API called successfully. Returned data: ' + data);
736
+ }, (error) => {
737
+ console.error(error);
738
+ });
739
+
740
+ ```
741
+
742
+ ### Parameters
743
+
744
+
745
+ Name | Type | Description | Notes
746
+ ------------- | ------------- | ------------- | -------------
747
+ **id** | **Number**| The ID of the deal |
748
+ **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]
749
+ **limit** | **Number**| Items shown per page | [optional]
750
+
751
+ ### Return type
752
+
753
+ [**ChangelogResponse**](ChangelogResponse.md)
754
+
755
+ ### Authorization
756
+
757
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
758
+
759
+ ### HTTP request headers
760
+
761
+ - **Content-Type**: Not defined
762
+ - **Accept**: application/json
763
+
764
+
704
765
  ## getDealFiles
705
766
 
706
767
  > ListFilesResponse getDealFiles(id, opts)
@@ -933,6 +994,65 @@ Name | Type | Description | Notes
933
994
  - **Accept**: application/json
934
995
 
935
996
 
997
+ ## getDealParticipantsChangelog
998
+
999
+ > ParticipantsChangelog getDealParticipantsChangelog(id, opts)
1000
+
1001
+ List updates about participants of a deal
1002
+
1003
+ List updates about participants of a deal. This is a cursor-paginated endpoint. 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>.
1004
+
1005
+ ### Example
1006
+
1007
+ ```javascript
1008
+ import Pipedrive from 'pipedrive';
1009
+ let apiClient = new Pipedrive.ApiClient();
1010
+ // Configure API key authorization: api_key
1011
+ let api_key = apiClient.authentications['api_key'];
1012
+ api_key.apiKey = 'YOUR API KEY';
1013
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1014
+ //api_key.apiKeyPrefix = 'Token';
1015
+ // Configure OAuth2 access token for authorization: oauth2
1016
+ let oauth2 = apiClient.authentications['oauth2'];
1017
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
1018
+
1019
+ let apiInstance = new Pipedrive.DealsApi(apiClient);
1020
+ let id = 56; // Number | The ID of the deal
1021
+ let opts = {
1022
+ 'limit': 56, // Number | Items shown per page
1023
+ 'cursor': "cursor_example" // String | For pagination, the marker (an opaque string value) representing the first item on the next page
1024
+ };
1025
+ apiInstance.getDealParticipantsChangelog(id, opts).then((data) => {
1026
+ console.log('API called successfully. Returned data: ' + data);
1027
+ }, (error) => {
1028
+ console.error(error);
1029
+ });
1030
+
1031
+ ```
1032
+
1033
+ ### Parameters
1034
+
1035
+
1036
+ Name | Type | Description | Notes
1037
+ ------------- | ------------- | ------------- | -------------
1038
+ **id** | **Number**| The ID of the deal |
1039
+ **limit** | **Number**| Items shown per page | [optional]
1040
+ **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]
1041
+
1042
+ ### Return type
1043
+
1044
+ [**ParticipantsChangelog**](ParticipantsChangelog.md)
1045
+
1046
+ ### Authorization
1047
+
1048
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
1049
+
1050
+ ### HTTP request headers
1051
+
1052
+ - **Content-Type**: Not defined
1053
+ - **Accept**: application/json
1054
+
1055
+
936
1056
  ## getDealPersons
937
1057
 
938
1058
  > ListPersonsResponse getDealPersons(id, opts)
package/docs/Field.md CHANGED
@@ -9,9 +9,10 @@ Name | Type | Description | Notes
9
9
  **name** | **String** | The name of the field | [optional]
10
10
  **orderNr** | **Number** | The order number of the field | [optional]
11
11
  **fieldType** | [**FieldTypeAsString**](FieldTypeAsString.md) | | [optional]
12
- **addTime** | **String** | The creation time of the field | [optional]
13
- **updateTime** | **String** | The update time of the field | [optional]
12
+ **addTime** | **Date** | The creation time of the field | [optional]
13
+ **updateTime** | **Date** | The update time of the field | [optional]
14
14
  **lastUpdatedByUserId** | **Number** | The ID of the user who created or most recently updated the field, only applicable for custom fields | [optional]
15
+ **createdByUserId** | **Number** | The ID of the user who created the field | [optional]
15
16
  **activeFlag** | **Boolean** | The active flag of the field | [optional]
16
17
  **editFlag** | **Boolean** | The edit flag of the field | [optional]
17
18
  **indexVisibleFlag** | **Boolean** | Not used | [optional]
@@ -5,6 +5,5 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **success** | **Boolean** | If the response is successful or not | [optional]
8
- **data** | [**ListPermittedUsersResponseAllOfData**](ListPermittedUsersResponseAllOfData.md) | | [optional]
9
8
 
10
9
 
package/docs/NewDeal.md CHANGED
@@ -15,6 +15,9 @@ Name | Type | Description | Notes
15
15
  **stageId** | **Number** | The ID of the stage this deal will be added to. Please note that a pipeline will be assigned automatically based on the `stage_id`. If omitted, the deal will be placed in the first stage of the default pipeline. | [optional]
16
16
  **status** | **String** | open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open. | [optional]
17
17
  **addTime** | **String** | The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional]
18
+ **wonTime** | **String** | The optional date and time of changing the deal status as won in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Won. Can not be used together with `lost_time`. | [optional]
19
+ **lostTime** | **String** | The optional date and time of changing the deal status as lost in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Lost. Can not be used together with `won_time`. | [optional]
20
+ **closeTime** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional]
18
21
  **expectedCloseDate** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional]
19
22
  **probability** | **Number** | The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled. | [optional]
20
23
  **lostReason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional]
@@ -11,6 +11,7 @@ Method | HTTP request | Description
11
11
  [**deleteOrganizations**](OrganizationsApi.md#deleteOrganizations) | **DELETE** /organizations | Delete multiple organizations in bulk
12
12
  [**getOrganization**](OrganizationsApi.md#getOrganization) | **GET** /organizations/{id} | Get details of an organization
13
13
  [**getOrganizationActivities**](OrganizationsApi.md#getOrganizationActivities) | **GET** /organizations/{id}/activities | List activities associated with an organization
14
+ [**getOrganizationChangelog**](OrganizationsApi.md#getOrganizationChangelog) | **GET** /organizations/{id}/changelog | List updates about organization field values
14
15
  [**getOrganizationDeals**](OrganizationsApi.md#getOrganizationDeals) | **GET** /organizations/{id}/deals | List deals associated with an organization
15
16
  [**getOrganizationFiles**](OrganizationsApi.md#getOrganizationFiles) | **GET** /organizations/{id}/files | List files attached to an organization
16
17
  [**getOrganizationFollowers**](OrganizationsApi.md#getOrganizationFollowers) | **GET** /organizations/{id}/followers | List followers of an organization
@@ -415,6 +416,65 @@ Name | Type | Description | Notes
415
416
  - **Accept**: application/json
416
417
 
417
418
 
419
+ ## getOrganizationChangelog
420
+
421
+ > ChangelogResponse getOrganizationChangelog(id, opts)
422
+
423
+ List updates about organization field values
424
+
425
+ Lists updates about field values of an organization.
426
+
427
+ ### Example
428
+
429
+ ```javascript
430
+ import Pipedrive from 'pipedrive';
431
+ let apiClient = new Pipedrive.ApiClient();
432
+ // Configure API key authorization: api_key
433
+ let api_key = apiClient.authentications['api_key'];
434
+ api_key.apiKey = 'YOUR API KEY';
435
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
436
+ //api_key.apiKeyPrefix = 'Token';
437
+ // Configure OAuth2 access token for authorization: oauth2
438
+ let oauth2 = apiClient.authentications['oauth2'];
439
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
440
+
441
+ let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
442
+ let id = 56; // Number | The ID of the organization
443
+ let opts = {
444
+ 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page
445
+ 'limit': 56 // Number | Items shown per page
446
+ };
447
+ apiInstance.getOrganizationChangelog(id, opts).then((data) => {
448
+ console.log('API called successfully. Returned data: ' + data);
449
+ }, (error) => {
450
+ console.error(error);
451
+ });
452
+
453
+ ```
454
+
455
+ ### Parameters
456
+
457
+
458
+ Name | Type | Description | Notes
459
+ ------------- | ------------- | ------------- | -------------
460
+ **id** | **Number**| The ID of the organization |
461
+ **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]
462
+ **limit** | **Number**| Items shown per page | [optional]
463
+
464
+ ### Return type
465
+
466
+ [**ChangelogResponse**](ChangelogResponse.md)
467
+
468
+ ### Authorization
469
+
470
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
471
+
472
+ ### HTTP request headers
473
+
474
+ - **Content-Type**: Not defined
475
+ - **Accept**: application/json
476
+
477
+
418
478
  ## getOrganizationDeals
419
479
 
420
480
  > ListDealsResponse getOrganizationDeals(id, opts)
@@ -0,0 +1,11 @@
1
+ # Pipedrive.ParticipantsChangelog
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **success** | **Boolean** | If the request was successful or not | [optional]
8
+ **data** | [**[ParticipantsChangelogItem]**](ParticipantsChangelogItem.md) | The array of participant changelog | [optional]
9
+ **additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional]
10
+
11
+
@@ -0,0 +1,12 @@
1
+ # Pipedrive.ParticipantsChangelogItem
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **actorUserId** | **Number** | The ID of the user | [optional]
8
+ **personId** | **Number** | The ID of the person | [optional]
9
+ **action** | **String** | Deal participant action type | [optional]
10
+ **time** | **String** | The deal participant action log time | [optional]
11
+
12
+
@@ -15,8 +15,8 @@ Name | Type | Description | Notes
15
15
  **revenueMovementType** | **String** | Represents the movement of revenue in comparison with the previous payment. Possible values are: `New` - first payment of the subscription. `Recurring` - no movement. `Expansion` - current payment amount > previous payment amount. `Contraction` - current payment amount < previous payment amount. `Churn` - last payment of the subscription. | [optional]
16
16
  **paymentType** | **String** | The type of the payment. Possible values are: `Recurring` - payments occur over fixed intervals of time, `Additional` - extra payment not the recurring payment of the recurring subscription, `Installment` - payment of the installment subscription. | [optional]
17
17
  **description** | **String** | The description of the payment | [optional]
18
- **addTime** | **String** | The creation time of the payment | [optional]
19
- **updateTime** | **String** | The update time of the payment | [optional]
18
+ **addTime** | **Date** | The creation time of the payment | [optional]
19
+ **updateTime** | **Date** | The update time of the payment | [optional]
20
20
 
21
21
 
22
22
 
@@ -13,6 +13,7 @@ Method | HTTP request | Description
13
13
  [**deletePersons**](PersonsApi.md#deletePersons) | **DELETE** /persons | Delete multiple persons in bulk
14
14
  [**getPerson**](PersonsApi.md#getPerson) | **GET** /persons/{id} | Get details of a person
15
15
  [**getPersonActivities**](PersonsApi.md#getPersonActivities) | **GET** /persons/{id}/activities | List activities associated with a person
16
+ [**getPersonChangelog**](PersonsApi.md#getPersonChangelog) | **GET** /persons/{id}/changelog | List updates about person field values
16
17
  [**getPersonDeals**](PersonsApi.md#getPersonDeals) | **GET** /persons/{id}/deals | List deals associated with a person
17
18
  [**getPersonFiles**](PersonsApi.md#getPersonFiles) | **GET** /persons/{id}/files | List files attached to a person
18
19
  [**getPersonFollowers**](PersonsApi.md#getPersonFollowers) | **GET** /persons/{id}/followers | List followers of a person
@@ -535,6 +536,65 @@ Name | Type | Description | Notes
535
536
  - **Accept**: application/json
536
537
 
537
538
 
539
+ ## getPersonChangelog
540
+
541
+ > ChangelogResponse getPersonChangelog(id, opts)
542
+
543
+ List updates about person field values
544
+
545
+ Lists updates about field values of a person.
546
+
547
+ ### Example
548
+
549
+ ```javascript
550
+ import Pipedrive from 'pipedrive';
551
+ let apiClient = new Pipedrive.ApiClient();
552
+ // Configure API key authorization: api_key
553
+ let api_key = apiClient.authentications['api_key'];
554
+ api_key.apiKey = 'YOUR API KEY';
555
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
556
+ //api_key.apiKeyPrefix = 'Token';
557
+ // Configure OAuth2 access token for authorization: oauth2
558
+ let oauth2 = apiClient.authentications['oauth2'];
559
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
560
+
561
+ let apiInstance = new Pipedrive.PersonsApi(apiClient);
562
+ let id = 56; // Number | The ID of the person
563
+ let opts = {
564
+ 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page
565
+ 'limit': 56 // Number | Items shown per page
566
+ };
567
+ apiInstance.getPersonChangelog(id, opts).then((data) => {
568
+ console.log('API called successfully. Returned data: ' + data);
569
+ }, (error) => {
570
+ console.error(error);
571
+ });
572
+
573
+ ```
574
+
575
+ ### Parameters
576
+
577
+
578
+ Name | Type | Description | Notes
579
+ ------------- | ------------- | ------------- | -------------
580
+ **id** | **Number**| The ID of the person |
581
+ **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]
582
+ **limit** | **Number**| Items shown per page | [optional]
583
+
584
+ ### Return type
585
+
586
+ [**ChangelogResponse**](ChangelogResponse.md)
587
+
588
+ ### Authorization
589
+
590
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
591
+
592
+ ### HTTP request headers
593
+
594
+ - **Content-Type**: Not defined
595
+ - **Accept**: application/json
596
+
597
+
538
598
  ## getPersonDeals
539
599
 
540
600
  > ListDealsResponse getPersonDeals(id, opts)
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
  **addTime** | **String** | The product field creation time. Format: YYYY-MM-DD HH:MM:SS | [optional]
14
14
  **updateTime** | **String** | The product field last update time. Format: YYYY-MM-DD HH:MM:SS | [optional]
15
15
  **lastUpdatedByUserId** | **Number** | The ID of the last user to update the product field | [optional]
16
+ **createdByUserId** | **Number** | The ID of the user who created the product field | [optional]
16
17
  **activeFlag** | **Boolean** | Whether or not the product field is currently active | [optional]
17
18
  **editFlag** | **Boolean** | Whether or not the product field name and metadata is editable | [optional]
18
19
  **addVisibleFlag** | **Boolean** | Whether or not the product field is visible in the Add Product Modal | [optional]
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **addTime** | **String** | The product field creation time. Format: YYYY-MM-DD HH:MM:SS | [optional]
11
11
  **updateTime** | **String** | The product field last update time. Format: YYYY-MM-DD HH:MM:SS | [optional]
12
12
  **lastUpdatedByUserId** | **Number** | The ID of the last user to update the product field | [optional]
13
+ **createdByUserId** | **Number** | The ID of the user who created the product field | [optional]
13
14
  **activeFlag** | **Boolean** | Whether or not the product field is currently active | [optional]
14
15
  **editFlag** | **Boolean** | Whether or not the product field name and metadata is editable | [optional]
15
16
  **addVisibleFlag** | **Boolean** | Whether or not the product field is visible in the Add Product Modal | [optional]
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
18
18
  **endDate** | **Date** | The end date of the subscription | [optional]
19
19
  **lifetimeValue** | **Number** | The total value of all payments | [optional]
20
20
  **finalStatus** | **String** | The final status of the subscription | [optional]
21
- **addTime** | **String** | The creation time of the subscription | [optional]
22
- **updateTime** | **String** | The update time of the subscription | [optional]
21
+ **addTime** | **Date** | The creation time of the subscription | [optional]
22
+ **updateTime** | **Date** | The update time of the subscription | [optional]
23
23
 
24
24
 
@@ -14,6 +14,9 @@ Name | Type | Description | Notes
14
14
  **pipelineId** | **Number** | The ID of the pipeline this deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that `pipeline_id` and `stage_id` should not be used together as `pipeline_id` will be ignored. | [optional]
15
15
  **stageId** | **Number** | The ID of the stage this deal will be added to. Please note that a pipeline will be assigned automatically based on the `stage_id`. | [optional]
16
16
  **status** | **String** | open = Open, won = Won, lost = Lost, deleted = Deleted. | [optional]
17
+ **wonTime** | **String** | The optional date and time of changing the deal status as won in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Won. Can not be used together with `lost_time`. | [optional]
18
+ **lostTime** | **String** | The optional date and time of changing the deal status as lost in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Lost. Can not be used together with `won_time`. | [optional]
19
+ **closeTime** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional]
17
20
  **expectedCloseDate** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional]
18
21
  **probability** | **Number** | The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled. | [optional]
19
22
  **lostReason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional]