diff --git a/CHANGELOG.md b/CHANGELOG.md index 14429b55..53b5d8a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19). ## [Unreleased] +### Added +- Added documentation for new endpoints `/deals/{id}/changelog`, `/persons/{id}/changelog` and `/organizations/{id}/changelog`. ## [22.5.0] - 2024-02-02 ### Added diff --git a/README.md b/README.md index f42788d3..e5fb65e6 100644 --- a/README.md +++ b/README.md @@ -391,6 +391,7 @@ Class | Method | HTTP request | Description *Pipedrive.DealsApi* | [**duplicateDeal**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#duplicateDeal) | **POST** /deals/{id}/duplicate | Duplicate deal *Pipedrive.DealsApi* | [**getDeal**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDeal) | **GET** /deals/{id} | Get details of a deal *Pipedrive.DealsApi* | [**getDealActivities**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDealActivities) | **GET** /deals/{id}/activities | List activities associated with a deal +*Pipedrive.DealsApi* | [**getDealChangelog**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDealChangelog) | **GET** /deals/{id}/changelog | List updates about deal field values *Pipedrive.DealsApi* | [**getDealFiles**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDealFiles) | **GET** /deals/{id}/files | List files attached to a deal *Pipedrive.DealsApi* | [**getDealFollowers**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDealFollowers) | **GET** /deals/{id}/followers | List followers of a deal *Pipedrive.DealsApi* | [**getDealMailMessages**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDealMailMessages) | **GET** /deals/{id}/mailMessages | List mail messages associated with a deal @@ -487,6 +488,7 @@ Class | Method | HTTP request | Description *Pipedrive.OrganizationsApi* | [**deleteOrganizations**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#deleteOrganizations) | **DELETE** /organizations | Delete multiple organizations in bulk *Pipedrive.OrganizationsApi* | [**getOrganization**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganization) | **GET** /organizations/{id} | Get details of an organization *Pipedrive.OrganizationsApi* | [**getOrganizationActivities**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationActivities) | **GET** /organizations/{id}/activities | List activities associated with an organization +*Pipedrive.OrganizationsApi* | [**getOrganizationChangelog**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationChangelog) | **GET** /organizations/{id}/changelog | List updates about organization field values *Pipedrive.OrganizationsApi* | [**getOrganizationDeals**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationDeals) | **GET** /organizations/{id}/deals | List deals associated with an organization *Pipedrive.OrganizationsApi* | [**getOrganizationFiles**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationFiles) | **GET** /organizations/{id}/files | List files attached to an organization *Pipedrive.OrganizationsApi* | [**getOrganizationFollowers**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationFollowers) | **GET** /organizations/{id}/followers | List followers of an organization @@ -517,6 +519,7 @@ Class | Method | HTTP request | Description *Pipedrive.PersonsApi* | [**deletePersons**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#deletePersons) | **DELETE** /persons | Delete multiple persons in bulk *Pipedrive.PersonsApi* | [**getPerson**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPerson) | **GET** /persons/{id} | Get details of a person *Pipedrive.PersonsApi* | [**getPersonActivities**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonActivities) | **GET** /persons/{id}/activities | List activities associated with a person +*Pipedrive.PersonsApi* | [**getPersonChangelog**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonChangelog) | **GET** /persons/{id}/changelog | List updates about person field values *Pipedrive.PersonsApi* | [**getPersonDeals**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonDeals) | **GET** /persons/{id}/deals | List deals associated with a person *Pipedrive.PersonsApi* | [**getPersonFiles**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonFiles) | **GET** /persons/{id}/files | List files attached to a person *Pipedrive.PersonsApi* | [**getPersonFollowers**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonFollowers) | **GET** /persons/{id}/followers | List followers of a person @@ -762,6 +765,9 @@ Class | Method | HTTP request | Description - [Pipedrive.CallLogResponse500](https://github.com/pipedrive/client-nodejs/blob/master/docs/CallLogResponse500.md) - [Pipedrive.CallLogsResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/CallLogsResponse.md) - [Pipedrive.CallLogsResponseAdditionalData](https://github.com/pipedrive/client-nodejs/blob/master/docs/CallLogsResponseAdditionalData.md) + - [Pipedrive.ChangelogResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChangelogResponse.md) + - [Pipedrive.ChangelogResponseAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChangelogResponseAllOf.md) + - [Pipedrive.ChangelogResponseAllOfData](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChangelogResponseAllOfData.md) - [Pipedrive.ChannelObject](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChannelObject.md) - [Pipedrive.ChannelObjectResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChannelObjectResponse.md) - [Pipedrive.ChannelObjectResponseData](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChannelObjectResponseData.md) diff --git a/docs/ActivityTypeObjectResponse.md b/docs/ActivityTypeObjectResponse.md index 6df68adb..ea7be796 100644 --- a/docs/ActivityTypeObjectResponse.md +++ b/docs/ActivityTypeObjectResponse.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **keyString** | **String** | A string that is generated by the API based on the given name of the activity type upon creation | [optional] **activeFlag** | **Boolean** | The active flag of the activity type | [optional] **isCustomFlag** | **Boolean** | Whether the activity type is a custom one or not | [optional] -**addTime** | **String** | The creation time of the activity type | [optional] -**updateTime** | **String** | The update time of the activity type | [optional] +**addTime** | **Date** | The creation time of the activity type | [optional] +**updateTime** | **Date** | The update time of the activity type | [optional] diff --git a/docs/ChangelogResponse.md b/docs/ChangelogResponse.md new file mode 100644 index 00000000..0b442d6e --- /dev/null +++ b/docs/ChangelogResponse.md @@ -0,0 +1,11 @@ +# Pipedrive.ChangelogResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **Boolean** | If the response is successful or not | [optional] +**data** | [**[ChangelogResponseAllOfData]**](ChangelogResponseAllOfData.md) | | [optional] +**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] + + diff --git a/docs/ChangelogResponseAllOf.md b/docs/ChangelogResponseAllOf.md new file mode 100644 index 00000000..c6a8efa1 --- /dev/null +++ b/docs/ChangelogResponseAllOf.md @@ -0,0 +1,10 @@ +# Pipedrive.ChangelogResponseAllOf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[ChangelogResponseAllOfData]**](ChangelogResponseAllOfData.md) | | [optional] +**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] + + diff --git a/docs/ChangelogResponseAllOfData.md b/docs/ChangelogResponseAllOfData.md new file mode 100644 index 00000000..da229d7d --- /dev/null +++ b/docs/ChangelogResponseAllOfData.md @@ -0,0 +1,16 @@ +# Pipedrive.ChangelogResponseAllOfData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fieldKey** | **String** | The key of the field that was changed | [optional] +**oldValue** | **String** | The value of the field before the change | [optional] +**newValue** | **String** | The value of the field after the change | [optional] +**actorUserId** | **Number** | The ID of the user who made the change | [optional] +**time** | **String** | The date and time of the change | [optional] +**changeSource** | **String** | The source of change, for example 'app', 'mobile', 'api', etc. | [optional] +**changeSourceUserAgent** | **String** | The user agent from which the change was made | [optional] +**isBulkUpdateFlag** | **Boolean** | Whether the change was made as part of a bulk update | [optional] + + diff --git a/docs/DealsApi.md b/docs/DealsApi.md index 08503ffb..2f858fdf 100644 --- a/docs/DealsApi.md +++ b/docs/DealsApi.md @@ -16,6 +16,7 @@ Method | HTTP request | Description [**duplicateDeal**](DealsApi.md#duplicateDeal) | **POST** /deals/{id}/duplicate | Duplicate deal [**getDeal**](DealsApi.md#getDeal) | **GET** /deals/{id} | Get details of a deal [**getDealActivities**](DealsApi.md#getDealActivities) | **GET** /deals/{id}/activities | List activities associated with a deal +[**getDealChangelog**](DealsApi.md#getDealChangelog) | **GET** /deals/{id}/changelog | List updates about deal field values [**getDealFiles**](DealsApi.md#getDealFiles) | **GET** /deals/{id}/files | List files attached to a deal [**getDealFollowers**](DealsApi.md#getDealFollowers) | **GET** /deals/{id}/followers | List followers of a deal [**getDealMailMessages**](DealsApi.md#getDealMailMessages) | **GET** /deals/{id}/mailMessages | List mail messages associated with a deal @@ -702,6 +703,65 @@ Name | Type | Description | Notes - **Accept**: application/json +## getDealChangelog + +> ChangelogResponse getDealChangelog(id, opts) + +List updates about deal field values + +Lists updates about field values of a deal. + +### Example + +```javascript +import Pipedrive from 'pipedrive'; +let apiClient = new Pipedrive.ApiClient(); +// Configure API key authorization: api_key +let api_key = apiClient.authentications['api_key']; +api_key.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//api_key.apiKeyPrefix = 'Token'; +// Configure OAuth2 access token for authorization: oauth2 +let oauth2 = apiClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +let apiInstance = new Pipedrive.DealsApi(apiClient); +let id = 56; // Number | The ID of the deal +let opts = { + 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page + 'limit': 56 // Number | Items shown per page +}; +apiInstance.getDealChangelog(id, opts).then((data) => { + console.log('API called successfully. Returned data: ' + data); +}, (error) => { + console.error(error); +}); + +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **Number**| The ID of the deal | + **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] + **limit** | **Number**| Items shown per page | [optional] + +### Return type + +[**ChangelogResponse**](ChangelogResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## getDealFiles > ListFilesResponse getDealFiles(id, opts) diff --git a/docs/Field.md b/docs/Field.md index 699f6946..7b8a99af 100644 --- a/docs/Field.md +++ b/docs/Field.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **name** | **String** | The name of the field | [optional] **orderNr** | **Number** | The order number of the field | [optional] **fieldType** | [**FieldTypeAsString**](FieldTypeAsString.md) | | [optional] -**addTime** | **String** | The creation time of the field | [optional] -**updateTime** | **String** | The update time of the field | [optional] +**addTime** | **Date** | The creation time of the field | [optional] +**updateTime** | **Date** | The update time of the field | [optional] **lastUpdatedByUserId** | **Number** | The ID of the user who created or most recently updated the field, only applicable for custom fields | [optional] **activeFlag** | **Boolean** | The active flag of the field | [optional] **editFlag** | **Boolean** | The edit flag of the field | [optional] diff --git a/docs/OrganizationsApi.md b/docs/OrganizationsApi.md index 8adf0035..565b181c 100644 --- a/docs/OrganizationsApi.md +++ b/docs/OrganizationsApi.md @@ -11,6 +11,7 @@ Method | HTTP request | Description [**deleteOrganizations**](OrganizationsApi.md#deleteOrganizations) | **DELETE** /organizations | Delete multiple organizations in bulk [**getOrganization**](OrganizationsApi.md#getOrganization) | **GET** /organizations/{id} | Get details of an organization [**getOrganizationActivities**](OrganizationsApi.md#getOrganizationActivities) | **GET** /organizations/{id}/activities | List activities associated with an organization +[**getOrganizationChangelog**](OrganizationsApi.md#getOrganizationChangelog) | **GET** /organizations/{id}/changelog | List updates about organization field values [**getOrganizationDeals**](OrganizationsApi.md#getOrganizationDeals) | **GET** /organizations/{id}/deals | List deals associated with an organization [**getOrganizationFiles**](OrganizationsApi.md#getOrganizationFiles) | **GET** /organizations/{id}/files | List files attached to an organization [**getOrganizationFollowers**](OrganizationsApi.md#getOrganizationFollowers) | **GET** /organizations/{id}/followers | List followers of an organization @@ -415,6 +416,65 @@ Name | Type | Description | Notes - **Accept**: application/json +## getOrganizationChangelog + +> ChangelogResponse getOrganizationChangelog(id, opts) + +List updates about organization field values + +Lists updates about field values of an organization. + +### Example + +```javascript +import Pipedrive from 'pipedrive'; +let apiClient = new Pipedrive.ApiClient(); +// Configure API key authorization: api_key +let api_key = apiClient.authentications['api_key']; +api_key.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//api_key.apiKeyPrefix = 'Token'; +// Configure OAuth2 access token for authorization: oauth2 +let oauth2 = apiClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +let apiInstance = new Pipedrive.OrganizationsApi(apiClient); +let id = 56; // Number | The ID of the organization +let opts = { + 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page + 'limit': 56 // Number | Items shown per page +}; +apiInstance.getOrganizationChangelog(id, opts).then((data) => { + console.log('API called successfully. Returned data: ' + data); +}, (error) => { + console.error(error); +}); + +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **Number**| The ID of the organization | + **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] + **limit** | **Number**| Items shown per page | [optional] + +### Return type + +[**ChangelogResponse**](ChangelogResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## getOrganizationDeals > ListDealsResponse getOrganizationDeals(id, opts) diff --git a/docs/PaymentItem.md b/docs/PaymentItem.md index 7f0d1bc2..6f5ee6a0 100644 --- a/docs/PaymentItem.md +++ b/docs/PaymentItem.md @@ -15,8 +15,8 @@ Name | Type | Description | Notes **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] **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] **description** | **String** | The description of the payment | [optional] -**addTime** | **String** | The creation time of the payment | [optional] -**updateTime** | **String** | The update time of the payment | [optional] +**addTime** | **Date** | The creation time of the payment | [optional] +**updateTime** | **Date** | The update time of the payment | [optional] diff --git a/docs/PersonsApi.md b/docs/PersonsApi.md index 919c7595..a5f19c03 100644 --- a/docs/PersonsApi.md +++ b/docs/PersonsApi.md @@ -13,6 +13,7 @@ Method | HTTP request | Description [**deletePersons**](PersonsApi.md#deletePersons) | **DELETE** /persons | Delete multiple persons in bulk [**getPerson**](PersonsApi.md#getPerson) | **GET** /persons/{id} | Get details of a person [**getPersonActivities**](PersonsApi.md#getPersonActivities) | **GET** /persons/{id}/activities | List activities associated with a person +[**getPersonChangelog**](PersonsApi.md#getPersonChangelog) | **GET** /persons/{id}/changelog | List updates about person field values [**getPersonDeals**](PersonsApi.md#getPersonDeals) | **GET** /persons/{id}/deals | List deals associated with a person [**getPersonFiles**](PersonsApi.md#getPersonFiles) | **GET** /persons/{id}/files | List files attached to a person [**getPersonFollowers**](PersonsApi.md#getPersonFollowers) | **GET** /persons/{id}/followers | List followers of a person @@ -535,6 +536,65 @@ Name | Type | Description | Notes - **Accept**: application/json +## getPersonChangelog + +> ChangelogResponse getPersonChangelog(id, opts) + +List updates about person field values + +Lists updates about field values of a person. + +### Example + +```javascript +import Pipedrive from 'pipedrive'; +let apiClient = new Pipedrive.ApiClient(); +// Configure API key authorization: api_key +let api_key = apiClient.authentications['api_key']; +api_key.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//api_key.apiKeyPrefix = 'Token'; +// Configure OAuth2 access token for authorization: oauth2 +let oauth2 = apiClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +let apiInstance = new Pipedrive.PersonsApi(apiClient); +let id = 56; // Number | The ID of the person +let opts = { + 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page + 'limit': 56 // Number | Items shown per page +}; +apiInstance.getPersonChangelog(id, opts).then((data) => { + console.log('API called successfully. Returned data: ' + data); +}, (error) => { + console.error(error); +}); + +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **Number**| The ID of the person | + **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] + **limit** | **Number**| Items shown per page | [optional] + +### Return type + +[**ChangelogResponse**](ChangelogResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## getPersonDeals > ListDealsResponse getPersonDeals(id, opts) diff --git a/docs/SubscriptionItem.md b/docs/SubscriptionItem.md index 7a233208..609b818d 100644 --- a/docs/SubscriptionItem.md +++ b/docs/SubscriptionItem.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes **endDate** | **Date** | The end date of the subscription | [optional] **lifetimeValue** | **Number** | The total value of all payments | [optional] **finalStatus** | **String** | The final status of the subscription | [optional] -**addTime** | **String** | The creation time of the subscription | [optional] -**updateTime** | **String** | The update time of the subscription | [optional] +**addTime** | **Date** | The creation time of the subscription | [optional] +**updateTime** | **Date** | The update time of the subscription | [optional] diff --git a/src/api/DealsApi.js b/src/api/DealsApi.js index 167492f6..1451bb97 100644 --- a/src/api/DealsApi.js +++ b/src/api/DealsApi.js @@ -16,6 +16,7 @@ import ApiClient from "../ApiClient"; import AddDealFollowerRequest from '../model/AddDealFollowerRequest'; import AddDealParticipantRequest from '../model/AddDealParticipantRequest'; import AddedDealFollower from '../model/AddedDealFollower'; +import ChangelogResponse from '../model/ChangelogResponse'; import DealFlowResponse from '../model/DealFlowResponse'; import DealListActivitiesResponse from '../model/DealListActivitiesResponse'; import DealParticipants from '../model/DealParticipants'; @@ -923,6 +924,82 @@ export default class DealsApi { } + /** + * List updates about deal field values + * Lists updates about field values of a deal. + * @param {Number} id The ID of the deal + * @param {Object} opts Optional parameters + * @param {String} opts.cursor For pagination, the marker (an opaque string value) representing the first item on the next page + * @param {Number} opts.limit Items shown per page + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ChangelogResponse} and HTTP response + */ + getDealChangelogWithHttpInfo(id, opts) { + opts = opts || {}; + let postBody = null; + + // verify the required parameter 'id' is set + if (id === undefined || id === null) { + throw new Error("Missing the required parameter 'id' when calling getDealChangelog"); + } + + + + let pathParams = { + 'id': id, + }; + let queryParams = { + 'cursor': opts['cursor'] === undefined ? opts['cursor'] : opts['cursor'], + 'limit': opts['limit'] === undefined ? opts['limit'] : opts['limit'], + }; + let headerParams = { + }; + let formParams = { + }; + + let formParamArray = [ + ]; + + let contentTypes = []; + const isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded'); + const isJSON = contentTypes.includes('application/json'); + + if (isJSON) { + postBody = { ...postBody, ...opts }; + } else if (isURLEncoded) { + for (let key in opts) { + if (opts.hasOwnProperty(key) && !formParamArray.includes(key)) { + formParams[key] = opts[key]; + } + } + } + + let authNames = ['api_key', 'oauth2', ]; + let accepts = ['application/json', ]; + let returnType = ChangelogResponse; + return this.apiClient.callApi( + '/deals/{id}/changelog', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * List updates about deal field values + * Lists updates about field values of a deal. + * @param {Number} id The ID of the deal + * @param {Object} opts Optional parameters + * @param {String} opts.cursor For pagination, the marker (an opaque string value) representing the first item on the next page + * @param {Number} opts.limit Items shown per page + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ChangelogResponse} + */ + getDealChangelog(id, opts) { + return this.getDealChangelogWithHttpInfo(id, opts) + .then(function(response_and_data) { + return response_and_data; + }); + } + + /** * List files attached to a deal * Lists files associated with a deal. diff --git a/src/api/OrganizationsApi.js b/src/api/OrganizationsApi.js index 0414351f..3c5414cd 100644 --- a/src/api/OrganizationsApi.js +++ b/src/api/OrganizationsApi.js @@ -15,6 +15,7 @@ import ApiClient from "../ApiClient"; import AddOrganizationFollowerRequest from '../model/AddOrganizationFollowerRequest'; import AllOrganizationsGetResponse from '../model/AllOrganizationsGetResponse'; +import ChangelogResponse from '../model/ChangelogResponse'; import FailResponse from '../model/FailResponse'; import InlineResponse2001 from '../model/InlineResponse2001'; import ListActivitiesResponse from '../model/ListActivitiesResponse'; @@ -552,6 +553,82 @@ export default class OrganizationsApi { } + /** + * List updates about organization field values + * Lists updates about field values of an organization. + * @param {Number} id The ID of the organization + * @param {Object} opts Optional parameters + * @param {String} opts.cursor For pagination, the marker (an opaque string value) representing the first item on the next page + * @param {Number} opts.limit Items shown per page + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ChangelogResponse} and HTTP response + */ + getOrganizationChangelogWithHttpInfo(id, opts) { + opts = opts || {}; + let postBody = null; + + // verify the required parameter 'id' is set + if (id === undefined || id === null) { + throw new Error("Missing the required parameter 'id' when calling getOrganizationChangelog"); + } + + + + let pathParams = { + 'id': id, + }; + let queryParams = { + 'cursor': opts['cursor'] === undefined ? opts['cursor'] : opts['cursor'], + 'limit': opts['limit'] === undefined ? opts['limit'] : opts['limit'], + }; + let headerParams = { + }; + let formParams = { + }; + + let formParamArray = [ + ]; + + let contentTypes = []; + const isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded'); + const isJSON = contentTypes.includes('application/json'); + + if (isJSON) { + postBody = { ...postBody, ...opts }; + } else if (isURLEncoded) { + for (let key in opts) { + if (opts.hasOwnProperty(key) && !formParamArray.includes(key)) { + formParams[key] = opts[key]; + } + } + } + + let authNames = ['api_key', 'oauth2', ]; + let accepts = ['application/json', ]; + let returnType = ChangelogResponse; + return this.apiClient.callApi( + '/organizations/{id}/changelog', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * List updates about organization field values + * Lists updates about field values of an organization. + * @param {Number} id The ID of the organization + * @param {Object} opts Optional parameters + * @param {String} opts.cursor For pagination, the marker (an opaque string value) representing the first item on the next page + * @param {Number} opts.limit Items shown per page + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ChangelogResponse} + */ + getOrganizationChangelog(id, opts) { + return this.getOrganizationChangelogWithHttpInfo(id, opts) + .then(function(response_and_data) { + return response_and_data; + }); + } + + /** * List deals associated with an organization * Lists deals associated with an organization. diff --git a/src/api/PersonsApi.js b/src/api/PersonsApi.js index 476cfeb4..15838f8c 100644 --- a/src/api/PersonsApi.js +++ b/src/api/PersonsApi.js @@ -17,6 +17,7 @@ import AddFollowerToPersonResponse from '../model/AddFollowerToPersonResponse'; import AddPersonFollowerRequest from '../model/AddPersonFollowerRequest'; import AddPersonPictureResponse from '../model/AddPersonPictureResponse'; import AddPersonResponse from '../model/AddPersonResponse'; +import ChangelogResponse from '../model/ChangelogResponse'; import DeletePersonResponse from '../model/DeletePersonResponse'; import DeletePersonsInBulkResponse from '../model/DeletePersonsInBulkResponse'; import FailResponse from '../model/FailResponse'; @@ -715,6 +716,82 @@ export default class PersonsApi { } + /** + * List updates about person field values + * Lists updates about field values of a person. + * @param {Number} id The ID of the person + * @param {Object} opts Optional parameters + * @param {String} opts.cursor For pagination, the marker (an opaque string value) representing the first item on the next page + * @param {Number} opts.limit Items shown per page + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ChangelogResponse} and HTTP response + */ + getPersonChangelogWithHttpInfo(id, opts) { + opts = opts || {}; + let postBody = null; + + // verify the required parameter 'id' is set + if (id === undefined || id === null) { + throw new Error("Missing the required parameter 'id' when calling getPersonChangelog"); + } + + + + let pathParams = { + 'id': id, + }; + let queryParams = { + 'cursor': opts['cursor'] === undefined ? opts['cursor'] : opts['cursor'], + 'limit': opts['limit'] === undefined ? opts['limit'] : opts['limit'], + }; + let headerParams = { + }; + let formParams = { + }; + + let formParamArray = [ + ]; + + let contentTypes = []; + const isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded'); + const isJSON = contentTypes.includes('application/json'); + + if (isJSON) { + postBody = { ...postBody, ...opts }; + } else if (isURLEncoded) { + for (let key in opts) { + if (opts.hasOwnProperty(key) && !formParamArray.includes(key)) { + formParams[key] = opts[key]; + } + } + } + + let authNames = ['api_key', 'oauth2', ]; + let accepts = ['application/json', ]; + let returnType = ChangelogResponse; + return this.apiClient.callApi( + '/persons/{id}/changelog', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * List updates about person field values + * Lists updates about field values of a person. + * @param {Number} id The ID of the person + * @param {Object} opts Optional parameters + * @param {String} opts.cursor For pagination, the marker (an opaque string value) representing the first item on the next page + * @param {Number} opts.limit Items shown per page + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ChangelogResponse} + */ + getPersonChangelog(id, opts) { + return this.getPersonChangelogWithHttpInfo(id, opts) + .then(function(response_and_data) { + return response_and_data; + }); + } + + /** * List deals associated with a person * Lists deals associated with a person. diff --git a/src/index.js b/src/index.js index ffb131e7..724a1fa7 100644 --- a/src/index.js +++ b/src/index.js @@ -149,6 +149,9 @@ import CallLogResponse410 from './model/CallLogResponse410'; import CallLogResponse500 from './model/CallLogResponse500'; import CallLogsResponse from './model/CallLogsResponse'; import CallLogsResponseAdditionalData from './model/CallLogsResponseAdditionalData'; +import ChangelogResponse from './model/ChangelogResponse'; +import ChangelogResponseAllOf from './model/ChangelogResponseAllOf'; +import ChangelogResponseAllOfData from './model/ChangelogResponseAllOfData'; import ChannelObject from './model/ChannelObject'; import ChannelObjectResponse from './model/ChannelObjectResponse'; import ChannelObjectResponseData from './model/ChannelObjectResponseData'; @@ -1707,6 +1710,24 @@ export { */ CallLogsResponseAdditionalData, + /** + * The ChangelogResponse model constructor. + * @property {module:model/ChangelogResponse} + */ + ChangelogResponse, + + /** + * The ChangelogResponseAllOf model constructor. + * @property {module:model/ChangelogResponseAllOf} + */ + ChangelogResponseAllOf, + + /** + * The ChangelogResponseAllOfData model constructor. + * @property {module:model/ChangelogResponseAllOfData} + */ + ChangelogResponseAllOfData, + /** * The ChannelObject model constructor. * @property {module:model/ChannelObject} diff --git a/src/model/ActivityTypeObjectResponse.js b/src/model/ActivityTypeObjectResponse.js index 098bd3fe..4908b0b7 100644 --- a/src/model/ActivityTypeObjectResponse.js +++ b/src/model/ActivityTypeObjectResponse.js @@ -89,12 +89,12 @@ class ActivityTypeObjectResponse { delete data['is_custom_flag']; } if (data.hasOwnProperty('add_time')) { - obj['add_time'] = ApiClient.convertToType(data['add_time'], 'String'); + obj['add_time'] = ApiClient.convertToType(data['add_time'], 'Date'); delete data['add_time']; } if (data.hasOwnProperty('update_time')) { - obj['update_time'] = ApiClient.convertToType(data['update_time'], 'String'); + obj['update_time'] = ApiClient.convertToType(data['update_time'], 'Date'); delete data['update_time']; } @@ -159,13 +159,13 @@ ActivityTypeObjectResponse.prototype['is_custom_flag'] = undefined; /** * The creation time of the activity type - * @member {String} add_time + * @member {Date} add_time */ ActivityTypeObjectResponse.prototype['add_time'] = undefined; /** * The update time of the activity type - * @member {String} update_time + * @member {Date} update_time */ ActivityTypeObjectResponse.prototype['update_time'] = undefined; diff --git a/src/model/ChangelogResponse.js b/src/model/ChangelogResponse.js new file mode 100644 index 00000000..a793389c --- /dev/null +++ b/src/model/ChangelogResponse.js @@ -0,0 +1,122 @@ +/** + * Pipedrive API v1 + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import AdditionalDataWithCursorPagination from './AdditionalDataWithCursorPagination'; +import BaseResponse from './BaseResponse'; +import ChangelogResponseAllOf from './ChangelogResponseAllOf'; +import ChangelogResponseAllOfData from './ChangelogResponseAllOfData'; + +/** + * The ChangelogResponse model module. + * @module model/ChangelogResponse + * @version 1.0.0 + */ +class ChangelogResponse { + /** + * Constructs a new ChangelogResponse. + * @alias module:model/ChangelogResponse + * @implements module:model/BaseResponse + * @implements module:model/ChangelogResponseAllOf + */ + constructor() { + BaseResponse.initialize(this);ChangelogResponseAllOf.initialize(this); + ChangelogResponse.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a ChangelogResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/ChangelogResponse} obj Optional instance to populate. + * @return {module:model/ChangelogResponse} The populated ChangelogResponse instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new ChangelogResponse(); + BaseResponse.constructFromObject(data, obj); + ChangelogResponseAllOf.constructFromObject(data, obj); + + if (data.hasOwnProperty('success')) { + obj['success'] = ApiClient.convertToType(data['success'], 'Boolean'); + + delete data['success']; + } + if (data.hasOwnProperty('data')) { + obj['data'] = ApiClient.convertToType(data['data'], [ChangelogResponseAllOfData]); + + delete data['data']; + } + if (data.hasOwnProperty('additional_data')) { + obj['additional_data'] = AdditionalDataWithCursorPagination.constructFromObject(data['additional_data']); + + delete data['additional_data']; + } + + if (Object.keys(data).length > 0) { + Object.assign(obj, data); + } + + } + return obj; + } + + +} + +/** + * If the response is successful or not + * @member {Boolean} success + */ +ChangelogResponse.prototype['success'] = undefined; + +/** + * @member {Array.} data + */ +ChangelogResponse.prototype['data'] = undefined; + +/** + * @member {module:model/AdditionalDataWithCursorPagination} additional_data + */ +ChangelogResponse.prototype['additional_data'] = undefined; + + +// Implement BaseResponse interface: +/** + * If the response is successful or not + * @member {Boolean} success + */ +BaseResponse.prototype['success'] = undefined; +// Implement ChangelogResponseAllOf interface: +/** + * @member {Array.} data + */ +ChangelogResponseAllOf.prototype['data'] = undefined; +/** + * @member {module:model/AdditionalDataWithCursorPagination} additional_data + */ +ChangelogResponseAllOf.prototype['additional_data'] = undefined; + + + + +export default ChangelogResponse; + diff --git a/src/model/ChangelogResponseAllOf.js b/src/model/ChangelogResponseAllOf.js new file mode 100644 index 00000000..627cd40f --- /dev/null +++ b/src/model/ChangelogResponseAllOf.js @@ -0,0 +1,90 @@ +/** + * Pipedrive API v1 + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import AdditionalDataWithCursorPagination from './AdditionalDataWithCursorPagination'; +import ChangelogResponseAllOfData from './ChangelogResponseAllOfData'; + +/** + * The ChangelogResponseAllOf model module. + * @module model/ChangelogResponseAllOf + * @version 1.0.0 + */ +class ChangelogResponseAllOf { + /** + * Constructs a new ChangelogResponseAllOf. + * @alias module:model/ChangelogResponseAllOf + */ + constructor() { + + ChangelogResponseAllOf.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a ChangelogResponseAllOf from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/ChangelogResponseAllOf} obj Optional instance to populate. + * @return {module:model/ChangelogResponseAllOf} The populated ChangelogResponseAllOf instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new ChangelogResponseAllOf(); + + if (data.hasOwnProperty('data')) { + obj['data'] = ApiClient.convertToType(data['data'], [ChangelogResponseAllOfData]); + + delete data['data']; + } + if (data.hasOwnProperty('additional_data')) { + obj['additional_data'] = AdditionalDataWithCursorPagination.constructFromObject(data['additional_data']); + + delete data['additional_data']; + } + + if (Object.keys(data).length > 0) { + Object.assign(obj, data); + } + + } + return obj; + } + + +} + +/** + * @member {Array.} data + */ +ChangelogResponseAllOf.prototype['data'] = undefined; + +/** + * @member {module:model/AdditionalDataWithCursorPagination} additional_data + */ +ChangelogResponseAllOf.prototype['additional_data'] = undefined; + + + + + + +export default ChangelogResponseAllOf; + diff --git a/src/model/ChangelogResponseAllOfData.js b/src/model/ChangelogResponseAllOfData.js new file mode 100644 index 00000000..ff821251 --- /dev/null +++ b/src/model/ChangelogResponseAllOfData.js @@ -0,0 +1,156 @@ +/** + * Pipedrive API v1 + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The ChangelogResponseAllOfData model module. + * @module model/ChangelogResponseAllOfData + * @version 1.0.0 + */ +class ChangelogResponseAllOfData { + /** + * Constructs a new ChangelogResponseAllOfData. + * @alias module:model/ChangelogResponseAllOfData + */ + constructor() { + + ChangelogResponseAllOfData.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a ChangelogResponseAllOfData from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/ChangelogResponseAllOfData} obj Optional instance to populate. + * @return {module:model/ChangelogResponseAllOfData} The populated ChangelogResponseAllOfData instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new ChangelogResponseAllOfData(); + + if (data.hasOwnProperty('field_key')) { + obj['field_key'] = ApiClient.convertToType(data['field_key'], 'String'); + + delete data['field_key']; + } + if (data.hasOwnProperty('old_value')) { + obj['old_value'] = ApiClient.convertToType(data['old_value'], 'String'); + + delete data['old_value']; + } + if (data.hasOwnProperty('new_value')) { + obj['new_value'] = ApiClient.convertToType(data['new_value'], 'String'); + + delete data['new_value']; + } + if (data.hasOwnProperty('actor_user_id')) { + obj['actor_user_id'] = ApiClient.convertToType(data['actor_user_id'], 'Number'); + + delete data['actor_user_id']; + } + if (data.hasOwnProperty('time')) { + obj['time'] = ApiClient.convertToType(data['time'], 'String'); + + delete data['time']; + } + if (data.hasOwnProperty('change_source')) { + obj['change_source'] = ApiClient.convertToType(data['change_source'], 'String'); + + delete data['change_source']; + } + if (data.hasOwnProperty('change_source_user_agent')) { + obj['change_source_user_agent'] = ApiClient.convertToType(data['change_source_user_agent'], 'String'); + + delete data['change_source_user_agent']; + } + if (data.hasOwnProperty('is_bulk_update_flag')) { + obj['is_bulk_update_flag'] = ApiClient.convertToType(data['is_bulk_update_flag'], 'Boolean'); + + delete data['is_bulk_update_flag']; + } + + if (Object.keys(data).length > 0) { + Object.assign(obj, data); + } + + } + return obj; + } + + +} + +/** + * The key of the field that was changed + * @member {String} field_key + */ +ChangelogResponseAllOfData.prototype['field_key'] = undefined; + +/** + * The value of the field before the change + * @member {String} old_value + */ +ChangelogResponseAllOfData.prototype['old_value'] = undefined; + +/** + * The value of the field after the change + * @member {String} new_value + */ +ChangelogResponseAllOfData.prototype['new_value'] = undefined; + +/** + * The ID of the user who made the change + * @member {Number} actor_user_id + */ +ChangelogResponseAllOfData.prototype['actor_user_id'] = undefined; + +/** + * The date and time of the change + * @member {String} time + */ +ChangelogResponseAllOfData.prototype['time'] = undefined; + +/** + * The source of change, for example 'app', 'mobile', 'api', etc. + * @member {String} change_source + */ +ChangelogResponseAllOfData.prototype['change_source'] = undefined; + +/** + * The user agent from which the change was made + * @member {String} change_source_user_agent + */ +ChangelogResponseAllOfData.prototype['change_source_user_agent'] = undefined; + +/** + * Whether the change was made as part of a bulk update + * @member {Boolean} is_bulk_update_flag + */ +ChangelogResponseAllOfData.prototype['is_bulk_update_flag'] = undefined; + + + + + + +export default ChangelogResponseAllOfData; + diff --git a/src/model/Field.js b/src/model/Field.js index 1597a9ba..a01e07d6 100644 --- a/src/model/Field.js +++ b/src/model/Field.js @@ -74,12 +74,12 @@ class Field { delete data['field_type']; } if (data.hasOwnProperty('add_time')) { - obj['add_time'] = ApiClient.convertToType(data['add_time'], 'String'); + obj['add_time'] = ApiClient.convertToType(data['add_time'], 'Date'); delete data['add_time']; } if (data.hasOwnProperty('update_time')) { - obj['update_time'] = ApiClient.convertToType(data['update_time'], 'String'); + obj['update_time'] = ApiClient.convertToType(data['update_time'], 'Date'); delete data['update_time']; } @@ -206,13 +206,13 @@ Field.prototype['field_type'] = undefined; /** * The creation time of the field - * @member {String} add_time + * @member {Date} add_time */ Field.prototype['add_time'] = undefined; /** * The update time of the field - * @member {String} update_time + * @member {Date} update_time */ Field.prototype['update_time'] = undefined; diff --git a/src/model/PaymentItem.js b/src/model/PaymentItem.js index f3db4998..4b00e8a1 100644 --- a/src/model/PaymentItem.js +++ b/src/model/PaymentItem.js @@ -103,12 +103,12 @@ class PaymentItem { delete data['description']; } if (data.hasOwnProperty('add_time')) { - obj['add_time'] = ApiClient.convertToType(data['add_time'], 'String'); + obj['add_time'] = ApiClient.convertToType(data['add_time'], 'Date'); delete data['add_time']; } if (data.hasOwnProperty('update_time')) { - obj['update_time'] = ApiClient.convertToType(data['update_time'], 'String'); + obj['update_time'] = ApiClient.convertToType(data['update_time'], 'Date'); delete data['update_time']; } @@ -192,13 +192,13 @@ PaymentItem.prototype['description'] = undefined; /** * The creation time of the payment - * @member {String} add_time + * @member {Date} add_time */ PaymentItem.prototype['add_time'] = undefined; /** * The update time of the payment - * @member {String} update_time + * @member {Date} update_time */ PaymentItem.prototype['update_time'] = undefined; diff --git a/src/model/SubscriptionItem.js b/src/model/SubscriptionItem.js index 2926d1c0..1e4ed3ec 100644 --- a/src/model/SubscriptionItem.js +++ b/src/model/SubscriptionItem.js @@ -118,12 +118,12 @@ class SubscriptionItem { delete data['final_status']; } if (data.hasOwnProperty('add_time')) { - obj['add_time'] = ApiClient.convertToType(data['add_time'], 'String'); + obj['add_time'] = ApiClient.convertToType(data['add_time'], 'Date'); delete data['add_time']; } if (data.hasOwnProperty('update_time')) { - obj['update_time'] = ApiClient.convertToType(data['update_time'], 'String'); + obj['update_time'] = ApiClient.convertToType(data['update_time'], 'Date'); delete data['update_time']; } @@ -225,13 +225,13 @@ SubscriptionItem.prototype['final_status'] = undefined; /** * The creation time of the subscription - * @member {String} add_time + * @member {Date} add_time */ SubscriptionItem.prototype['add_time'] = undefined; /** * The update time of the subscription - * @member {String} update_time + * @member {Date} update_time */ SubscriptionItem.prototype['update_time'] = undefined;