diff --git a/CHANGELOG.md b/CHANGELOG.md index 72b37877..01c0c53e 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] +### Fixed +- Documentation for response models: changed property names to snake_case instead of camelCase ## [22.8.0] - 2024-05-21 ### Added diff --git a/docs/ActivitiesApi.md b/docs/ActivitiesApi.md index 69235b71..b4b1868b 100644 --- a/docs/ActivitiesApi.md +++ b/docs/ActivitiesApi.md @@ -53,7 +53,7 @@ apiInstance.addActivity(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **activityPostObject** | [**ActivityPostObject**](ActivityPostObject.md)| | [optional] + **ActivityPostObject** | [**ActivityPostObject**](ActivityPostObject.md)| | [optional] ### Return type @@ -198,6 +198,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.ActivitiesApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'userId': 56, // Number | The ID of the user whose activities will be fetched. If omitted, the user associated with the API token will be used. If 0, activities for all company users will be fetched based on the permission sets. 'filterId': 56, // Number | The ID of the filter to use (will narrow down results if used together with `user_id` parameter) @@ -221,13 +222,13 @@ apiInstance.getActivities(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Number**| The ID of the user whose activities will be fetched. If omitted, the user associated with the API token will be used. If 0, activities for all company users will be fetched based on the permission sets. | [optional] - **filterId** | **Number**| The ID of the filter to use (will narrow down results if used together with `user_id` parameter) | [optional] + **user_id** | **Number**| The ID of the user whose activities will be fetched. If omitted, the user associated with the API token will be used. If 0, activities for all company users will be fetched based on the permission sets. | [optional] + **filter_id** | **Number**| The ID of the filter to use (will narrow down results if used together with `user_id` parameter) | [optional] **type** | **String**| 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. | [optional] **limit** | **Number**| For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. | [optional] **start** | **Number**| For pagination, the position that represents the first result for the page | [optional] - **startDate** | **Date**| Use the activity due date where you wish to begin fetching activities from. Insert due date in YYYY-MM-DD format. | [optional] - **endDate** | **Date**| Use the activity due date where you wish to stop fetching activities from. Insert due date in YYYY-MM-DD format. | [optional] + **start_date** | **Date**| Use the activity due date where you wish to begin fetching activities from. Insert due date in YYYY-MM-DD format. | [optional] + **end_date** | **Date**| Use the activity due date where you wish to stop fetching activities from. Insert due date in YYYY-MM-DD format. | [optional] **done** | [**NumberBoolean**](.md)| Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both done and not done activities. | [optional] ### Return type @@ -267,6 +268,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.ActivitiesApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page 'limit': 100, // Number | 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. @@ -293,7 +295,7 @@ Name | Type | Description | Notes **limit** | **Number**| 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. | [optional] **since** | **String**| 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. | [optional] **until** | **String**| 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. | [optional] - **userId** | **Number**| The ID of the user whose activities will be fetched. If omitted, all activities are returned. | [optional] + **user_id** | **Number**| The ID of the user whose activities will be fetched. If omitted, all activities are returned. | [optional] **done** | **Boolean**| Whether the activity is done or not. `false` = Not done, `true` = Done. If omitted, returns both done and not done activities. | [optional] **type** | **String**| 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. | [optional] @@ -405,7 +407,7 @@ apiInstance.updateActivity(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the activity | - **activityPutObject** | [**ActivityPutObject**](ActivityPutObject.md)| | [optional] + **ActivityPutObject** | [**ActivityPutObject**](ActivityPutObject.md)| | [optional] ### Return type diff --git a/docs/ActivityCollectionResponseObject.md b/docs/ActivityCollectionResponseObject.md index bfd2dfeb..945cac0d 100644 --- a/docs/ActivityCollectionResponseObject.md +++ b/docs/ActivityCollectionResponseObject.md @@ -4,41 +4,41 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dueDate** | **Date** | The due date of the activity. Format: YYYY-MM-DD | [optional] -**dueTime** | **String** | The due time of the activity in UTC. Format: HH:MM | [optional] +**due_date** | **Date** | The due date of the activity. Format: YYYY-MM-DD | [optional] +**due_time** | **String** | The due time of the activity in UTC. Format: HH:MM | [optional] **duration** | **String** | The duration of the activity. Format: HH:MM | [optional] -**dealId** | **Number** | The ID of the deal this activity is associated with | [optional] -**leadId** | **String** | The ID of the lead in the UUID format this activity is associated with | [optional] -**personId** | **Number** | The ID of the person this activity is associated with | [optional] -**projectId** | **Number** | The ID of the project this activity is associated with | [optional] -**orgId** | **Number** | The ID of the organization this activity is associated with | [optional] +**deal_id** | **Number** | The ID of the deal this activity is associated with | [optional] +**lead_id** | **String** | The ID of the lead in the UUID format this activity is associated with | [optional] +**person_id** | **Number** | The ID of the person this activity is associated with | [optional] +**project_id** | **Number** | The ID of the project this activity is associated with | [optional] +**org_id** | **Number** | The ID of the organization this activity is associated with | [optional] **location** | **String** | The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps. | [optional] -**publicDescription** | **String** | Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity. | [optional] +**public_description** | **String** | Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity. | [optional] **id** | **Number** | The ID of the activity, generated when the activity was created | [optional] **done** | **Boolean** | Whether the activity is done or not | [optional] **subject** | **String** | The subject of the activity | [optional] **type** | **String** | The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes. | [optional] -**userId** | **Number** | The ID of the user whom the activity is assigned to | [optional] -**busyFlag** | **Boolean** | Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] -**companyId** | **Number** | The user's company ID | [optional] -**conferenceMeetingClient** | **String** | The ID of the Marketplace app, which is connected to this activity | [optional] -**conferenceMeetingUrl** | **String** | The link to join the meeting which is associated with this activity | [optional] -**conferenceMeetingId** | **String** | The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity | [optional] -**addTime** | **String** | The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**markedAsDoneTime** | **String** | The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**activeFlag** | **Boolean** | Whether the activity is active or not | [optional] -**updateTime** | **String** | The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateUserId** | **Number** | The ID of the user who was the last to update this activity | [optional] -**sourceTimezone** | **String** | The timezone the activity was created in an external calendar | [optional] -**locationSubpremise** | **String** | A subfield of the location field. Indicates apartment/suite number. | [optional] -**locationStreetNumber** | **String** | A subfield of the location field. Indicates house number. | [optional] -**locationRoute** | **String** | A subfield of the location field. Indicates street name. | [optional] -**locationSublocality** | **String** | A subfield of the location field. Indicates district/sublocality. | [optional] -**locationLocality** | **String** | A subfield of the location field. Indicates city/town/village/locality. | [optional] -**locationAdminAreaLevel1** | **String** | A subfield of the location field. Indicates state/county. | [optional] -**locationAdminAreaLevel2** | **String** | A subfield of the location field. Indicates region. | [optional] -**locationCountry** | **String** | A subfield of the location field. Indicates country. | [optional] -**locationPostalCode** | **String** | A subfield of the location field. Indicates ZIP/postal code. | [optional] -**locationFormattedAddress** | **String** | A subfield of the location field. Indicates full/combined address. | [optional] +**user_id** | **Number** | The ID of the user whom the activity is assigned to | [optional] +**busy_flag** | **Boolean** | Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] +**company_id** | **Number** | The user's company ID | [optional] +**conference_meeting_client** | **String** | The ID of the Marketplace app, which is connected to this activity | [optional] +**conference_meeting_url** | **String** | The link to join the meeting which is associated with this activity | [optional] +**conference_meeting_id** | **String** | The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity | [optional] +**add_time** | **String** | The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**marked_as_done_time** | **String** | The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**active_flag** | **Boolean** | Whether the activity is active or not | [optional] +**update_time** | **String** | The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_user_id** | **Number** | The ID of the user who was the last to update this activity | [optional] +**source_timezone** | **String** | The timezone the activity was created in an external calendar | [optional] +**location_subpremise** | **String** | A subfield of the location field. Indicates apartment/suite number. | [optional] +**location_street_number** | **String** | A subfield of the location field. Indicates house number. | [optional] +**location_route** | **String** | A subfield of the location field. Indicates street name. | [optional] +**location_sublocality** | **String** | A subfield of the location field. Indicates district/sublocality. | [optional] +**location_locality** | **String** | A subfield of the location field. Indicates city/town/village/locality. | [optional] +**location_admin_area_level_1** | **String** | A subfield of the location field. Indicates state/county. | [optional] +**location_admin_area_level_2** | **String** | A subfield of the location field. Indicates region. | [optional] +**location_country** | **String** | A subfield of the location field. Indicates country. | [optional] +**location_postal_code** | **String** | A subfield of the location field. Indicates ZIP/postal code. | [optional] +**location_formatted_address** | **String** | A subfield of the location field. Indicates full/combined address. | [optional] diff --git a/docs/ActivityCollectionResponseObjectAllOf.md b/docs/ActivityCollectionResponseObjectAllOf.md index 03747a6a..91014448 100644 --- a/docs/ActivityCollectionResponseObjectAllOf.md +++ b/docs/ActivityCollectionResponseObjectAllOf.md @@ -8,27 +8,27 @@ Name | Type | Description | Notes **done** | **Boolean** | Whether the activity is done or not | [optional] **subject** | **String** | The subject of the activity | [optional] **type** | **String** | The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes. | [optional] -**userId** | **Number** | The ID of the user whom the activity is assigned to | [optional] -**busyFlag** | **Boolean** | Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] -**companyId** | **Number** | The user's company ID | [optional] -**conferenceMeetingClient** | **String** | The ID of the Marketplace app, which is connected to this activity | [optional] -**conferenceMeetingUrl** | **String** | The link to join the meeting which is associated with this activity | [optional] -**conferenceMeetingId** | **String** | The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity | [optional] -**addTime** | **String** | The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**markedAsDoneTime** | **String** | The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**activeFlag** | **Boolean** | Whether the activity is active or not | [optional] -**updateTime** | **String** | The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateUserId** | **Number** | The ID of the user who was the last to update this activity | [optional] -**sourceTimezone** | **String** | The timezone the activity was created in an external calendar | [optional] -**locationSubpremise** | **String** | A subfield of the location field. Indicates apartment/suite number. | [optional] -**locationStreetNumber** | **String** | A subfield of the location field. Indicates house number. | [optional] -**locationRoute** | **String** | A subfield of the location field. Indicates street name. | [optional] -**locationSublocality** | **String** | A subfield of the location field. Indicates district/sublocality. | [optional] -**locationLocality** | **String** | A subfield of the location field. Indicates city/town/village/locality. | [optional] -**locationAdminAreaLevel1** | **String** | A subfield of the location field. Indicates state/county. | [optional] -**locationAdminAreaLevel2** | **String** | A subfield of the location field. Indicates region. | [optional] -**locationCountry** | **String** | A subfield of the location field. Indicates country. | [optional] -**locationPostalCode** | **String** | A subfield of the location field. Indicates ZIP/postal code. | [optional] -**locationFormattedAddress** | **String** | A subfield of the location field. Indicates full/combined address. | [optional] +**user_id** | **Number** | The ID of the user whom the activity is assigned to | [optional] +**busy_flag** | **Boolean** | Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] +**company_id** | **Number** | The user's company ID | [optional] +**conference_meeting_client** | **String** | The ID of the Marketplace app, which is connected to this activity | [optional] +**conference_meeting_url** | **String** | The link to join the meeting which is associated with this activity | [optional] +**conference_meeting_id** | **String** | The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity | [optional] +**add_time** | **String** | The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**marked_as_done_time** | **String** | The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**active_flag** | **Boolean** | Whether the activity is active or not | [optional] +**update_time** | **String** | The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_user_id** | **Number** | The ID of the user who was the last to update this activity | [optional] +**source_timezone** | **String** | The timezone the activity was created in an external calendar | [optional] +**location_subpremise** | **String** | A subfield of the location field. Indicates apartment/suite number. | [optional] +**location_street_number** | **String** | A subfield of the location field. Indicates house number. | [optional] +**location_route** | **String** | A subfield of the location field. Indicates street name. | [optional] +**location_sublocality** | **String** | A subfield of the location field. Indicates district/sublocality. | [optional] +**location_locality** | **String** | A subfield of the location field. Indicates city/town/village/locality. | [optional] +**location_admin_area_level_1** | **String** | A subfield of the location field. Indicates state/county. | [optional] +**location_admin_area_level_2** | **String** | A subfield of the location field. Indicates region. | [optional] +**location_country** | **String** | A subfield of the location field. Indicates country. | [optional] +**location_postal_code** | **String** | A subfield of the location field. Indicates ZIP/postal code. | [optional] +**location_formatted_address** | **String** | A subfield of the location field. Indicates full/combined address. | [optional] diff --git a/docs/ActivityDistributionData.md b/docs/ActivityDistributionData.md index f7759f5f..4b16721c 100644 --- a/docs/ActivityDistributionData.md +++ b/docs/ActivityDistributionData.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**activityDistribution** | [**ActivityDistributionDataActivityDistribution**](ActivityDistributionDataActivityDistribution.md) | | [optional] +**activity_distribution** | [**ActivityDistributionDataActivityDistribution**](ActivityDistributionDataActivityDistribution.md) | | [optional] diff --git a/docs/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERID.md b/docs/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERID.md index 370a49c8..91eed2e2 100644 --- a/docs/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERID.md +++ b/docs/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERID.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **activities** | [**ActivityDistributionDataActivityDistributionASSIGNEDTOUSERIDActivities**](ActivityDistributionDataActivityDistributionASSIGNEDTOUSERIDActivities.md) | | [optional] **name** | **String** | The name of the user | [optional] -**activityCount** | **Number** | The overall count of activities for the user | [optional] +**activity_count** | **Number** | The overall count of activities for the user | [optional] **share** | **Number** | The percentage of activities belongs to the user | [optional] diff --git a/docs/ActivityDistributionDataWithAdditionalData.md b/docs/ActivityDistributionDataWithAdditionalData.md index b6a42491..8a1e904c 100644 --- a/docs/ActivityDistributionDataWithAdditionalData.md +++ b/docs/ActivityDistributionDataWithAdditionalData.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**activityDistribution** | [**ActivityDistributionDataActivityDistribution**](ActivityDistributionDataActivityDistribution.md) | | [optional] +**activity_distribution** | [**ActivityDistributionDataActivityDistribution**](ActivityDistributionDataActivityDistribution.md) | | [optional] **start** | **Number** | Pagination start | [optional] **limit** | **Number** | Items shown per page | [optional] -**moreItemsInCollection** | **Boolean** | If there are more list items in the collection than displayed or not | [optional] +**more_items_in_collection** | **Boolean** | If there are more list items in the collection than displayed or not | [optional] diff --git a/docs/ActivityInfo.md b/docs/ActivityInfo.md index 2dac17d6..e01db6b7 100644 --- a/docs/ActivityInfo.md +++ b/docs/ActivityInfo.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] diff --git a/docs/ActivityObjectFragment.md b/docs/ActivityObjectFragment.md index 35d75169..9d587071 100644 --- a/docs/ActivityObjectFragment.md +++ b/docs/ActivityObjectFragment.md @@ -4,15 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dueDate** | **Date** | The due date of the activity. Format: YYYY-MM-DD | [optional] -**dueTime** | **String** | The due time of the activity in UTC. Format: HH:MM | [optional] +**due_date** | **Date** | The due date of the activity. Format: YYYY-MM-DD | [optional] +**due_time** | **String** | The due time of the activity in UTC. Format: HH:MM | [optional] **duration** | **String** | The duration of the activity. Format: HH:MM | [optional] -**dealId** | **Number** | The ID of the deal this activity is associated with | [optional] -**leadId** | **String** | The ID of the lead in the UUID format this activity is associated with | [optional] -**personId** | **Number** | The ID of the person this activity is associated with | [optional] -**projectId** | **Number** | The ID of the project this activity is associated with | [optional] -**orgId** | **Number** | The ID of the organization this activity is associated with | [optional] +**deal_id** | **Number** | The ID of the deal this activity is associated with | [optional] +**lead_id** | **String** | The ID of the lead in the UUID format this activity is associated with | [optional] +**person_id** | **Number** | The ID of the person this activity is associated with | [optional] +**project_id** | **Number** | The ID of the project this activity is associated with | [optional] +**org_id** | **Number** | The ID of the organization this activity is associated with | [optional] **location** | **String** | The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps. | [optional] -**publicDescription** | **String** | Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity. | [optional] +**public_description** | **String** | Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity. | [optional] diff --git a/docs/ActivityPostObject.md b/docs/ActivityPostObject.md index a8212a22..ab031c97 100644 --- a/docs/ActivityPostObject.md +++ b/docs/ActivityPostObject.md @@ -4,22 +4,22 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dueDate** | **Date** | The due date of the activity. Format: YYYY-MM-DD | [optional] -**dueTime** | **String** | The due time of the activity in UTC. Format: HH:MM | [optional] +**due_date** | **Date** | The due date of the activity. Format: YYYY-MM-DD | [optional] +**due_time** | **String** | The due time of the activity in UTC. Format: HH:MM | [optional] **duration** | **String** | The duration of the activity. Format: HH:MM | [optional] -**dealId** | **Number** | The ID of the deal this activity is associated with | [optional] -**leadId** | **String** | The ID of the lead in the UUID format this activity is associated with | [optional] -**personId** | **Number** | The ID of the person this activity is associated with | [optional] -**projectId** | **Number** | The ID of the project this activity is associated with | [optional] -**orgId** | **Number** | The ID of the organization this activity is associated with | [optional] +**deal_id** | **Number** | The ID of the deal this activity is associated with | [optional] +**lead_id** | **String** | The ID of the lead in the UUID format this activity is associated with | [optional] +**person_id** | **Number** | The ID of the person this activity is associated with | [optional] +**project_id** | **Number** | The ID of the project this activity is associated with | [optional] +**org_id** | **Number** | The ID of the organization this activity is associated with | [optional] **location** | **String** | The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps. | [optional] -**publicDescription** | **String** | Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity. | [optional] +**public_description** | **String** | Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity. | [optional] **note** | **String** | The note of the activity (HTML format) | [optional] **subject** | **String** | The subject of the activity. When value for subject is not set, it will be given a default value `Call`. | [optional] **type** | **String** | The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes. When value for type is not set, it will be given a default value `Call`. | [optional] -**userId** | **Number** | The ID of the user whom the activity is assigned to. If omitted, the activity is assigned to the authorized user. | [optional] +**user_id** | **Number** | The ID of the user whom the activity is assigned to. If omitted, the activity is assigned to the authorized user. | [optional] **participants** | **[Object]** | List of multiple persons (participants) this activity is associated with. If omitted, single participant from `person_id` field is used. It requires a structure as follows: `[{\"person_id\":1,\"primary_flag\":true}]` | [optional] -**busyFlag** | **Boolean** | Set the activity as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with `null`. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] +**busy_flag** | **Boolean** | Set the activity as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with `null`. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] **attendees** | **[Object]** | The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: `[{\"email_address\":\"mail@example.org\"}]` or `[{\"person_id\":1, \"email_address\":\"mail@example.org\"}]` | [optional] **done** | [**NumberBoolean**](NumberBoolean.md) | Whether the activity is done or not. 0 = Not done, 1 = Done | [optional] diff --git a/docs/ActivityPostObjectAllOf.md b/docs/ActivityPostObjectAllOf.md index c221d155..22a96fc7 100644 --- a/docs/ActivityPostObjectAllOf.md +++ b/docs/ActivityPostObjectAllOf.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **note** | **String** | The note of the activity (HTML format) | [optional] **subject** | **String** | The subject of the activity. When value for subject is not set, it will be given a default value `Call`. | [optional] **type** | **String** | The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes. When value for type is not set, it will be given a default value `Call`. | [optional] -**userId** | **Number** | The ID of the user whom the activity is assigned to. If omitted, the activity is assigned to the authorized user. | [optional] +**user_id** | **Number** | The ID of the user whom the activity is assigned to. If omitted, the activity is assigned to the authorized user. | [optional] **participants** | **[Object]** | List of multiple persons (participants) this activity is associated with. If omitted, single participant from `person_id` field is used. It requires a structure as follows: `[{\"person_id\":1,\"primary_flag\":true}]` | [optional] -**busyFlag** | **Boolean** | Set the activity as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with `null`. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] +**busy_flag** | **Boolean** | Set the activity as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with `null`. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] **attendees** | **[Object]** | The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: `[{\"email_address\":\"mail@example.org\"}]` or `[{\"person_id\":1, \"email_address\":\"mail@example.org\"}]` | [optional] **done** | [**NumberBoolean**](NumberBoolean.md) | Whether the activity is done or not. 0 = Not done, 1 = Done | [optional] diff --git a/docs/ActivityPutObject.md b/docs/ActivityPutObject.md index fd4a943f..43c3b4ed 100644 --- a/docs/ActivityPutObject.md +++ b/docs/ActivityPutObject.md @@ -4,22 +4,22 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dueDate** | **Date** | The due date of the activity. Format: YYYY-MM-DD | [optional] -**dueTime** | **String** | The due time of the activity in UTC. Format: HH:MM | [optional] +**due_date** | **Date** | The due date of the activity. Format: YYYY-MM-DD | [optional] +**due_time** | **String** | The due time of the activity in UTC. Format: HH:MM | [optional] **duration** | **String** | The duration of the activity. Format: HH:MM | [optional] -**dealId** | **Number** | The ID of the deal this activity is associated with | [optional] -**leadId** | **String** | The ID of the lead in the UUID format this activity is associated with | [optional] -**personId** | **Number** | The ID of the person this activity is associated with | [optional] -**projectId** | **Number** | The ID of the project this activity is associated with | [optional] -**orgId** | **Number** | The ID of the organization this activity is associated with | [optional] +**deal_id** | **Number** | The ID of the deal this activity is associated with | [optional] +**lead_id** | **String** | The ID of the lead in the UUID format this activity is associated with | [optional] +**person_id** | **Number** | The ID of the person this activity is associated with | [optional] +**project_id** | **Number** | The ID of the project this activity is associated with | [optional] +**org_id** | **Number** | The ID of the organization this activity is associated with | [optional] **location** | **String** | The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps. | [optional] -**publicDescription** | **String** | Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity. | [optional] +**public_description** | **String** | Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity. | [optional] **note** | **String** | The note of the activity (HTML format) | [optional] **subject** | **String** | The subject of the activity | [optional] **type** | **String** | The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes. | [optional] -**userId** | **Number** | The ID of the user whom the activity is assigned to | [optional] +**user_id** | **Number** | The ID of the user whom the activity is assigned to | [optional] **participants** | **[Object]** | List of multiple persons (participants) this activity is associated with. It requires a structure as follows: `[{\"person_id\":1,\"primary_flag\":true}]` | [optional] -**busyFlag** | **Boolean** | Set the activity as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with `null`. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] +**busy_flag** | **Boolean** | Set the activity as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with `null`. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] **attendees** | **[Object]** | The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: `[{\"email_address\":\"mail@example.org\"}]` or `[{\"person_id\":1, \"email_address\":\"mail@example.org\"}]` | [optional] **done** | [**NumberBoolean**](NumberBoolean.md) | Whether the activity is done or not. 0 = Not done, 1 = Done | [optional] diff --git a/docs/ActivityPutObjectAllOf.md b/docs/ActivityPutObjectAllOf.md index 299528d9..d4e925a8 100644 --- a/docs/ActivityPutObjectAllOf.md +++ b/docs/ActivityPutObjectAllOf.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **note** | **String** | The note of the activity (HTML format) | [optional] **subject** | **String** | The subject of the activity | [optional] **type** | **String** | The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes. | [optional] -**userId** | **Number** | The ID of the user whom the activity is assigned to | [optional] +**user_id** | **Number** | The ID of the user whom the activity is assigned to | [optional] **participants** | **[Object]** | List of multiple persons (participants) this activity is associated with. It requires a structure as follows: `[{\"person_id\":1,\"primary_flag\":true}]` | [optional] -**busyFlag** | **Boolean** | Set the activity as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with `null`. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] +**busy_flag** | **Boolean** | Set the activity as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with `null`. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] **attendees** | **[Object]** | The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: `[{\"email_address\":\"mail@example.org\"}]` or `[{\"person_id\":1, \"email_address\":\"mail@example.org\"}]` | [optional] **done** | [**NumberBoolean**](NumberBoolean.md) | Whether the activity is done or not. 0 = Not done, 1 = Done | [optional] diff --git a/docs/ActivityRecordAdditionalData.md b/docs/ActivityRecordAdditionalData.md index b5c386fb..bae828cd 100644 --- a/docs/ActivityRecordAdditionalData.md +++ b/docs/ActivityRecordAdditionalData.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**updatesStoryId** | **Number** | This field will be deprecated | [optional] +**updates_story_id** | **Number** | This field will be deprecated | [optional] diff --git a/docs/ActivityResponseObject.md b/docs/ActivityResponseObject.md index 6844ba99..5c3216c3 100644 --- a/docs/ActivityResponseObject.md +++ b/docs/ActivityResponseObject.md @@ -4,66 +4,66 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dueDate** | **Date** | The due date of the activity. Format: YYYY-MM-DD | [optional] -**dueTime** | **String** | The due time of the activity in UTC. Format: HH:MM | [optional] +**due_date** | **Date** | The due date of the activity. Format: YYYY-MM-DD | [optional] +**due_time** | **String** | The due time of the activity in UTC. Format: HH:MM | [optional] **duration** | **String** | The duration of the activity. Format: HH:MM | [optional] -**dealId** | **Number** | The ID of the deal this activity is associated with | [optional] -**leadId** | **String** | The ID of the lead in the UUID format this activity is associated with | [optional] -**personId** | **Number** | The ID of the person this activity is associated with | [optional] -**projectId** | **Number** | The ID of the project this activity is associated with | [optional] -**orgId** | **Number** | The ID of the organization this activity is associated with | [optional] +**deal_id** | **Number** | The ID of the deal this activity is associated with | [optional] +**lead_id** | **String** | The ID of the lead in the UUID format this activity is associated with | [optional] +**person_id** | **Number** | The ID of the person this activity is associated with | [optional] +**project_id** | **Number** | The ID of the project this activity is associated with | [optional] +**org_id** | **Number** | The ID of the organization this activity is associated with | [optional] **location** | **String** | The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps. | [optional] -**publicDescription** | **String** | Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity. | [optional] +**public_description** | **String** | Additional details about the activity that is synced to your external calendar. Unlike the note added to the activity, the description is publicly visible to any guests added to the activity. | [optional] **id** | **Number** | The ID of the activity, generated when the activity was created | [optional] **note** | **String** | The note of the activity (HTML format) | [optional] **done** | **Boolean** | Whether the activity is done or not | [optional] **subject** | **String** | The subject of the activity | [optional] **type** | **String** | The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes. | [optional] -**userId** | **Number** | The ID of the user whom the activity is assigned to | [optional] +**user_id** | **Number** | The ID of the user whom the activity is assigned to | [optional] **participants** | **[Object]** | List of multiple persons (participants) this activity is associated with | [optional] -**busyFlag** | **Boolean** | Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] +**busy_flag** | **Boolean** | Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] **attendees** | **[Object]** | The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. | [optional] -**companyId** | **Number** | The user's company ID | [optional] -**referenceType** | **String** | If the activity references some other object, it is indicated here. For example, value `Salesphone` refers to activities created with Caller. | [optional] -**referenceId** | **Number** | Together with the `reference_type`, gives the ID of the other object | [optional] -**conferenceMeetingClient** | **String** | The ID of the Marketplace app, which is connected to this activity | [optional] -**conferenceMeetingUrl** | **String** | The link to join the meeting which is associated with this activity | [optional] -**conferenceMeetingId** | **String** | The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity | [optional] -**addTime** | **String** | The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**markedAsDoneTime** | **String** | The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**lastNotificationTime** | **String** | The date and time of latest notifications sent about this activity to the participants or the attendees of this activity | [optional] -**lastNotificationUserId** | **Number** | The ID of the user who triggered the sending of the latest notifications about this activity to the participants or the attendees of this activity | [optional] -**notificationLanguageId** | **Number** | The ID of the language the notifications are sent in | [optional] -**activeFlag** | **Boolean** | Whether the activity is active or not | [optional] -**updateTime** | **String** | The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateUserId** | **Number** | The ID of the user who was the last to update this activity | [optional] -**gcalEventId** | **String** | For the activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] -**googleCalendarId** | **String** | The Google calendar ID that this activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] -**googleCalendarEtag** | **String** | The Google calendar API etag (version) that is used for syncing this activity. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] -**calendarSyncIncludeContext** | **String** | For activities that sync to an external calendar, this setting indicates if the activity syncs with context (what are the deals, persons, organizations this activity is related to) | [optional] -**sourceTimezone** | **String** | The timezone the activity was created in an external calendar | [optional] -**recRule** | **String** | The rule for the recurrence of the activity. Is important for activities synced into Pipedrive from an external calendar. Example: \"RRULE:FREQ=WEEKLY;BYDAY=WE\" | [optional] -**recRuleExtension** | **String** | Additional rules for the recurrence of the activity, extend the `rec_rule`. Is important for activities synced into Pipedrive from an external calendar. | [optional] -**recMasterActivityId** | **Number** | The ID of parent activity for a recurrent activity if the current activity is an exception to recurrence rules | [optional] +**company_id** | **Number** | The user's company ID | [optional] +**reference_type** | **String** | If the activity references some other object, it is indicated here. For example, value `Salesphone` refers to activities created with Caller. | [optional] +**reference_id** | **Number** | Together with the `reference_type`, gives the ID of the other object | [optional] +**conference_meeting_client** | **String** | The ID of the Marketplace app, which is connected to this activity | [optional] +**conference_meeting_url** | **String** | The link to join the meeting which is associated with this activity | [optional] +**conference_meeting_id** | **String** | The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity | [optional] +**add_time** | **String** | The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**marked_as_done_time** | **String** | The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**last_notification_time** | **String** | The date and time of latest notifications sent about this activity to the participants or the attendees of this activity | [optional] +**last_notification_user_id** | **Number** | The ID of the user who triggered the sending of the latest notifications about this activity to the participants or the attendees of this activity | [optional] +**notification_language_id** | **Number** | The ID of the language the notifications are sent in | [optional] +**active_flag** | **Boolean** | Whether the activity is active or not | [optional] +**update_time** | **String** | The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_user_id** | **Number** | The ID of the user who was the last to update this activity | [optional] +**gcal_event_id** | **String** | For the activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] +**google_calendar_id** | **String** | The Google calendar ID that this activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] +**google_calendar_etag** | **String** | The Google calendar API etag (version) that is used for syncing this activity. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] +**calendar_sync_include_context** | **String** | For activities that sync to an external calendar, this setting indicates if the activity syncs with context (what are the deals, persons, organizations this activity is related to) | [optional] +**source_timezone** | **String** | The timezone the activity was created in an external calendar | [optional] +**rec_rule** | **String** | The rule for the recurrence of the activity. Is important for activities synced into Pipedrive from an external calendar. Example: \"RRULE:FREQ=WEEKLY;BYDAY=WE\" | [optional] +**rec_rule_extension** | **String** | Additional rules for the recurrence of the activity, extend the `rec_rule`. Is important for activities synced into Pipedrive from an external calendar. | [optional] +**rec_master_activity_id** | **Number** | The ID of parent activity for a recurrent activity if the current activity is an exception to recurrence rules | [optional] **series** | **[Object]** | The list of recurring activity instances. It is in a structure as follows: `[{due_date: \"2020-06-24\", due_time: \"10:00:00\"}]` | [optional] -**createdByUserId** | **Number** | The ID of the user who created the activity | [optional] -**locationSubpremise** | **String** | A subfield of the location field. Indicates apartment/suite number. | [optional] -**locationStreetNumber** | **String** | A subfield of the location field. Indicates house number. | [optional] -**locationRoute** | **String** | A subfield of the location field. Indicates street name. | [optional] -**locationSublocality** | **String** | A subfield of the location field. Indicates district/sublocality. | [optional] -**locationLocality** | **String** | A subfield of the location field. Indicates city/town/village/locality. | [optional] -**locationAdminAreaLevel1** | **String** | A subfield of the location field. Indicates state/county. | [optional] -**locationAdminAreaLevel2** | **String** | A subfield of the location field. Indicates region. | [optional] -**locationCountry** | **String** | A subfield of the location field. Indicates country. | [optional] -**locationPostalCode** | **String** | A subfield of the location field. Indicates ZIP/postal code. | [optional] -**locationFormattedAddress** | **String** | A subfield of the location field. Indicates full/combined address. | [optional] -**orgName** | **String** | The name of the organization this activity is associated with | [optional] -**personName** | **String** | The name of the person this activity is associated with | [optional] -**dealTitle** | **String** | The name of the deal this activity is associated with | [optional] -**ownerName** | **String** | The name of the user this activity is owned by | [optional] -**personDropboxBcc** | **String** | The BCC email address of the person | [optional] -**dealDropboxBcc** | **String** | The BCC email address of the deal | [optional] -**assignedToUserId** | **Number** | The ID of the user to whom the activity is assigned to. Equal to `user_id`. | [optional] +**created_by_user_id** | **Number** | The ID of the user who created the activity | [optional] +**location_subpremise** | **String** | A subfield of the location field. Indicates apartment/suite number. | [optional] +**location_street_number** | **String** | A subfield of the location field. Indicates house number. | [optional] +**location_route** | **String** | A subfield of the location field. Indicates street name. | [optional] +**location_sublocality** | **String** | A subfield of the location field. Indicates district/sublocality. | [optional] +**location_locality** | **String** | A subfield of the location field. Indicates city/town/village/locality. | [optional] +**location_admin_area_level_1** | **String** | A subfield of the location field. Indicates state/county. | [optional] +**location_admin_area_level_2** | **String** | A subfield of the location field. Indicates region. | [optional] +**location_country** | **String** | A subfield of the location field. Indicates country. | [optional] +**location_postal_code** | **String** | A subfield of the location field. Indicates ZIP/postal code. | [optional] +**location_formatted_address** | **String** | A subfield of the location field. Indicates full/combined address. | [optional] +**org_name** | **String** | The name of the organization this activity is associated with | [optional] +**person_name** | **String** | The name of the person this activity is associated with | [optional] +**deal_title** | **String** | The name of the deal this activity is associated with | [optional] +**owner_name** | **String** | The name of the user this activity is owned by | [optional] +**person_dropbox_bcc** | **String** | The BCC email address of the person | [optional] +**deal_dropbox_bcc** | **String** | The BCC email address of the deal | [optional] +**assigned_to_user_id** | **Number** | The ID of the user to whom the activity is assigned to. Equal to `user_id`. | [optional] **file** | **Object** | The file that is attached to this activity. For example, this can be a reference to an audio note file generated with Pipedrive mobile app. | [optional] diff --git a/docs/ActivityResponseObjectAllOf.md b/docs/ActivityResponseObjectAllOf.md index 381192f3..fb47476d 100644 --- a/docs/ActivityResponseObjectAllOf.md +++ b/docs/ActivityResponseObjectAllOf.md @@ -9,51 +9,51 @@ Name | Type | Description | Notes **done** | **Boolean** | Whether the activity is done or not | [optional] **subject** | **String** | The subject of the activity | [optional] **type** | **String** | The type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes. | [optional] -**userId** | **Number** | The ID of the user whom the activity is assigned to | [optional] +**user_id** | **Number** | The ID of the user whom the activity is assigned to | [optional] **participants** | **[Object]** | List of multiple persons (participants) this activity is associated with | [optional] -**busyFlag** | **Boolean** | Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] +**busy_flag** | **Boolean** | Marks if the activity is set as 'Busy' or 'Free'. If the flag is set to `true`, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (`null`), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time. | [optional] **attendees** | **[Object]** | The attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. | [optional] -**companyId** | **Number** | The user's company ID | [optional] -**referenceType** | **String** | If the activity references some other object, it is indicated here. For example, value `Salesphone` refers to activities created with Caller. | [optional] -**referenceId** | **Number** | Together with the `reference_type`, gives the ID of the other object | [optional] -**conferenceMeetingClient** | **String** | The ID of the Marketplace app, which is connected to this activity | [optional] -**conferenceMeetingUrl** | **String** | The link to join the meeting which is associated with this activity | [optional] -**conferenceMeetingId** | **String** | The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity | [optional] -**addTime** | **String** | The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**markedAsDoneTime** | **String** | The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**lastNotificationTime** | **String** | The date and time of latest notifications sent about this activity to the participants or the attendees of this activity | [optional] -**lastNotificationUserId** | **Number** | The ID of the user who triggered the sending of the latest notifications about this activity to the participants or the attendees of this activity | [optional] -**notificationLanguageId** | **Number** | The ID of the language the notifications are sent in | [optional] -**activeFlag** | **Boolean** | Whether the activity is active or not | [optional] -**updateTime** | **String** | The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateUserId** | **Number** | The ID of the user who was the last to update this activity | [optional] -**gcalEventId** | **String** | For the activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] -**googleCalendarId** | **String** | The Google calendar ID that this activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] -**googleCalendarEtag** | **String** | The Google calendar API etag (version) that is used for syncing this activity. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] -**calendarSyncIncludeContext** | **String** | For activities that sync to an external calendar, this setting indicates if the activity syncs with context (what are the deals, persons, organizations this activity is related to) | [optional] -**sourceTimezone** | **String** | The timezone the activity was created in an external calendar | [optional] -**recRule** | **String** | The rule for the recurrence of the activity. Is important for activities synced into Pipedrive from an external calendar. Example: \"RRULE:FREQ=WEEKLY;BYDAY=WE\" | [optional] -**recRuleExtension** | **String** | Additional rules for the recurrence of the activity, extend the `rec_rule`. Is important for activities synced into Pipedrive from an external calendar. | [optional] -**recMasterActivityId** | **Number** | The ID of parent activity for a recurrent activity if the current activity is an exception to recurrence rules | [optional] +**company_id** | **Number** | The user's company ID | [optional] +**reference_type** | **String** | If the activity references some other object, it is indicated here. For example, value `Salesphone` refers to activities created with Caller. | [optional] +**reference_id** | **Number** | Together with the `reference_type`, gives the ID of the other object | [optional] +**conference_meeting_client** | **String** | The ID of the Marketplace app, which is connected to this activity | [optional] +**conference_meeting_url** | **String** | The link to join the meeting which is associated with this activity | [optional] +**conference_meeting_id** | **String** | The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this activity | [optional] +**add_time** | **String** | The creation date and time of the activity in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**marked_as_done_time** | **String** | The date and time this activity was marked as done. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**last_notification_time** | **String** | The date and time of latest notifications sent about this activity to the participants or the attendees of this activity | [optional] +**last_notification_user_id** | **Number** | The ID of the user who triggered the sending of the latest notifications about this activity to the participants or the attendees of this activity | [optional] +**notification_language_id** | **Number** | The ID of the language the notifications are sent in | [optional] +**active_flag** | **Boolean** | Whether the activity is active or not | [optional] +**update_time** | **String** | The last update date and time of the activity. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_user_id** | **Number** | The ID of the user who was the last to update this activity | [optional] +**gcal_event_id** | **String** | For the activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] +**google_calendar_id** | **String** | The Google calendar ID that this activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] +**google_calendar_etag** | **String** | The Google calendar API etag (version) that is used for syncing this activity. NB! This field is related to old Google calendar sync and will be deprecated soon. | [optional] +**calendar_sync_include_context** | **String** | For activities that sync to an external calendar, this setting indicates if the activity syncs with context (what are the deals, persons, organizations this activity is related to) | [optional] +**source_timezone** | **String** | The timezone the activity was created in an external calendar | [optional] +**rec_rule** | **String** | The rule for the recurrence of the activity. Is important for activities synced into Pipedrive from an external calendar. Example: \"RRULE:FREQ=WEEKLY;BYDAY=WE\" | [optional] +**rec_rule_extension** | **String** | Additional rules for the recurrence of the activity, extend the `rec_rule`. Is important for activities synced into Pipedrive from an external calendar. | [optional] +**rec_master_activity_id** | **Number** | The ID of parent activity for a recurrent activity if the current activity is an exception to recurrence rules | [optional] **series** | **[Object]** | The list of recurring activity instances. It is in a structure as follows: `[{due_date: \"2020-06-24\", due_time: \"10:00:00\"}]` | [optional] -**createdByUserId** | **Number** | The ID of the user who created the activity | [optional] -**locationSubpremise** | **String** | A subfield of the location field. Indicates apartment/suite number. | [optional] -**locationStreetNumber** | **String** | A subfield of the location field. Indicates house number. | [optional] -**locationRoute** | **String** | A subfield of the location field. Indicates street name. | [optional] -**locationSublocality** | **String** | A subfield of the location field. Indicates district/sublocality. | [optional] -**locationLocality** | **String** | A subfield of the location field. Indicates city/town/village/locality. | [optional] -**locationAdminAreaLevel1** | **String** | A subfield of the location field. Indicates state/county. | [optional] -**locationAdminAreaLevel2** | **String** | A subfield of the location field. Indicates region. | [optional] -**locationCountry** | **String** | A subfield of the location field. Indicates country. | [optional] -**locationPostalCode** | **String** | A subfield of the location field. Indicates ZIP/postal code. | [optional] -**locationFormattedAddress** | **String** | A subfield of the location field. Indicates full/combined address. | [optional] -**orgName** | **String** | The name of the organization this activity is associated with | [optional] -**personName** | **String** | The name of the person this activity is associated with | [optional] -**dealTitle** | **String** | The name of the deal this activity is associated with | [optional] -**ownerName** | **String** | The name of the user this activity is owned by | [optional] -**personDropboxBcc** | **String** | The BCC email address of the person | [optional] -**dealDropboxBcc** | **String** | The BCC email address of the deal | [optional] -**assignedToUserId** | **Number** | The ID of the user to whom the activity is assigned to. Equal to `user_id`. | [optional] +**created_by_user_id** | **Number** | The ID of the user who created the activity | [optional] +**location_subpremise** | **String** | A subfield of the location field. Indicates apartment/suite number. | [optional] +**location_street_number** | **String** | A subfield of the location field. Indicates house number. | [optional] +**location_route** | **String** | A subfield of the location field. Indicates street name. | [optional] +**location_sublocality** | **String** | A subfield of the location field. Indicates district/sublocality. | [optional] +**location_locality** | **String** | A subfield of the location field. Indicates city/town/village/locality. | [optional] +**location_admin_area_level_1** | **String** | A subfield of the location field. Indicates state/county. | [optional] +**location_admin_area_level_2** | **String** | A subfield of the location field. Indicates region. | [optional] +**location_country** | **String** | A subfield of the location field. Indicates country. | [optional] +**location_postal_code** | **String** | A subfield of the location field. Indicates ZIP/postal code. | [optional] +**location_formatted_address** | **String** | A subfield of the location field. Indicates full/combined address. | [optional] +**org_name** | **String** | The name of the organization this activity is associated with | [optional] +**person_name** | **String** | The name of the person this activity is associated with | [optional] +**deal_title** | **String** | The name of the deal this activity is associated with | [optional] +**owner_name** | **String** | The name of the user this activity is owned by | [optional] +**person_dropbox_bcc** | **String** | The BCC email address of the person | [optional] +**deal_dropbox_bcc** | **String** | The BCC email address of the deal | [optional] +**assigned_to_user_id** | **Number** | The ID of the user to whom the activity is assigned to. Equal to `user_id`. | [optional] **file** | **Object** | The file that is attached to this activity. For example, this can be a reference to an audio note file generated with Pipedrive mobile app. | [optional] diff --git a/docs/ActivityTypeCreateRequest.md b/docs/ActivityTypeCreateRequest.md index 1a55f30b..3701ea6c 100644 --- a/docs/ActivityTypeCreateRequest.md +++ b/docs/ActivityTypeCreateRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the activity type | -**iconKey** | [**IconKey**](IconKey.md) | | +**icon_key** | [**IconKey**](IconKey.md) | | **color** | **String** | A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black) | [optional] diff --git a/docs/ActivityTypeObjectResponse.md b/docs/ActivityTypeObjectResponse.md index ea7be796..2fccf92b 100644 --- a/docs/ActivityTypeObjectResponse.md +++ b/docs/ActivityTypeObjectResponse.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the activity type | [optional] **name** | **String** | The name of the activity type | [optional] -**iconKey** | [**IconKey**](IconKey.md) | | [optional] +**icon_key** | [**IconKey**](IconKey.md) | | [optional] **color** | **String** | A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black) | [optional] -**orderNr** | **Number** | An order number for the activity type. Order numbers should be used to order the types in the activity type selections. | [optional] -**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** | **Date** | The creation time of the activity type | [optional] -**updateTime** | **Date** | The update time of the activity type | [optional] +**order_nr** | **Number** | An order number for the activity type. Order numbers should be used to order the types in the activity type selections. | [optional] +**key_string** | **String** | A string that is generated by the API based on the given name of the activity type upon creation | [optional] +**active_flag** | **Boolean** | The active flag of the activity type | [optional] +**is_custom_flag** | **Boolean** | Whether the activity type is a custom one or not | [optional] +**add_time** | **Date** | The creation time of the activity type | [optional] +**update_time** | **Date** | The update time of the activity type | [optional] diff --git a/docs/ActivityTypeUpdateRequest.md b/docs/ActivityTypeUpdateRequest.md index 6ddaab15..469b10b5 100644 --- a/docs/ActivityTypeUpdateRequest.md +++ b/docs/ActivityTypeUpdateRequest.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the activity type | [optional] -**iconKey** | [**IconKey**](IconKey.md) | | [optional] +**icon_key** | [**IconKey**](IconKey.md) | | [optional] **color** | **String** | A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black) | [optional] -**orderNr** | **Number** | An order number for this activity type. Order numbers should be used to order the types in the activity type selections. | [optional] +**order_nr** | **Number** | An order number for this activity type. Order numbers should be used to order the types in the activity type selections. | [optional] diff --git a/docs/ActivityTypesApi.md b/docs/ActivityTypesApi.md index 8799969a..15e16e7f 100644 --- a/docs/ActivityTypesApi.md +++ b/docs/ActivityTypesApi.md @@ -51,7 +51,7 @@ apiInstance.addActivityType(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **activityTypeCreateRequest** | [**ActivityTypeCreateRequest**](ActivityTypeCreateRequest.md)| | [optional] + **ActivityTypeCreateRequest** | [**ActivityTypeCreateRequest**](ActivityTypeCreateRequest.md)| | [optional] ### Return type @@ -263,7 +263,7 @@ apiInstance.updateActivityType(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the activity type | - **activityTypeUpdateRequest** | [**ActivityTypeUpdateRequest**](ActivityTypeUpdateRequest.md)| | [optional] + **ActivityTypeUpdateRequest** | [**ActivityTypeUpdateRequest**](ActivityTypeUpdateRequest.md)| | [optional] ### Return type diff --git a/docs/AddActivityResponse200.md b/docs/AddActivityResponse200.md index 14400f05..df8f03ca 100644 --- a/docs/AddActivityResponse200.md +++ b/docs/AddActivityResponse200.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**ActivityResponseObject**](ActivityResponseObject.md) | | [optional] -**additionalData** | [**ActivityRecordAdditionalData**](ActivityRecordAdditionalData.md) | | [optional] -**relatedObjects** | [**AddActivityResponse200RelatedObjects**](AddActivityResponse200RelatedObjects.md) | | [optional] +**additional_data** | [**ActivityRecordAdditionalData**](ActivityRecordAdditionalData.md) | | [optional] +**related_objects** | [**AddActivityResponse200RelatedObjects**](AddActivityResponse200RelatedObjects.md) | | [optional] diff --git a/docs/AddDealFollowerRequest.md b/docs/AddDealFollowerRequest.md index 1ed0addb..cc561804 100644 --- a/docs/AddDealFollowerRequest.md +++ b/docs/AddDealFollowerRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user | +**user_id** | **Number** | The ID of the user | diff --git a/docs/AddDealParticipantRequest.md b/docs/AddDealParticipantRequest.md index 28724264..d9576c03 100644 --- a/docs/AddDealParticipantRequest.md +++ b/docs/AddDealParticipantRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**personId** | **Number** | The ID of the person | +**person_id** | **Number** | The ID of the person | diff --git a/docs/AddFollowerToPersonResponseAllOfData.md b/docs/AddFollowerToPersonResponseAllOfData.md index 600442a1..76e1f7f8 100644 --- a/docs/AddFollowerToPersonResponseAllOfData.md +++ b/docs/AddFollowerToPersonResponseAllOfData.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user who was added as a follower to a person | [optional] +**user_id** | **Number** | The ID of the user who was added as a follower to a person | [optional] **id** | **Number** | The ID of the follower | [optional] -**personId** | **Number** | The ID of the person to whom the follower was added | [optional] -**addTime** | **String** | The date and time when the follower was added to a person. Format: YYYY-MM-DD HH:MM:SS | [optional] +**person_id** | **Number** | The ID of the person to whom the follower was added | [optional] +**add_time** | **String** | The date and time when the follower was added to a person. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/docs/AddLeadRequest.md b/docs/AddLeadRequest.md index 1c33dcd0..e52b07c1 100644 --- a/docs/AddLeadRequest.md +++ b/docs/AddLeadRequest.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The name of the lead | -**ownerId** | **Number** | The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used. | [optional] -**labelIds** | **[String]** | The IDs of the lead labels which will be associated with the lead | [optional] -**personId** | **Number** | The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless `organization_id` is specified. | [optional] -**organizationId** | **Number** | The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified. | [optional] +**owner_id** | **Number** | The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used. | [optional] +**label_ids** | **[String]** | The IDs of the lead labels which will be associated with the lead | [optional] +**person_id** | **Number** | The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless `organization_id` is specified. | [optional] +**organization_id** | **Number** | The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified. | [optional] **value** | [**LeadValue**](LeadValue.md) | | [optional] -**expectedCloseDate** | **Date** | The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD. | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] -**wasSeen** | **Boolean** | A flag indicating whether the lead was seen by someone in the Pipedrive UI | [optional] -**originId** | **String** | The optional ID to further distinguish the origin of the lead - e.g. Which API integration created this lead. If omitted, `origin_id` will be set to null. | [optional] +**expected_close_date** | **Date** | The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD. | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**was_seen** | **Boolean** | A flag indicating whether the lead was seen by someone in the Pipedrive UI | [optional] +**origin_id** | **String** | The optional ID to further distinguish the origin of the lead - e.g. Which API integration created this lead. If omitted, `origin_id` will be set to null. | [optional] **channel** | **Number** | The ID of Marketing channel this lead was created from. Provided value must be one of the channels configured for your company. You can fetch allowed values with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. If omitted, channel will be set to null. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] diff --git a/docs/AddNoteRequest.md b/docs/AddNoteRequest.md index 3430ab7b..03072c47 100644 --- a/docs/AddNoteRequest.md +++ b/docs/AddNoteRequest.md @@ -5,15 +5,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | **String** | The content of the note in HTML format. Subject to sanitization on the back-end. | -**leadId** | **String** | The ID of the lead the note will be attached to. This property is required unless one of (`deal_id/person_id/org_id`) is specified. | [optional] -**dealId** | **Number** | The ID of the deal the note will be attached to. This property is required unless one of (`lead_id/person_id/org_id`) is specified. | [optional] -**personId** | **Number** | The ID of the person this note will be attached to. This property is required unless one of (`deal_id/lead_id/org_id`) is specified. | [optional] -**orgId** | **Number** | The ID of the organization this note will be attached to. This property is required unless one of (`deal_id/lead_id/person_id`) is specified. | [optional] -**userId** | **Number** | The ID of the user who will be marked as the author of the note. Only an admin can change the author. | [optional] -**addTime** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] -**pinnedToLeadFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to lead pinning state (`lead_id` is also required) | [optional] -**pinnedToDealFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to deal pinning state (`deal_id` is also required) | [optional] -**pinnedToOrganizationFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to organization pinning state (`org_id` is also required) | [optional] -**pinnedToPersonFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to person pinning state (`person_id` is also required) | [optional] +**lead_id** | **String** | The ID of the lead the note will be attached to. This property is required unless one of (`deal_id/person_id/org_id`) is specified. | [optional] +**deal_id** | **Number** | The ID of the deal the note will be attached to. This property is required unless one of (`lead_id/person_id/org_id`) is specified. | [optional] +**person_id** | **Number** | The ID of the person this note will be attached to. This property is required unless one of (`deal_id/lead_id/org_id`) is specified. | [optional] +**org_id** | **Number** | The ID of the organization this note will be attached to. This property is required unless one of (`deal_id/lead_id/person_id`) is specified. | [optional] +**user_id** | **Number** | The ID of the user who will be marked as the author of the note. Only an admin can change the author. | [optional] +**add_time** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**pinned_to_lead_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to lead pinning state (`lead_id` is also required) | [optional] +**pinned_to_deal_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to deal pinning state (`deal_id` is also required) | [optional] +**pinned_to_organization_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to organization pinning state (`org_id` is also required) | [optional] +**pinned_to_person_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to person pinning state (`person_id` is also required) | [optional] diff --git a/docs/AddNoteRequestAllOf.md b/docs/AddNoteRequestAllOf.md index 5669af0e..e3f36a64 100644 --- a/docs/AddNoteRequestAllOf.md +++ b/docs/AddNoteRequestAllOf.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | **String** | The content of the note in HTML format. Subject to sanitization on the back-end. | -**leadId** | **String** | The ID of the lead the note will be attached to. This property is required unless one of (`deal_id/person_id/org_id`) is specified. | [optional] -**dealId** | **Number** | The ID of the deal the note will be attached to. This property is required unless one of (`lead_id/person_id/org_id`) is specified. | [optional] -**personId** | **Number** | The ID of the person this note will be attached to. This property is required unless one of (`deal_id/lead_id/org_id`) is specified. | [optional] -**orgId** | **Number** | The ID of the organization this note will be attached to. This property is required unless one of (`deal_id/lead_id/person_id`) is specified. | [optional] +**lead_id** | **String** | The ID of the lead the note will be attached to. This property is required unless one of (`deal_id/person_id/org_id`) is specified. | [optional] +**deal_id** | **Number** | The ID of the deal the note will be attached to. This property is required unless one of (`lead_id/person_id/org_id`) is specified. | [optional] +**person_id** | **Number** | The ID of the person this note will be attached to. This property is required unless one of (`deal_id/lead_id/org_id`) is specified. | [optional] +**org_id** | **Number** | The ID of the organization this note will be attached to. This property is required unless one of (`deal_id/lead_id/person_id`) is specified. | [optional] diff --git a/docs/AddOrUpdateRoleSettingRequest.md b/docs/AddOrUpdateRoleSettingRequest.md index b4d8d2cb..08bbdf99 100644 --- a/docs/AddOrUpdateRoleSettingRequest.md +++ b/docs/AddOrUpdateRoleSettingRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**settingKey** | **String** | | +**setting_key** | **String** | | **value** | **Number** | Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class='role-setting'> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class='role-setting'> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner&#39;s visibility group</td></tr> <tr><td>`5`</td><td>Owner&#39;s visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href='https://support.pipedrive.com/en/article/visibility-groups'>here</a>. | diff --git a/docs/AddOrganizationFollowerRequest.md b/docs/AddOrganizationFollowerRequest.md index c307e891..350d41e2 100644 --- a/docs/AddOrganizationFollowerRequest.md +++ b/docs/AddOrganizationFollowerRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user | +**user_id** | **Number** | The ID of the user | diff --git a/docs/AddOrganizationRelationshipRequest.md b/docs/AddOrganizationRelationshipRequest.md index c4af32df..6dac3e34 100644 --- a/docs/AddOrganizationRelationshipRequest.md +++ b/docs/AddOrganizationRelationshipRequest.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orgId** | **Number** | The ID of the base organization for the returned calculated values | [optional] +**org_id** | **Number** | The ID of the base organization for the returned calculated values | [optional] **type** | **String** | The type of organization relationship | -**relOwnerOrgId** | **Number** | The owner of the relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter. | -**relLinkedOrgId** | **Number** | The linked organization in the relationship. If type is `parent`, then the linked organization is the daughter. | +**rel_owner_org_id** | **Number** | The owner of the relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter. | +**rel_linked_org_id** | **Number** | The linked organization in the relationship. If type is `parent`, then the linked organization is the daughter. | diff --git a/docs/AddPersonFollowerRequest.md b/docs/AddPersonFollowerRequest.md index f7474e09..88070104 100644 --- a/docs/AddPersonFollowerRequest.md +++ b/docs/AddPersonFollowerRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user | +**user_id** | **Number** | The ID of the user | diff --git a/docs/AddPersonResponse.md b/docs/AddPersonResponse.md index aeaa9480..fe0ddf50 100644 --- a/docs/AddPersonResponse.md +++ b/docs/AddPersonResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**PersonItem**](PersonItem.md) | | [optional] -**relatedObjects** | [**ListProductsResponseAllOfRelatedObjects**](ListProductsResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**ListProductsResponseAllOfRelatedObjects**](ListProductsResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/AddPersonResponseAllOf.md b/docs/AddPersonResponseAllOf.md index 86e10d63..e9628ee0 100644 --- a/docs/AddPersonResponseAllOf.md +++ b/docs/AddPersonResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**PersonItem**](PersonItem.md) | | [optional] -**relatedObjects** | [**ListProductsResponseAllOfRelatedObjects**](ListProductsResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**ListProductsResponseAllOfRelatedObjects**](ListProductsResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/AddProductAttachmentDetails.md b/docs/AddProductAttachmentDetails.md index 31d35bab..ee9cc8e3 100644 --- a/docs/AddProductAttachmentDetails.md +++ b/docs/AddProductAttachmentDetails.md @@ -4,31 +4,31 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productId** | **Number** | The ID of the product | [optional] -**itemPrice** | **Number** | The price at which this product will be added to the deal | [optional] +**product_id** | **Number** | The ID of the product | [optional] +**item_price** | **Number** | The price at which this product will be added to the deal | [optional] **quantity** | **Number** | Quantity – e.g. how many items of this product will be added to the deal | [optional] **discount** | **Number** | The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage | [optional] [default to 0] -**discountType** | **String** | The type of the discount's value | [optional] [default to 'percentage'] +**discount_type** | **String** | The type of the discount's value | [optional] [default to 'percentage'] **duration** | **Number** | The duration of the product. If omitted, will be set to 1 | [optional] [default to 1] -**durationUnit** | **String** | The type of the duration. (For example hourly, daily, etc.) | [optional] -**productVariationId** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] +**duration_unit** | **String** | The type of the duration. (For example hourly, daily, etc.) | [optional] +**product_variation_id** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] **comments** | **String** | A textual comment associated with this product-deal attachment | [optional] **tax** | **Number** | The product tax | [optional] -**taxMethod** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional] -**enabledFlag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] -**billingFrequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] -**billingFrequencyCycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] -**billingStartDate** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] +**tax_method** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional] +**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] +**billing_frequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] +**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] +**billing_start_date** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] **id** | **Number** | The ID of the deal-product (the ID of the product attached to the deal) | [optional] -**companyId** | **Number** | The ID of the company | [optional] -**dealId** | **Number** | The ID of the deal | [optional] +**company_id** | **Number** | The ID of the company | [optional] +**deal_id** | **Number** | The ID of the deal | [optional] **sum** | **Number** | The sum of all the products attached to the deal | [optional] **currency** | **String** | The currency associated with the deal product | [optional] -**addTime** | **String** | The date and time when the product was added to the deal | [optional] -**lastEdit** | **String** | The date and time when the deal product was last edited | [optional] -**activeFlag** | **Boolean** | Whether the product is active or not | [optional] +**add_time** | **String** | The date and time when the product was added to the deal | [optional] +**last_edit** | **String** | The date and time when the deal product was last edited | [optional] +**active_flag** | **Boolean** | Whether the product is active or not | [optional] **name** | **String** | The product name | [optional] -**productAttachmentId** | **Number** | The ID of the deal-product (the ID of the product attached to the deal) | [optional] +**product_attachment_id** | **Number** | The ID of the deal-product (the ID of the product attached to the deal) | [optional] diff --git a/docs/AddProductAttachmentDetailsAllOf.md b/docs/AddProductAttachmentDetailsAllOf.md index 934de3b6..5e0b50d8 100644 --- a/docs/AddProductAttachmentDetailsAllOf.md +++ b/docs/AddProductAttachmentDetailsAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productAttachmentId** | **Number** | The ID of the deal-product (the ID of the product attached to the deal) | [optional] +**product_attachment_id** | **Number** | The ID of the deal-product (the ID of the product attached to the deal) | [optional] diff --git a/docs/AddProductFollowerRequest.md b/docs/AddProductFollowerRequest.md index 5fbfcbc0..907e362e 100644 --- a/docs/AddProductFollowerRequest.md +++ b/docs/AddProductFollowerRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user | +**user_id** | **Number** | The ID of the user | diff --git a/docs/AddProductRequestBody.md b/docs/AddProductRequestBody.md index 1eb7970a..c0334ead 100644 --- a/docs/AddProductRequestBody.md +++ b/docs/AddProductRequestBody.md @@ -8,12 +8,12 @@ Name | Type | Description | Notes **code** | **String** | The product code | [optional] **unit** | **String** | The unit in which this product is sold | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] -**activeFlag** | **Boolean** | Whether this product will be made active or not | [optional] [default to true] +**active_flag** | **Boolean** | Whether this product will be made active or not | [optional] [default to true] **selectable** | **Boolean** | Whether this product can be selected in deals or not | [optional] [default to true] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] -**ownerId** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**owner_id** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional] **prices** | **[Object]** | An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional] -**billingFrequency** | [**BillingFrequency1**](BillingFrequency1.md) | | [optional] -**billingFrequencyCycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] +**billing_frequency** | [**BillingFrequency1**](BillingFrequency1.md) | | [optional] +**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] diff --git a/docs/AddProductRequestBodyAllOf.md b/docs/AddProductRequestBodyAllOf.md index 46554fb0..2ce33c97 100644 --- a/docs/AddProductRequestBodyAllOf.md +++ b/docs/AddProductRequestBodyAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**billingFrequency** | [**BillingFrequency1**](BillingFrequency1.md) | | [optional] +**billing_frequency** | [**BillingFrequency1**](BillingFrequency1.md) | | [optional] diff --git a/docs/AddProjectResponse201.md b/docs/AddProjectResponse201.md index 319c0b70..b7635905 100644 --- a/docs/AddProjectResponse201.md +++ b/docs/AddProjectResponse201.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**ProjectResponseObject**](ProjectResponseObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/AddRole.md b/docs/AddRole.md index 46590af4..f47b7c12 100644 --- a/docs/AddRole.md +++ b/docs/AddRole.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the role | -**parentRoleId** | **Number** | The ID of the parent role | [optional] +**parent_role_id** | **Number** | The ID of the parent role | [optional] diff --git a/docs/AddRoleAssignmentRequest.md b/docs/AddRoleAssignmentRequest.md index cd8859da..333fbc07 100644 --- a/docs/AddRoleAssignmentRequest.md +++ b/docs/AddRoleAssignmentRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user | +**user_id** | **Number** | The ID of the user | diff --git a/docs/AddTaskResponse201.md b/docs/AddTaskResponse201.md index ad96f671..964666a0 100644 --- a/docs/AddTaskResponse201.md +++ b/docs/AddTaskResponse201.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**TaskResponseObject**](TaskResponseObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/AddUserRequest.md b/docs/AddUserRequest.md index db4e49a7..5f4e46db 100644 --- a/docs/AddUserRequest.md +++ b/docs/AddUserRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **String** | The email of the user | **access** | [**[UserAccess]**](UserAccess.md) | The access given to the user. Each item in the array represents access to a specific app. Optionally may include either admin flag or permission set ID to specify which access to give within the app. If both are omitted, the default access for the corresponding app will be used. It requires structure as follows: `[{ app: 'sales', permission_set_id: '62cc4d7f-4038-4352-abf3-a8c1c822b631' }, { app: 'global', admin: true }, { app: 'account_settings' }]` | [optional] -**activeFlag** | **Boolean** | Whether the user is active or not. `false` = Not activated, `true` = Activated | [optional] [default to true] +**active_flag** | **Boolean** | Whether the user is active or not. `false` = Not activated, `true` = Activated | [optional] [default to true] diff --git a/docs/AddWebhookRequest.md b/docs/AddWebhookRequest.md index 76c3d40a..66f130f4 100644 --- a/docs/AddWebhookRequest.md +++ b/docs/AddWebhookRequest.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**subscriptionUrl** | **String** | A full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the `subscription_url` and the chosen URL must not redirect to another link. | -**eventAction** | **String** | The type of action to receive notifications about. Wildcard will match all supported actions. | -**eventObject** | **String** | The type of object to receive notifications about. Wildcard will match all supported objects. | -**userId** | **Number** | The ID of the user that this webhook will be authorized with. You have the option to use a different user's `user_id`. If it is not set, the current user's `user_id` will be used. As each webhook event is checked against a user's permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s `user_id`. | [optional] -**httpAuthUser** | **String** | The HTTP basic auth username of the subscription URL endpoint (if required) | [optional] -**httpAuthPassword** | **String** | The HTTP basic auth password of the subscription URL endpoint (if required) | [optional] +**subscription_url** | **String** | A full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the `subscription_url` and the chosen URL must not redirect to another link. | +**event_action** | **String** | The type of action to receive notifications about. Wildcard will match all supported actions. | +**event_object** | **String** | The type of object to receive notifications about. Wildcard will match all supported objects. | +**user_id** | **Number** | The ID of the user that this webhook will be authorized with. You have the option to use a different user's `user_id`. If it is not set, the current user's `user_id` will be used. As each webhook event is checked against a user's permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s `user_id`. | [optional] +**http_auth_user** | **String** | The HTTP basic auth username of the subscription URL endpoint (if required) | [optional] +**http_auth_password** | **String** | The HTTP basic auth password of the subscription URL endpoint (if required) | [optional] **version** | **String** | The webhook's version | [optional] [default to '1.0'] diff --git a/docs/AddedDealFollowerData.md b/docs/AddedDealFollowerData.md index e9574a73..64c9b8d6 100644 --- a/docs/AddedDealFollowerData.md +++ b/docs/AddedDealFollowerData.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The user ID who added the follower | [optional] +**user_id** | **Number** | The user ID who added the follower | [optional] **id** | **Number** | The follower ID | [optional] -**dealId** | **Number** | The ID of the deal which the follower was added to | [optional] -**addTime** | **String** | The date and time when the deal follower was added | [optional] +**deal_id** | **Number** | The ID of the deal which the follower was added to | [optional] +**add_time** | **String** | The date and time when the deal follower was added | [optional] diff --git a/docs/AdditionalBaseOrganizationItemInfo.md b/docs/AdditionalBaseOrganizationItemInfo.md index 6aef6606..eb7df2da 100644 --- a/docs/AdditionalBaseOrganizationItemInfo.md +++ b/docs/AdditionalBaseOrganizationItemInfo.md @@ -4,37 +4,37 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**emailMessagesCount** | **Number** | The count of email messages related to the organization | [optional] -**peopleCount** | **Number** | The count of persons related to the organization | [optional] -**activitiesCount** | **Number** | The count of activities related to the organization | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the organization | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the organization | [optional] -**filesCount** | **Number** | The count of files related to the organization | [optional] -**notesCount** | **Number** | The count of notes related to the organization | [optional] -**followersCount** | **Number** | The count of followers related to the organization | [optional] +**email_messages_count** | **Number** | The count of email messages related to the organization | [optional] +**people_count** | **Number** | The count of persons related to the organization | [optional] +**activities_count** | **Number** | The count of activities related to the organization | [optional] +**done_activities_count** | **Number** | The count of done activities related to the organization | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the organization | [optional] +**files_count** | **Number** | The count of files related to the organization | [optional] +**notes_count** | **Number** | The count of notes related to the organization | [optional] +**followers_count** | **Number** | The count of followers related to the organization | [optional] **address** | **String** | The full address of the organization | [optional] -**addressSubpremise** | **String** | The sub-premise of the organization location | [optional] -**addressStreetNumber** | **String** | The street number of the organization location | [optional] -**addressRoute** | **String** | The route of the organization location | [optional] -**addressSublocality** | **String** | The sub-locality of the organization location | [optional] -**addressLocality** | **String** | The locality of the organization location | [optional] -**addressAdminAreaLevel1** | **String** | The level 1 admin area of the organization location | [optional] -**addressAdminAreaLevel2** | **String** | The level 2 admin area of the organization location | [optional] -**addressCountry** | **String** | The country of the organization location | [optional] -**addressPostalCode** | **String** | The postal code of the organization location | [optional] -**addressFormattedAddress** | **String** | The formatted organization location | [optional] -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] +**address_subpremise** | **String** | The sub-premise of the organization location | [optional] +**address_street_number** | **String** | The street number of the organization location | [optional] +**address_route** | **String** | The route of the organization location | [optional] +**address_sublocality** | **String** | The sub-locality of the organization location | [optional] +**address_locality** | **String** | The locality of the organization location | [optional] +**address_admin_area_level_1** | **String** | The level 1 admin area of the organization location | [optional] +**address_admin_area_level_2** | **String** | The level 2 admin area of the organization location | [optional] +**address_country** | **String** | The country of the organization location | [optional] +**address_postal_code** | **String** | The postal code of the organization location | [optional] +**address_formatted_address** | **String** | The formatted organization location | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] diff --git a/docs/AdditionalData.md b/docs/AdditionalData.md index 9904455e..c593abf9 100644 --- a/docs/AdditionalData.md +++ b/docs/AdditionalData.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start** | **Number** | Pagination start | [optional] **limit** | **Number** | Items shown per page | [optional] -**moreItemsInCollection** | **Boolean** | If there are more list items in the collection than displayed or not | [optional] +**more_items_in_collection** | **Boolean** | If there are more list items in the collection than displayed or not | [optional] diff --git a/docs/AdditionalDataWithCursorPagination.md b/docs/AdditionalDataWithCursorPagination.md index 2b502720..7d32fa08 100644 --- a/docs/AdditionalDataWithCursorPagination.md +++ b/docs/AdditionalDataWithCursorPagination.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**nextCursor** | **String** | The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned. | [optional] +**next_cursor** | **String** | The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned. | [optional] diff --git a/docs/AdditionalMergePersonInfo.md b/docs/AdditionalMergePersonInfo.md index bf0c482a..cd950feb 100644 --- a/docs/AdditionalMergePersonInfo.md +++ b/docs/AdditionalMergePersonInfo.md @@ -4,35 +4,35 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ownerId** | **Number** | The ID of the owner related to the person | [optional] -**orgId** | **Number** | The ID of the organization related to the person | [optional] -**mergeWhatId** | **Number** | The ID of the person with what the main person was merged | [optional] +**owner_id** | **Number** | The ID of the owner related to the person | [optional] +**org_id** | **Number** | The ID of the organization related to the person | [optional] +**merge_what_id** | **Number** | The ID of the person with what the main person was merged | [optional] **name** | **String** | The name of the person | [optional] -**firstName** | **String** | The first name of the person | [optional] -**lastName** | **String** | The last name of the person | [optional] -**emailMessagesCount** | **Number** | The count of email messages related to the person | [optional] -**activitiesCount** | **Number** | The count of activities related to the person | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the person | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the person | [optional] -**filesCount** | **Number** | The count of files related to the person | [optional] -**notesCount** | **Number** | The count of notes related to the person | [optional] -**followersCount** | **Number** | The count of followers related to the person | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the person | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the person | [optional] -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] -**participantOpenDealsCount** | **Number** | The count of open participant deals related with the item | [optional] -**participantClosedDealsCount** | **Number** | The count of closed participant deals related with the item | [optional] +**first_name** | **String** | The first name of the person | [optional] +**last_name** | **String** | The last name of the person | [optional] +**email_messages_count** | **Number** | The count of email messages related to the person | [optional] +**activities_count** | **Number** | The count of activities related to the person | [optional] +**done_activities_count** | **Number** | The count of done activities related to the person | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the person | [optional] +**files_count** | **Number** | The count of files related to the person | [optional] +**notes_count** | **Number** | The count of notes related to the person | [optional] +**followers_count** | **Number** | The count of followers related to the person | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the person | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the person | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] +**participant_open_deals_count** | **Number** | The count of open participant deals related with the item | [optional] +**participant_closed_deals_count** | **Number** | The count of closed participant deals related with the item | [optional] diff --git a/docs/AdditionalPersonInfo.md b/docs/AdditionalPersonInfo.md index 014c8f6f..03402a1b 100644 --- a/docs/AdditionalPersonInfo.md +++ b/docs/AdditionalPersonInfo.md @@ -4,32 +4,32 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ownerId** | [**Owner**](Owner.md) | | [optional] -**orgId** | [**RelationshipOrganizationInfoItemWithActiveFlag**](RelationshipOrganizationInfoItemWithActiveFlag.md) | | [optional] +**owner_id** | [**Owner**](Owner.md) | | [optional] +**org_id** | [**RelationshipOrganizationInfoItemWithActiveFlag**](RelationshipOrganizationInfoItemWithActiveFlag.md) | | [optional] **name** | **String** | The name of the person | [optional] -**firstName** | **String** | The first name of the person | [optional] -**lastName** | **String** | The last name of the person | [optional] -**emailMessagesCount** | **Number** | The count of email messages related to the person | [optional] -**activitiesCount** | **Number** | The count of activities related to the person | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the person | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the person | [optional] -**filesCount** | **Number** | The count of files related to the person | [optional] -**notesCount** | **Number** | The count of notes related to the person | [optional] -**followersCount** | **Number** | The count of followers related to the person | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the person | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the person | [optional] -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] +**first_name** | **String** | The first name of the person | [optional] +**last_name** | **String** | The last name of the person | [optional] +**email_messages_count** | **Number** | The count of email messages related to the person | [optional] +**activities_count** | **Number** | The count of activities related to the person | [optional] +**done_activities_count** | **Number** | The count of done activities related to the person | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the person | [optional] +**files_count** | **Number** | The count of files related to the person | [optional] +**notes_count** | **Number** | The count of notes related to the person | [optional] +**followers_count** | **Number** | The count of followers related to the person | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the person | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the person | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] diff --git a/docs/AllOrganizationRelationshipsGetResponse.md b/docs/AllOrganizationRelationshipsGetResponse.md index 9c5eba37..b0555123 100644 --- a/docs/AllOrganizationRelationshipsGetResponse.md +++ b/docs/AllOrganizationRelationshipsGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[OrganizationRelationshipDetails]**](OrganizationRelationshipDetails.md) | The array of organization relationships | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/AllOrganizationRelationshipsGetResponseAllOf.md b/docs/AllOrganizationRelationshipsGetResponseAllOf.md index c6c70782..f49607cc 100644 --- a/docs/AllOrganizationRelationshipsGetResponseAllOf.md +++ b/docs/AllOrganizationRelationshipsGetResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[OrganizationRelationshipDetails]**](OrganizationRelationshipDetails.md) | The array of organization relationships | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/AllOrganizationsGetResponse.md b/docs/AllOrganizationsGetResponse.md index 402d7503..018dc415 100644 --- a/docs/AllOrganizationsGetResponse.md +++ b/docs/AllOrganizationsGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[BaseOrganizationItem]**](BaseOrganizationItem.md) | The array of organizations | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/AllOrganizationsGetResponseAllOf.md b/docs/AllOrganizationsGetResponseAllOf.md index 0fbd93b9..7a0d96ab 100644 --- a/docs/AllOrganizationsGetResponseAllOf.md +++ b/docs/AllOrganizationsGetResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[BaseOrganizationItem]**](BaseOrganizationItem.md) | The array of organizations | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/BaseComment.md b/docs/BaseComment.md index 7c972382..1ed0470d 100644 --- a/docs/BaseComment.md +++ b/docs/BaseComment.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | **String** | The ID of the note | [optional] -**activeFlag** | **Boolean** | Whether the note is active or deleted | [optional] -**addTime** | **String** | The creation date and time of the note | [optional] -**updateTime** | **String** | The creation date and time of the note | [optional] +**active_flag** | **Boolean** | Whether the note is active or deleted | [optional] +**add_time** | **String** | The creation date and time of the note | [optional] +**update_time** | **String** | The creation date and time of the note | [optional] **content** | **String** | The content of the note in HTML format. Subject to sanitization on the back-end. | [optional] -**objectId** | **String** | The ID of the object that the comment is attached to, will be the id of the note | [optional] -**objectType** | **String** | The type of object that the comment is attached to, will be \"note\" | [optional] -**userId** | **Number** | The ID of the user who created the comment | [optional] -**updaterId** | **Number** | The ID of the user who last updated the comment | [optional] -**companyId** | **Number** | The ID of the company | [optional] +**object_id** | **String** | The ID of the object that the comment is attached to, will be the id of the note | [optional] +**object_type** | **String** | The type of object that the comment is attached to, will be \"note\" | [optional] +**user_id** | **Number** | The ID of the user who created the comment | [optional] +**updater_id** | **Number** | The ID of the user who last updated the comment | [optional] +**company_id** | **Number** | The ID of the company | [optional] diff --git a/docs/BaseCurrency.md b/docs/BaseCurrency.md index 33bfd2bc..39cac780 100644 --- a/docs/BaseCurrency.md +++ b/docs/BaseCurrency.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **id** | **Number** | The ID of the currency | [optional] **code** | **String** | The code of the currency | [optional] **name** | **String** | The name of the currency | [optional] -**decimalPoints** | **Number** | The amount of decimal points of the currency | [optional] +**decimal_points** | **Number** | The amount of decimal points of the currency | [optional] **symbol** | **String** | The symbol of the currency | [optional] -**activeFlag** | **Boolean** | Whether the currency is active or not | [optional] -**isCustomFlag** | **Boolean** | Whether the currency is a custom one or not | [optional] +**active_flag** | **Boolean** | Whether the currency is active or not | [optional] +**is_custom_flag** | **Boolean** | Whether the currency is a custom one or not | [optional] diff --git a/docs/BaseDeal.md b/docs/BaseDeal.md index ba82acb3..3466feaf 100644 --- a/docs/BaseDeal.md +++ b/docs/BaseDeal.md @@ -4,61 +4,61 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**stageId** | **Number** | The ID of the deal stage | [optional] +**stage_id** | **Number** | The ID of the deal stage | [optional] **title** | **String** | The title of the deal | [optional] **value** | **Number** | The value of the deal | [optional] **currency** | **String** | The currency associated with the deal | [optional] -**addTime** | **String** | The creation date and time of the deal | [optional] -**updateTime** | **String** | The last updated date and time of the deal | [optional] -**stageChangeTime** | **String** | The last updated date and time of the deal stage | [optional] +**add_time** | **String** | The creation date and time of the deal | [optional] +**update_time** | **String** | The last updated date and time of the deal | [optional] +**stage_change_time** | **String** | The last updated date and time of the deal stage | [optional] **active** | **Boolean** | Whether the deal is active or not | [optional] **deleted** | **Boolean** | Whether the deal is deleted or not | [optional] **status** | **String** | The status of the deal | [optional] **probability** | **Number** | The success probability percentage of the deal | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] -**lostReason** | **String** | The reason for losing the deal | [optional] -**visibleTo** | **String** | The visibility of the deal | [optional] -**closeTime** | **String** | The date and time of closing the deal | [optional] -**pipelineId** | **Number** | The ID of the pipeline associated with the deal | [optional] -**wonTime** | **String** | The date and time of changing the deal status as won | [optional] -**firstWonTime** | **String** | The date and time of the first time changing the deal status as won | [optional] -**lostTime** | **String** | The date and time of changing the deal status as lost | [optional] -**productsCount** | **Number** | The number of products associated with the deal | [optional] -**filesCount** | **Number** | The number of files associated with the deal | [optional] -**notesCount** | **Number** | The number of notes associated with the deal | [optional] -**followersCount** | **Number** | The number of followers associated with the deal | [optional] -**emailMessagesCount** | **Number** | The number of emails associated with the deal | [optional] -**activitiesCount** | **Number** | The number of activities associated with the deal | [optional] -**doneActivitiesCount** | **Number** | The number of completed activities associated with the deal | [optional] -**undoneActivitiesCount** | **Number** | The number of incomplete activities associated with the deal | [optional] -**participantsCount** | **Number** | The number of participants associated with the deal | [optional] -**expectedCloseDate** | **Date** | The expected close date of the deal | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the deal | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the deal | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] +**lost_reason** | **String** | The reason for losing the deal | [optional] +**visible_to** | **String** | The visibility of the deal | [optional] +**close_time** | **String** | The date and time of closing the deal | [optional] +**pipeline_id** | **Number** | The ID of the pipeline associated with the deal | [optional] +**won_time** | **String** | The date and time of changing the deal status as won | [optional] +**first_won_time** | **String** | The date and time of the first time changing the deal status as won | [optional] +**lost_time** | **String** | The date and time of changing the deal status as lost | [optional] +**products_count** | **Number** | The number of products associated with the deal | [optional] +**files_count** | **Number** | The number of files associated with the deal | [optional] +**notes_count** | **Number** | The number of notes associated with the deal | [optional] +**followers_count** | **Number** | The number of followers associated with the deal | [optional] +**email_messages_count** | **Number** | The number of emails associated with the deal | [optional] +**activities_count** | **Number** | The number of activities associated with the deal | [optional] +**done_activities_count** | **Number** | The number of completed activities associated with the deal | [optional] +**undone_activities_count** | **Number** | The number of incomplete activities associated with the deal | [optional] +**participants_count** | **Number** | The number of participants associated with the deal | [optional] +**expected_close_date** | **Date** | The expected close date of the deal | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the deal | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the deal | [optional] **label** | **String** | The label or multiple labels assigned to the deal | [optional] -**stageOrderNr** | **Number** | The order number of the deal stage associated with the deal | [optional] -**personName** | **String** | The name of the person associated with the deal | [optional] -**orgName** | **String** | The name of the organization associated with the deal | [optional] -**nextActivitySubject** | **String** | The subject of the next activity associated with the deal | [optional] -**nextActivityType** | **String** | The type of the next activity associated with the deal | [optional] -**nextActivityDuration** | **String** | The duration of the next activity associated with the deal | [optional] -**nextActivityNote** | **String** | The note of the next activity associated with the deal | [optional] -**formattedValue** | **String** | The deal value formatted with selected currency. E.g. US$500 | [optional] -**weightedValue** | **Number** | Probability times deal value. Probability can either be deal probability or if not set, then stage probability. | [optional] -**formattedWeightedValue** | **String** | The weighted_value formatted with selected currency. E.g. US$500 | [optional] -**weightedValueCurrency** | **String** | The currency associated with the deal | [optional] -**rottenTime** | **String** | The date and time of changing the deal status as rotten | [optional] -**ownerName** | **String** | The name of the deal owner | [optional] -**ccEmail** | **String** | The BCC email of the deal | [optional] -**orgHidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] -**personHidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] +**stage_order_nr** | **Number** | The order number of the deal stage associated with the deal | [optional] +**person_name** | **String** | The name of the person associated with the deal | [optional] +**org_name** | **String** | The name of the organization associated with the deal | [optional] +**next_activity_subject** | **String** | The subject of the next activity associated with the deal | [optional] +**next_activity_type** | **String** | The type of the next activity associated with the deal | [optional] +**next_activity_duration** | **String** | The duration of the next activity associated with the deal | [optional] +**next_activity_note** | **String** | The note of the next activity associated with the deal | [optional] +**formatted_value** | **String** | The deal value formatted with selected currency. E.g. US$500 | [optional] +**weighted_value** | **Number** | Probability times deal value. Probability can either be deal probability or if not set, then stage probability. | [optional] +**formatted_weighted_value** | **String** | The weighted_value formatted with selected currency. E.g. US$500 | [optional] +**weighted_value_currency** | **String** | The currency associated with the deal | [optional] +**rotten_time** | **String** | The date and time of changing the deal status as rotten | [optional] +**owner_name** | **String** | The name of the deal owner | [optional] +**cc_email** | **String** | The BCC email of the deal | [optional] +**org_hidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] +**person_hidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] **origin** | **String** | The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. | [optional] -**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] +**origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] diff --git a/docs/BaseFollowerItem.md b/docs/BaseFollowerItem.md index 8023d637..56d9e4f2 100644 --- a/docs/BaseFollowerItem.md +++ b/docs/BaseFollowerItem.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The user ID of the follower related to the item | [optional] +**user_id** | **Number** | The user ID of the follower related to the item | [optional] **id** | **Number** | The ID of the follower | [optional] -**addTime** | **Date** | The date and time of adding the follower to the item | [optional] +**add_time** | **Date** | The date and time of adding the follower to the item | [optional] diff --git a/docs/BaseMailThread.md b/docs/BaseMailThread.md index 8d15dc63..4d6749ea 100644 --- a/docs/BaseMailThread.md +++ b/docs/BaseMailThread.md @@ -5,41 +5,41 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | ID of the mail thread | [optional] -**accountId** | **String** | The connection account ID | [optional] -**userId** | **Number** | ID of the user whom mail message will be assigned to | [optional] +**account_id** | **String** | The connection account ID | [optional] +**user_id** | **Number** | ID of the user whom mail message will be assigned to | [optional] **subject** | **String** | The subject | [optional] **snippet** | **String** | A snippet | [optional] -**readFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is read | [optional] -**mailTrackingStatus** | **String** | Mail tracking status | [optional] -**hasAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has an attachment | [optional] -**hasInlineAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has inline attachments | [optional] -**hasRealAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has real attachments (which are not inline) | [optional] -**deletedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is deleted | [optional] -**syncedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is synced | [optional] -**smartBccFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether one of the parties of the mail thread is Bcc | [optional] -**mailLinkTrackingEnabledFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the link tracking of the mail thread is enabled | [optional] +**read_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is read | [optional] +**mail_tracking_status** | **String** | Mail tracking status | [optional] +**has_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has an attachment | [optional] +**has_inline_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has inline attachments | [optional] +**has_real_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has real attachments (which are not inline) | [optional] +**deleted_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is deleted | [optional] +**synced_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is synced | [optional] +**smart_bcc_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether one of the parties of the mail thread is Bcc | [optional] +**mail_link_tracking_enabled_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the link tracking of the mail thread is enabled | [optional] **parties** | [**BaseMailThreadAllOfParties**](BaseMailThreadAllOfParties.md) | | [optional] -**draftsParties** | **[Object]** | Parties of the drafted mail thread | [optional] +**drafts_parties** | **[Object]** | Parties of the drafted mail thread | [optional] **folders** | **[String]** | Folders in which messages from thread are being stored | [optional] **version** | **Number** | Version | [optional] -**snippetDraft** | **String** | A snippet from a draft | [optional] -**snippetSent** | **String** | A snippet from a message sent | [optional] -**messageCount** | **Number** | An amount of messages | [optional] -**hasDraftFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has any drafts | [optional] -**hasSentFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has messages sent | [optional] -**archivedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is archived | [optional] -**sharedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is shared | [optional] -**externalDeletedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has been deleted externally | [optional] -**firstMessageToMeFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread was initialized by others | [optional] -**lastMessageTimestamp** | **Date** | Last message timestamp | [optional] -**firstMessageTimestamp** | **Date** | The time when the mail thread has had the first message received or created | [optional] -**lastMessageSentTimestamp** | **Date** | The last time when the mail thread has had a message sent | [optional] -**lastMessageReceivedTimestamp** | **Date** | The last time when the mail thread has had a message received | [optional] -**addTime** | **Date** | The time when the mail thread was inserted to database | [optional] -**updateTime** | **Date** | The time when the mail thread was updated in database received | [optional] -**dealId** | **Number** | The ID of the deal | [optional] -**dealStatus** | **String** | Status of the deal | [optional] -**leadId** | **String** | The ID of the lead | [optional] -**allMessagesSentFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether all the mail thread messages have been sent | [optional] +**snippet_draft** | **String** | A snippet from a draft | [optional] +**snippet_sent** | **String** | A snippet from a message sent | [optional] +**message_count** | **Number** | An amount of messages | [optional] +**has_draft_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has any drafts | [optional] +**has_sent_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has messages sent | [optional] +**archived_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is archived | [optional] +**shared_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is shared | [optional] +**external_deleted_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has been deleted externally | [optional] +**first_message_to_me_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread was initialized by others | [optional] +**last_message_timestamp** | **Date** | Last message timestamp | [optional] +**first_message_timestamp** | **Date** | The time when the mail thread has had the first message received or created | [optional] +**last_message_sent_timestamp** | **Date** | The last time when the mail thread has had a message sent | [optional] +**last_message_received_timestamp** | **Date** | The last time when the mail thread has had a message received | [optional] +**add_time** | **Date** | The time when the mail thread was inserted to database | [optional] +**update_time** | **Date** | The time when the mail thread was updated in database received | [optional] +**deal_id** | **Number** | The ID of the deal | [optional] +**deal_status** | **String** | Status of the deal | [optional] +**lead_id** | **String** | The ID of the lead | [optional] +**all_messages_sent_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether all the mail thread messages have been sent | [optional] diff --git a/docs/BaseMailThreadAllOf.md b/docs/BaseMailThreadAllOf.md index c7a0c54c..99cf984e 100644 --- a/docs/BaseMailThreadAllOf.md +++ b/docs/BaseMailThreadAllOf.md @@ -5,27 +5,27 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **parties** | [**BaseMailThreadAllOfParties**](BaseMailThreadAllOfParties.md) | | [optional] -**draftsParties** | **[Object]** | Parties of the drafted mail thread | [optional] +**drafts_parties** | **[Object]** | Parties of the drafted mail thread | [optional] **folders** | **[String]** | Folders in which messages from thread are being stored | [optional] **version** | **Number** | Version | [optional] -**snippetDraft** | **String** | A snippet from a draft | [optional] -**snippetSent** | **String** | A snippet from a message sent | [optional] -**messageCount** | **Number** | An amount of messages | [optional] -**hasDraftFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has any drafts | [optional] -**hasSentFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has messages sent | [optional] -**archivedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is archived | [optional] -**sharedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is shared | [optional] -**externalDeletedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has been deleted externally | [optional] -**firstMessageToMeFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread was initialized by others | [optional] -**lastMessageTimestamp** | **Date** | Last message timestamp | [optional] -**firstMessageTimestamp** | **Date** | The time when the mail thread has had the first message received or created | [optional] -**lastMessageSentTimestamp** | **Date** | The last time when the mail thread has had a message sent | [optional] -**lastMessageReceivedTimestamp** | **Date** | The last time when the mail thread has had a message received | [optional] -**addTime** | **Date** | The time when the mail thread was inserted to database | [optional] -**updateTime** | **Date** | The time when the mail thread was updated in database received | [optional] -**dealId** | **Number** | The ID of the deal | [optional] -**dealStatus** | **String** | Status of the deal | [optional] -**leadId** | **String** | The ID of the lead | [optional] -**allMessagesSentFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether all the mail thread messages have been sent | [optional] +**snippet_draft** | **String** | A snippet from a draft | [optional] +**snippet_sent** | **String** | A snippet from a message sent | [optional] +**message_count** | **Number** | An amount of messages | [optional] +**has_draft_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has any drafts | [optional] +**has_sent_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has messages sent | [optional] +**archived_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is archived | [optional] +**shared_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is shared | [optional] +**external_deleted_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has been deleted externally | [optional] +**first_message_to_me_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread was initialized by others | [optional] +**last_message_timestamp** | **Date** | Last message timestamp | [optional] +**first_message_timestamp** | **Date** | The time when the mail thread has had the first message received or created | [optional] +**last_message_sent_timestamp** | **Date** | The last time when the mail thread has had a message sent | [optional] +**last_message_received_timestamp** | **Date** | The last time when the mail thread has had a message received | [optional] +**add_time** | **Date** | The time when the mail thread was inserted to database | [optional] +**update_time** | **Date** | The time when the mail thread was updated in database received | [optional] +**deal_id** | **Number** | The ID of the deal | [optional] +**deal_status** | **String** | Status of the deal | [optional] +**lead_id** | **String** | The ID of the lead | [optional] +**all_messages_sent_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether all the mail thread messages have been sent | [optional] diff --git a/docs/BaseMailThreadMessages.md b/docs/BaseMailThreadMessages.md index d96237b8..21593c98 100644 --- a/docs/BaseMailThreadMessages.md +++ b/docs/BaseMailThreadMessages.md @@ -5,31 +5,31 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | ID of the mail thread | [optional] -**accountId** | **String** | The connection account ID | [optional] -**userId** | **Number** | ID of the user whom mail message will be assigned to | [optional] +**account_id** | **String** | The connection account ID | [optional] +**user_id** | **Number** | ID of the user whom mail message will be assigned to | [optional] **subject** | **String** | The subject | [optional] **snippet** | **String** | A snippet | [optional] -**readFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is read | [optional] -**mailTrackingStatus** | **String** | Mail tracking status | [optional] -**hasAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has an attachment | [optional] -**hasInlineAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has inline attachments | [optional] -**hasRealAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has real attachments (which are not inline) | [optional] -**deletedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is deleted | [optional] -**syncedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is synced | [optional] -**smartBccFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether one of the parties of the mail thread is Bcc | [optional] -**mailLinkTrackingEnabledFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the link tracking of the mail thread is enabled | [optional] +**read_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is read | [optional] +**mail_tracking_status** | **String** | Mail tracking status | [optional] +**has_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has an attachment | [optional] +**has_inline_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has inline attachments | [optional] +**has_real_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has real attachments (which are not inline) | [optional] +**deleted_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is deleted | [optional] +**synced_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is synced | [optional] +**smart_bcc_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether one of the parties of the mail thread is Bcc | [optional] +**mail_link_tracking_enabled_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the link tracking of the mail thread is enabled | [optional] **from** | [**[MailThreadParticipant]**](MailThreadParticipant.md) | Senders of the mail thread | [optional] **to** | [**[MailThreadParticipant]**](MailThreadParticipant.md) | Recipients of the mail thread | [optional] **cc** | [**[MailThreadParticipant]**](MailThreadParticipant.md) | Participants of the Cc | [optional] **bcc** | [**[MailThreadParticipant]**](MailThreadParticipant.md) | Participants of the Bcc | [optional] -**bodyUrl** | **String** | A link to the mail thread message | [optional] -**mailThreadId** | **Number** | ID of the mail thread | [optional] +**body_url** | **String** | A link to the mail thread message | [optional] +**mail_thread_id** | **Number** | ID of the mail thread | [optional] **draft** | **String** | If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise `null`. | [optional] -**hasBodyFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message has a body | [optional] -**sentFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message is sent | [optional] -**sentFromPipedriveFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message is sent from Pipedrive | [optional] -**messageTime** | **Date** | The time when the mail message was received or created | [optional] -**addTime** | **Date** | The time when the mail message was inserted to database | [optional] -**updateTime** | **Date** | The time when the mail message was updated in database received | [optional] +**has_body_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message has a body | [optional] +**sent_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message is sent | [optional] +**sent_from_pipedrive_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message is sent from Pipedrive | [optional] +**message_time** | **Date** | The time when the mail message was received or created | [optional] +**add_time** | **Date** | The time when the mail message was inserted to database | [optional] +**update_time** | **Date** | The time when the mail message was updated in database received | [optional] diff --git a/docs/BaseMailThreadMessagesAllOf.md b/docs/BaseMailThreadMessagesAllOf.md index e09b6749..c86b2c24 100644 --- a/docs/BaseMailThreadMessagesAllOf.md +++ b/docs/BaseMailThreadMessagesAllOf.md @@ -8,14 +8,14 @@ Name | Type | Description | Notes **to** | [**[MailThreadParticipant]**](MailThreadParticipant.md) | Recipients of the mail thread | [optional] **cc** | [**[MailThreadParticipant]**](MailThreadParticipant.md) | Participants of the Cc | [optional] **bcc** | [**[MailThreadParticipant]**](MailThreadParticipant.md) | Participants of the Bcc | [optional] -**bodyUrl** | **String** | A link to the mail thread message | [optional] -**mailThreadId** | **Number** | ID of the mail thread | [optional] +**body_url** | **String** | A link to the mail thread message | [optional] +**mail_thread_id** | **Number** | ID of the mail thread | [optional] **draft** | **String** | If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise `null`. | [optional] -**hasBodyFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message has a body | [optional] -**sentFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message is sent | [optional] -**sentFromPipedriveFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message is sent from Pipedrive | [optional] -**messageTime** | **Date** | The time when the mail message was received or created | [optional] -**addTime** | **Date** | The time when the mail message was inserted to database | [optional] -**updateTime** | **Date** | The time when the mail message was updated in database received | [optional] +**has_body_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message has a body | [optional] +**sent_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message is sent | [optional] +**sent_from_pipedrive_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread message is sent from Pipedrive | [optional] +**message_time** | **Date** | The time when the mail message was received or created | [optional] +**add_time** | **Date** | The time when the mail message was inserted to database | [optional] +**update_time** | **Date** | The time when the mail message was updated in database received | [optional] diff --git a/docs/BaseNote.md b/docs/BaseNote.md index 2e638ff8..21de4c63 100644 --- a/docs/BaseNote.md +++ b/docs/BaseNote.md @@ -5,22 +5,22 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the note | [optional] -**activeFlag** | **Boolean** | Whether the note is active or deleted | [optional] -**addTime** | **String** | The creation date and time of the note | [optional] +**active_flag** | **Boolean** | Whether the note is active or deleted | [optional] +**add_time** | **String** | The creation date and time of the note | [optional] **content** | **String** | The content of the note in HTML format. Subject to sanitization on the back-end. | [optional] **deal** | [**BaseNoteDealTitle**](BaseNoteDealTitle.md) | | [optional] -**leadId** | **String** | The ID of the lead the note is attached to | [optional] -**dealId** | **Number** | The ID of the deal the note is attached to | [optional] -**lastUpdateUserId** | **Number** | The ID of the user who last updated the note | [optional] -**orgId** | **Number** | The ID of the organization the note is attached to | [optional] +**lead_id** | **String** | The ID of the lead the note is attached to | [optional] +**deal_id** | **Number** | The ID of the deal the note is attached to | [optional] +**last_update_user_id** | **Number** | The ID of the user who last updated the note | [optional] +**org_id** | **Number** | The ID of the organization the note is attached to | [optional] **organization** | [**BaseNoteOrganization**](BaseNoteOrganization.md) | | [optional] **person** | [**BaseNotePerson**](BaseNotePerson.md) | | [optional] -**personId** | **Number** | The ID of the person the note is attached to | [optional] -**pinnedToDealFlag** | **Boolean** | If true, the results are filtered by note to deal pinning state | [optional] -**pinnedToOrganizationFlag** | **Boolean** | If true, the results are filtered by note to organization pinning state | [optional] -**pinnedToPersonFlag** | **Boolean** | If true, the results are filtered by note to person pinning state | [optional] -**updateTime** | **String** | The last updated date and time of the note | [optional] +**person_id** | **Number** | The ID of the person the note is attached to | [optional] +**pinned_to_deal_flag** | **Boolean** | If true, the results are filtered by note to deal pinning state | [optional] +**pinned_to_organization_flag** | **Boolean** | If true, the results are filtered by note to organization pinning state | [optional] +**pinned_to_person_flag** | **Boolean** | If true, the results are filtered by note to person pinning state | [optional] +**update_time** | **String** | The last updated date and time of the note | [optional] **user** | [**NoteCreatorUser**](NoteCreatorUser.md) | | [optional] -**userId** | **Number** | The ID of the note creator | [optional] +**user_id** | **Number** | The ID of the note creator | [optional] diff --git a/docs/BaseOrganizationItem.md b/docs/BaseOrganizationItem.md index 661e8ae7..2c22553b 100644 --- a/docs/BaseOrganizationItem.md +++ b/docs/BaseOrganizationItem.md @@ -5,50 +5,50 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the organization | [optional] -**companyId** | **Number** | The ID of the company related to the organization | [optional] -**ownerId** | [**Owner**](Owner.md) | | [optional] +**company_id** | **Number** | The ID of the company related to the organization | [optional] +**owner_id** | [**Owner**](Owner.md) | | [optional] **name** | **String** | The name of the organization | [optional] -**activeFlag** | **Boolean** | Whether the organization is active or not | [optional] -**pictureId** | [**PictureDataWithValue**](PictureDataWithValue.md) | | [optional] -**countryCode** | **String** | The country code of the organization | [optional] -**firstChar** | **String** | The first character of the organization name | [optional] -**addTime** | **String** | The creation date and time of the organization | [optional] -**updateTime** | **String** | The last updated date and time of the organization | [optional] -**visibleTo** | **String** | The visibility group ID of who can see the organization | [optional] +**active_flag** | **Boolean** | Whether the organization is active or not | [optional] +**picture_id** | [**PictureDataWithValue**](PictureDataWithValue.md) | | [optional] +**country_code** | **String** | The country code of the organization | [optional] +**first_char** | **String** | The first character of the organization name | [optional] +**add_time** | **String** | The creation date and time of the organization | [optional] +**update_time** | **String** | The last updated date and time of the organization | [optional] +**visible_to** | **String** | The visibility group ID of who can see the organization | [optional] **label** | **Number** | The label assigned to the organization | [optional] -**ownerName** | **String** | The name of the organization owner | [optional] -**ccEmail** | **String** | The BCC email associated with the organization | [optional] -**emailMessagesCount** | **Number** | The count of email messages related to the organization | [optional] -**peopleCount** | **Number** | The count of persons related to the organization | [optional] -**activitiesCount** | **Number** | The count of activities related to the organization | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the organization | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the organization | [optional] -**filesCount** | **Number** | The count of files related to the organization | [optional] -**notesCount** | **Number** | The count of notes related to the organization | [optional] -**followersCount** | **Number** | The count of followers related to the organization | [optional] +**owner_name** | **String** | The name of the organization owner | [optional] +**cc_email** | **String** | The BCC email associated with the organization | [optional] +**email_messages_count** | **Number** | The count of email messages related to the organization | [optional] +**people_count** | **Number** | The count of persons related to the organization | [optional] +**activities_count** | **Number** | The count of activities related to the organization | [optional] +**done_activities_count** | **Number** | The count of done activities related to the organization | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the organization | [optional] +**files_count** | **Number** | The count of files related to the organization | [optional] +**notes_count** | **Number** | The count of notes related to the organization | [optional] +**followers_count** | **Number** | The count of followers related to the organization | [optional] **address** | **String** | The full address of the organization | [optional] -**addressSubpremise** | **String** | The sub-premise of the organization location | [optional] -**addressStreetNumber** | **String** | The street number of the organization location | [optional] -**addressRoute** | **String** | The route of the organization location | [optional] -**addressSublocality** | **String** | The sub-locality of the organization location | [optional] -**addressLocality** | **String** | The locality of the organization location | [optional] -**addressAdminAreaLevel1** | **String** | The level 1 admin area of the organization location | [optional] -**addressAdminAreaLevel2** | **String** | The level 2 admin area of the organization location | [optional] -**addressCountry** | **String** | The country of the organization location | [optional] -**addressPostalCode** | **String** | The postal code of the organization location | [optional] -**addressFormattedAddress** | **String** | The formatted organization location | [optional] -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] +**address_subpremise** | **String** | The sub-premise of the organization location | [optional] +**address_street_number** | **String** | The street number of the organization location | [optional] +**address_route** | **String** | The route of the organization location | [optional] +**address_sublocality** | **String** | The sub-locality of the organization location | [optional] +**address_locality** | **String** | The locality of the organization location | [optional] +**address_admin_area_level_1** | **String** | The level 1 admin area of the organization location | [optional] +**address_admin_area_level_2** | **String** | The level 2 admin area of the organization location | [optional] +**address_country** | **String** | The country of the organization location | [optional] +**address_postal_code** | **String** | The postal code of the organization location | [optional] +**address_formatted_address** | **String** | The formatted organization location | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] diff --git a/docs/BaseOrganizationItemFields.md b/docs/BaseOrganizationItemFields.md index b061c164..d338a74b 100644 --- a/docs/BaseOrganizationItemFields.md +++ b/docs/BaseOrganizationItemFields.md @@ -5,18 +5,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the organization | [optional] -**companyId** | **Number** | The ID of the company related to the organization | [optional] -**ownerId** | [**Owner**](Owner.md) | | [optional] +**company_id** | **Number** | The ID of the company related to the organization | [optional] +**owner_id** | [**Owner**](Owner.md) | | [optional] **name** | **String** | The name of the organization | [optional] -**activeFlag** | **Boolean** | Whether the organization is active or not | [optional] -**pictureId** | [**PictureDataWithValue**](PictureDataWithValue.md) | | [optional] -**countryCode** | **String** | The country code of the organization | [optional] -**firstChar** | **String** | The first character of the organization name | [optional] -**addTime** | **String** | The creation date and time of the organization | [optional] -**updateTime** | **String** | The last updated date and time of the organization | [optional] -**visibleTo** | **String** | The visibility group ID of who can see the organization | [optional] +**active_flag** | **Boolean** | Whether the organization is active or not | [optional] +**picture_id** | [**PictureDataWithValue**](PictureDataWithValue.md) | | [optional] +**country_code** | **String** | The country code of the organization | [optional] +**first_char** | **String** | The first character of the organization name | [optional] +**add_time** | **String** | The creation date and time of the organization | [optional] +**update_time** | **String** | The last updated date and time of the organization | [optional] +**visible_to** | **String** | The visibility group ID of who can see the organization | [optional] **label** | **Number** | The label assigned to the organization | [optional] -**ownerName** | **String** | The name of the organization owner | [optional] -**ccEmail** | **String** | The BCC email associated with the organization | [optional] +**owner_name** | **String** | The name of the organization owner | [optional] +**cc_email** | **String** | The BCC email associated with the organization | [optional] diff --git a/docs/BaseOrganizationItemWithEditNameFlag.md b/docs/BaseOrganizationItemWithEditNameFlag.md index c44e9d8a..28eecabb 100644 --- a/docs/BaseOrganizationItemWithEditNameFlag.md +++ b/docs/BaseOrganizationItemWithEditNameFlag.md @@ -5,51 +5,51 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the organization | [optional] -**companyId** | **Number** | The ID of the company related to the organization | [optional] -**ownerId** | [**Owner**](Owner.md) | | [optional] +**company_id** | **Number** | The ID of the company related to the organization | [optional] +**owner_id** | [**Owner**](Owner.md) | | [optional] **name** | **String** | The name of the organization | [optional] -**activeFlag** | **Boolean** | Whether the organization is active or not | [optional] -**pictureId** | [**PictureDataWithValue**](PictureDataWithValue.md) | | [optional] -**countryCode** | **String** | The country code of the organization | [optional] -**firstChar** | **String** | The first character of the organization name | [optional] -**addTime** | **String** | The creation date and time of the organization | [optional] -**updateTime** | **String** | The last updated date and time of the organization | [optional] -**visibleTo** | **String** | The visibility group ID of who can see the organization | [optional] +**active_flag** | **Boolean** | Whether the organization is active or not | [optional] +**picture_id** | [**PictureDataWithValue**](PictureDataWithValue.md) | | [optional] +**country_code** | **String** | The country code of the organization | [optional] +**first_char** | **String** | The first character of the organization name | [optional] +**add_time** | **String** | The creation date and time of the organization | [optional] +**update_time** | **String** | The last updated date and time of the organization | [optional] +**visible_to** | **String** | The visibility group ID of who can see the organization | [optional] **label** | **Number** | The label assigned to the organization | [optional] -**ownerName** | **String** | The name of the organization owner | [optional] -**ccEmail** | **String** | The BCC email associated with the organization | [optional] -**emailMessagesCount** | **Number** | The count of email messages related to the organization | [optional] -**peopleCount** | **Number** | The count of persons related to the organization | [optional] -**activitiesCount** | **Number** | The count of activities related to the organization | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the organization | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the organization | [optional] -**filesCount** | **Number** | The count of files related to the organization | [optional] -**notesCount** | **Number** | The count of notes related to the organization | [optional] -**followersCount** | **Number** | The count of followers related to the organization | [optional] +**owner_name** | **String** | The name of the organization owner | [optional] +**cc_email** | **String** | The BCC email associated with the organization | [optional] +**email_messages_count** | **Number** | The count of email messages related to the organization | [optional] +**people_count** | **Number** | The count of persons related to the organization | [optional] +**activities_count** | **Number** | The count of activities related to the organization | [optional] +**done_activities_count** | **Number** | The count of done activities related to the organization | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the organization | [optional] +**files_count** | **Number** | The count of files related to the organization | [optional] +**notes_count** | **Number** | The count of notes related to the organization | [optional] +**followers_count** | **Number** | The count of followers related to the organization | [optional] **address** | **String** | The full address of the organization | [optional] -**addressSubpremise** | **String** | The sub-premise of the organization location | [optional] -**addressStreetNumber** | **String** | The street number of the organization location | [optional] -**addressRoute** | **String** | The route of the organization location | [optional] -**addressSublocality** | **String** | The sub-locality of the organization location | [optional] -**addressLocality** | **String** | The locality of the organization location | [optional] -**addressAdminAreaLevel1** | **String** | The level 1 admin area of the organization location | [optional] -**addressAdminAreaLevel2** | **String** | The level 2 admin area of the organization location | [optional] -**addressCountry** | **String** | The country of the organization location | [optional] -**addressPostalCode** | **String** | The postal code of the organization location | [optional] -**addressFormattedAddress** | **String** | The formatted organization location | [optional] -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] -**editName** | **Boolean** | If the company ID of the organization and company ID of the request is same or not | [optional] +**address_subpremise** | **String** | The sub-premise of the organization location | [optional] +**address_street_number** | **String** | The street number of the organization location | [optional] +**address_route** | **String** | The route of the organization location | [optional] +**address_sublocality** | **String** | The sub-locality of the organization location | [optional] +**address_locality** | **String** | The locality of the organization location | [optional] +**address_admin_area_level_1** | **String** | The level 1 admin area of the organization location | [optional] +**address_admin_area_level_2** | **String** | The level 2 admin area of the organization location | [optional] +**address_country** | **String** | The country of the organization location | [optional] +**address_postal_code** | **String** | The postal code of the organization location | [optional] +**address_formatted_address** | **String** | The formatted organization location | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] +**edit_name** | **Boolean** | If the company ID of the organization and company ID of the request is same or not | [optional] diff --git a/docs/BaseOrganizationItemWithEditNameFlagAllOf.md b/docs/BaseOrganizationItemWithEditNameFlagAllOf.md index 54f784b6..302dbe72 100644 --- a/docs/BaseOrganizationItemWithEditNameFlagAllOf.md +++ b/docs/BaseOrganizationItemWithEditNameFlagAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**editName** | **Boolean** | If the company ID of the organization and company ID of the request is same or not | [optional] +**edit_name** | **Boolean** | If the company ID of the organization and company ID of the request is same or not | [optional] diff --git a/docs/BaseOrganizationRelationshipItem.md b/docs/BaseOrganizationRelationshipItem.md index 6683c287..1868bb4c 100644 --- a/docs/BaseOrganizationRelationshipItem.md +++ b/docs/BaseOrganizationRelationshipItem.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the organization relationship | [optional] **type** | **String** | The type of the relationship | [optional] -**relOwnerOrgId** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] -**relLinkedOrgId** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] -**addTime** | **String** | The creation date and time of the relationship | [optional] -**updateTime** | **String** | The last updated date and time of the relationship | [optional] -**activeFlag** | **String** | Whether the relationship is active or not | [optional] +**rel_owner_org_id** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] +**rel_linked_org_id** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] +**add_time** | **String** | The creation date and time of the relationship | [optional] +**update_time** | **String** | The last updated date and time of the relationship | [optional] +**active_flag** | **String** | Whether the relationship is active or not | [optional] diff --git a/docs/BasePersonItem.md b/docs/BasePersonItem.md index b4b232f5..a2cfb80f 100644 --- a/docs/BasePersonItem.md +++ b/docs/BasePersonItem.md @@ -5,18 +5,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the person | [optional] -**companyId** | **Number** | The ID of the company related to the person | [optional] -**activeFlag** | **Boolean** | Whether the person is active or not | [optional] +**company_id** | **Number** | The ID of the company related to the person | [optional] +**active_flag** | **Boolean** | Whether the person is active or not | [optional] **phone** | [**[BasePersonItemPhone]**](BasePersonItemPhone.md) | A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ \"value\": \"12345\", \"primary\": \"true\", \"label\": \"mobile\" }]`. Please note that only `value` is required. | [optional] **email** | [**[BasePersonItemEmail]**](BasePersonItemEmail.md) | An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ \"value\": \"mail@example.com\", \"primary\": \"true\", \"label\": \"main\" } ]`. Please note that only `value` is required. | [optional] -**firstChar** | **String** | The first letter of the name of the person | [optional] -**addTime** | **String** | The date and time when the person was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] -**updateTime** | **String** | The last updated date and time of the person. Format: YYYY-MM-DD HH:MM:SS | [optional] -**visibleTo** | **String** | The visibility group ID of who can see the person | [optional] -**pictureId** | [**PictureDataWithID**](PictureDataWithID.md) | | [optional] +**first_char** | **String** | The first letter of the name of the person | [optional] +**add_time** | **String** | The date and time when the person was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] +**update_time** | **String** | The last updated date and time of the person. Format: YYYY-MM-DD HH:MM:SS | [optional] +**visible_to** | **String** | The visibility group ID of who can see the person | [optional] +**picture_id** | [**PictureDataWithID**](PictureDataWithID.md) | | [optional] **label** | **Number** | The label assigned to the person | [optional] -**orgName** | **String** | The name of the organization associated with the person | [optional] -**ownerName** | **String** | The name of the owner associated with the person | [optional] -**ccEmail** | **String** | The BCC email associated with the person | [optional] +**org_name** | **String** | The name of the organization associated with the person | [optional] +**owner_name** | **String** | The name of the owner associated with the person | [optional] +**cc_email** | **String** | The BCC email associated with the person | [optional] diff --git a/docs/BasePipeline.md b/docs/BasePipeline.md index aeb88c86..9b01cdd0 100644 --- a/docs/BasePipeline.md +++ b/docs/BasePipeline.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the pipeline | [optional] **name** | **String** | The name of the pipeline | [optional] -**urlTitle** | **String** | The pipeline title displayed in the URL | [optional] -**orderNr** | **Number** | Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline. | [optional] +**url_title** | **String** | The pipeline title displayed in the URL | [optional] +**order_nr** | **Number** | Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline. | [optional] **active** | **Boolean** | Whether this pipeline will be made inactive (hidden) or active | [optional] -**dealProbability** | **Boolean** | Whether deal probability is disabled or enabled for this pipeline | [optional] -**addTime** | **String** | The pipeline creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The pipeline update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**deal_probability** | **Boolean** | Whether deal probability is disabled or enabled for this pipeline | [optional] +**add_time** | **String** | The pipeline creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The pipeline update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] diff --git a/docs/BasePipelineWithSelectedFlag.md b/docs/BasePipelineWithSelectedFlag.md index 40b28a03..6838a479 100644 --- a/docs/BasePipelineWithSelectedFlag.md +++ b/docs/BasePipelineWithSelectedFlag.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the pipeline | [optional] **name** | **String** | The name of the pipeline | [optional] -**urlTitle** | **String** | The pipeline title displayed in the URL | [optional] -**orderNr** | **Number** | Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline. | [optional] +**url_title** | **String** | The pipeline title displayed in the URL | [optional] +**order_nr** | **Number** | Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline. | [optional] **active** | **Boolean** | Whether this pipeline will be made inactive (hidden) or active | [optional] -**dealProbability** | **Boolean** | Whether deal probability is disabled or enabled for this pipeline | [optional] -**addTime** | **String** | The pipeline creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The pipeline update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**deal_probability** | **Boolean** | Whether deal probability is disabled or enabled for this pipeline | [optional] +**add_time** | **String** | The pipeline creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The pipeline update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] **selected** | **Boolean** | A boolean that shows if the pipeline is selected from a filter or not | [optional] diff --git a/docs/BaseProduct.md b/docs/BaseProduct.md index d3fd983f..3a26abb2 100644 --- a/docs/BaseProduct.md +++ b/docs/BaseProduct.md @@ -9,12 +9,12 @@ Name | Type | Description | Notes **code** | **String** | The product code | [optional] **unit** | **String** | The unit in which this product is sold | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] -**activeFlag** | **Boolean** | Whether this product is active or not | [optional] [default to true] +**active_flag** | **Boolean** | Whether this product is active or not | [optional] [default to true] **selectable** | **Boolean** | Whether this product is selected in deals or not | [optional] [default to true] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | Visibility of the product | [optional] -**ownerId** | **Object** | Information about the Pipedrive user who owns the product | [optional] -**billingFrequency** | **String** | Only available in Advanced and above plans How often a customer is billed for access to a service or product | [optional] [default to 'one-time'] -**billingFrequencyCycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field is always `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | Visibility of the product | [optional] +**owner_id** | **Object** | Information about the Pipedrive user who owns the product | [optional] +**billing_frequency** | **String** | Only available in Advanced and above plans How often a customer is billed for access to a service or product | [optional] [default to 'one-time'] +**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field is always `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] diff --git a/docs/BaseRole.md b/docs/BaseRole.md index f4cfb478..9367343e 100644 --- a/docs/BaseRole.md +++ b/docs/BaseRole.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**parentRoleId** | **Number** | The ID of the parent role | [optional] +**parent_role_id** | **Number** | The ID of the parent role | [optional] **name** | **String** | The name of the role | [optional] diff --git a/docs/BaseStage.md b/docs/BaseStage.md index c816103a..c1f309cc 100644 --- a/docs/BaseStage.md +++ b/docs/BaseStage.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the stage | [optional] -**orderNr** | **Number** | Defines the order of the stage | [optional] +**order_nr** | **Number** | Defines the order of the stage | [optional] **name** | **String** | The name of the stage | [optional] -**activeFlag** | **Boolean** | Whether the stage is active or deleted | [optional] -**dealProbability** | **Number** | The success probability percentage of the deal. Used/shown when the deal weighted values are used. | [optional] -**pipelineId** | **Number** | The ID of the pipeline to add the stage to | [optional] -**rottenFlag** | **Boolean** | Whether deals in this stage can become rotten | [optional] -**rottenDays** | **Number** | The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. | [optional] -**addTime** | **String** | The stage creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The stage update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**active_flag** | **Boolean** | Whether the stage is active or deleted | [optional] +**deal_probability** | **Number** | The success probability percentage of the deal. Used/shown when the deal weighted values are used. | [optional] +**pipeline_id** | **Number** | The ID of the pipeline to add the stage to | [optional] +**rotten_flag** | **Boolean** | Whether deals in this stage can become rotten | [optional] +**rotten_days** | **Number** | The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. | [optional] +**add_time** | **String** | The stage creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The stage update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] diff --git a/docs/BaseTeam.md b/docs/BaseTeam.md index 0f29490b..d2ab9e38 100644 --- a/docs/BaseTeam.md +++ b/docs/BaseTeam.md @@ -7,11 +7,11 @@ Name | Type | Description | Notes **id** | **Number** | The team ID | [optional] **name** | **String** | The team name | [optional] **description** | **String** | The team description | [optional] -**managerId** | **Number** | The team manager ID | [optional] +**manager_id** | **Number** | The team manager ID | [optional] **users** | **[Number]** | The list of user IDs | [optional] -**activeFlag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is active | [optional] -**deletedFlag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is deleted | [optional] -**addTime** | **String** | The team creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] -**createdByUserId** | **Number** | The ID of the user who created the team | [optional] +**active_flag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is active | [optional] +**deleted_flag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is deleted | [optional] +**add_time** | **String** | The team creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] +**created_by_user_id** | **Number** | The ID of the user who created the team | [optional] diff --git a/docs/BaseTeamAdditionalProperties.md b/docs/BaseTeamAdditionalProperties.md index 295d3306..e73f1a94 100644 --- a/docs/BaseTeamAdditionalProperties.md +++ b/docs/BaseTeamAdditionalProperties.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**addTime** | **String** | The team creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] -**createdByUserId** | **Number** | The ID of the user who created the team | [optional] +**add_time** | **String** | The team creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] +**created_by_user_id** | **Number** | The ID of the user who created the team | [optional] diff --git a/docs/BaseUser.md b/docs/BaseUser.md index e2f503e6..56536ab1 100644 --- a/docs/BaseUser.md +++ b/docs/BaseUser.md @@ -6,23 +6,23 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The user ID | [optional] **name** | **String** | The user name | [optional] -**defaultCurrency** | **String** | The user default currency | [optional] +**default_currency** | **String** | The user default currency | [optional] **locale** | **String** | The user locale | [optional] **lang** | **Number** | The user language ID | [optional] **email** | **String** | The user email | [optional] **phone** | **String** | The user phone | [optional] **activated** | **Boolean** | Boolean that indicates whether the user is activated | [optional] -**lastLogin** | **String** | The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS | [optional] +**last_login** | **String** | The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS | [optional] **created** | **String** | The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS | [optional] **modified** | **String** | The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS | [optional] -**hasCreatedCompany** | **Boolean** | Boolean that indicates whether the user has created a company | [optional] +**has_created_company** | **Boolean** | Boolean that indicates whether the user has created a company | [optional] **access** | [**[UserAccess]**](UserAccess.md) | | [optional] -**activeFlag** | **Boolean** | Boolean that indicates whether the user is activated | [optional] -**timezoneName** | **String** | The user timezone name | [optional] -**timezoneOffset** | **String** | The user timezone offset | [optional] -**roleId** | **Number** | The ID of the user role | [optional] -**iconUrl** | **String** | The user icon URL | [optional] -**isYou** | **Boolean** | Boolean that indicates if the requested user is the same which is logged in (in this case, always true) | [optional] -**isDeleted** | **Boolean** | Boolean that indicates whether the user is deleted from the company | [optional] +**active_flag** | **Boolean** | Boolean that indicates whether the user is activated | [optional] +**timezone_name** | **String** | The user timezone name | [optional] +**timezone_offset** | **String** | The user timezone offset | [optional] +**role_id** | **Number** | The ID of the user role | [optional] +**icon_url** | **String** | The user icon URL | [optional] +**is_you** | **Boolean** | Boolean that indicates if the requested user is the same which is logged in (in this case, always true) | [optional] +**is_deleted** | **Boolean** | Boolean that indicates whether the user is deleted from the company | [optional] diff --git a/docs/BaseUserMe.md b/docs/BaseUserMe.md index 12cda614..88237786 100644 --- a/docs/BaseUserMe.md +++ b/docs/BaseUserMe.md @@ -6,29 +6,29 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The user ID | [optional] **name** | **String** | The user name | [optional] -**defaultCurrency** | **String** | The user default currency | [optional] +**default_currency** | **String** | The user default currency | [optional] **locale** | **String** | The user locale | [optional] **lang** | **Number** | The user language ID | [optional] **email** | **String** | The user email | [optional] **phone** | **String** | The user phone | [optional] **activated** | **Boolean** | Boolean that indicates whether the user is activated | [optional] -**lastLogin** | **String** | The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS | [optional] +**last_login** | **String** | The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS | [optional] **created** | **String** | The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS | [optional] **modified** | **String** | The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS | [optional] -**hasCreatedCompany** | **Boolean** | Boolean that indicates whether the user has created a company | [optional] +**has_created_company** | **Boolean** | Boolean that indicates whether the user has created a company | [optional] **access** | [**[UserAccess]**](UserAccess.md) | | [optional] -**activeFlag** | **Boolean** | Boolean that indicates whether the user is activated | [optional] -**timezoneName** | **String** | The user timezone name | [optional] -**timezoneOffset** | **String** | The user timezone offset | [optional] -**roleId** | **Number** | The ID of the user role | [optional] -**iconUrl** | **String** | The user icon URL | [optional] -**isYou** | **Boolean** | Boolean that indicates if the requested user is the same which is logged in (in this case, always true) | [optional] -**isDeleted** | **Boolean** | Boolean that indicates whether the user is deleted from the company | [optional] -**companyId** | **Number** | The user company ID | [optional] -**companyName** | **String** | The user company name | [optional] -**companyDomain** | **String** | The user company domain | [optional] -**companyCountry** | **String** | The user company country | [optional] -**companyIndustry** | **String** | The user company industry | [optional] +**active_flag** | **Boolean** | Boolean that indicates whether the user is activated | [optional] +**timezone_name** | **String** | The user timezone name | [optional] +**timezone_offset** | **String** | The user timezone offset | [optional] +**role_id** | **Number** | The ID of the user role | [optional] +**icon_url** | **String** | The user icon URL | [optional] +**is_you** | **Boolean** | Boolean that indicates if the requested user is the same which is logged in (in this case, always true) | [optional] +**is_deleted** | **Boolean** | Boolean that indicates whether the user is deleted from the company | [optional] +**company_id** | **Number** | The user company ID | [optional] +**company_name** | **String** | The user company name | [optional] +**company_domain** | **String** | The user company domain | [optional] +**company_country** | **String** | The user company country | [optional] +**company_industry** | **String** | The user company industry | [optional] **language** | [**BaseUserMeAllOfLanguage**](BaseUserMeAllOfLanguage.md) | | [optional] diff --git a/docs/BaseUserMeAllOf.md b/docs/BaseUserMeAllOf.md index e1985e02..e4c2e68e 100644 --- a/docs/BaseUserMeAllOf.md +++ b/docs/BaseUserMeAllOf.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**companyId** | **Number** | The user company ID | [optional] -**companyName** | **String** | The user company name | [optional] -**companyDomain** | **String** | The user company domain | [optional] -**companyCountry** | **String** | The user company country | [optional] -**companyIndustry** | **String** | The user company industry | [optional] +**company_id** | **Number** | The user company ID | [optional] +**company_name** | **String** | The user company name | [optional] +**company_domain** | **String** | The user company domain | [optional] +**company_country** | **String** | The user company country | [optional] +**company_industry** | **String** | The user company industry | [optional] **language** | [**BaseUserMeAllOfLanguage**](BaseUserMeAllOfLanguage.md) | | [optional] diff --git a/docs/BaseUserMeAllOfLanguage.md b/docs/BaseUserMeAllOfLanguage.md index 97febb49..3c0708fd 100644 --- a/docs/BaseUserMeAllOfLanguage.md +++ b/docs/BaseUserMeAllOfLanguage.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**languageCode** | **String** | The language code. E.g. en | [optional] -**countryCode** | **String** | The country code. E.g. US | [optional] +**language_code** | **String** | The language code. E.g. en | [optional] +**country_code** | **String** | The country code. E.g. US | [optional] diff --git a/docs/BaseWebhook.md b/docs/BaseWebhook.md index 4e402f3a..84c9798a 100644 --- a/docs/BaseWebhook.md +++ b/docs/BaseWebhook.md @@ -5,23 +5,23 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the Webhook | [optional] -**companyId** | **Number** | The ID of the company related to the Webhook | [optional] -**ownerId** | **Number** | The ID of the user who owns the Webhook | [optional] -**userId** | **Number** | The ID of the user related to the Webhook | [optional] -**eventAction** | **String** | The Webhook action | [optional] -**eventObject** | **String** | The Webhook object | [optional] -**subscriptionUrl** | **String** | The subscription URL of the Webhook | [optional] -**isActive** | [**NumberBooleanDefault1**](NumberBooleanDefault1.md) | The Webhook's status | [optional] -**addTime** | **Date** | The date when the Webhook was added | [optional] -**removeTime** | **Date** | The date when the Webhook was removed (if removed) | [optional] +**company_id** | **Number** | The ID of the company related to the Webhook | [optional] +**owner_id** | **Number** | The ID of the user who owns the Webhook | [optional] +**user_id** | **Number** | The ID of the user related to the Webhook | [optional] +**event_action** | **String** | The Webhook action | [optional] +**event_object** | **String** | The Webhook object | [optional] +**subscription_url** | **String** | The subscription URL of the Webhook | [optional] +**is_active** | [**NumberBooleanDefault1**](NumberBooleanDefault1.md) | The Webhook's status | [optional] +**add_time** | **Date** | The date when the Webhook was added | [optional] +**remove_time** | **Date** | The date when the Webhook was removed (if removed) | [optional] **type** | **String** | The type of the Webhook | [optional] -**httpAuthUser** | **String** | The username of the `subscription_url` of the Webhook | [optional] -**httpAuthPassword** | **String** | The password of the `subscription_url` of the Webhook | [optional] -**additionalData** | **Object** | Any additional data related to the Webhook | [optional] -**removeReason** | **String** | The removal reason of the Webhook (if removed) | [optional] -**lastDeliveryTime** | **Date** | The last delivery time of the Webhook | [optional] -**lastHttpStatus** | **Number** | The last delivery HTTP status of the Webhook | [optional] -**adminId** | **Number** | The ID of the admin of the Webhook | [optional] +**http_auth_user** | **String** | The username of the `subscription_url` of the Webhook | [optional] +**http_auth_password** | **String** | The password of the `subscription_url` of the Webhook | [optional] +**additional_data** | **Object** | Any additional data related to the Webhook | [optional] +**remove_reason** | **String** | The removal reason of the Webhook (if removed) | [optional] +**last_delivery_time** | **Date** | The last delivery time of the Webhook | [optional] +**last_http_status** | **Number** | The last delivery HTTP status of the Webhook | [optional] +**admin_id** | **Number** | The ID of the admin of the Webhook | [optional] diff --git a/docs/BasicDeal.md b/docs/BasicDeal.md index ee266e34..2637fec7 100644 --- a/docs/BasicDeal.md +++ b/docs/BasicDeal.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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] -**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] -**closeTime** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**expectedCloseDate** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional] +**won_time** | **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] +**lost_time** | **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] +**close_time** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**expected_close_date** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional] **probability** | **Number** | The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled. | [optional] -**lostReason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the deal. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**lost_reason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the deal. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] diff --git a/docs/BasicDealProduct.md b/docs/BasicDealProduct.md index 47fad2eb..d102c39f 100644 --- a/docs/BasicDealProduct.md +++ b/docs/BasicDealProduct.md @@ -4,21 +4,21 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productId** | **Number** | The ID of the product to use | [optional] -**itemPrice** | **Number** | The price at which this product will be added to the deal | [optional] +**product_id** | **Number** | The ID of the product to use | [optional] +**item_price** | **Number** | The price at which this product will be added to the deal | [optional] **quantity** | **Number** | Quantity – e.g. how many items of this product will be added to the deal | [optional] **discount** | **Number** | The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage | [optional] [default to 0] -**discountType** | **String** | The type of the discount's value | [optional] [default to 'percentage'] +**discount_type** | **String** | The type of the discount's value | [optional] [default to 'percentage'] **duration** | **Number** | The duration of the product. If omitted, will be set to 1 | [optional] [default to 1] -**durationUnit** | [**DealProductUnitDuration**](DealProductUnitDuration.md) | The unit duration of the product | [optional] -**productVariationId** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] +**duration_unit** | [**DealProductUnitDuration**](DealProductUnitDuration.md) | The unit duration of the product | [optional] +**product_variation_id** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] **comments** | **String** | A textual comment associated with this product-deal attachment | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] -**taxMethod** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional] -**enabledFlag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] -**billingFrequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] -**billingFrequencyCycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] -**billingStartDate** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] +**tax_method** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional] +**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] +**billing_frequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] +**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] +**billing_start_date** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] diff --git a/docs/BasicDealProductAllOf.md b/docs/BasicDealProductAllOf.md index cb6bf4d4..a89c397d 100644 --- a/docs/BasicDealProductAllOf.md +++ b/docs/BasicDealProductAllOf.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productId** | **Number** | The ID of the product to use | [optional] -**itemPrice** | **Number** | The price at which this product will be added to the deal | [optional] +**product_id** | **Number** | The ID of the product to use | [optional] +**item_price** | **Number** | The price at which this product will be added to the deal | [optional] **quantity** | **Number** | Quantity – e.g. how many items of this product will be added to the deal | [optional] **discount** | **Number** | The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage | [optional] [default to 0] -**discountType** | **String** | The type of the discount's value | [optional] [default to 'percentage'] +**discount_type** | **String** | The type of the discount's value | [optional] [default to 'percentage'] **duration** | **Number** | The duration of the product. If omitted, will be set to 1 | [optional] [default to 1] -**durationUnit** | [**DealProductUnitDuration**](DealProductUnitDuration.md) | The unit duration of the product | [optional] -**productVariationId** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] +**duration_unit** | [**DealProductUnitDuration**](DealProductUnitDuration.md) | The unit duration of the product | [optional] +**product_variation_id** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] **comments** | **String** | A textual comment associated with this product-deal attachment | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] -**taxMethod** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional] -**enabledFlag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] +**tax_method** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional] +**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] diff --git a/docs/BasicGoal.md b/docs/BasicGoal.md index ba3bacc7..93fe6350 100644 --- a/docs/BasicGoal.md +++ b/docs/BasicGoal.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **title** | **String** | The title of the goal | [optional] **assignee** | **Object** | Who this goal is assigned to. It requires the following JSON structure: `{ \"id\": \"1\", \"type\": \"person\" }`. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team. | [optional] **type** | **Object** | The type of the goal. It requires the following JSON structure: `{ \"name\": \"deals_started\", \"params\": { \"pipeline_id\": [1, 2], \"activity_type_id\": [9] } }`. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. The `pipeline_id` and `activity_type_id` need to be given as an array of integers. To track the goal in all pipelines, set `pipeline_id` as `null` and similarly, to track the goal for all activities, set `activity_type_id` as `null`.” | [optional] -**expectedOutcome** | **Object** | The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: `{ \"target\": \"50\", \"tracking_metric\": \"quantity\" }` or `{ \"target\": \"50\", \"tracking_metric\": \"sum\", \"currency_id\": 1 }`. `currency_id` should only be added to `sum` type of goals. | [optional] +**expected_outcome** | **Object** | The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: `{ \"target\": \"50\", \"tracking_metric\": \"quantity\" }` or `{ \"target\": \"50\", \"tracking_metric\": \"sum\", \"currency_id\": 1 }`. `currency_id` should only be added to `sum` type of goals. | [optional] **duration** | **Object** | The date when the goal starts and ends. It requires the following JSON structure: `{ \"start\": \"2019-01-01\", \"end\": \"2022-12-31\" }`. Date in format of YYYY-MM-DD. \"end\" can be set to `null` for an infinite, open-ended goal. | [optional] **interval** | **String** | The interval of the goal | [optional] diff --git a/docs/BasicOrganization.md b/docs/BasicOrganization.md index 48fc8264..50840f40 100644 --- a/docs/BasicOrganization.md +++ b/docs/BasicOrganization.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ownerId** | **Number** | The ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used. | [optional] +**owner_id** | **Number** | The ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used. | [optional] **label** | **Number** | The ID of the label. | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the organization. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the organization. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] diff --git a/docs/BasicPerson.md b/docs/BasicPerson.md index d8094d55..be81aad9 100644 --- a/docs/BasicPerson.md +++ b/docs/BasicPerson.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ownerId** | **Number** | The ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used. | [optional] -**orgId** | **Number** | The ID of the organization this person will belong to | [optional] +**owner_id** | **Number** | The ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used. | [optional] +**org_id** | **Number** | The ID of the organization this person will belong to | [optional] **email** | [**[BasicPersonEmail]**](BasicPersonEmail.md) | An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ \"value\": \"mail@example.com\", \"primary\": \"true\", \"label\": \"main\" }]`. Please note that only `value` is required. | [optional] **phone** | [**[BasePersonItemPhone]**](BasePersonItemPhone.md) | A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ \"value\": \"12345\", \"primary\": \"true\", \"label\": \"mobile\" }]`. Please note that only `value` is required. | [optional] **label** | **Number** | The ID of the label. | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the person. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] -**marketingStatus** | [**MarketingStatus**](MarketingStatus.md) | If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table> | [optional] -**addTime** | **String** | The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the person. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**marketing_status** | [**MarketingStatus**](MarketingStatus.md) | If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table> | [optional] +**add_time** | **String** | The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/docs/CalculatedFields.md b/docs/CalculatedFields.md index 0bd8185b..d418087a 100644 --- a/docs/CalculatedFields.md +++ b/docs/CalculatedFields.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**calculatedType** | **String** | The calculated type of the relationship with the linked organization | [optional] -**calculatedRelatedOrgId** | **Number** | The ID of the linked organization | [optional] +**calculated_type** | **String** | The calculated type of the relationship with the linked organization | [optional] +**calculated_related_org_id** | **Number** | The ID of the linked organization | [optional] diff --git a/docs/CallLogObject.md b/docs/CallLogObject.md index 3e1a773b..41ecd768 100644 --- a/docs/CallLogObject.md +++ b/docs/CallLogObject.md @@ -4,19 +4,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users. | [optional] -**activityId** | **Number** | If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity. | [optional] +**user_id** | **Number** | The ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users. | [optional] +**activity_id** | **Number** | If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity. | [optional] **subject** | **String** | The name of the activity this call is attached to | [optional] **duration** | **String** | The duration of the call in seconds | [optional] **outcome** | **String** | Describes the outcome of the call | -**fromPhoneNumber** | **String** | The number that made the call | [optional] -**toPhoneNumber** | **String** | The number called | -**startTime** | **Date** | The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. | -**endTime** | **Date** | The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. | -**personId** | **Number** | The ID of the person this call is associated with | [optional] -**orgId** | **Number** | The ID of the organization this call is associated with | [optional] -**dealId** | **Number** | The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] -**leadId** | **String** | The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] +**from_phone_number** | **String** | The number that made the call | [optional] +**to_phone_number** | **String** | The number called | +**start_time** | **Date** | The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. | +**end_time** | **Date** | The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. | +**person_id** | **Number** | The ID of the person this call is associated with | [optional] +**org_id** | **Number** | The ID of the organization this call is associated with | [optional] +**deal_id** | **Number** | The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] +**lead_id** | **String** | The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] **note** | **String** | The note for the call log in HTML format | [optional] diff --git a/docs/CallLogResponse400.md b/docs/CallLogResponse400.md index 55e85bd2..9ab90fa2 100644 --- a/docs/CallLogResponse400.md +++ b/docs/CallLogResponse400.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The description of the error | [optional] -**errorInfo** | **String** | A message describing how to solve the problem | [optional] +**error_info** | **String** | A message describing how to solve the problem | [optional] **data** | **Object** | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/CallLogResponse403.md b/docs/CallLogResponse403.md index 925ad143..811deb51 100644 --- a/docs/CallLogResponse403.md +++ b/docs/CallLogResponse403.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The description of the error | [optional] -**errorInfo** | **String** | A message describing how to solve the problem | [optional] +**error_info** | **String** | A message describing how to solve the problem | [optional] **data** | **Object** | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/CallLogResponse404.md b/docs/CallLogResponse404.md index e4f673e9..7cd3a2b7 100644 --- a/docs/CallLogResponse404.md +++ b/docs/CallLogResponse404.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The description of the error | [optional] -**errorInfo** | **String** | A message describing how to solve the problem | [optional] +**error_info** | **String** | A message describing how to solve the problem | [optional] **data** | **Object** | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/CallLogResponse409.md b/docs/CallLogResponse409.md index 86bc17c9..ef45954b 100644 --- a/docs/CallLogResponse409.md +++ b/docs/CallLogResponse409.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The description of the error | [optional] -**errorInfo** | **String** | A message describing how to solve the problem | [optional] +**error_info** | **String** | A message describing how to solve the problem | [optional] **data** | **Object** | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/CallLogResponse410.md b/docs/CallLogResponse410.md index 4e88b335..df00c0ab 100644 --- a/docs/CallLogResponse410.md +++ b/docs/CallLogResponse410.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The description of the error | [optional] -**errorInfo** | **String** | A message describing how to solve the problem | [optional] +**error_info** | **String** | A message describing how to solve the problem | [optional] **data** | **Object** | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/CallLogResponse500.md b/docs/CallLogResponse500.md index 688c7655..49ecd1d1 100644 --- a/docs/CallLogResponse500.md +++ b/docs/CallLogResponse500.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The description of the error | [optional] -**errorInfo** | **String** | A message describing how to solve the problem | [optional] +**error_info** | **String** | A message describing how to solve the problem | [optional] **data** | **Object** | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/CallLogsApi.md b/docs/CallLogsApi.md index 43d48fff..0271a5e5 100644 --- a/docs/CallLogsApi.md +++ b/docs/CallLogsApi.md @@ -51,7 +51,7 @@ apiInstance.addCallLog(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **callLogObject** | [**CallLogObject**](CallLogObject.md)| | [optional] + **CallLogObject** | [**CallLogObject**](CallLogObject.md)| | [optional] ### Return type @@ -251,6 +251,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.CallLogsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | For pagination, the limit of entries to be returned. The upper limit is 50. diff --git a/docs/CallLogsResponse.md b/docs/CallLogsResponse.md index c298272b..54930d18 100644 --- a/docs/CallLogsResponse.md +++ b/docs/CallLogsResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ResponseCallLogObject]**](ResponseCallLogObject.md) | | [optional] -**additionalData** | [**CallLogsResponseAdditionalData**](CallLogsResponseAdditionalData.md) | | [optional] +**additional_data** | [**CallLogsResponseAdditionalData**](CallLogsResponseAdditionalData.md) | | [optional] diff --git a/docs/ChangelogResponse.md b/docs/ChangelogResponse.md index 0b442d6e..5526bbfd 100644 --- a/docs/ChangelogResponse.md +++ b/docs/ChangelogResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ChangelogResponseAllOfData]**](ChangelogResponseAllOfData.md) | | [optional] -**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] +**additional_data** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] diff --git a/docs/ChangelogResponseAllOf.md b/docs/ChangelogResponseAllOf.md index c6a8efa1..f166dfba 100644 --- a/docs/ChangelogResponseAllOf.md +++ b/docs/ChangelogResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[ChangelogResponseAllOfData]**](ChangelogResponseAllOfData.md) | | [optional] -**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] +**additional_data** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] diff --git a/docs/ChangelogResponseAllOfData.md b/docs/ChangelogResponseAllOfData.md index da229d7d..c541c4eb 100644 --- a/docs/ChangelogResponseAllOfData.md +++ b/docs/ChangelogResponseAllOfData.md @@ -4,13 +4,13 @@ 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] +**field_key** | **String** | The key of the field that was changed | [optional] +**old_value** | **String** | The value of the field before the change | [optional] +**new_value** | **String** | The value of the field after the change | [optional] +**actor_user_id** | **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] +**change_source** | **String** | The source of change, for example 'app', 'mobile', 'api', etc. | [optional] +**change_source_user_agent** | **String** | The user agent from which the change was made | [optional] +**is_bulk_update_flag** | **Boolean** | Whether the change was made as part of a bulk update | [optional] diff --git a/docs/ChannelObject.md b/docs/ChannelObject.md index f817cf48..8f981f13 100644 --- a/docs/ChannelObject.md +++ b/docs/ChannelObject.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the channel | -**providerChannelId** | **String** | The channel ID | -**avatarUrl** | **String** | The URL for an icon that represents your channel | [optional] -**templateSupport** | **Boolean** | If true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more [here](https://pipedrive.readme.io/docs/implementing-messaging-app-extension). | [optional] [default to false] -**providerType** | **String** | It controls the icons (like the icon next to the conversation) | [optional] [default to 'other'] +**provider_channel_id** | **String** | The channel ID | +**avatar_url** | **String** | The URL for an icon that represents your channel | [optional] +**template_support** | **Boolean** | If true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more [here](https://pipedrive.readme.io/docs/implementing-messaging-app-extension). | [optional] [default to false] +**provider_type** | **String** | It controls the icons (like the icon next to the conversation) | [optional] [default to 'other'] diff --git a/docs/ChannelObjectResponseData.md b/docs/ChannelObjectResponseData.md index 36f2d195..ec8ff578 100644 --- a/docs/ChannelObjectResponseData.md +++ b/docs/ChannelObjectResponseData.md @@ -6,14 +6,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The unique channel ID used internally in omnichannel-api and the frontend of the extension | [optional] **name** | **String** | The name of the channel | [optional] -**avatarUrl** | **String** | The URL for an icon that represents your channel | [optional] -**providerChannelId** | **String** | The channel ID you specified while creating the channel | [optional] -**marketplaceClientId** | **String** | The client_id of your app in Pipedrive marketplace | [optional] -**pdCompanyId** | **Number** | The ID of the user's company in Pipedrive | [optional] -**pdUserId** | **Number** | The ID of the user in Pipedrive | [optional] -**createdAt** | **Date** | The date and time when your channel was created in the API | [optional] -**providerType** | **String** | Value of the provider_type sent to this endpoint | [optional] -**templateSupport** | **Boolean** | Value of the template_support sent to this endpoint | [optional] +**avatar_url** | **String** | The URL for an icon that represents your channel | [optional] +**provider_channel_id** | **String** | The channel ID you specified while creating the channel | [optional] +**marketplace_client_id** | **String** | The client_id of your app in Pipedrive marketplace | [optional] +**pd_company_id** | **Number** | The ID of the user's company in Pipedrive | [optional] +**pd_user_id** | **Number** | The ID of the user in Pipedrive | [optional] +**created_at** | **Date** | The date and time when your channel was created in the API | [optional] +**provider_type** | **String** | Value of the provider_type sent to this endpoint | [optional] +**template_support** | **Boolean** | Value of the template_support sent to this endpoint | [optional] diff --git a/docs/ChannelsApi.md b/docs/ChannelsApi.md index fa880e6b..8788c205 100644 --- a/docs/ChannelsApi.md +++ b/docs/ChannelsApi.md @@ -50,7 +50,7 @@ apiInstance.addChannel(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **channelObject** | [**ChannelObject**](ChannelObject.md)| | [optional] + **ChannelObject** | [**ChannelObject**](ChannelObject.md)| | [optional] ### Return type @@ -157,8 +157,8 @@ apiInstance.deleteConversation(channelId, conversationId).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **channelId** | **String**| The ID of the channel provided by the integration | - **conversationId** | **String**| The ID of the conversation provided by the integration | + **channel-id** | **String**| The ID of the channel provided by the integration | + **conversation-id** | **String**| The ID of the conversation provided by the integration | ### Return type @@ -213,7 +213,7 @@ apiInstance.receiveMessage(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **messageObject** | [**MessageObject**](MessageObject.md)| | [optional] + **MessageObject** | [**MessageObject**](MessageObject.md)| | [optional] ### Return type diff --git a/docs/CommonMailThread.md b/docs/CommonMailThread.md index 8624954b..6701bfc1 100644 --- a/docs/CommonMailThread.md +++ b/docs/CommonMailThread.md @@ -5,18 +5,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | ID of the mail thread | [optional] -**accountId** | **String** | The connection account ID | [optional] -**userId** | **Number** | ID of the user whom mail message will be assigned to | [optional] +**account_id** | **String** | The connection account ID | [optional] +**user_id** | **Number** | ID of the user whom mail message will be assigned to | [optional] **subject** | **String** | The subject | [optional] **snippet** | **String** | A snippet | [optional] -**readFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is read | [optional] -**mailTrackingStatus** | **String** | Mail tracking status | [optional] -**hasAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has an attachment | [optional] -**hasInlineAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has inline attachments | [optional] -**hasRealAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has real attachments (which are not inline) | [optional] -**deletedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is deleted | [optional] -**syncedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is synced | [optional] -**smartBccFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether one of the parties of the mail thread is Bcc | [optional] -**mailLinkTrackingEnabledFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the link tracking of the mail thread is enabled | [optional] +**read_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is read | [optional] +**mail_tracking_status** | **String** | Mail tracking status | [optional] +**has_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has an attachment | [optional] +**has_inline_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has inline attachments | [optional] +**has_real_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread has real attachments (which are not inline) | [optional] +**deleted_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is deleted | [optional] +**synced_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail thread is synced | [optional] +**smart_bcc_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether one of the parties of the mail thread is Bcc | [optional] +**mail_link_tracking_enabled_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the link tracking of the mail thread is enabled | [optional] diff --git a/docs/CreateTeam.md b/docs/CreateTeam.md index d930128a..85cd6ec6 100644 --- a/docs/CreateTeam.md +++ b/docs/CreateTeam.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The team name | [optional] **description** | **String** | The team description | [optional] -**managerId** | **Number** | The team manager ID | [optional] +**manager_id** | **Number** | The team manager ID | [optional] **users** | **[Number]** | The list of user IDs | [optional] diff --git a/docs/CurrenciesApi.md b/docs/CurrenciesApi.md index b8bd7543..f3d662ec 100644 --- a/docs/CurrenciesApi.md +++ b/docs/CurrenciesApi.md @@ -31,6 +31,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.CurrenciesApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'term': "term_example" // String | Optional search term that is searched for from currency's name and/or code }; diff --git a/docs/DealCollectionResponseObject.md b/docs/DealCollectionResponseObject.md index 05e1f3e4..f62a6bda 100644 --- a/docs/DealCollectionResponseObject.md +++ b/docs/DealCollectionResponseObject.md @@ -5,25 +5,25 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the deal | [optional] -**creatorUserId** | **Number** | The ID of the deal creator | [optional] -**userId** | **Number** | The ID of the user | [optional] -**personId** | **Number** | The ID of the person associated with the deal | [optional] -**orgId** | **Number** | The ID of the organization associated with the deal | [optional] -**stageId** | **Number** | The ID of the deal stage | [optional] +**creator_user_id** | **Number** | The ID of the deal creator | [optional] +**user_id** | **Number** | The ID of the user | [optional] +**person_id** | **Number** | The ID of the person associated with the deal | [optional] +**org_id** | **Number** | The ID of the organization associated with the deal | [optional] +**stage_id** | **Number** | The ID of the deal stage | [optional] **title** | **String** | The title of the deal | [optional] **value** | **Number** | The value of the deal | [optional] **currency** | **String** | The currency associated with the deal | [optional] -**addTime** | **String** | The creation date and time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The last update date and time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**add_time** | **String** | The creation date and time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The last update date and time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] **status** | **String** | The status of the deal | [optional] **probability** | **Number** | The success probability percentage of the deal | [optional] -**lostReason** | **String** | The reason for losing the deal | [optional] -**visibleTo** | **String** | The visibility of the deal | [optional] -**closeTime** | **String** | The date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**pipelineId** | **Number** | The ID of the pipeline associated with the deal | [optional] -**wonTime** | **String** | The date and time of changing the deal status to won in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**lostTime** | **String** | The date and time of changing the deal status to lost in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**expectedCloseDate** | **Date** | The expected close date of the deal | [optional] +**lost_reason** | **String** | The reason for losing the deal | [optional] +**visible_to** | **String** | The visibility of the deal | [optional] +**close_time** | **String** | The date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**pipeline_id** | **Number** | The ID of the pipeline associated with the deal | [optional] +**won_time** | **String** | The date and time of changing the deal status to won in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**lost_time** | **String** | The date and time of changing the deal status to lost in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**expected_close_date** | **Date** | The expected close date of the deal | [optional] **label** | **String** | The label or multiple labels assigned to the deal | [optional] diff --git a/docs/DealCountAndActivityInfo.md b/docs/DealCountAndActivityInfo.md index 052cd836..76484437 100644 --- a/docs/DealCountAndActivityInfo.md +++ b/docs/DealCountAndActivityInfo.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] diff --git a/docs/DealFieldsApi.md b/docs/DealFieldsApi.md index f3d14e2c..c0250b83 100644 --- a/docs/DealFieldsApi.md +++ b/docs/DealFieldsApi.md @@ -52,7 +52,7 @@ apiInstance.addDealField(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fieldCreateRequest** | [**FieldCreateRequest**](FieldCreateRequest.md)| | [optional] + **FieldCreateRequest** | [**FieldCreateRequest**](FieldCreateRequest.md)| | [optional] ### Return type @@ -250,6 +250,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealFieldsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -325,7 +326,7 @@ apiInstance.updateDealField(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the field | - **fieldUpdateRequest** | [**FieldUpdateRequest**](FieldUpdateRequest.md)| | [optional] + **FieldUpdateRequest** | [**FieldUpdateRequest**](FieldUpdateRequest.md)| | [optional] ### Return type diff --git a/docs/DealFlowResponse.md b/docs/DealFlowResponse.md index d85b7900..d6595921 100644 --- a/docs/DealFlowResponse.md +++ b/docs/DealFlowResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[DealFlowResponseAllOfData]**](DealFlowResponseAllOfData.md) | | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**DealFlowResponseAllOfRelatedObjects**](DealFlowResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**DealFlowResponseAllOfRelatedObjects**](DealFlowResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/DealFlowResponseAllOf.md b/docs/DealFlowResponseAllOf.md index a010bab2..64990cb0 100644 --- a/docs/DealFlowResponseAllOf.md +++ b/docs/DealFlowResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[DealFlowResponseAllOfData]**](DealFlowResponseAllOfData.md) | | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**DealFlowResponseAllOfRelatedObjects**](DealFlowResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**DealFlowResponseAllOfRelatedObjects**](DealFlowResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/DealListActivitiesResponse.md b/docs/DealListActivitiesResponse.md index 881beeed..263ca549 100644 --- a/docs/DealListActivitiesResponse.md +++ b/docs/DealListActivitiesResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ActivityResponseObject]**](ActivityResponseObject.md) | The array of activities | [optional] -**additionalData** | [**ActivityDistributionDataWithAdditionalData**](ActivityDistributionDataWithAdditionalData.md) | | [optional] -**relatedObjects** | [**DealListActivitiesResponseAllOfRelatedObjects**](DealListActivitiesResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**ActivityDistributionDataWithAdditionalData**](ActivityDistributionDataWithAdditionalData.md) | | [optional] +**related_objects** | [**DealListActivitiesResponseAllOfRelatedObjects**](DealListActivitiesResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/DealListActivitiesResponseAllOf.md b/docs/DealListActivitiesResponseAllOf.md index 3d02c6c3..1f86fd5d 100644 --- a/docs/DealListActivitiesResponseAllOf.md +++ b/docs/DealListActivitiesResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[ActivityResponseObject]**](ActivityResponseObject.md) | The array of activities | [optional] -**additionalData** | [**ActivityDistributionDataWithAdditionalData**](ActivityDistributionDataWithAdditionalData.md) | | [optional] -**relatedObjects** | [**DealListActivitiesResponseAllOfRelatedObjects**](DealListActivitiesResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**ActivityDistributionDataWithAdditionalData**](ActivityDistributionDataWithAdditionalData.md) | | [optional] +**related_objects** | [**DealListActivitiesResponseAllOfRelatedObjects**](DealListActivitiesResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/DealNonStrict.md b/docs/DealNonStrict.md index a3800b0a..c489daf1 100644 --- a/docs/DealNonStrict.md +++ b/docs/DealNonStrict.md @@ -5,65 +5,65 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the deal | [optional] -**creatorUserId** | [**DealNonStrictModeFieldsCreatorUserId**](DealNonStrictModeFieldsCreatorUserId.md) | | [optional] -**userId** | [**DealUserDataWithId**](DealUserDataWithId.md) | | [optional] -**personId** | [**DealPersonDataWithId**](DealPersonDataWithId.md) | | [optional] -**orgId** | [**DealOrganizationDataWithId**](DealOrganizationDataWithId.md) | | [optional] -**stageId** | **Number** | The ID of the deal stage | [optional] +**creator_user_id** | [**DealNonStrictModeFieldsCreatorUserId**](DealNonStrictModeFieldsCreatorUserId.md) | | [optional] +**user_id** | [**DealUserDataWithId**](DealUserDataWithId.md) | | [optional] +**person_id** | [**DealPersonDataWithId**](DealPersonDataWithId.md) | | [optional] +**org_id** | [**DealOrganizationDataWithId**](DealOrganizationDataWithId.md) | | [optional] +**stage_id** | **Number** | The ID of the deal stage | [optional] **title** | **String** | The title of the deal | [optional] **value** | **Number** | The value of the deal | [optional] **currency** | **String** | The currency associated with the deal | [optional] -**addTime** | **String** | The creation date and time of the deal | [optional] -**updateTime** | **String** | The last updated date and time of the deal | [optional] -**stageChangeTime** | **String** | The last updated date and time of the deal stage | [optional] +**add_time** | **String** | The creation date and time of the deal | [optional] +**update_time** | **String** | The last updated date and time of the deal | [optional] +**stage_change_time** | **String** | The last updated date and time of the deal stage | [optional] **active** | **Boolean** | Whether the deal is active or not | [optional] **deleted** | **Boolean** | Whether the deal is deleted or not | [optional] **status** | **String** | The status of the deal | [optional] **probability** | **Number** | The success probability percentage of the deal | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] -**lostReason** | **String** | The reason for losing the deal | [optional] -**visibleTo** | **String** | The visibility of the deal | [optional] -**closeTime** | **String** | The date and time of closing the deal | [optional] -**pipelineId** | **Number** | The ID of the pipeline associated with the deal | [optional] -**wonTime** | **String** | The date and time of changing the deal status as won | [optional] -**firstWonTime** | **String** | The date and time of the first time changing the deal status as won | [optional] -**lostTime** | **String** | The date and time of changing the deal status as lost | [optional] -**productsCount** | **Number** | The number of products associated with the deal | [optional] -**filesCount** | **Number** | The number of files associated with the deal | [optional] -**notesCount** | **Number** | The number of notes associated with the deal | [optional] -**followersCount** | **Number** | The number of followers associated with the deal | [optional] -**emailMessagesCount** | **Number** | The number of emails associated with the deal | [optional] -**activitiesCount** | **Number** | The number of activities associated with the deal | [optional] -**doneActivitiesCount** | **Number** | The number of completed activities associated with the deal | [optional] -**undoneActivitiesCount** | **Number** | The number of incomplete activities associated with the deal | [optional] -**participantsCount** | **Number** | The number of participants associated with the deal | [optional] -**expectedCloseDate** | **Date** | The expected close date of the deal | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the deal | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the deal | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] +**lost_reason** | **String** | The reason for losing the deal | [optional] +**visible_to** | **String** | The visibility of the deal | [optional] +**close_time** | **String** | The date and time of closing the deal | [optional] +**pipeline_id** | **Number** | The ID of the pipeline associated with the deal | [optional] +**won_time** | **String** | The date and time of changing the deal status as won | [optional] +**first_won_time** | **String** | The date and time of the first time changing the deal status as won | [optional] +**lost_time** | **String** | The date and time of changing the deal status as lost | [optional] +**products_count** | **Number** | The number of products associated with the deal | [optional] +**files_count** | **Number** | The number of files associated with the deal | [optional] +**notes_count** | **Number** | The number of notes associated with the deal | [optional] +**followers_count** | **Number** | The number of followers associated with the deal | [optional] +**email_messages_count** | **Number** | The number of emails associated with the deal | [optional] +**activities_count** | **Number** | The number of activities associated with the deal | [optional] +**done_activities_count** | **Number** | The number of completed activities associated with the deal | [optional] +**undone_activities_count** | **Number** | The number of incomplete activities associated with the deal | [optional] +**participants_count** | **Number** | The number of participants associated with the deal | [optional] +**expected_close_date** | **Date** | The expected close date of the deal | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the deal | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the deal | [optional] **label** | **String** | The label or multiple labels assigned to the deal | [optional] -**stageOrderNr** | **Number** | The order number of the deal stage associated with the deal | [optional] -**personName** | **String** | The name of the person associated with the deal | [optional] -**orgName** | **String** | The name of the organization associated with the deal | [optional] -**nextActivitySubject** | **String** | The subject of the next activity associated with the deal | [optional] -**nextActivityType** | **String** | The type of the next activity associated with the deal | [optional] -**nextActivityDuration** | **String** | The duration of the next activity associated with the deal | [optional] -**nextActivityNote** | **String** | The note of the next activity associated with the deal | [optional] -**formattedValue** | **String** | The deal value formatted with selected currency. E.g. US$500 | [optional] -**weightedValue** | **Number** | Probability times deal value. Probability can either be deal probability or if not set, then stage probability. | [optional] -**formattedWeightedValue** | **String** | The weighted_value formatted with selected currency. E.g. US$500 | [optional] -**weightedValueCurrency** | **String** | The currency associated with the deal | [optional] -**rottenTime** | **String** | The date and time of changing the deal status as rotten | [optional] -**ownerName** | **String** | The name of the deal owner | [optional] -**ccEmail** | **String** | The BCC email of the deal | [optional] -**orgHidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] -**personHidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] +**stage_order_nr** | **Number** | The order number of the deal stage associated with the deal | [optional] +**person_name** | **String** | The name of the person associated with the deal | [optional] +**org_name** | **String** | The name of the organization associated with the deal | [optional] +**next_activity_subject** | **String** | The subject of the next activity associated with the deal | [optional] +**next_activity_type** | **String** | The type of the next activity associated with the deal | [optional] +**next_activity_duration** | **String** | The duration of the next activity associated with the deal | [optional] +**next_activity_note** | **String** | The note of the next activity associated with the deal | [optional] +**formatted_value** | **String** | The deal value formatted with selected currency. E.g. US$500 | [optional] +**weighted_value** | **Number** | Probability times deal value. Probability can either be deal probability or if not set, then stage probability. | [optional] +**formatted_weighted_value** | **String** | The weighted_value formatted with selected currency. E.g. US$500 | [optional] +**weighted_value_currency** | **String** | The currency associated with the deal | [optional] +**rotten_time** | **String** | The date and time of changing the deal status as rotten | [optional] +**owner_name** | **String** | The name of the deal owner | [optional] +**cc_email** | **String** | The BCC email of the deal | [optional] +**org_hidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] +**person_hidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] **origin** | **String** | The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. | [optional] -**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] +**origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] diff --git a/docs/DealNonStrictModeFields.md b/docs/DealNonStrictModeFields.md index 5daab3e6..1085ff09 100644 --- a/docs/DealNonStrictModeFields.md +++ b/docs/DealNonStrictModeFields.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the deal | [optional] -**creatorUserId** | [**DealNonStrictModeFieldsCreatorUserId**](DealNonStrictModeFieldsCreatorUserId.md) | | [optional] -**userId** | [**DealUserDataWithId**](DealUserDataWithId.md) | | [optional] -**personId** | [**DealPersonDataWithId**](DealPersonDataWithId.md) | | [optional] -**orgId** | [**DealOrganizationDataWithId**](DealOrganizationDataWithId.md) | | [optional] +**creator_user_id** | [**DealNonStrictModeFieldsCreatorUserId**](DealNonStrictModeFieldsCreatorUserId.md) | | [optional] +**user_id** | [**DealUserDataWithId**](DealUserDataWithId.md) | | [optional] +**person_id** | [**DealPersonDataWithId**](DealPersonDataWithId.md) | | [optional] +**org_id** | [**DealOrganizationDataWithId**](DealOrganizationDataWithId.md) | | [optional] diff --git a/docs/DealNonStrictModeFieldsCreatorUserId.md b/docs/DealNonStrictModeFieldsCreatorUserId.md index ba349d5a..7ecc3436 100644 --- a/docs/DealNonStrictModeFieldsCreatorUserId.md +++ b/docs/DealNonStrictModeFieldsCreatorUserId.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **id** | **Number** | The ID of the deal creator | [optional] **name** | **String** | The name of the deal creator | [optional] **email** | **String** | The email of the deal creator | [optional] -**hasPic** | **Boolean** | If the creator has a picture or not | [optional] -**picHash** | **String** | The creator picture hash | [optional] -**activeFlag** | **Boolean** | Whether the creator is active or not | [optional] +**has_pic** | **Boolean** | If the creator has a picture or not | [optional] +**pic_hash** | **String** | The creator picture hash | [optional] +**active_flag** | **Boolean** | Whether the creator is active or not | [optional] **value** | **Number** | The ID of the deal creator | [optional] diff --git a/docs/DealNonStrictWithDetails.md b/docs/DealNonStrictWithDetails.md index c16b1299..dd3b9699 100644 --- a/docs/DealNonStrictWithDetails.md +++ b/docs/DealNonStrictWithDetails.md @@ -5,71 +5,71 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the deal | [optional] -**creatorUserId** | [**DealNonStrictModeFieldsCreatorUserId**](DealNonStrictModeFieldsCreatorUserId.md) | | [optional] -**userId** | [**DealUserDataWithId**](DealUserDataWithId.md) | | [optional] -**personId** | [**DealPersonDataWithId**](DealPersonDataWithId.md) | | [optional] -**orgId** | [**DealOrganizationDataWithId**](DealOrganizationDataWithId.md) | | [optional] -**stageId** | **Number** | The ID of the deal stage | [optional] +**creator_user_id** | [**DealNonStrictModeFieldsCreatorUserId**](DealNonStrictModeFieldsCreatorUserId.md) | | [optional] +**user_id** | [**DealUserDataWithId**](DealUserDataWithId.md) | | [optional] +**person_id** | [**DealPersonDataWithId**](DealPersonDataWithId.md) | | [optional] +**org_id** | [**DealOrganizationDataWithId**](DealOrganizationDataWithId.md) | | [optional] +**stage_id** | **Number** | The ID of the deal stage | [optional] **title** | **String** | The title of the deal | [optional] **value** | **Number** | The value of the deal | [optional] **currency** | **String** | The currency associated with the deal | [optional] -**addTime** | **String** | The creation date and time of the deal | [optional] -**updateTime** | **String** | The last updated date and time of the deal | [optional] -**stageChangeTime** | **String** | The last updated date and time of the deal stage | [optional] +**add_time** | **String** | The creation date and time of the deal | [optional] +**update_time** | **String** | The last updated date and time of the deal | [optional] +**stage_change_time** | **String** | The last updated date and time of the deal stage | [optional] **active** | **Boolean** | Whether the deal is active or not | [optional] **deleted** | **Boolean** | Whether the deal is deleted or not | [optional] **status** | **String** | The status of the deal | [optional] **probability** | **Number** | The success probability percentage of the deal | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] -**lostReason** | **String** | The reason for losing the deal | [optional] -**visibleTo** | **String** | The visibility of the deal | [optional] -**closeTime** | **String** | The date and time of closing the deal | [optional] -**pipelineId** | **Number** | The ID of the pipeline associated with the deal | [optional] -**wonTime** | **String** | The date and time of changing the deal status as won | [optional] -**firstWonTime** | **String** | The date and time of the first time changing the deal status as won | [optional] -**lostTime** | **String** | The date and time of changing the deal status as lost | [optional] -**productsCount** | **Number** | The number of products associated with the deal | [optional] -**filesCount** | **Number** | The number of files associated with the deal | [optional] -**notesCount** | **Number** | The number of notes associated with the deal | [optional] -**followersCount** | **Number** | The number of followers associated with the deal | [optional] -**emailMessagesCount** | **Number** | The number of emails associated with the deal | [optional] -**activitiesCount** | **Number** | The number of activities associated with the deal | [optional] -**doneActivitiesCount** | **Number** | The number of completed activities associated with the deal | [optional] -**undoneActivitiesCount** | **Number** | The number of incomplete activities associated with the deal | [optional] -**participantsCount** | **Number** | The number of participants associated with the deal | [optional] -**expectedCloseDate** | **Date** | The expected close date of the deal | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the deal | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the deal | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] +**lost_reason** | **String** | The reason for losing the deal | [optional] +**visible_to** | **String** | The visibility of the deal | [optional] +**close_time** | **String** | The date and time of closing the deal | [optional] +**pipeline_id** | **Number** | The ID of the pipeline associated with the deal | [optional] +**won_time** | **String** | The date and time of changing the deal status as won | [optional] +**first_won_time** | **String** | The date and time of the first time changing the deal status as won | [optional] +**lost_time** | **String** | The date and time of changing the deal status as lost | [optional] +**products_count** | **Number** | The number of products associated with the deal | [optional] +**files_count** | **Number** | The number of files associated with the deal | [optional] +**notes_count** | **Number** | The number of notes associated with the deal | [optional] +**followers_count** | **Number** | The number of followers associated with the deal | [optional] +**email_messages_count** | **Number** | The number of emails associated with the deal | [optional] +**activities_count** | **Number** | The number of activities associated with the deal | [optional] +**done_activities_count** | **Number** | The number of completed activities associated with the deal | [optional] +**undone_activities_count** | **Number** | The number of incomplete activities associated with the deal | [optional] +**participants_count** | **Number** | The number of participants associated with the deal | [optional] +**expected_close_date** | **Date** | The expected close date of the deal | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the deal | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the deal | [optional] **label** | **String** | The label or multiple labels assigned to the deal | [optional] -**stageOrderNr** | **Number** | The order number of the deal stage associated with the deal | [optional] -**personName** | **String** | The name of the person associated with the deal | [optional] -**orgName** | **String** | The name of the organization associated with the deal | [optional] -**nextActivitySubject** | **String** | The subject of the next activity associated with the deal | [optional] -**nextActivityType** | **String** | The type of the next activity associated with the deal | [optional] -**nextActivityDuration** | **String** | The duration of the next activity associated with the deal | [optional] -**nextActivityNote** | **String** | The note of the next activity associated with the deal | [optional] -**formattedValue** | **String** | The deal value formatted with selected currency. E.g. US$500 | [optional] -**weightedValue** | **Number** | Probability times deal value. Probability can either be deal probability or if not set, then stage probability. | [optional] -**formattedWeightedValue** | **String** | The weighted_value formatted with selected currency. E.g. US$500 | [optional] -**weightedValueCurrency** | **String** | The currency associated with the deal | [optional] -**rottenTime** | **String** | The date and time of changing the deal status as rotten | [optional] -**ownerName** | **String** | The name of the deal owner | [optional] -**ccEmail** | **String** | The BCC email of the deal | [optional] -**orgHidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] -**personHidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] +**stage_order_nr** | **Number** | The order number of the deal stage associated with the deal | [optional] +**person_name** | **String** | The name of the person associated with the deal | [optional] +**org_name** | **String** | The name of the organization associated with the deal | [optional] +**next_activity_subject** | **String** | The subject of the next activity associated with the deal | [optional] +**next_activity_type** | **String** | The type of the next activity associated with the deal | [optional] +**next_activity_duration** | **String** | The duration of the next activity associated with the deal | [optional] +**next_activity_note** | **String** | The note of the next activity associated with the deal | [optional] +**formatted_value** | **String** | The deal value formatted with selected currency. E.g. US$500 | [optional] +**weighted_value** | **Number** | Probability times deal value. Probability can either be deal probability or if not set, then stage probability. | [optional] +**formatted_weighted_value** | **String** | The weighted_value formatted with selected currency. E.g. US$500 | [optional] +**weighted_value_currency** | **String** | The currency associated with the deal | [optional] +**rotten_time** | **String** | The date and time of changing the deal status as rotten | [optional] +**owner_name** | **String** | The name of the deal owner | [optional] +**cc_email** | **String** | The BCC email of the deal | [optional] +**org_hidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] +**person_hidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] **origin** | **String** | The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. | [optional] -**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] +**origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] -**averageTimeToWon** | [**DealNonStrictWithDetailsAllOfAverageTimeToWon**](DealNonStrictWithDetailsAllOfAverageTimeToWon.md) | | [optional] -**averageStageProgress** | **Number** | The average of the deal stage progression | [optional] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**average_time_to_won** | [**DealNonStrictWithDetailsAllOfAverageTimeToWon**](DealNonStrictWithDetailsAllOfAverageTimeToWon.md) | | [optional] +**average_stage_progress** | **Number** | The average of the deal stage progression | [optional] **age** | [**DealNonStrictWithDetailsAllOfAge**](DealNonStrictWithDetailsAllOfAge.md) | | [optional] -**stayInPipelineStages** | [**DealNonStrictWithDetailsAllOfStayInPipelineStages**](DealNonStrictWithDetailsAllOfStayInPipelineStages.md) | | [optional] -**lastActivity** | **Object** | The details of the last activity associated with the deal | [optional] -**nextActivity** | **Object** | The details of the next activity associated with the deal | [optional] +**stay_in_pipeline_stages** | [**DealNonStrictWithDetailsAllOfStayInPipelineStages**](DealNonStrictWithDetailsAllOfStayInPipelineStages.md) | | [optional] +**last_activity** | **Object** | The details of the last activity associated with the deal | [optional] +**next_activity** | **Object** | The details of the next activity associated with the deal | [optional] diff --git a/docs/DealNonStrictWithDetailsAllOf.md b/docs/DealNonStrictWithDetailsAllOf.md index 804fd435..31b4c0c9 100644 --- a/docs/DealNonStrictWithDetailsAllOf.md +++ b/docs/DealNonStrictWithDetailsAllOf.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**averageTimeToWon** | [**DealNonStrictWithDetailsAllOfAverageTimeToWon**](DealNonStrictWithDetailsAllOfAverageTimeToWon.md) | | [optional] -**averageStageProgress** | **Number** | The average of the deal stage progression | [optional] +**average_time_to_won** | [**DealNonStrictWithDetailsAllOfAverageTimeToWon**](DealNonStrictWithDetailsAllOfAverageTimeToWon.md) | | [optional] +**average_stage_progress** | **Number** | The average of the deal stage progression | [optional] **age** | [**DealNonStrictWithDetailsAllOfAge**](DealNonStrictWithDetailsAllOfAge.md) | | [optional] -**stayInPipelineStages** | [**DealNonStrictWithDetailsAllOfStayInPipelineStages**](DealNonStrictWithDetailsAllOfStayInPipelineStages.md) | | [optional] -**lastActivity** | **Object** | The details of the last activity associated with the deal | [optional] -**nextActivity** | **Object** | The details of the next activity associated with the deal | [optional] +**stay_in_pipeline_stages** | [**DealNonStrictWithDetailsAllOfStayInPipelineStages**](DealNonStrictWithDetailsAllOfStayInPipelineStages.md) | | [optional] +**last_activity** | **Object** | The details of the last activity associated with the deal | [optional] +**next_activity** | **Object** | The details of the next activity associated with the deal | [optional] diff --git a/docs/DealNonStrictWithDetailsAllOfAge.md b/docs/DealNonStrictWithDetailsAllOfAge.md index 5ebbd1b2..edfa418a 100644 --- a/docs/DealNonStrictWithDetailsAllOfAge.md +++ b/docs/DealNonStrictWithDetailsAllOfAge.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **h** | **Number** | Hours | [optional] **i** | **Number** | Minutes | [optional] **s** | **Number** | Seconds | [optional] -**totalSeconds** | **Number** | The total time in seconds | [optional] +**total_seconds** | **Number** | The total time in seconds | [optional] diff --git a/docs/DealNonStrictWithDetailsAllOfAverageTimeToWon.md b/docs/DealNonStrictWithDetailsAllOfAverageTimeToWon.md index cde870da..8019bdf3 100644 --- a/docs/DealNonStrictWithDetailsAllOfAverageTimeToWon.md +++ b/docs/DealNonStrictWithDetailsAllOfAverageTimeToWon.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **h** | **Number** | Hours | [optional] **i** | **Number** | Minutes | [optional] **s** | **Number** | Seconds | [optional] -**totalSeconds** | **Number** | The total time in seconds | [optional] +**total_seconds** | **Number** | The total time in seconds | [optional] diff --git a/docs/DealNonStrictWithDetailsAllOfStayInPipelineStages.md b/docs/DealNonStrictWithDetailsAllOfStayInPipelineStages.md index c6c9cf84..d4548d7b 100644 --- a/docs/DealNonStrictWithDetailsAllOfStayInPipelineStages.md +++ b/docs/DealNonStrictWithDetailsAllOfStayInPipelineStages.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**timesInStages** | **Object** | The number of seconds a deal has been in each stage of the pipeline | [optional] -**orderOfStages** | **[Number]** | The order of the deal progression through the pipeline stages | [optional] +**times_in_stages** | **Object** | The number of seconds a deal has been in each stage of the pipeline | [optional] +**order_of_stages** | **[Number]** | The order of the deal progression through the pipeline stages | [optional] diff --git a/docs/DealOrganizationData.md b/docs/DealOrganizationData.md index 0dd41884..b9e51824 100644 --- a/docs/DealOrganizationData.md +++ b/docs/DealOrganizationData.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the organization associated with the deal | [optional] -**peopleCount** | **Number** | The number of people connected with the organization that is associated with the deal | [optional] -**ownerId** | **Number** | The ID of the owner of the organization that is associated with the deal | [optional] +**people_count** | **Number** | The number of people connected with the organization that is associated with the deal | [optional] +**owner_id** | **Number** | The ID of the owner of the organization that is associated with the deal | [optional] **address** | **String** | The address of the organization that is associated with the deal | [optional] -**activeFlag** | **Boolean** | Whether the associated organization is active or not | [optional] -**ccEmail** | **String** | The BCC email of the organization associated with the deal | [optional] +**active_flag** | **Boolean** | Whether the associated organization is active or not | [optional] +**cc_email** | **String** | The BCC email of the organization associated with the deal | [optional] diff --git a/docs/DealOrganizationDataWithId.md b/docs/DealOrganizationDataWithId.md index c133d1ac..2e22f690 100644 --- a/docs/DealOrganizationDataWithId.md +++ b/docs/DealOrganizationDataWithId.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the organization associated with the deal | [optional] -**peopleCount** | **Number** | The number of people connected with the organization that is associated with the deal | [optional] -**ownerId** | **Number** | The ID of the owner of the organization that is associated with the deal | [optional] +**people_count** | **Number** | The number of people connected with the organization that is associated with the deal | [optional] +**owner_id** | **Number** | The ID of the owner of the organization that is associated with the deal | [optional] **address** | **String** | The address of the organization that is associated with the deal | [optional] -**activeFlag** | **Boolean** | Whether the associated organization is active or not | [optional] -**ccEmail** | **String** | The BCC email of the organization associated with the deal | [optional] +**active_flag** | **Boolean** | Whether the associated organization is active or not | [optional] +**cc_email** | **String** | The BCC email of the organization associated with the deal | [optional] **value** | **Number** | The ID of the organization associated with the deal | [optional] diff --git a/docs/DealParticipantCountInfo.md b/docs/DealParticipantCountInfo.md index 9eaccee7..c8d49aa3 100644 --- a/docs/DealParticipantCountInfo.md +++ b/docs/DealParticipantCountInfo.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**participantOpenDealsCount** | **Number** | The count of open participant deals related with the item | [optional] -**participantClosedDealsCount** | **Number** | The count of closed participant deals related with the item | [optional] +**participant_open_deals_count** | **Number** | The count of open participant deals related with the item | [optional] +**participant_closed_deals_count** | **Number** | The count of closed participant deals related with the item | [optional] diff --git a/docs/DealParticipants.md b/docs/DealParticipants.md index de0e93aa..1359917a 100644 --- a/docs/DealParticipants.md +++ b/docs/DealParticipants.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the request was successful or not | [optional] **data** | [**[PersonItem]**](PersonItem.md) | The array of participants | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**GetDealsRelatedObjects**](GetDealsRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**GetDealsRelatedObjects**](GetDealsRelatedObjects.md) | | [optional] diff --git a/docs/DealParticipantsChangelog.md b/docs/DealParticipantsChangelog.md index b4795aef..8854def7 100644 --- a/docs/DealParticipantsChangelog.md +++ b/docs/DealParticipantsChangelog.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**actorUserId** | **Number** | The ID of the user | [optional] -**personId** | **Number** | The ID of the person | [optional] +**actor_user_id** | **Number** | The ID of the user | [optional] +**person_id** | **Number** | The ID of the person | [optional] **action** | **String** | Deal participant action type | [optional] **time** | **String** | The deal participant action log time | [optional] diff --git a/docs/DealPersonData.md b/docs/DealPersonData.md index 43fe57a1..9f3f8102 100644 --- a/docs/DealPersonData.md +++ b/docs/DealPersonData.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**activeFlag** | **Boolean** | Whether the associated person is active or not | [optional] +**active_flag** | **Boolean** | Whether the associated person is active or not | [optional] **name** | **String** | The name of the person associated with the deal | [optional] **email** | [**[DealPersonDataEmail]**](DealPersonDataEmail.md) | The emails of the person associated with the deal | [optional] **phone** | [**[DealPersonDataPhone]**](DealPersonDataPhone.md) | The phone numbers of the person associated with the deal | [optional] -**ownerId** | **Number** | The ID of the owner of the person that is associated with the deal | [optional] +**owner_id** | **Number** | The ID of the owner of the person that is associated with the deal | [optional] diff --git a/docs/DealPersonDataWithId.md b/docs/DealPersonDataWithId.md index 73bce98a..6a975b82 100644 --- a/docs/DealPersonDataWithId.md +++ b/docs/DealPersonDataWithId.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**activeFlag** | **Boolean** | Whether the associated person is active or not | [optional] +**active_flag** | **Boolean** | Whether the associated person is active or not | [optional] **name** | **String** | The name of the person associated with the deal | [optional] **email** | [**[DealPersonDataEmail]**](DealPersonDataEmail.md) | The emails of the person associated with the deal | [optional] **phone** | [**[DealPersonDataPhone]**](DealPersonDataPhone.md) | The phone numbers of the person associated with the deal | [optional] -**ownerId** | **Number** | The ID of the owner of the person that is associated with the deal | [optional] +**owner_id** | **Number** | The ID of the owner of the person that is associated with the deal | [optional] **value** | **Number** | The ID of the person associated with the deal | [optional] diff --git a/docs/DealProductRequestBody.md b/docs/DealProductRequestBody.md index 34d7f28d..6907833c 100644 --- a/docs/DealProductRequestBody.md +++ b/docs/DealProductRequestBody.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productId** | **Number** | The ID of the product to use | [optional] -**itemPrice** | **Number** | The price at which this product will be added to the deal | [optional] +**product_id** | **Number** | The ID of the product to use | [optional] +**item_price** | **Number** | The price at which this product will be added to the deal | [optional] **quantity** | **Number** | How many items of this product will be added to the deal | [optional] **discount** | **Number** | The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage | [optional] [default to 0] -**discountType** | **String** | The type of the discount's value | [optional] [default to 'percentage'] +**discount_type** | **String** | The type of the discount's value | [optional] [default to 'percentage'] **duration** | **Number** | The duration of the product | [optional] [default to 1] -**durationUnit** | [**DealProductUnitDuration**](DealProductUnitDuration.md) | The unit duration of the product | [optional] -**productVariationId** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] +**duration_unit** | [**DealProductUnitDuration**](DealProductUnitDuration.md) | The unit duration of the product | [optional] +**product_variation_id** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] **comments** | **String** | A textual comment associated with this product-deal attachment | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] -**taxMethod** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount | [optional] -**enabledFlag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] +**tax_method** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount | [optional] +**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] diff --git a/docs/DealSearchItem.md b/docs/DealSearchItem.md index 3a412495..4f55f0bf 100644 --- a/docs/DealSearchItem.md +++ b/docs/DealSearchItem.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultScore** | **Number** | Search result relevancy | [optional] +**result_score** | **Number** | Search result relevancy | [optional] **item** | [**DealSearchItemItem**](DealSearchItemItem.md) | | [optional] diff --git a/docs/DealSearchItemItem.md b/docs/DealSearchItemItem.md index 45495289..d467c407 100644 --- a/docs/DealSearchItemItem.md +++ b/docs/DealSearchItemItem.md @@ -10,12 +10,12 @@ Name | Type | Description | Notes **value** | **Number** | The value of the deal | [optional] **currency** | **String** | The currency of the deal | [optional] **status** | **String** | The status of the deal | [optional] -**visibleTo** | **Number** | The visibility of the deal | [optional] +**visible_to** | **Number** | The visibility of the deal | [optional] **owner** | [**DealSearchItemItemOwner**](DealSearchItemItemOwner.md) | | [optional] **stage** | [**DealSearchItemItemStage**](DealSearchItemItemStage.md) | | [optional] **person** | [**DealSearchItemItemPerson**](DealSearchItemItemPerson.md) | | [optional] **organization** | [**DealSearchItemItemOrganization**](DealSearchItemItemOrganization.md) | | [optional] -**customFields** | **[String]** | Custom fields | [optional] +**custom_fields** | **[String]** | Custom fields | [optional] **notes** | **[String]** | An array of notes | [optional] diff --git a/docs/DealSearchResponse.md b/docs/DealSearchResponse.md index 087882eb..32c69dfb 100644 --- a/docs/DealSearchResponse.md +++ b/docs/DealSearchResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**DealSearchResponseAllOfData**](DealSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/DealSearchResponseAllOf.md b/docs/DealSearchResponseAllOf.md index 8d9566e0..7f502fe1 100644 --- a/docs/DealSearchResponseAllOf.md +++ b/docs/DealSearchResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**DealSearchResponseAllOfData**](DealSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/DealStrict.md b/docs/DealStrict.md index 26508b7e..e356b3b0 100644 --- a/docs/DealStrict.md +++ b/docs/DealStrict.md @@ -5,65 +5,65 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the deal | [optional] -**creatorUserId** | **Number** | The ID of the deal creator | [optional] -**userId** | **Number** | The ID of the user | [optional] -**personId** | **Number** | The ID of the person associated with the deal | [optional] -**orgId** | **Number** | The ID of the organization associated with the deal | [optional] -**stageId** | **Number** | The ID of the deal stage | [optional] +**creator_user_id** | **Number** | The ID of the deal creator | [optional] +**user_id** | **Number** | The ID of the user | [optional] +**person_id** | **Number** | The ID of the person associated with the deal | [optional] +**org_id** | **Number** | The ID of the organization associated with the deal | [optional] +**stage_id** | **Number** | The ID of the deal stage | [optional] **title** | **String** | The title of the deal | [optional] **value** | **Number** | The value of the deal | [optional] **currency** | **String** | The currency associated with the deal | [optional] -**addTime** | **String** | The creation date and time of the deal | [optional] -**updateTime** | **String** | The last updated date and time of the deal | [optional] -**stageChangeTime** | **String** | The last updated date and time of the deal stage | [optional] +**add_time** | **String** | The creation date and time of the deal | [optional] +**update_time** | **String** | The last updated date and time of the deal | [optional] +**stage_change_time** | **String** | The last updated date and time of the deal stage | [optional] **active** | **Boolean** | Whether the deal is active or not | [optional] **deleted** | **Boolean** | Whether the deal is deleted or not | [optional] **status** | **String** | The status of the deal | [optional] **probability** | **Number** | The success probability percentage of the deal | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] -**lostReason** | **String** | The reason for losing the deal | [optional] -**visibleTo** | **String** | The visibility of the deal | [optional] -**closeTime** | **String** | The date and time of closing the deal | [optional] -**pipelineId** | **Number** | The ID of the pipeline associated with the deal | [optional] -**wonTime** | **String** | The date and time of changing the deal status as won | [optional] -**firstWonTime** | **String** | The date and time of the first time changing the deal status as won | [optional] -**lostTime** | **String** | The date and time of changing the deal status as lost | [optional] -**productsCount** | **Number** | The number of products associated with the deal | [optional] -**filesCount** | **Number** | The number of files associated with the deal | [optional] -**notesCount** | **Number** | The number of notes associated with the deal | [optional] -**followersCount** | **Number** | The number of followers associated with the deal | [optional] -**emailMessagesCount** | **Number** | The number of emails associated with the deal | [optional] -**activitiesCount** | **Number** | The number of activities associated with the deal | [optional] -**doneActivitiesCount** | **Number** | The number of completed activities associated with the deal | [optional] -**undoneActivitiesCount** | **Number** | The number of incomplete activities associated with the deal | [optional] -**participantsCount** | **Number** | The number of participants associated with the deal | [optional] -**expectedCloseDate** | **Date** | The expected close date of the deal | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the deal | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the deal | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] +**lost_reason** | **String** | The reason for losing the deal | [optional] +**visible_to** | **String** | The visibility of the deal | [optional] +**close_time** | **String** | The date and time of closing the deal | [optional] +**pipeline_id** | **Number** | The ID of the pipeline associated with the deal | [optional] +**won_time** | **String** | The date and time of changing the deal status as won | [optional] +**first_won_time** | **String** | The date and time of the first time changing the deal status as won | [optional] +**lost_time** | **String** | The date and time of changing the deal status as lost | [optional] +**products_count** | **Number** | The number of products associated with the deal | [optional] +**files_count** | **Number** | The number of files associated with the deal | [optional] +**notes_count** | **Number** | The number of notes associated with the deal | [optional] +**followers_count** | **Number** | The number of followers associated with the deal | [optional] +**email_messages_count** | **Number** | The number of emails associated with the deal | [optional] +**activities_count** | **Number** | The number of activities associated with the deal | [optional] +**done_activities_count** | **Number** | The number of completed activities associated with the deal | [optional] +**undone_activities_count** | **Number** | The number of incomplete activities associated with the deal | [optional] +**participants_count** | **Number** | The number of participants associated with the deal | [optional] +**expected_close_date** | **Date** | The expected close date of the deal | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the deal | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the deal | [optional] **label** | **String** | The label or multiple labels assigned to the deal | [optional] -**stageOrderNr** | **Number** | The order number of the deal stage associated with the deal | [optional] -**personName** | **String** | The name of the person associated with the deal | [optional] -**orgName** | **String** | The name of the organization associated with the deal | [optional] -**nextActivitySubject** | **String** | The subject of the next activity associated with the deal | [optional] -**nextActivityType** | **String** | The type of the next activity associated with the deal | [optional] -**nextActivityDuration** | **String** | The duration of the next activity associated with the deal | [optional] -**nextActivityNote** | **String** | The note of the next activity associated with the deal | [optional] -**formattedValue** | **String** | The deal value formatted with selected currency. E.g. US$500 | [optional] -**weightedValue** | **Number** | Probability times deal value. Probability can either be deal probability or if not set, then stage probability. | [optional] -**formattedWeightedValue** | **String** | The weighted_value formatted with selected currency. E.g. US$500 | [optional] -**weightedValueCurrency** | **String** | The currency associated with the deal | [optional] -**rottenTime** | **String** | The date and time of changing the deal status as rotten | [optional] -**ownerName** | **String** | The name of the deal owner | [optional] -**ccEmail** | **String** | The BCC email of the deal | [optional] -**orgHidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] -**personHidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] +**stage_order_nr** | **Number** | The order number of the deal stage associated with the deal | [optional] +**person_name** | **String** | The name of the person associated with the deal | [optional] +**org_name** | **String** | The name of the organization associated with the deal | [optional] +**next_activity_subject** | **String** | The subject of the next activity associated with the deal | [optional] +**next_activity_type** | **String** | The type of the next activity associated with the deal | [optional] +**next_activity_duration** | **String** | The duration of the next activity associated with the deal | [optional] +**next_activity_note** | **String** | The note of the next activity associated with the deal | [optional] +**formatted_value** | **String** | The deal value formatted with selected currency. E.g. US$500 | [optional] +**weighted_value** | **Number** | Probability times deal value. Probability can either be deal probability or if not set, then stage probability. | [optional] +**formatted_weighted_value** | **String** | The weighted_value formatted with selected currency. E.g. US$500 | [optional] +**weighted_value_currency** | **String** | The currency associated with the deal | [optional] +**rotten_time** | **String** | The date and time of changing the deal status as rotten | [optional] +**owner_name** | **String** | The name of the deal owner | [optional] +**cc_email** | **String** | The BCC email of the deal | [optional] +**org_hidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] +**person_hidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] **origin** | **String** | The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. | [optional] -**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] +**origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] diff --git a/docs/DealStrictModeFields.md b/docs/DealStrictModeFields.md index 8815713f..2fcee167 100644 --- a/docs/DealStrictModeFields.md +++ b/docs/DealStrictModeFields.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the deal | [optional] -**creatorUserId** | **Number** | The ID of the deal creator | [optional] -**userId** | **Number** | The ID of the user | [optional] -**personId** | **Number** | The ID of the person associated with the deal | [optional] -**orgId** | **Number** | The ID of the organization associated with the deal | [optional] +**creator_user_id** | **Number** | The ID of the deal creator | [optional] +**user_id** | **Number** | The ID of the user | [optional] +**person_id** | **Number** | The ID of the person associated with the deal | [optional] +**org_id** | **Number** | The ID of the organization associated with the deal | [optional] diff --git a/docs/DealStrictWithMergeId.md b/docs/DealStrictWithMergeId.md index 76526172..f006c86c 100644 --- a/docs/DealStrictWithMergeId.md +++ b/docs/DealStrictWithMergeId.md @@ -5,66 +5,66 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the deal | [optional] -**creatorUserId** | **Number** | The ID of the deal creator | [optional] -**userId** | **Number** | The ID of the user | [optional] -**personId** | **Number** | The ID of the person associated with the deal | [optional] -**orgId** | **Number** | The ID of the organization associated with the deal | [optional] -**stageId** | **Number** | The ID of the deal stage | [optional] +**creator_user_id** | **Number** | The ID of the deal creator | [optional] +**user_id** | **Number** | The ID of the user | [optional] +**person_id** | **Number** | The ID of the person associated with the deal | [optional] +**org_id** | **Number** | The ID of the organization associated with the deal | [optional] +**stage_id** | **Number** | The ID of the deal stage | [optional] **title** | **String** | The title of the deal | [optional] **value** | **Number** | The value of the deal | [optional] **currency** | **String** | The currency associated with the deal | [optional] -**addTime** | **String** | The creation date and time of the deal | [optional] -**updateTime** | **String** | The last updated date and time of the deal | [optional] -**stageChangeTime** | **String** | The last updated date and time of the deal stage | [optional] +**add_time** | **String** | The creation date and time of the deal | [optional] +**update_time** | **String** | The last updated date and time of the deal | [optional] +**stage_change_time** | **String** | The last updated date and time of the deal stage | [optional] **active** | **Boolean** | Whether the deal is active or not | [optional] **deleted** | **Boolean** | Whether the deal is deleted or not | [optional] **status** | **String** | The status of the deal | [optional] **probability** | **Number** | The success probability percentage of the deal | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] -**lostReason** | **String** | The reason for losing the deal | [optional] -**visibleTo** | **String** | The visibility of the deal | [optional] -**closeTime** | **String** | The date and time of closing the deal | [optional] -**pipelineId** | **Number** | The ID of the pipeline associated with the deal | [optional] -**wonTime** | **String** | The date and time of changing the deal status as won | [optional] -**firstWonTime** | **String** | The date and time of the first time changing the deal status as won | [optional] -**lostTime** | **String** | The date and time of changing the deal status as lost | [optional] -**productsCount** | **Number** | The number of products associated with the deal | [optional] -**filesCount** | **Number** | The number of files associated with the deal | [optional] -**notesCount** | **Number** | The number of notes associated with the deal | [optional] -**followersCount** | **Number** | The number of followers associated with the deal | [optional] -**emailMessagesCount** | **Number** | The number of emails associated with the deal | [optional] -**activitiesCount** | **Number** | The number of activities associated with the deal | [optional] -**doneActivitiesCount** | **Number** | The number of completed activities associated with the deal | [optional] -**undoneActivitiesCount** | **Number** | The number of incomplete activities associated with the deal | [optional] -**participantsCount** | **Number** | The number of participants associated with the deal | [optional] -**expectedCloseDate** | **Date** | The expected close date of the deal | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the deal | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the deal | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] +**lost_reason** | **String** | The reason for losing the deal | [optional] +**visible_to** | **String** | The visibility of the deal | [optional] +**close_time** | **String** | The date and time of closing the deal | [optional] +**pipeline_id** | **Number** | The ID of the pipeline associated with the deal | [optional] +**won_time** | **String** | The date and time of changing the deal status as won | [optional] +**first_won_time** | **String** | The date and time of the first time changing the deal status as won | [optional] +**lost_time** | **String** | The date and time of changing the deal status as lost | [optional] +**products_count** | **Number** | The number of products associated with the deal | [optional] +**files_count** | **Number** | The number of files associated with the deal | [optional] +**notes_count** | **Number** | The number of notes associated with the deal | [optional] +**followers_count** | **Number** | The number of followers associated with the deal | [optional] +**email_messages_count** | **Number** | The number of emails associated with the deal | [optional] +**activities_count** | **Number** | The number of activities associated with the deal | [optional] +**done_activities_count** | **Number** | The number of completed activities associated with the deal | [optional] +**undone_activities_count** | **Number** | The number of incomplete activities associated with the deal | [optional] +**participants_count** | **Number** | The number of participants associated with the deal | [optional] +**expected_close_date** | **Date** | The expected close date of the deal | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the deal | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the deal | [optional] **label** | **String** | The label or multiple labels assigned to the deal | [optional] -**stageOrderNr** | **Number** | The order number of the deal stage associated with the deal | [optional] -**personName** | **String** | The name of the person associated with the deal | [optional] -**orgName** | **String** | The name of the organization associated with the deal | [optional] -**nextActivitySubject** | **String** | The subject of the next activity associated with the deal | [optional] -**nextActivityType** | **String** | The type of the next activity associated with the deal | [optional] -**nextActivityDuration** | **String** | The duration of the next activity associated with the deal | [optional] -**nextActivityNote** | **String** | The note of the next activity associated with the deal | [optional] -**formattedValue** | **String** | The deal value formatted with selected currency. E.g. US$500 | [optional] -**weightedValue** | **Number** | Probability times deal value. Probability can either be deal probability or if not set, then stage probability. | [optional] -**formattedWeightedValue** | **String** | The weighted_value formatted with selected currency. E.g. US$500 | [optional] -**weightedValueCurrency** | **String** | The currency associated with the deal | [optional] -**rottenTime** | **String** | The date and time of changing the deal status as rotten | [optional] -**ownerName** | **String** | The name of the deal owner | [optional] -**ccEmail** | **String** | The BCC email of the deal | [optional] -**orgHidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] -**personHidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] +**stage_order_nr** | **Number** | The order number of the deal stage associated with the deal | [optional] +**person_name** | **String** | The name of the person associated with the deal | [optional] +**org_name** | **String** | The name of the organization associated with the deal | [optional] +**next_activity_subject** | **String** | The subject of the next activity associated with the deal | [optional] +**next_activity_type** | **String** | The type of the next activity associated with the deal | [optional] +**next_activity_duration** | **String** | The duration of the next activity associated with the deal | [optional] +**next_activity_note** | **String** | The note of the next activity associated with the deal | [optional] +**formatted_value** | **String** | The deal value formatted with selected currency. E.g. US$500 | [optional] +**weighted_value** | **Number** | Probability times deal value. Probability can either be deal probability or if not set, then stage probability. | [optional] +**formatted_weighted_value** | **String** | The weighted_value formatted with selected currency. E.g. US$500 | [optional] +**weighted_value_currency** | **String** | The currency associated with the deal | [optional] +**rotten_time** | **String** | The date and time of changing the deal status as rotten | [optional] +**owner_name** | **String** | The name of the deal owner | [optional] +**cc_email** | **String** | The BCC email of the deal | [optional] +**org_hidden** | **Boolean** | If the organization that is associated with the deal is hidden or not | [optional] +**person_hidden** | **Boolean** | If the person that is associated with the deal is hidden or not | [optional] **origin** | **String** | The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. | [optional] -**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] +**origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] -**mergeWhatId** | **Number** | The deal ID of the deal which the original deal was merged with | [optional] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**merge_what_id** | **Number** | The deal ID of the deal which the original deal was merged with | [optional] diff --git a/docs/DealStrictWithMergeIdAllOf.md b/docs/DealStrictWithMergeIdAllOf.md index 2b2c1269..41a56021 100644 --- a/docs/DealStrictWithMergeIdAllOf.md +++ b/docs/DealStrictWithMergeIdAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mergeWhatId** | **Number** | The deal ID of the deal which the original deal was merged with | [optional] +**merge_what_id** | **Number** | The deal ID of the deal which the original deal was merged with | [optional] diff --git a/docs/DealSummary.md b/docs/DealSummary.md index 5600b149..373978bc 100644 --- a/docs/DealSummary.md +++ b/docs/DealSummary.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**perStages** | [**DealSummaryPerStages**](DealSummaryPerStages.md) | | [optional] -**perCurrency** | [**DealSummaryPerCurrency**](DealSummaryPerCurrency.md) | | [optional] -**totalCount** | **Number** | Deals count | [optional] -**perCurrencyFull** | [**DealSummaryPerCurrencyFull**](DealSummaryPerCurrencyFull.md) | | [optional] +**per_stages** | [**DealSummaryPerStages**](DealSummaryPerStages.md) | | [optional] +**per_currency** | [**DealSummaryPerCurrency**](DealSummaryPerCurrency.md) | | [optional] +**total_count** | **Number** | Deals count | [optional] +**per_currency_full** | [**DealSummaryPerCurrencyFull**](DealSummaryPerCurrencyFull.md) | | [optional] diff --git a/docs/DealSummaryPerStagesSTAGEIDCURRENCYID.md b/docs/DealSummaryPerStagesSTAGEIDCURRENCYID.md index ddb43d61..40915107 100644 --- a/docs/DealSummaryPerStagesSTAGEIDCURRENCYID.md +++ b/docs/DealSummaryPerStagesSTAGEIDCURRENCYID.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **Number** | Deals count per currency | [optional] **value** | **Number** | Deals value per currency | [optional] -**valueFormatted** | **String** | Deals value formatted per currency | [optional] -**weightedValue** | **Number** | Deals weighted value per currency | [optional] -**weightedValueFormatted** | **String** | Deals weighted value formatted per currency | [optional] +**value_formatted** | **String** | Deals value formatted per currency | [optional] +**weighted_value** | **Number** | Deals weighted value per currency | [optional] +**weighted_value_formatted** | **String** | Deals weighted value formatted per currency | [optional] diff --git a/docs/DealUserData.md b/docs/DealUserData.md index 89b1e574..221f6197 100644 --- a/docs/DealUserData.md +++ b/docs/DealUserData.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **Number** | The ID of the user | [optional] **name** | **String** | The name of the user | [optional] **email** | **String** | The email of the user | [optional] -**hasPic** | **Boolean** | If the user has a picture or not | [optional] -**picHash** | **String** | The user picture hash | [optional] -**activeFlag** | **Boolean** | Whether the user is active or not | [optional] +**has_pic** | **Boolean** | If the user has a picture or not | [optional] +**pic_hash** | **String** | The user picture hash | [optional] +**active_flag** | **Boolean** | Whether the user is active or not | [optional] diff --git a/docs/DealUserDataWithId.md b/docs/DealUserDataWithId.md index a49620f9..96c53716 100644 --- a/docs/DealUserDataWithId.md +++ b/docs/DealUserDataWithId.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **id** | **Number** | The ID of the user | [optional] **name** | **String** | The name of the user | [optional] **email** | **String** | The email of the user | [optional] -**hasPic** | **Boolean** | If the user has a picture or not | [optional] -**picHash** | **String** | The user picture hash | [optional] -**activeFlag** | **Boolean** | Whether the user is active or not | [optional] +**has_pic** | **Boolean** | If the user has a picture or not | [optional] +**pic_hash** | **String** | The user picture hash | [optional] +**active_flag** | **Boolean** | Whether the user is active or not | [optional] **value** | **Number** | The ID of the user | [optional] diff --git a/docs/DealsApi.md b/docs/DealsApi.md index 8479eb83..c22cc289 100644 --- a/docs/DealsApi.md +++ b/docs/DealsApi.md @@ -76,7 +76,7 @@ apiInstance.addDeal(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **newDeal** | [**NewDeal**](NewDeal.md)| | [optional] + **NewDeal** | [**NewDeal**](NewDeal.md)| | [optional] ### Return type @@ -133,7 +133,7 @@ apiInstance.addDealFollower(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the deal | - **addDealFollowerRequest** | [**AddDealFollowerRequest**](AddDealFollowerRequest.md)| | [optional] + **AddDealFollowerRequest** | [**AddDealFollowerRequest**](AddDealFollowerRequest.md)| | [optional] ### Return type @@ -190,7 +190,7 @@ apiInstance.addDealParticipant(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the deal | - **addDealParticipantRequest** | [**AddDealParticipantRequest**](AddDealParticipantRequest.md)| | [optional] + **AddDealParticipantRequest** | [**AddDealParticipantRequest**](AddDealParticipantRequest.md)| | [optional] ### Return type @@ -247,7 +247,7 @@ apiInstance.addDealProduct(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the deal | - **newDealProduct** | [**NewDealProduct**](NewDealProduct.md)| | [optional] + **NewDealProduct** | [**NewDealProduct**](NewDealProduct.md)| | [optional] ### Return type @@ -355,7 +355,7 @@ apiInstance.deleteDealFollower(id, followerId).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the deal | - **followerId** | **Number**| The ID of the follower | + **follower_id** | **Number**| The ID of the follower | ### Return type @@ -410,7 +410,7 @@ apiInstance.deleteDealParticipant(id, dealParticipantId).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the deal | - **dealParticipantId** | **Number**| The ID of the participant of the deal | + **deal_participant_id** | **Number**| The ID of the participant of the deal | ### Return type @@ -465,7 +465,7 @@ apiInstance.deleteDealProduct(id, productAttachmentId).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the deal | - **productAttachmentId** | **Number**| The product attachment ID | + **product_attachment_id** | **Number**| The product attachment ID | ### Return type @@ -664,6 +664,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); let id = 56; // Number | The ID of the deal +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -727,6 +728,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); let id = 56; // Number | The ID of the deal +// snake_case as well as camelCase is supported for naming opts properties 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 @@ -786,6 +788,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); let id = 56; // Number | The ID of the deal +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -900,6 +903,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); let id = 56; // Number | The ID of the deal +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -959,6 +963,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); let id = 56; // Number | The ID of the deal +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -1018,6 +1023,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); let id = 56; // Number | The ID of the deal +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'limit': 56, // Number | Items shown per page 'cursor': "cursor_example" // String | For pagination, the marker (an opaque string value) representing the first item on the next page @@ -1077,6 +1083,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); let id = 56; // Number | The ID of the deal +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -1136,6 +1143,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); let id = 56; // Number | The ID of the deal +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -1157,7 +1165,7 @@ Name | Type | Description | Notes **id** | **Number**| The ID of the deal | **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] - **includeProductData** | [**NumberBoolean**](.md)| Whether to fetch product data along with each attached product (1) or not (0, default) | [optional] + **include_product_data** | [**NumberBoolean**](.md)| Whether to fetch product data along with each attached product (1) or not (0, default) | [optional] ### Return type @@ -1197,6 +1205,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); let id = 56; // Number | The ID of the deal +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -1219,7 +1228,7 @@ Name | Type | Description | Notes **id** | **Number**| The ID of the deal | **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] - **allChanges** | **String**| Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates. | [optional] + **all_changes** | **String**| Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates. | [optional] **items** | **String**| A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change). | [optional] ### Return type @@ -1312,6 +1321,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'userId': 56, // Number | If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied. 'filterId': 56, // Number | The ID of the filter to use @@ -1335,14 +1345,14 @@ apiInstance.getDeals(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Number**| If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied. | [optional] - **filterId** | **Number**| The ID of the filter to use | [optional] - **stageId** | **Number**| If supplied, only deals within the given stage will be returned | [optional] + **user_id** | **Number**| If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied. | [optional] + **filter_id** | **Number**| The ID of the filter to use | [optional] + **stage_id** | **Number**| If supplied, only deals within the given stage will be returned | [optional] **status** | **String**| Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. | [optional] [default to 'all_not_deleted'] **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] **sort** | **String**| 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). | [optional] - **ownedByYou** | [**NumberBoolean**](.md)| When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied. | [optional] + **owned_by_you** | [**NumberBoolean**](.md)| When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied. | [optional] ### Return type @@ -1381,6 +1391,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page 'limit': 100, // Number | 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. @@ -1407,8 +1418,8 @@ Name | Type | Description | Notes **limit** | **Number**| 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. | [optional] **since** | **String**| 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. | [optional] **until** | **String**| 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. | [optional] - **userId** | **Number**| If supplied, only deals matching the given user will be returned | [optional] - **stageId** | **Number**| If supplied, only deals within the given stage will be returned | [optional] + **user_id** | **Number**| If supplied, only deals matching the given user will be returned | [optional] + **stage_id** | **Number**| If supplied, only deals within the given stage will be returned | [optional] **status** | **String**| Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. | [optional] ### Return type @@ -1448,6 +1459,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'status': "status_example", // String | Only fetch deals with a specific status. open = Open, won = Won, lost = Lost. 'filterId': 56, // Number | user_id will not be considered. Only deals matching the given filter will be returned. @@ -1468,9 +1480,9 @@ apiInstance.getDealsSummary(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | **String**| Only fetch deals with a specific status. open = Open, won = Won, lost = Lost. | [optional] - **filterId** | **Number**| <code>user_id</code> will not be considered. Only deals matching the given filter will be returned. | [optional] - **userId** | **Number**| Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`. | [optional] - **stageId** | **Number**| Only deals within the given stage will be returned | [optional] + **filter_id** | **Number**| <code>user_id</code> will not be considered. Only deals matching the given filter will be returned. | [optional] + **user_id** | **Number**| Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`. | [optional] + **stage_id** | **Number**| Only deals within the given stage will be returned | [optional] ### Return type @@ -1513,6 +1525,7 @@ let startDate = new Date("2013-10-20"); // Date | The date when the first interv let interval = "interval_example"; // String | The type of the interval
ValueDescription
`day`Day
`week`A full week (7 days) starting from `start_date`
`month`A full month (depending on the number of days in given month) starting from `start_date`
`quarter`A full quarter (3 months) starting from `start_date`
let amount = 56; // Number | The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months). let fieldKey = "fieldKey_example"; // String | The date field key which deals will be retrieved from +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'userId': 56, // Number | If supplied, only deals matching the given user will be returned 'pipelineId': 56, // Number | If supplied, only deals matching the given pipeline will be returned @@ -1533,15 +1546,15 @@ apiInstance.getDealsTimeline(startDate, interval, amount, fieldKey, opts).then(( Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **startDate** | **Date**| The date when the first interval starts. Format: YYYY-MM-DD. | + **start_date** | **Date**| The date when the first interval starts. Format: YYYY-MM-DD. | **interval** | **String**| The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table> | **amount** | **Number**| The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months). | - **fieldKey** | **String**| The date field key which deals will be retrieved from | - **userId** | **Number**| If supplied, only deals matching the given user will be returned | [optional] - **pipelineId** | **Number**| If supplied, only deals matching the given pipeline will be returned | [optional] - **filterId** | **Number**| If supplied, only deals matching the given filter will be returned | [optional] - **excludeDeals** | [**NumberBoolean**](.md)| Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned. | [optional] - **totalsConvertCurrency** | **String**| The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user's default currency is used. | [optional] + **field_key** | **String**| The date field key which deals will be retrieved from | + **user_id** | **Number**| If supplied, only deals matching the given user will be returned | [optional] + **pipeline_id** | **Number**| If supplied, only deals matching the given pipeline will be returned | [optional] + **filter_id** | **Number**| If supplied, only deals matching the given filter will be returned | [optional] + **exclude_deals** | [**NumberBoolean**](.md)| Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned. | [optional] + **totals_convert_currency** | **String**| The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user's default currency is used. | [optional] ### Return type @@ -1598,7 +1611,7 @@ apiInstance.mergeDeals(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the deal | - **mergeDealsRequest** | [**MergeDealsRequest**](MergeDealsRequest.md)| | [optional] + **MergeDealsRequest** | [**MergeDealsRequest**](MergeDealsRequest.md)| | [optional] ### Return type @@ -1638,6 +1651,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.DealsApi(apiClient); let term = "term_example"; // String | The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'fields': "fields_example", // String | A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields here. 'exactMatch': true, // Boolean | When enabled, only full exact matches against the given term are returned. It is not case sensitive. @@ -1663,11 +1677,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. | **fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. | [optional] - **exactMatch** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] - **personId** | **Number**| Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000. | [optional] - **organizationId** | **Number**| Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000. | [optional] + **exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] + **person_id** | **Number**| Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000. | [optional] + **organization_id** | **Number**| Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000. | [optional] **status** | **String**| Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000. | [optional] - **includeFields** | **String**| Supports including optional fields in the results which are not provided by default | [optional] + **include_fields** | **String**| Supports including optional fields in the results which are not provided by default | [optional] **start** | **Number**| Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] @@ -1726,7 +1740,7 @@ apiInstance.updateDeal(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the deal | - **updateDealRequest** | [**UpdateDealRequest**](UpdateDealRequest.md)| | [optional] + **UpdateDealRequest** | [**UpdateDealRequest**](UpdateDealRequest.md)| | [optional] ### Return type @@ -1784,8 +1798,8 @@ apiInstance.updateDealProduct(id, productAttachmentId, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the deal | - **productAttachmentId** | **Number**| The ID of the deal-product (the ID of the product attached to the deal) | - **updateDealProduct** | [**UpdateDealProduct**](UpdateDealProduct.md)| | [optional] + **product_attachment_id** | **Number**| The ID of the deal-product (the ID of the product attached to the deal) | + **UpdateDealProduct** | [**UpdateDealProduct**](UpdateDealProduct.md)| | [optional] ### Return type diff --git a/docs/DealsCountAndActivityInfo.md b/docs/DealsCountAndActivityInfo.md index acac42c6..5249f56c 100644 --- a/docs/DealsCountAndActivityInfo.md +++ b/docs/DealsCountAndActivityInfo.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] diff --git a/docs/DealsCountInfo.md b/docs/DealsCountInfo.md index 8690b8b7..c5505751 100644 --- a/docs/DealsCountInfo.md +++ b/docs/DealsCountInfo.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] diff --git a/docs/DealsMovementsInfo.md b/docs/DealsMovementsInfo.md index 73a8cb50..a16c585c 100644 --- a/docs/DealsMovementsInfo.md +++ b/docs/DealsMovementsInfo.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **Number** | The count of the deals | [optional] -**dealsIds** | **[Number]** | The IDs of the deals that have been moved | [optional] +**deals_ids** | **[Number]** | The IDs of the deals that have been moved | [optional] **values** | [**DealsMovementsInfoValues**](DealsMovementsInfoValues.md) | | [optional] -**formattedValues** | [**DealsMovementsInfoFormattedValues**](DealsMovementsInfoFormattedValues.md) | | [optional] +**formatted_values** | [**DealsMovementsInfoFormattedValues**](DealsMovementsInfoFormattedValues.md) | | [optional] diff --git a/docs/DeleteProjectResponse200.md b/docs/DeleteProjectResponse200.md index a36d53f5..38a67031 100644 --- a/docs/DeleteProjectResponse200.md +++ b/docs/DeleteProjectResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**DeleteProject**](DeleteProject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/DeleteRoleAssignmentRequest.md b/docs/DeleteRoleAssignmentRequest.md index efe7cd39..1e6c753d 100644 --- a/docs/DeleteRoleAssignmentRequest.md +++ b/docs/DeleteRoleAssignmentRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user | +**user_id** | **Number** | The ID of the user | diff --git a/docs/DeleteTaskResponse200.md b/docs/DeleteTaskResponse200.md index a8c47e60..20394e45 100644 --- a/docs/DeleteTaskResponse200.md +++ b/docs/DeleteTaskResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**DeleteTask**](DeleteTask.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/EmailInfo.md b/docs/EmailInfo.md index 9b7c50a9..6fb4fe50 100644 --- a/docs/EmailInfo.md +++ b/docs/EmailInfo.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the person | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the person | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the person | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the person | [optional] diff --git a/docs/ExpectedOutcome.md b/docs/ExpectedOutcome.md index 23c5019d..20360c6f 100644 --- a/docs/ExpectedOutcome.md +++ b/docs/ExpectedOutcome.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **target** | **Number** | The numeric target of the goal | [optional] -**trackingMetric** | **String** | The tracking metric of the goal | [optional] +**tracking_metric** | **String** | The tracking metric of the goal | [optional] diff --git a/docs/Field.md b/docs/Field.md index 71c8802f..e2962a79 100644 --- a/docs/Field.md +++ b/docs/Field.md @@ -7,26 +7,26 @@ Name | Type | Description | Notes **id** | **Number** | The ID of the field. Value is `null` in case of subfields. | [optional] **key** | **String** | The key of the field. For custom fields this is generated upon creation. | [optional] **name** | **String** | The name of the field | [optional] -**orderNr** | **Number** | The order number of the field | [optional] -**fieldType** | [**FieldTypeAsString**](FieldTypeAsString.md) | | [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] -**createdByUserId** | **Number** | The ID of the user who created the field | [optional] -**activeFlag** | **Boolean** | The active flag of the field | [optional] -**editFlag** | **Boolean** | The edit flag of the field | [optional] -**indexVisibleFlag** | **Boolean** | Not used | [optional] -**detailsVisibleFlag** | **Boolean** | Not used | [optional] -**addVisibleFlag** | **Boolean** | Not used | [optional] -**importantFlag** | **Boolean** | Not used | [optional] -**bulkEditAllowed** | **Boolean** | Whether or not the field of an item can be edited in bulk | [optional] -**searchableFlag** | **Boolean** | Whether or not items can be searched by this field | [optional] -**filteringAllowed** | **Boolean** | Whether or not items can be filtered by this field | [optional] -**sortableFlag** | **Boolean** | Whether or not items can be sorted by this field | [optional] -**mandatoryFlag** | **Boolean** | Whether or not the field is mandatory | [optional] +**order_nr** | **Number** | The order number of the field | [optional] +**field_type** | [**FieldTypeAsString**](FieldTypeAsString.md) | | [optional] +**add_time** | **Date** | The creation time of the field | [optional] +**update_time** | **Date** | The update time of the field | [optional] +**last_updated_by_user_id** | **Number** | The ID of the user who created or most recently updated the field, only applicable for custom fields | [optional] +**created_by_user_id** | **Number** | The ID of the user who created the field | [optional] +**active_flag** | **Boolean** | The active flag of the field | [optional] +**edit_flag** | **Boolean** | The edit flag of the field | [optional] +**index_visible_flag** | **Boolean** | Not used | [optional] +**details_visible_flag** | **Boolean** | Not used | [optional] +**add_visible_flag** | **Boolean** | Not used | [optional] +**important_flag** | **Boolean** | Not used | [optional] +**bulk_edit_allowed** | **Boolean** | Whether or not the field of an item can be edited in bulk | [optional] +**searchable_flag** | **Boolean** | Whether or not items can be searched by this field | [optional] +**filtering_allowed** | **Boolean** | Whether or not items can be filtered by this field | [optional] +**sortable_flag** | **Boolean** | Whether or not items can be sorted by this field | [optional] +**mandatory_flag** | **Boolean** | Whether or not the field is mandatory | [optional] **options** | **[Object]** | The options of the field. When there are no options, `null` is returned. | [optional] -**optionsDeleted** | **[Object]** | The deleted options of the field. Only present when there is at least 1 deleted option. | [optional] -**isSubfield** | **Boolean** | Whether or not the field is a subfield of another field. Only present if field is subfield. | [optional] +**options_deleted** | **[Object]** | The deleted options of the field. Only present when there is at least 1 deleted option. | [optional] +**is_subfield** | **Boolean** | Whether or not the field is a subfield of another field. Only present if field is subfield. | [optional] **subfields** | **[Object]** | The subfields of the field. Only present when the field has subfields. | [optional] diff --git a/docs/FieldCreateRequest.md b/docs/FieldCreateRequest.md index d910a461..cab9e36c 100644 --- a/docs/FieldCreateRequest.md +++ b/docs/FieldCreateRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the field | **options** | **[Object]** | When `field_type` is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. Example: `[{\"label\":\"New Item\"}]` | [optional] -**addVisibleFlag** | **Boolean** | Whether the field is available in the 'add new' modal or not (both in the web and mobile app) | [optional] [default to true] -**fieldType** | [**FieldTypeAsString**](FieldTypeAsString.md) | | +**add_visible_flag** | **Boolean** | Whether the field is available in the 'add new' modal or not (both in the web and mobile app) | [optional] [default to true] +**field_type** | [**FieldTypeAsString**](FieldTypeAsString.md) | | diff --git a/docs/FieldCreateRequestAllOf.md b/docs/FieldCreateRequestAllOf.md index 718a8c83..5346e301 100644 --- a/docs/FieldCreateRequestAllOf.md +++ b/docs/FieldCreateRequestAllOf.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the field | **options** | **[Object]** | When `field_type` is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. Example: `[{\"label\":\"New Item\"}]` | [optional] -**addVisibleFlag** | **Boolean** | Whether the field is available in the 'add new' modal or not (both in the web and mobile app) | [optional] [default to true] +**add_visible_flag** | **Boolean** | Whether the field is available in the 'add new' modal or not (both in the web and mobile app) | [optional] [default to true] diff --git a/docs/FieldType.md b/docs/FieldType.md index 9bafec75..6d4d9a8d 100644 --- a/docs/FieldType.md +++ b/docs/FieldType.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**fieldType** | [**FieldTypeAsString**](FieldTypeAsString.md) | | +**field_type** | [**FieldTypeAsString**](FieldTypeAsString.md) | | diff --git a/docs/FieldUpdateRequest.md b/docs/FieldUpdateRequest.md index 4aefa25f..df814920 100644 --- a/docs/FieldUpdateRequest.md +++ b/docs/FieldUpdateRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the field | [optional] **options** | **[Object]** | When `field_type` is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: `[{\"id\":123,\"label\":\"Existing Item\"},{\"label\":\"New Item\"}]` | [optional] -**addVisibleFlag** | **Boolean** | Whether the field is available in 'add new' modal or not (both in web and mobile app) | [optional] [default to true] +**add_visible_flag** | **Boolean** | Whether the field is available in 'add new' modal or not (both in web and mobile app) | [optional] [default to true] diff --git a/docs/FieldsResponse.md b/docs/FieldsResponse.md index 1eaeb6c8..69595d1a 100644 --- a/docs/FieldsResponse.md +++ b/docs/FieldsResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[Field]**](Field.md) | | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/FieldsResponseAllOf.md b/docs/FieldsResponseAllOf.md index adcc32c6..9b2619a6 100644 --- a/docs/FieldsResponseAllOf.md +++ b/docs/FieldsResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[Field]**](Field.md) | | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/FileData.md b/docs/FileData.md index e9be04b0..a793e993 100644 --- a/docs/FileData.md +++ b/docs/FileData.md @@ -5,30 +5,30 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the file | [optional] -**userId** | **Number** | The ID of the user to associate the file with | [optional] -**dealId** | **Number** | The ID of the deal to associate the file with | [optional] -**personId** | **Number** | The ID of the person to associate the file with | [optional] -**orgId** | **Number** | The ID of the organization to associate the file with | [optional] -**productId** | **Number** | The ID of the product to associate the file with | [optional] -**activityId** | **Number** | The ID of the activity to associate the file with | [optional] -**leadId** | **String** | The ID of the lead to associate the file with | [optional] -**addTime** | **String** | The date and time when the file was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] -**updateTime** | **String** | The last updated date and time of the file. Format: YYYY-MM-DD HH:MM:SS | [optional] -**fileName** | **String** | The original name of the file | [optional] -**fileSize** | **Number** | The size of the file | [optional] -**activeFlag** | **Boolean** | Whether the user is active or not. false = Not activated, true = Activated | [optional] -**inlineFlag** | **Boolean** | Whether the file was uploaded as inline or not | [optional] -**remoteLocation** | **String** | The location type to send the file to. Only googledrive is supported at the moment. | [optional] -**remoteId** | **String** | The ID of the remote item | [optional] +**user_id** | **Number** | The ID of the user to associate the file with | [optional] +**deal_id** | **Number** | The ID of the deal to associate the file with | [optional] +**person_id** | **Number** | The ID of the person to associate the file with | [optional] +**org_id** | **Number** | The ID of the organization to associate the file with | [optional] +**product_id** | **Number** | The ID of the product to associate the file with | [optional] +**activity_id** | **Number** | The ID of the activity to associate the file with | [optional] +**lead_id** | **String** | The ID of the lead to associate the file with | [optional] +**add_time** | **String** | The date and time when the file was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] +**update_time** | **String** | The last updated date and time of the file. Format: YYYY-MM-DD HH:MM:SS | [optional] +**file_name** | **String** | The original name of the file | [optional] +**file_size** | **Number** | The size of the file | [optional] +**active_flag** | **Boolean** | Whether the user is active or not. false = Not activated, true = Activated | [optional] +**inline_flag** | **Boolean** | Whether the file was uploaded as inline or not | [optional] +**remote_location** | **String** | The location type to send the file to. Only googledrive is supported at the moment. | [optional] +**remote_id** | **String** | The ID of the remote item | [optional] **cid** | **String** | The ID of the inline attachment | [optional] -**s3Bucket** | **String** | The location of the cloud storage | [optional] -**mailMessageId** | **String** | The ID of the mail message to associate the file with | [optional] -**mailTemplateId** | **String** | The ID of the mail template to associate the file with | [optional] -**dealName** | **String** | The name of the deal associated with the file | [optional] -**personName** | **String** | The name of the person associated with the file | [optional] -**orgName** | **String** | The name of the organization associated with the file | [optional] -**productName** | **String** | The name of the product associated with the file | [optional] -**leadName** | **String** | The name of the lead associated with the file | [optional] +**s3_bucket** | **String** | The location of the cloud storage | [optional] +**mail_message_id** | **String** | The ID of the mail message to associate the file with | [optional] +**mail_template_id** | **String** | The ID of the mail template to associate the file with | [optional] +**deal_name** | **String** | The name of the deal associated with the file | [optional] +**person_name** | **String** | The name of the person associated with the file | [optional] +**org_name** | **String** | The name of the organization associated with the file | [optional] +**product_name** | **String** | The name of the product associated with the file | [optional] +**lead_name** | **String** | The name of the lead associated with the file | [optional] **url** | **String** | The URL of the download file | [optional] **name** | **String** | The visible name of the file | [optional] **description** | **String** | The description of the file | [optional] diff --git a/docs/FileItem.md b/docs/FileItem.md index 5ffd394b..a734a6db 100644 --- a/docs/FileItem.md +++ b/docs/FileItem.md @@ -5,30 +5,30 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the file | [optional] -**userId** | **Number** | The ID of the user to associate the file with | [optional] -**dealId** | **Number** | The ID of the deal to associate the file with | [optional] -**personId** | **Number** | The ID of the person to associate the file with | [optional] -**orgId** | **Number** | The ID of the organization to associate the file with | [optional] -**productId** | **Number** | The ID of the product to associate the file with | [optional] -**activityId** | **Number** | The ID of the activity to associate the file with | [optional] -**leadId** | **String** | The ID of the lead to associate the file with | [optional] -**addTime** | **String** | The date and time when the file was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] -**updateTime** | **String** | The last updated date and time of the file. Format: YYYY-MM-DD HH:MM:SS | [optional] -**fileName** | **String** | The original name of the file | [optional] -**fileSize** | **Number** | The size of the file | [optional] -**activeFlag** | **Boolean** | Whether the user is active or not. false = Not activated, true = Activated | [optional] -**inlineFlag** | **Boolean** | Whether the file was uploaded as inline or not | [optional] -**remoteLocation** | **String** | The location type to send the file to. Only googledrive is supported at the moment. | [optional] -**remoteId** | **String** | The ID of the remote item | [optional] +**user_id** | **Number** | The ID of the user to associate the file with | [optional] +**deal_id** | **Number** | The ID of the deal to associate the file with | [optional] +**person_id** | **Number** | The ID of the person to associate the file with | [optional] +**org_id** | **Number** | The ID of the organization to associate the file with | [optional] +**product_id** | **Number** | The ID of the product to associate the file with | [optional] +**activity_id** | **Number** | The ID of the activity to associate the file with | [optional] +**lead_id** | **String** | The ID of the lead to associate the file with | [optional] +**add_time** | **String** | The date and time when the file was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] +**update_time** | **String** | The last updated date and time of the file. Format: YYYY-MM-DD HH:MM:SS | [optional] +**file_name** | **String** | The original name of the file | [optional] +**file_size** | **Number** | The size of the file | [optional] +**active_flag** | **Boolean** | Whether the user is active or not. false = Not activated, true = Activated | [optional] +**inline_flag** | **Boolean** | Whether the file was uploaded as inline or not | [optional] +**remote_location** | **String** | The location type to send the file to. Only googledrive is supported at the moment. | [optional] +**remote_id** | **String** | The ID of the remote item | [optional] **cid** | **String** | The ID of the inline attachment | [optional] -**s3Bucket** | **String** | The location of the cloud storage | [optional] -**mailMessageId** | **String** | The ID of the mail message to associate the file with | [optional] -**mailTemplateId** | **String** | The ID of the mail template to associate the file with | [optional] -**dealName** | **String** | The name of the deal associated with the dile | [optional] -**personName** | **String** | The name of the person associated with the file | [optional] -**orgName** | **String** | The name of the organization associated with the file | [optional] -**productName** | **String** | The name of the product associated with the file | [optional] -**leadName** | **String** | The name of the lead associated with the file | [optional] +**s3_bucket** | **String** | The location of the cloud storage | [optional] +**mail_message_id** | **String** | The ID of the mail message to associate the file with | [optional] +**mail_template_id** | **String** | The ID of the mail template to associate the file with | [optional] +**deal_name** | **String** | The name of the deal associated with the dile | [optional] +**person_name** | **String** | The name of the person associated with the file | [optional] +**org_name** | **String** | The name of the organization associated with the file | [optional] +**product_name** | **String** | The name of the product associated with the file | [optional] +**lead_name** | **String** | The name of the lead associated with the file | [optional] **url** | **String** | The URL of the download file | [optional] **name** | **String** | The visible name of the file | [optional] **description** | **String** | The description of the file | [optional] diff --git a/docs/FilesApi.md b/docs/FilesApi.md index 19ef0898..d79b1f9b 100644 --- a/docs/FilesApi.md +++ b/docs/FilesApi.md @@ -39,6 +39,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.FilesApi(apiClient); let file = "/path/to/file"; // File | A single file, supplied in the multipart/form-data encoding and contained within the given boundaries +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'dealId': 56, // Number | The ID of the deal to associate file(s) with 'personId': 56, // Number | The ID of the person to associate file(s) with @@ -61,12 +62,12 @@ apiInstance.addFile(file, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file** | **File**| A single file, supplied in the multipart/form-data encoding and contained within the given boundaries | - **dealId** | **Number**| The ID of the deal to associate file(s) with | [optional] - **personId** | **Number**| The ID of the person to associate file(s) with | [optional] - **orgId** | **Number**| The ID of the organization to associate file(s) with | [optional] - **productId** | **Number**| The ID of the product to associate file(s) with | [optional] - **activityId** | **Number**| The ID of the activity to associate file(s) with | [optional] - **leadId** | **String**| The ID of the lead to associate file(s) with | [optional] + **deal_id** | **Number**| The ID of the deal to associate file(s) with | [optional] + **person_id** | **Number**| The ID of the person to associate file(s) with | [optional] + **org_id** | **Number**| The ID of the organization to associate file(s) with | [optional] + **product_id** | **Number**| The ID of the product to associate file(s) with | [optional] + **activity_id** | **Number**| The ID of the activity to associate file(s) with | [optional] + **lead_id** | **String**| The ID of the lead to associate file(s) with | [optional] ### Return type @@ -123,11 +124,11 @@ apiInstance.addFileAndLinkIt(fileType, title, itemType, itemId, remoteLocation). Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fileType** | **String**| The file type | + **file_type** | **String**| The file type | **title** | **String**| The title of the file | - **itemType** | **String**| The item type | - **itemId** | **Number**| The ID of the item to associate the file with | - **remoteLocation** | **String**| The location type to send the file to. Only `googledrive` is supported at the moment. | + **item_type** | **String**| The item type | + **item_id** | **Number**| The ID of the item to associate the file with | + **remote_location** | **String**| The location type to send the file to. Only `googledrive` is supported at the moment. | ### Return type @@ -325,6 +326,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.FilesApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -401,10 +403,10 @@ apiInstance.linkFileToItem(itemType, itemId, remoteId, remoteLocation).then((dat Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **itemType** | **String**| The item type | - **itemId** | **Number**| The ID of the item to associate the file with | - **remoteId** | **String**| The remote item ID | - **remoteLocation** | **String**| The location type to send the file to. Only `googledrive` is supported at the moment. | + **item_type** | **String**| The item type | + **item_id** | **Number**| The ID of the item to associate the file with | + **remote_id** | **String**| The remote item ID | + **remote_location** | **String**| The location type to send the file to. Only `googledrive` is supported at the moment. | ### Return type @@ -444,6 +446,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.FilesApi(apiClient); let id = 56; // Number | The ID of the file +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'name': "name_example", // String | The visible name of the file 'description': "description_example" // String | The description of the file diff --git a/docs/FilterGetItem.md b/docs/FilterGetItem.md index 614e6925..789e4a49 100644 --- a/docs/FilterGetItem.md +++ b/docs/FilterGetItem.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the filter | [optional] **name** | **String** | The name of the filter | [optional] -**activeFlag** | **Boolean** | The active flag of the filter | [optional] +**active_flag** | **Boolean** | The active flag of the filter | [optional] **type** | **String** | The type of the item | [optional] -**userId** | **Number** | The owner of the filter | [optional] -**addTime** | **String** | The date and time when the filter was added | [optional] -**updateTime** | **String** | The date and time when the filter was updated | [optional] -**visibleTo** | **Number** | The visibility group ID of who can see then filter | [optional] -**customViewId** | **Number** | Used by Pipedrive webapp | [optional] +**user_id** | **Number** | The owner of the filter | [optional] +**add_time** | **String** | The date and time when the filter was added | [optional] +**update_time** | **String** | The date and time when the filter was updated | [optional] +**visible_to** | **Number** | The visibility group ID of who can see then filter | [optional] +**custom_view_id** | **Number** | Used by Pipedrive webapp | [optional] diff --git a/docs/FiltersApi.md b/docs/FiltersApi.md index 0ff0074b..5b1f3dcc 100644 --- a/docs/FiltersApi.md +++ b/docs/FiltersApi.md @@ -53,7 +53,7 @@ apiInstance.addFilter(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **addFilterRequest** | [**AddFilterRequest**](AddFilterRequest.md)| | [optional] + **AddFilterRequest** | [**AddFilterRequest**](AddFilterRequest.md)| | [optional] ### Return type @@ -300,6 +300,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.FiltersApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'type': new Pipedrive.FilterType() // FilterType | The types of filters to fetch }; @@ -373,7 +374,7 @@ apiInstance.updateFilter(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the filter | - **updateFilterRequest** | [**UpdateFilterRequest**](UpdateFilterRequest.md)| | [optional] + **UpdateFilterRequest** | [**UpdateFilterRequest**](UpdateFilterRequest.md)| | [optional] ### Return type diff --git a/docs/FiltersPostResponseAllOfData.md b/docs/FiltersPostResponseAllOfData.md index e098b629..6a150983 100644 --- a/docs/FiltersPostResponseAllOfData.md +++ b/docs/FiltersPostResponseAllOfData.md @@ -6,14 +6,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the created filter | [optional] **name** | **String** | The name of the created filter | [optional] -**activeFlag** | **Boolean** | The activity flag of the created filter | [optional] +**active_flag** | **Boolean** | The activity flag of the created filter | [optional] **type** | [**FilterType**](FilterType.md) | | [optional] -**temporaryFlag** | **Boolean** | If the created filter is temporary or not | [optional] -**userId** | **Number** | The user ID of the created filter | [optional] -**addTime** | **String** | The add time of the created filter | [optional] -**updateTime** | **String** | The update time of the created filter | [optional] -**visibleTo** | **Number** | The visibility group ID of the created filter | [optional] -**customViewId** | **Number** | The custom view ID of the created filter | [optional] +**temporary_flag** | **Boolean** | If the created filter is temporary or not | [optional] +**user_id** | **Number** | The user ID of the created filter | [optional] +**add_time** | **String** | The add time of the created filter | [optional] +**update_time** | **String** | The update time of the created filter | [optional] +**visible_to** | **Number** | The visibility group ID of the created filter | [optional] +**custom_view_id** | **Number** | The custom view ID of the created filter | [optional] **conditions** | **Object** | The created filter conditions object | [optional] diff --git a/docs/FollowerData.md b/docs/FollowerData.md index aeed47d5..34925a3e 100644 --- a/docs/FollowerData.md +++ b/docs/FollowerData.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the follower | [optional] **email** | **String** | The email of the follower | [optional] -**userId** | **Number** | The user ID of the follower | [optional] -**picHash** | **String** | The follower picture hash | [optional] +**user_id** | **Number** | The user ID of the follower | [optional] +**pic_hash** | **String** | The follower picture hash | [optional] diff --git a/docs/FollowerDataWithID.md b/docs/FollowerDataWithID.md index 77d08be4..1e1009e7 100644 --- a/docs/FollowerDataWithID.md +++ b/docs/FollowerDataWithID.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **id** | **Number** | The ID of the follower associated with the item | [optional] **name** | **String** | The name of the follower | [optional] **email** | **String** | The email of the follower | [optional] -**userId** | **Number** | The user ID of the follower | [optional] -**picHash** | **String** | The follower picture hash | [optional] +**user_id** | **Number** | The user ID of the follower | [optional] +**pic_hash** | **String** | The follower picture hash | [optional] diff --git a/docs/FullProjectObject.md b/docs/FullProjectObject.md index 32079b62..49e4bc8b 100644 --- a/docs/FullProjectObject.md +++ b/docs/FullProjectObject.md @@ -5,20 +5,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The title of the project | [optional] -**boardId** | **Number** | The ID of the board this project is associated with | [optional] -**phaseId** | **Number** | The ID of the phase this project is associated with | [optional] +**board_id** | **Number** | The ID of the board this project is associated with | [optional] +**phase_id** | **Number** | The ID of the phase this project is associated with | [optional] **description** | **String** | The description of the project | [optional] **status** | **String** | The status of the project | [optional] -**ownerId** | **Number** | The ID of a project owner | [optional] -**startDate** | **Date** | The start date of the project. Format: YYYY-MM-DD. | [optional] -**endDate** | **Date** | The end date of the project. Format: YYYY-MM-DD. | [optional] -**dealIds** | **[Number]** | An array of IDs of the deals this project is associated with | [optional] -**orgId** | **Number** | The ID of the organization this project is associated with | [optional] -**personId** | **Number** | The ID of the person this project is associated with | [optional] +**owner_id** | **Number** | The ID of a project owner | [optional] +**start_date** | **Date** | The start date of the project. Format: YYYY-MM-DD. | [optional] +**end_date** | **Date** | The end date of the project. Format: YYYY-MM-DD. | [optional] +**deal_ids** | **[Number]** | An array of IDs of the deals this project is associated with | [optional] +**org_id** | **Number** | The ID of the organization this project is associated with | [optional] +**person_id** | **Number** | The ID of the person this project is associated with | [optional] **labels** | **[Number]** | An array of IDs of the labels this project has | [optional] -**addTime** | **String** | The creation date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The update date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**statusChangeTime** | **String** | The status changed date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**archiveTime** | **String** | The archived date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. If not archived then 'null'. | [optional] +**add_time** | **String** | The creation date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The update date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**status_change_time** | **String** | The status changed date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**archive_time** | **String** | The archived date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. If not archived then 'null'. | [optional] diff --git a/docs/FullRole.md b/docs/FullRole.md index f582c1ef..18c95cd1 100644 --- a/docs/FullRole.md +++ b/docs/FullRole.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**parentRoleId** | **Number** | The ID of the parent role | [optional] +**parent_role_id** | **Number** | The ID of the parent role | [optional] **name** | **String** | The name of the role | [optional] **id** | **Number** | The ID of the role | [optional] -**activeFlag** | **Boolean** | Whether the role is active or not | [optional] -**assignmentCount** | **String** | The number of users assigned to this role | [optional] -**subRoleCount** | **String** | The number of sub-roles | [optional] +**active_flag** | **Boolean** | Whether the role is active or not | [optional] +**assignment_count** | **String** | The number of users assigned to this role | [optional] +**sub_role_count** | **String** | The number of sub-roles | [optional] **level** | **Number** | The level of role in the role hierarchy | [optional] diff --git a/docs/FullTaskObject.md b/docs/FullTaskObject.md index eefc5f68..1611a2cc 100644 --- a/docs/FullTaskObject.md +++ b/docs/FullTaskObject.md @@ -5,15 +5,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The title of the task | [optional] -**projectId** | **Number** | The ID of the project this task is associated with | [optional] +**project_id** | **Number** | The ID of the project this task is associated with | [optional] **description** | **String** | The description of the task | [optional] -**parentTaskId** | **Number** | The ID of a parent task. Can not be ID of a task which is already a subtask. | [optional] -**assigneeId** | **Number** | The ID of the user who will be the assignee of the task | [optional] +**parent_task_id** | **Number** | The ID of a parent task. Can not be ID of a task which is already a subtask. | [optional] +**assignee_id** | **Number** | The ID of the user who will be the assignee of the task | [optional] **done** | [**NumberBoolean**](NumberBoolean.md) | Whether the task is done or not. 0 = Not done, 1 = Done. | [optional] -**dueDate** | **Date** | The due date of the task. Format: YYYY-MM-DD. | [optional] -**creatorId** | **Number** | The creator of a task | [optional] -**addTime** | **String** | The creation date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The update date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**markedAsDoneTime** | **String** | The marked as done date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**due_date** | **Date** | The due date of the task. Format: YYYY-MM-DD. | [optional] +**creator_id** | **Number** | The creator of a task | [optional] +**add_time** | **String** | The creation date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The update date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**marked_as_done_time** | **String** | The marked as done date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] diff --git a/docs/GetActivitiesCollectionResponse200.md b/docs/GetActivitiesCollectionResponse200.md index 623d8c9b..e4a9c9d0 100644 --- a/docs/GetActivitiesCollectionResponse200.md +++ b/docs/GetActivitiesCollectionResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[ActivityCollectionResponseObject]**](ActivityCollectionResponseObject.md) | | [optional] -**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] +**additional_data** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] diff --git a/docs/GetActivitiesResponse200.md b/docs/GetActivitiesResponse200.md index 9c9bd8dc..db5d2eeb 100644 --- a/docs/GetActivitiesResponse200.md +++ b/docs/GetActivitiesResponse200.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[ActivityResponseObject]**](ActivityResponseObject.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] -**relatedObjects** | [**GetActivitiesResponse200RelatedObjects**](GetActivitiesResponse200RelatedObjects.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**related_objects** | [**GetActivitiesResponse200RelatedObjects**](GetActivitiesResponse200RelatedObjects.md) | | [optional] diff --git a/docs/GetActivityResponse200.md b/docs/GetActivityResponse200.md index 5c7fed94..011721fc 100644 --- a/docs/GetActivityResponse200.md +++ b/docs/GetActivityResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**ActivityResponseObject**](ActivityResponseObject.md) | | [optional] -**relatedObjects** | [**GetActivitiesResponse200RelatedObjects**](GetActivitiesResponse200RelatedObjects.md) | | [optional] +**related_objects** | [**GetActivitiesResponse200RelatedObjects**](GetActivitiesResponse200RelatedObjects.md) | | [optional] diff --git a/docs/GetAddedDeal.md b/docs/GetAddedDeal.md index 7f40492d..39acd59f 100644 --- a/docs/GetAddedDeal.md +++ b/docs/GetAddedDeal.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**DealNonStrict**](DealNonStrict.md) | | [optional] -**relatedObjects** | [**GetDealsRelatedObjects**](GetDealsRelatedObjects.md) | | [optional] +**related_objects** | [**GetDealsRelatedObjects**](GetDealsRelatedObjects.md) | | [optional] diff --git a/docs/GetAllFiles.md b/docs/GetAllFiles.md index a4cd9d56..41358b63 100644 --- a/docs/GetAllFiles.md +++ b/docs/GetAllFiles.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the request was successful or not | [optional] **data** | [**[FileData]**](FileData.md) | The array of all uploaded files | [optional] -**additionalData** | [**AdditionalDataWithPaginationDetails**](AdditionalDataWithPaginationDetails.md) | | [optional] +**additional_data** | [**AdditionalDataWithPaginationDetails**](AdditionalDataWithPaginationDetails.md) | | [optional] diff --git a/docs/GetAllPersonsResponse.md b/docs/GetAllPersonsResponse.md index b6bf372e..18674f49 100644 --- a/docs/GetAllPersonsResponse.md +++ b/docs/GetAllPersonsResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[PersonItem]**](PersonItem.md) | The array of persons | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/GetAllPersonsResponseAllOf.md b/docs/GetAllPersonsResponseAllOf.md index 027cf0c8..dcd57673 100644 --- a/docs/GetAllPersonsResponseAllOf.md +++ b/docs/GetAllPersonsResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[PersonItem]**](PersonItem.md) | The array of persons | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/GetAllProductFieldsResponse.md b/docs/GetAllProductFieldsResponse.md index 2a03e99e..c8eb1bd8 100644 --- a/docs/GetAllProductFieldsResponse.md +++ b/docs/GetAllProductFieldsResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ProductField]**](ProductField.md) | Array containing data for all product fields | [optional] -**additionalData** | **Object** | Additional data for the product field, such as pagination | [optional] +**additional_data** | **Object** | Additional data for the product field, such as pagination | [optional] diff --git a/docs/GetComments.md b/docs/GetComments.md index 5704a9e5..dca46d6d 100644 --- a/docs/GetComments.md +++ b/docs/GetComments.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the request was successful or not | [optional] **data** | [**[BaseComment]**](BaseComment.md) | The array of comments | [optional] -**additionalData** | [**AdditionalDataWithOffsetPagination**](AdditionalDataWithOffsetPagination.md) | | [optional] +**additional_data** | [**AdditionalDataWithOffsetPagination**](AdditionalDataWithOffsetPagination.md) | | [optional] diff --git a/docs/GetDeal.md b/docs/GetDeal.md index f7ebf51b..3e3a17f5 100644 --- a/docs/GetDeal.md +++ b/docs/GetDeal.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**DealNonStrictWithDetails**](DealNonStrictWithDetails.md) | | [optional] -**additionalData** | [**GetDealAdditionalData**](GetDealAdditionalData.md) | | [optional] -**relatedObjects** | [**GetDealRelatedObjects**](GetDealRelatedObjects.md) | | [optional] +**additional_data** | [**GetDealAdditionalData**](GetDealAdditionalData.md) | | [optional] +**related_objects** | [**GetDealRelatedObjects**](GetDealRelatedObjects.md) | | [optional] diff --git a/docs/GetDealAdditionalData.md b/docs/GetDealAdditionalData.md index 172af6ba..b9633c97 100644 --- a/docs/GetDealAdditionalData.md +++ b/docs/GetDealAdditionalData.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dropboxEmail** | **String** | The BCC email of the deal | [optional] +**dropbox_email** | **String** | The BCC email of the deal | [optional] diff --git a/docs/GetDeals.md b/docs/GetDeals.md index f560847a..667a079d 100644 --- a/docs/GetDeals.md +++ b/docs/GetDeals.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[DealNonStrict]**](DealNonStrict.md) | The array of deals | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**GetDealsRelatedObjects**](GetDealsRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**GetDealsRelatedObjects**](GetDealsRelatedObjects.md) | | [optional] diff --git a/docs/GetDealsCollection.md b/docs/GetDealsCollection.md index 6a71adb0..7b849e0d 100644 --- a/docs/GetDealsCollection.md +++ b/docs/GetDealsCollection.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[DealCollectionResponseObject]**](DealCollectionResponseObject.md) | | [optional] -**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] +**additional_data** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] diff --git a/docs/GetDealsConversionRatesInPipelineAllOfData.md b/docs/GetDealsConversionRatesInPipelineAllOfData.md index ead53c78..f3a388ff 100644 --- a/docs/GetDealsConversionRatesInPipelineAllOfData.md +++ b/docs/GetDealsConversionRatesInPipelineAllOfData.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**stageConversions** | [**[StageConversions]**](StageConversions.md) | The stage conversions | [optional] -**wonConversion** | **Number** | The won conversion | [optional] -**lostConversion** | **Number** | The lost conversion | [optional] +**stage_conversions** | [**[StageConversions]**](StageConversions.md) | The stage conversions | [optional] +**won_conversion** | **Number** | The won conversion | [optional] +**lost_conversion** | **Number** | The lost conversion | [optional] diff --git a/docs/GetDealsMovementsInPipelineAllOfData.md b/docs/GetDealsMovementsInPipelineAllOfData.md index d194810e..140aec08 100644 --- a/docs/GetDealsMovementsInPipelineAllOfData.md +++ b/docs/GetDealsMovementsInPipelineAllOfData.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**movementsBetweenStages** | [**GetDealsMovementsInPipelineAllOfDataMovementsBetweenStages**](GetDealsMovementsInPipelineAllOfDataMovementsBetweenStages.md) | | [optional] -**newDeals** | [**DealsMovementsInfo**](DealsMovementsInfo.md) | | [optional] -**dealsLeftOpen** | [**DealsMovementsInfo**](DealsMovementsInfo.md) | | [optional] -**wonDeals** | [**DealsMovementsInfo**](DealsMovementsInfo.md) | | [optional] -**lostDeals** | [**DealsMovementsInfo**](DealsMovementsInfo.md) | | [optional] -**averageAgeInDays** | [**GetDealsMovementsInPipelineAllOfDataAverageAgeInDays**](GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.md) | | [optional] +**movements_between_stages** | [**GetDealsMovementsInPipelineAllOfDataMovementsBetweenStages**](GetDealsMovementsInPipelineAllOfDataMovementsBetweenStages.md) | | [optional] +**new_deals** | [**DealsMovementsInfo**](DealsMovementsInfo.md) | | [optional] +**deals_left_open** | [**DealsMovementsInfo**](DealsMovementsInfo.md) | | [optional] +**won_deals** | [**DealsMovementsInfo**](DealsMovementsInfo.md) | | [optional] +**lost_deals** | [**DealsMovementsInfo**](DealsMovementsInfo.md) | | [optional] +**average_age_in_days** | [**GetDealsMovementsInPipelineAllOfDataAverageAgeInDays**](GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.md) | | [optional] diff --git a/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.md b/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.md index eb557c86..dcb5af8b 100644 --- a/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.md +++ b/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**acrossAllStages** | **Number** | The moved deals average age across all stages | [optional] -**byStages** | [**[GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages]**](GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.md) | The moved deals average age by stages | [optional] +**across_all_stages** | **Number** | The moved deals average age across all stages | [optional] +**by_stages** | [**[GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages]**](GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.md) | The moved deals average age by stages | [optional] diff --git a/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.md b/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.md index 6fd394cd..6f2e5c56 100644 --- a/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.md +++ b/docs/GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**stageId** | **Number** | The stage ID | [optional] +**stage_id** | **Number** | The stage ID | [optional] **value** | **Number** | The average deals age in specific stage | [optional] diff --git a/docs/GetDealsSummaryData.md b/docs/GetDealsSummaryData.md index 556adf90..ac8d8bac 100644 --- a/docs/GetDealsSummaryData.md +++ b/docs/GetDealsSummaryData.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**valuesTotal** | [**GetDealsSummaryDataValuesTotal**](GetDealsSummaryDataValuesTotal.md) | | [optional] -**weightedValuesTotal** | [**GetDealsSummaryDataWeightedValuesTotal**](GetDealsSummaryDataWeightedValuesTotal.md) | | [optional] -**totalCount** | **Number** | The total number of deals | [optional] -**totalCurrencyConvertedValue** | **Number** | The total value of deals converted into the company default currency | [optional] -**totalWeightedCurrencyConvertedValue** | **Number** | The total weighted value of deals converted into the company default currency | [optional] -**totalCurrencyConvertedValueFormatted** | **String** | The total converted value of deals formatted with the company default currency. E.g. US$5,100.96 | [optional] -**totalWeightedCurrencyConvertedValueFormatted** | **String** | The total weighted value of deals formatted with the company default currency. E.g. US$5,100.96 | [optional] +**values_total** | [**GetDealsSummaryDataValuesTotal**](GetDealsSummaryDataValuesTotal.md) | | [optional] +**weighted_values_total** | [**GetDealsSummaryDataWeightedValuesTotal**](GetDealsSummaryDataWeightedValuesTotal.md) | | [optional] +**total_count** | **Number** | The total number of deals | [optional] +**total_currency_converted_value** | **Number** | The total value of deals converted into the company default currency | [optional] +**total_weighted_currency_converted_value** | **Number** | The total weighted value of deals converted into the company default currency | [optional] +**total_currency_converted_value_formatted** | **String** | The total converted value of deals formatted with the company default currency. E.g. US$5,100.96 | [optional] +**total_weighted_currency_converted_value_formatted** | **String** | The total weighted value of deals formatted with the company default currency. E.g. US$5,100.96 | [optional] diff --git a/docs/GetDealsSummaryDataValuesTotal.md b/docs/GetDealsSummaryDataValuesTotal.md index 9b212f28..720a5aa0 100644 --- a/docs/GetDealsSummaryDataValuesTotal.md +++ b/docs/GetDealsSummaryDataValuesTotal.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **Number** | The total value of deals in the deal currency group | [optional] **count** | **Number** | The number of deals in the deal currency group | [optional] -**valueConverted** | **Number** | The total value of deals converted into the company default currency | [optional] -**valueFormatted** | **String** | The total value of deals formatted with deal currency. E.g. €50 | [optional] -**valueConvertedFormatted** | **String** | The value_converted formatted with deal currency. E.g. US$50.10 | [optional] +**value_converted** | **Number** | The total value of deals converted into the company default currency | [optional] +**value_formatted** | **String** | The total value of deals formatted with deal currency. E.g. €50 | [optional] +**value_converted_formatted** | **String** | The value_converted formatted with deal currency. E.g. US$50.10 | [optional] diff --git a/docs/GetDealsSummaryDataWeightedValuesTotal.md b/docs/GetDealsSummaryDataWeightedValuesTotal.md index e9e78740..b3ed0ed0 100644 --- a/docs/GetDealsSummaryDataWeightedValuesTotal.md +++ b/docs/GetDealsSummaryDataWeightedValuesTotal.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **Number** | The total weighted value of the deals in the deal currency group | [optional] **count** | **Number** | The number of deals in the deal currency group | [optional] -**valueFormatted** | **String** | The total weighted value of the deals formatted with deal currency. E.g. €50 | [optional] +**value_formatted** | **String** | The total weighted value of the deals formatted with deal currency. E.g. €50 | [optional] diff --git a/docs/GetDealsTimelineData.md b/docs/GetDealsTimelineData.md index eec5994d..f17e42e7 100644 --- a/docs/GetDealsTimelineData.md +++ b/docs/GetDealsTimelineData.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**periodStart** | **String** | The start date and time of the period | [optional] -**periodEnd** | **String** | The end date and time of the period | [optional] +**period_start** | **String** | The start date and time of the period | [optional] +**period_end** | **String** | The end date and time of the period | [optional] **deals** | [**[DealStrict]**](DealStrict.md) | | [optional] **totals** | [**GetDealsTimelineDataTotals**](GetDealsTimelineDataTotals.md) | | [optional] diff --git a/docs/GetDealsTimelineDataTotals.md b/docs/GetDealsTimelineDataTotals.md index e4faff54..45d2b82c 100644 --- a/docs/GetDealsTimelineDataTotals.md +++ b/docs/GetDealsTimelineDataTotals.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **Number** | The number of deals for the given period | [optional] **values** | **Object** | The total values of deals grouped by deal currency | [optional] -**weightedValues** | **Object** | The total weighted values of deals for the given period grouped by deal currency. The weighted value of a deal is calculated as probability times deal value. | [optional] -**openCount** | **Number** | The number of open deals for the given period | [optional] -**openValues** | **Object** | The total values of open deals for the given period grouped by deal currency | [optional] -**weightedOpenValues** | **Object** | The total weighted values of open deals for the given period grouped by deal currency. The weighted value of a deal is calculated as probability times deal value. | [optional] -**wonCount** | **Number** | The number of won deals for the given period | [optional] -**wonValues** | **Object** | The total values of won deals for the given period grouped by deal currency | [optional] +**weighted_values** | **Object** | The total weighted values of deals for the given period grouped by deal currency. The weighted value of a deal is calculated as probability times deal value. | [optional] +**open_count** | **Number** | The number of open deals for the given period | [optional] +**open_values** | **Object** | The total values of open deals for the given period grouped by deal currency | [optional] +**weighted_open_values** | **Object** | The total weighted values of open deals for the given period grouped by deal currency. The weighted value of a deal is calculated as probability times deal value. | [optional] +**won_count** | **Number** | The number of won deals for the given period | [optional] +**won_values** | **Object** | The total values of won deals for the given period grouped by deal currency | [optional] diff --git a/docs/GetLeadsResponse200.md b/docs/GetLeadsResponse200.md index 8d67ba59..342719ea 100644 --- a/docs/GetLeadsResponse200.md +++ b/docs/GetLeadsResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[LeadResponse]**](LeadResponse.md) | | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/GetNotes.md b/docs/GetNotes.md index b8d3ec32..22ae725d 100644 --- a/docs/GetNotes.md +++ b/docs/GetNotes.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the request was successful or not | [optional] **data** | [**[BaseNote]**](BaseNote.md) | The array of notes | [optional] -**additionalData** | [**AdditionalDataWithOffsetPagination**](AdditionalDataWithOffsetPagination.md) | | [optional] +**additional_data** | [**AdditionalDataWithOffsetPagination**](AdditionalDataWithOffsetPagination.md) | | [optional] diff --git a/docs/GetPersonDetailsResponse.md b/docs/GetPersonDetailsResponse.md index e3be47d7..944f8499 100644 --- a/docs/GetPersonDetailsResponse.md +++ b/docs/GetPersonDetailsResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**PersonItem**](PersonItem.md) | | [optional] -**additionalData** | [**GetPersonDetailsResponseAllOfAdditionalData**](GetPersonDetailsResponseAllOfAdditionalData.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**GetPersonDetailsResponseAllOfAdditionalData**](GetPersonDetailsResponseAllOfAdditionalData.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/GetPersonDetailsResponseAllOf.md b/docs/GetPersonDetailsResponseAllOf.md index ec34b707..47c7e3a9 100644 --- a/docs/GetPersonDetailsResponseAllOf.md +++ b/docs/GetPersonDetailsResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**PersonItem**](PersonItem.md) | | [optional] -**additionalData** | [**GetPersonDetailsResponseAllOfAdditionalData**](GetPersonDetailsResponseAllOfAdditionalData.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**GetPersonDetailsResponseAllOfAdditionalData**](GetPersonDetailsResponseAllOfAdditionalData.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/GetPersonDetailsResponseAllOfAdditionalData.md b/docs/GetPersonDetailsResponseAllOfAdditionalData.md index 4fb468f0..0e048f33 100644 --- a/docs/GetPersonDetailsResponseAllOfAdditionalData.md +++ b/docs/GetPersonDetailsResponseAllOfAdditionalData.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dropboxEmail** | **String** | Dropbox email for the person | [optional] +**dropbox_email** | **String** | Dropbox email for the person | [optional] diff --git a/docs/GetProjectBoardResponse200.md b/docs/GetProjectBoardResponse200.md index b0e3b2a7..d15f77c6 100644 --- a/docs/GetProjectBoardResponse200.md +++ b/docs/GetProjectBoardResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**ProjectBoardObject**](ProjectBoardObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/GetProjectBoardsResponse200.md b/docs/GetProjectBoardsResponse200.md index 899321f4..a1dedfcc 100644 --- a/docs/GetProjectBoardsResponse200.md +++ b/docs/GetProjectBoardsResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[ProjectBoardObject]**](ProjectBoardObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/GetProjectGroupsResponse200.md b/docs/GetProjectGroupsResponse200.md index 14607904..f657a746 100644 --- a/docs/GetProjectGroupsResponse200.md +++ b/docs/GetProjectGroupsResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[ProjectGroupsObject]**](ProjectGroupsObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/GetProjectPhaseResponse200.md b/docs/GetProjectPhaseResponse200.md index b32f8ac3..de49115a 100644 --- a/docs/GetProjectPhaseResponse200.md +++ b/docs/GetProjectPhaseResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**ProjectPhaseObject**](ProjectPhaseObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/GetProjectPhasesResponse200.md b/docs/GetProjectPhasesResponse200.md index e4a3c012..54e83700 100644 --- a/docs/GetProjectPhasesResponse200.md +++ b/docs/GetProjectPhasesResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[ProjectPhaseObject]**](ProjectPhaseObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/GetProjectPlanResponse200.md b/docs/GetProjectPlanResponse200.md index 54ee40e7..00a72b13 100644 --- a/docs/GetProjectPlanResponse200.md +++ b/docs/GetProjectPlanResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[ProjectPlanItemObject]**](ProjectPlanItemObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/GetProjectResponse200.md b/docs/GetProjectResponse200.md index 14f5234f..60defdef 100644 --- a/docs/GetProjectResponse200.md +++ b/docs/GetProjectResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**ProjectResponseObject**](ProjectResponseObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/GetProjectTemplateResponse200.md b/docs/GetProjectTemplateResponse200.md index e236c5dd..99f20b5d 100644 --- a/docs/GetProjectTemplateResponse200.md +++ b/docs/GetProjectTemplateResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**TemplateResponseObject**](TemplateResponseObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/GetProjectTemplatesResponse200.md b/docs/GetProjectTemplatesResponse200.md index d10c4823..afecb727 100644 --- a/docs/GetProjectTemplatesResponse200.md +++ b/docs/GetProjectTemplatesResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[TemplateResponseObject]**](TemplateResponseObject.md) | | [optional] -**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] +**additional_data** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] diff --git a/docs/GetProjectsResponse200.md b/docs/GetProjectsResponse200.md index 61b8526a..15b5b3fe 100644 --- a/docs/GetProjectsResponse200.md +++ b/docs/GetProjectsResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[ProjectResponseObject]**](ProjectResponseObject.md) | | [optional] -**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] +**additional_data** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] diff --git a/docs/GetRecents.md b/docs/GetRecents.md index 9daaa072..886529cb 100644 --- a/docs/GetRecents.md +++ b/docs/GetRecents.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[AnyOfRecents]**](AnyOfRecentsActivityRecentsActivityTypeRecentsDealRecentsFileRecentsFilterRecentsNoteRecentsPersonRecentsOrganizationRecentsPipelineRecentsProductRecentsStageRecentsUser.md) | | [optional] -**additionalData** | [**GetRecentsAdditionalData**](GetRecentsAdditionalData.md) | | [optional] +**additional_data** | [**GetRecentsAdditionalData**](GetRecentsAdditionalData.md) | | [optional] diff --git a/docs/GetRecentsAdditionalData.md b/docs/GetRecentsAdditionalData.md index 1bb1eb6a..3d8e9a1d 100644 --- a/docs/GetRecentsAdditionalData.md +++ b/docs/GetRecentsAdditionalData.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sinceTimestamp** | **String** | The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] -**lastTimestampOnPage** | **String** | The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] +**since_timestamp** | **String** | The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] +**last_timestamp_on_page** | **String** | The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] **pagination** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/GetRole.md b/docs/GetRole.md index 5849a22d..f2e3b88d 100644 --- a/docs/GetRole.md +++ b/docs/GetRole.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**SubRole**](SubRole.md) | | [optional] -**additionalData** | [**GetRoleAllOfAdditionalData**](GetRoleAllOfAdditionalData.md) | | [optional] +**additional_data** | [**GetRoleAllOfAdditionalData**](GetRoleAllOfAdditionalData.md) | | [optional] diff --git a/docs/GetRoleAllOf.md b/docs/GetRoleAllOf.md index 95867dcc..ad4abb89 100644 --- a/docs/GetRoleAllOf.md +++ b/docs/GetRoleAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**SubRole**](SubRole.md) | | [optional] -**additionalData** | [**GetRoleAllOfAdditionalData**](GetRoleAllOfAdditionalData.md) | | [optional] +**additional_data** | [**GetRoleAllOfAdditionalData**](GetRoleAllOfAdditionalData.md) | | [optional] diff --git a/docs/GetRoleAssignments.md b/docs/GetRoleAssignments.md index 320ff409..f2f28836 100644 --- a/docs/GetRoleAssignments.md +++ b/docs/GetRoleAssignments.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[RoleAssignment]**](RoleAssignment.md) | The role assignments | [optional] -**additionalData** | [**RolesAdditionalData**](RolesAdditionalData.md) | | [optional] +**additional_data** | [**RolesAdditionalData**](RolesAdditionalData.md) | | [optional] diff --git a/docs/GetRoleAssignmentsAllOf.md b/docs/GetRoleAssignmentsAllOf.md index bc9103bf..6a90ee1f 100644 --- a/docs/GetRoleAssignmentsAllOf.md +++ b/docs/GetRoleAssignmentsAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[RoleAssignment]**](RoleAssignment.md) | The role assignments | [optional] -**additionalData** | [**RolesAdditionalData**](RolesAdditionalData.md) | | [optional] +**additional_data** | [**RolesAdditionalData**](RolesAdditionalData.md) | | [optional] diff --git a/docs/GetRolePipelinesAllOfData.md b/docs/GetRolePipelinesAllOfData.md index 80744dc4..c1f1e7b2 100644 --- a/docs/GetRolePipelinesAllOfData.md +++ b/docs/GetRolePipelinesAllOfData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pipelineIds** | **[Number]** | Either visible or hidden pipeline ids | [optional] +**pipeline_ids** | **[Number]** | Either visible or hidden pipeline ids | [optional] **visible** | **Boolean** | Whether visible or hidden pipeline ids were returned | [optional] diff --git a/docs/GetRoles.md b/docs/GetRoles.md index 441205ed..10cbf71e 100644 --- a/docs/GetRoles.md +++ b/docs/GetRoles.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[FullRole]**](FullRole.md) | The array of roles | [optional] -**additionalData** | [**RolesAdditionalData**](RolesAdditionalData.md) | | [optional] +**additional_data** | [**RolesAdditionalData**](RolesAdditionalData.md) | | [optional] diff --git a/docs/GetRolesAllOf.md b/docs/GetRolesAllOf.md index 99a61d34..f4e1442d 100644 --- a/docs/GetRolesAllOf.md +++ b/docs/GetRolesAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[FullRole]**](FullRole.md) | The array of roles | [optional] -**additionalData** | [**RolesAdditionalData**](RolesAdditionalData.md) | | [optional] +**additional_data** | [**RolesAdditionalData**](RolesAdditionalData.md) | | [optional] diff --git a/docs/GetStageDeals.md b/docs/GetStageDeals.md index 02c06b6e..fb28d266 100644 --- a/docs/GetStageDeals.md +++ b/docs/GetStageDeals.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the request was successful or not | [optional] **data** | [**[DealStrict]**](DealStrict.md) | The array of deals | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/GetTaskResponse200.md b/docs/GetTaskResponse200.md index 9e79e297..47dbdd9b 100644 --- a/docs/GetTaskResponse200.md +++ b/docs/GetTaskResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**TaskResponseObject**](TaskResponseObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/GetTasksResponse200.md b/docs/GetTasksResponse200.md index d0784b67..561a29bc 100644 --- a/docs/GetTasksResponse200.md +++ b/docs/GetTasksResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[TaskResponseObject]**](TaskResponseObject.md) | | [optional] -**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] +**additional_data** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] diff --git a/docs/GoalsApi.md b/docs/GoalsApi.md index c74c9e18..290fe149 100644 --- a/docs/GoalsApi.md +++ b/docs/GoalsApi.md @@ -51,7 +51,7 @@ apiInstance.addGoal(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **newGoal** | [**NewGoal**](NewGoal.md)| | [optional] + **NewGoal** | [**NewGoal**](NewGoal.md)| | [optional] ### Return type @@ -160,8 +160,8 @@ apiInstance.getGoalResult(id, periodStart, periodEnd).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| The ID of the goal that the results are looked for | - **periodStart** | **Date**| The start date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or after the goal duration start date. | - **periodEnd** | **Date**| The end date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date. | + **period.start** | **Date**| The start date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or after the goal duration start date. | + **period.end** | **Date**| The end date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date. | ### Return type @@ -200,6 +200,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.GoalsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'typeName': "typeName_example", // String | The type of the goal. If provided, everyone's goals will be returned. 'title': "title_example", // String | The title of the goal @@ -228,19 +229,19 @@ apiInstance.getGoals(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **typeName** | **String**| The type of the goal. If provided, everyone's goals will be returned. | [optional] + **type.name** | **String**| The type of the goal. If provided, everyone's goals will be returned. | [optional] **title** | **String**| The title of the goal | [optional] - **isActive** | **Boolean**| Whether the goal is active or not | [optional] [default to true] - **assigneeId** | **Number**| The ID of the user who's goal to fetch. When omitted, only your goals will be returned. | [optional] - **assigneeType** | **String**| The type of the goal's assignee. If provided, everyone's goals will be returned. | [optional] - **expectedOutcomeTarget** | **Number**| The numeric value of the outcome. If provided, everyone's goals will be returned. | [optional] - **expectedOutcomeTrackingMetric** | **String**| The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned. | [optional] - **expectedOutcomeCurrencyId** | **Number**| The numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned. | [optional] - **typeParamsPipelineId** | [**[Number]**](Number.md)| An array of pipeline IDs or `null` for all pipelines. If provided, everyone's goals will be returned. | [optional] - **typeParamsStageId** | **Number**| The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned. | [optional] - **typeParamsActivityTypeId** | [**[Number]**](Number.md)| An array of IDs or `null` for all activity types. Only applicable for `activities_completed` and/or `activities_added` types of goals. If provided, everyone's goals will be returned. | [optional] - **periodStart** | **Date**| The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too. | [optional] - **periodEnd** | **Date**| The end date of the period for which to find goals. Date in format of YYYY-MM-DD. | [optional] + **is_active** | **Boolean**| Whether the goal is active or not | [optional] [default to true] + **assignee.id** | **Number**| The ID of the user who's goal to fetch. When omitted, only your goals will be returned. | [optional] + **assignee.type** | **String**| The type of the goal's assignee. If provided, everyone's goals will be returned. | [optional] + **expected_outcome.target** | **Number**| The numeric value of the outcome. If provided, everyone's goals will be returned. | [optional] + **expected_outcome.tracking_metric** | **String**| The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned. | [optional] + **expected_outcome.currency_id** | **Number**| The numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned. | [optional] + **type.params.pipeline_id** | [**[Number]**](Number.md)| An array of pipeline IDs or `null` for all pipelines. If provided, everyone's goals will be returned. | [optional] + **type.params.stage_id** | **Number**| The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned. | [optional] + **type.params.activity_type_id** | [**[Number]**](Number.md)| An array of IDs or `null` for all activity types. Only applicable for `activities_completed` and/or `activities_added` types of goals. If provided, everyone's goals will be returned. | [optional] + **period.start** | **Date**| The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too. | [optional] + **period.end** | **Date**| The end date of the period for which to find goals. Date in format of YYYY-MM-DD. | [optional] ### Return type @@ -297,7 +298,7 @@ apiInstance.updateGoal(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| The ID of the goal | - **basicGoal** | [**BasicGoal**](BasicGoal.md)| | [optional] + **BasicGoal** | [**BasicGoal**](BasicGoal.md)| | [optional] ### Return type diff --git a/docs/GoalsResponseComponent.md b/docs/GoalsResponseComponent.md index 597f8cf0..e92f0688 100644 --- a/docs/GoalsResponseComponent.md +++ b/docs/GoalsResponseComponent.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The ID of the goal | [optional] -**ownerId** | **Number** | The ID of the creator of the goal | [optional] +**owner_id** | **Number** | The ID of the creator of the goal | [optional] **title** | **String** | The title of the goal | [optional] **type** | [**GoalType**](GoalType.md) | | [optional] **assignee** | [**Assignee**](Assignee.md) | | [optional] **interval** | **String** | The interval of the goal | [optional] **duration** | [**Duration**](Duration.md) | | [optional] -**expectedOutcome** | [**ExpectedOutcome**](ExpectedOutcome.md) | | [optional] -**isActive** | **Boolean** | Whether the goal is currently active or not | [optional] -**reportIds** | **[String]** | The IDs of the reports that belong to the goal | [optional] +**expected_outcome** | [**ExpectedOutcome**](ExpectedOutcome.md) | | [optional] +**is_active** | **Boolean** | Whether the goal is currently active or not | [optional] +**report_ids** | **[String]** | The IDs of the reports that belong to the goal | [optional] diff --git a/docs/InlineResponse2001.md b/docs/InlineResponse2001.md index 2ad527a7..e43fc72a 100644 --- a/docs/InlineResponse2001.md +++ b/docs/InlineResponse2001.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[OrganizationsCollectionResponseObject]**](OrganizationsCollectionResponseObject.md) | | [optional] -**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] +**additional_data** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] diff --git a/docs/InlineResponse2002.md b/docs/InlineResponse2002.md index 97ff6733..5e33cff9 100644 --- a/docs/InlineResponse2002.md +++ b/docs/InlineResponse2002.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**[PersonsCollectionResponseObject]**](PersonsCollectionResponseObject.md) | | [optional] -**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] +**additional_data** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) | | [optional] diff --git a/docs/InlineResponse400.md b/docs/InlineResponse400.md index 562846ec..c5738ee0 100644 --- a/docs/InlineResponse400.md +++ b/docs/InlineResponse400.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The error description | [optional] -**errorInfo** | **String** | | [optional] -**additionalData** | [**InlineResponse400AdditionalData**](InlineResponse400AdditionalData.md) | | [optional] +**error_info** | **String** | | [optional] +**additional_data** | [**InlineResponse400AdditionalData**](InlineResponse400AdditionalData.md) | | [optional] diff --git a/docs/InlineResponse4001.md b/docs/InlineResponse4001.md index e55170d3..08f6fa65 100644 --- a/docs/InlineResponse4001.md +++ b/docs/InlineResponse4001.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The error description | [optional] -**errorInfo** | **String** | | [optional] -**additionalData** | [**InlineResponse4001AdditionalData**](InlineResponse4001AdditionalData.md) | | [optional] +**error_info** | **String** | | [optional] +**additional_data** | [**InlineResponse4001AdditionalData**](InlineResponse4001AdditionalData.md) | | [optional] diff --git a/docs/InlineResponse403.md b/docs/InlineResponse403.md index 42363f38..02cd2f17 100644 --- a/docs/InlineResponse403.md +++ b/docs/InlineResponse403.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The error description | [optional] -**errorInfo** | **String** | | [optional] -**additionalData** | [**InlineResponse403AdditionalData**](InlineResponse403AdditionalData.md) | | [optional] +**error_info** | **String** | | [optional] +**additional_data** | [**InlineResponse403AdditionalData**](InlineResponse403AdditionalData.md) | | [optional] diff --git a/docs/InlineResponse4031.md b/docs/InlineResponse4031.md index 7485660e..a99152dc 100644 --- a/docs/InlineResponse4031.md +++ b/docs/InlineResponse4031.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The error description | [optional] -**errorInfo** | **String** | | [optional] -**additionalData** | [**InlineResponse4031AdditionalData**](InlineResponse4031AdditionalData.md) | | [optional] +**error_info** | **String** | | [optional] +**additional_data** | [**InlineResponse4031AdditionalData**](InlineResponse4031AdditionalData.md) | | [optional] diff --git a/docs/InlineResponse404.md b/docs/InlineResponse404.md index 2cb2fa40..1e2bf835 100644 --- a/docs/InlineResponse404.md +++ b/docs/InlineResponse404.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The error description | [optional] -**errorInfo** | **String** | | [optional] -**additionalData** | [**InlineResponse404AdditionalData**](InlineResponse404AdditionalData.md) | | [optional] +**error_info** | **String** | | [optional] +**additional_data** | [**InlineResponse404AdditionalData**](InlineResponse404AdditionalData.md) | | [optional] diff --git a/docs/ItemSearchAdditionalDataPagination.md b/docs/ItemSearchAdditionalDataPagination.md index d4d6b57b..06cea6fb 100644 --- a/docs/ItemSearchAdditionalDataPagination.md +++ b/docs/ItemSearchAdditionalDataPagination.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start** | **Number** | Pagination start | [optional] **limit** | **Number** | Items shown per page | [optional] -**moreItemsInCollection** | **Boolean** | Whether there are more list items in the collection than displayed | [optional] -**nextStart** | **Number** | Next pagination start | [optional] +**more_items_in_collection** | **Boolean** | Whether there are more list items in the collection than displayed | [optional] +**next_start** | **Number** | Next pagination start | [optional] diff --git a/docs/ItemSearchApi.md b/docs/ItemSearchApi.md index 3ad510d7..0f4c7fdd 100644 --- a/docs/ItemSearchApi.md +++ b/docs/ItemSearchApi.md @@ -33,6 +33,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.ItemSearchApi(apiClient); let term = "term_example"; // String | The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'itemTypes': "itemTypes_example", // String | A comma-separated string array. The type of items to perform the search from. Defaults to all. 'fields': "fields_example", // String | A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:
Item typeField
Deal`custom_fields`, `notes`, `title`
Person`custom_fields`, `email`, `name`, `notes`, `phone`
Organization`address`, `custom_fields`, `name`, `notes`
Product`code`, `custom_fields`, `name`
Lead`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`
File`name`
Mail attachment`name`
Project `custom_fields`, `notes`, `title`, `description`

Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields here.
When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`. @@ -56,11 +57,11 @@ apiInstance.searchItem(term, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. | - **itemTypes** | **String**| A comma-separated string array. The type of items to perform the search from. Defaults to all. | [optional] + **item_types** | **String**| A comma-separated string array. The type of items to perform the search from. Defaults to all. | [optional] **fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<br/> When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`. | [optional] - **searchForRelatedItems** | **Boolean**| When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization | [optional] - **exactMatch** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] - **includeFields** | **String**| A comma-separated string array. Supports including optional fields in the results which are not provided by default. | [optional] + **search_for_related_items** | **Boolean**| When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization | [optional] + **exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] + **include_fields** | **String**| A comma-separated string array. Supports including optional fields in the results which are not provided by default. | [optional] **start** | **Number**| Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] @@ -104,6 +105,7 @@ let apiInstance = new Pipedrive.ItemSearchApi(apiClient); let term = "term_example"; // String | The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. let fieldType = "fieldType_example"; // String | The type of the field to perform the search from let fieldKey = "fieldKey_example"; // String | The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields here. +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'exactMatch': false, // Boolean | When enabled, only full exact matches against the given term are returned. The search is case sensitive. 'returnItemIds': true, // Boolean | Whether to return the IDs of the matching items or not. When not set or set to `0` or `false`, only distinct values of the searched field are returned. When set to `1` or `true`, the ID of each found item is returned. @@ -124,10 +126,10 @@ apiInstance.searchItemByField(term, fieldType, fieldKey, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. | - **fieldType** | **String**| The type of the field to perform the search from | - **fieldKey** | **String**| The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. | - **exactMatch** | **Boolean**| When enabled, only full exact matches against the given term are returned. The search <b>is</b> case sensitive. | [optional] [default to false] - **returnItemIds** | **Boolean**| Whether to return the IDs of the matching items or not. When not set or set to `0` or `false`, only distinct values of the searched field are returned. When set to `1` or `true`, the ID of each found item is returned. | [optional] + **field_type** | **String**| The type of the field to perform the search from | + **field_key** | **String**| The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. | + **exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. The search <b>is</b> case sensitive. | [optional] [default to false] + **return_item_ids** | **Boolean**| Whether to return the IDs of the matching items or not. When not set or set to `0` or `false`, only distinct values of the searched field are returned. When set to `1` or `true`, the ID of each found item is returned. | [optional] **start** | **Number**| Pagination start | [optional] **limit** | **Number**| Items shown per page | [optional] diff --git a/docs/ItemSearchFieldResponse.md b/docs/ItemSearchFieldResponse.md index 5cddaf9d..5a0e7ee7 100644 --- a/docs/ItemSearchFieldResponse.md +++ b/docs/ItemSearchFieldResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ItemSearchFieldResponseAllOfData]**](ItemSearchFieldResponseAllOfData.md) | The array of results | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/ItemSearchFieldResponseAllOf.md b/docs/ItemSearchFieldResponseAllOf.md index c52a4368..366b5ed3 100644 --- a/docs/ItemSearchFieldResponseAllOf.md +++ b/docs/ItemSearchFieldResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[ItemSearchFieldResponseAllOfData]**](ItemSearchFieldResponseAllOfData.md) | The array of results | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/ItemSearchFieldResponseAllOfData.md b/docs/ItemSearchFieldResponseAllOfData.md index 860a5efb..9d9f6051 100644 --- a/docs/ItemSearchFieldResponseAllOfData.md +++ b/docs/ItemSearchFieldResponseAllOfData.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the item | [optional] -**fieldKey** | **Object** | The value of the searched `field_key` | [optional] +**$field_key** | **Object** | The value of the searched `field_key` | [optional] diff --git a/docs/ItemSearchItem.md b/docs/ItemSearchItem.md index f6b71c0c..6fe0f4f2 100644 --- a/docs/ItemSearchItem.md +++ b/docs/ItemSearchItem.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultScore** | **Number** | Search result relevancy | [optional] +**result_score** | **Number** | Search result relevancy | [optional] **item** | **Object** | Item | [optional] diff --git a/docs/ItemSearchResponse.md b/docs/ItemSearchResponse.md index 2fa22440..7a473c83 100644 --- a/docs/ItemSearchResponse.md +++ b/docs/ItemSearchResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**ItemSearchResponseAllOfData**](ItemSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/ItemSearchResponseAllOf.md b/docs/ItemSearchResponseAllOf.md index 822795c2..a3f90aaa 100644 --- a/docs/ItemSearchResponseAllOf.md +++ b/docs/ItemSearchResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**ItemSearchResponseAllOfData**](ItemSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/ItemSearchResponseAllOfData.md b/docs/ItemSearchResponseAllOfData.md index e72c3eb5..7e36d673 100644 --- a/docs/ItemSearchResponseAllOfData.md +++ b/docs/ItemSearchResponseAllOfData.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **items** | [**[ItemSearchItem]**](ItemSearchItem.md) | The array of found items | [optional] -**relatedItems** | [**[ItemSearchItem]**](ItemSearchItem.md) | The array of related items if `search_for_related_items` was enabled | [optional] +**related_items** | [**[ItemSearchItem]**](ItemSearchItem.md) | The array of related items if `search_for_related_items` was enabled | [optional] diff --git a/docs/LeadLabelResponse.md b/docs/LeadLabelResponse.md index 255aef7c..9554b088 100644 --- a/docs/LeadLabelResponse.md +++ b/docs/LeadLabelResponse.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **id** | **String** | The unique ID of the lead label | [optional] **name** | **String** | The name of the lead label | [optional] **color** | [**LeadLabelColor**](LeadLabelColor.md) | | [optional] -**addTime** | **Date** | The date and time of when the lead label was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. | [optional] -**updateTime** | **Date** | The date and time of when the lead label was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. | [optional] +**add_time** | **Date** | The date and time of when the lead label was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. | [optional] +**update_time** | **Date** | The date and time of when the lead label was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. | [optional] diff --git a/docs/LeadLabelsApi.md b/docs/LeadLabelsApi.md index 3d7668da..406becfb 100644 --- a/docs/LeadLabelsApi.md +++ b/docs/LeadLabelsApi.md @@ -50,7 +50,7 @@ apiInstance.addLeadLabel(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **addLeadLabelRequest** | [**AddLeadLabelRequest**](AddLeadLabelRequest.md)| | [optional] + **AddLeadLabelRequest** | [**AddLeadLabelRequest**](AddLeadLabelRequest.md)| | [optional] ### Return type @@ -209,7 +209,7 @@ apiInstance.updateLeadLabel(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| The ID of the lead label | - **updateLeadLabelRequest** | [**UpdateLeadLabelRequest**](UpdateLeadLabelRequest.md)| | [optional] + **UpdateLeadLabelRequest** | [**UpdateLeadLabelRequest**](UpdateLeadLabelRequest.md)| | [optional] ### Return type diff --git a/docs/LeadResponse.md b/docs/LeadResponse.md index 75a389ac..4b4e13d3 100644 --- a/docs/LeadResponse.md +++ b/docs/LeadResponse.md @@ -6,24 +6,24 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The unique ID of the lead in the UUID format | [optional] **title** | **String** | The title of the lead | [optional] -**ownerId** | **Number** | The ID of the user who owns the lead | [optional] -**creatorId** | **Number** | The ID of the user who created the lead | [optional] -**labelIds** | **[String]** | The IDs of the lead labels which are associated with the lead | [optional] -**personId** | **Number** | The ID of a person which this lead is linked to | [optional] -**organizationId** | **Number** | The ID of an organization which this lead is linked to | [optional] -**sourceName** | **String** | Defines where the lead comes from. Will be `API` if the lead was created through the Public API and will be `Manually created` if the lead was created manually through the UI. | [optional] +**owner_id** | **Number** | The ID of the user who owns the lead | [optional] +**creator_id** | **Number** | The ID of the user who created the lead | [optional] +**label_ids** | **[String]** | The IDs of the lead labels which are associated with the lead | [optional] +**person_id** | **Number** | The ID of a person which this lead is linked to | [optional] +**organization_id** | **Number** | The ID of an organization which this lead is linked to | [optional] +**source_name** | **String** | Defines where the lead comes from. Will be `API` if the lead was created through the Public API and will be `Manually created` if the lead was created manually through the UI. | [optional] **origin** | **String** | The way this Lead was created. `origin` field is set by Pipedrive when Lead is created and cannot be changed. | [optional] -**originId** | **String** | The optional ID to further distinguish the origin of the lead - e.g. Which API integration created this Lead. | [optional] +**origin_id** | **String** | The optional ID to further distinguish the origin of the lead - e.g. Which API integration created this Lead. | [optional] **channel** | **Number** | The ID of your Marketing channel this Lead was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] -**isArchived** | **Boolean** | A flag indicating whether the lead is archived or not | [optional] -**wasSeen** | **Boolean** | A flag indicating whether the lead was seen by someone in the Pipedrive UI | [optional] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**is_archived** | **Boolean** | A flag indicating whether the lead is archived or not | [optional] +**was_seen** | **Boolean** | A flag indicating whether the lead was seen by someone in the Pipedrive UI | [optional] **value** | [**LeadValue**](LeadValue.md) | | [optional] -**expectedCloseDate** | **Date** | The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD. | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the lead | [optional] -**addTime** | **Date** | The date and time of when the lead was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. | [optional] -**updateTime** | **Date** | The date and time of when the lead was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers (private)</td></tr><tr><td>`3`</td><td>Entire company (shared)</td></tr></table> | [optional] -**ccEmail** | **String** | The BCC email of the lead | [optional] +**expected_close_date** | **Date** | The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD. | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the lead | [optional] +**add_time** | **Date** | The date and time of when the lead was created. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. | [optional] +**update_time** | **Date** | The date and time of when the lead was last updated. In ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers (private)</td></tr><tr><td>`3`</td><td>Entire company (shared)</td></tr></table> | [optional] +**cc_email** | **String** | The BCC email of the lead | [optional] diff --git a/docs/LeadResponse404.md b/docs/LeadResponse404.md index 4c1c550b..fe863cd0 100644 --- a/docs/LeadResponse404.md +++ b/docs/LeadResponse404.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **error** | **String** | The description of the error | [optional] -**errorInfo** | **String** | A message describing how to solve the problem | [optional] +**error_info** | **String** | A message describing how to solve the problem | [optional] **data** | **Object** | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/LeadSearchItem.md b/docs/LeadSearchItem.md index 507bf2d4..a75fa1c0 100644 --- a/docs/LeadSearchItem.md +++ b/docs/LeadSearchItem.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultScore** | **Number** | Search result relevancy | [optional] +**result_score** | **Number** | Search result relevancy | [optional] **item** | [**LeadSearchItemItem**](LeadSearchItemItem.md) | | [optional] diff --git a/docs/LeadSearchItemItem.md b/docs/LeadSearchItemItem.md index 1613c76d..7145393b 100644 --- a/docs/LeadSearchItemItem.md +++ b/docs/LeadSearchItemItem.md @@ -12,11 +12,11 @@ Name | Type | Description | Notes **organization** | [**LeadSearchItemItemOrganization**](LeadSearchItemItemOrganization.md) | | [optional] **phones** | **[String]** | | [optional] **emails** | **[String]** | | [optional] -**customFields** | **[String]** | Custom fields | [optional] +**custom_fields** | **[String]** | Custom fields | [optional] **notes** | **[String]** | An array of notes | [optional] **value** | **Number** | The value of the lead | [optional] **currency** | **String** | The currency of the lead | [optional] -**visibleTo** | **Number** | The visibility of the lead | [optional] -**isArchived** | **Boolean** | A flag indicating whether the lead is archived or not | [optional] +**visible_to** | **Number** | The visibility of the lead | [optional] +**is_archived** | **Boolean** | A flag indicating whether the lead is archived or not | [optional] diff --git a/docs/LeadSearchResponse.md b/docs/LeadSearchResponse.md index fb72e535..d7c4ffe3 100644 --- a/docs/LeadSearchResponse.md +++ b/docs/LeadSearchResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**LeadSearchResponseAllOfData**](LeadSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/LeadSearchResponseAllOf.md b/docs/LeadSearchResponseAllOf.md index b2f11e2e..e3b9bddb 100644 --- a/docs/LeadSearchResponseAllOf.md +++ b/docs/LeadSearchResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**LeadSearchResponseAllOfData**](LeadSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/LeadsApi.md b/docs/LeadsApi.md index b6e30c95..2e8e2896 100644 --- a/docs/LeadsApi.md +++ b/docs/LeadsApi.md @@ -53,7 +53,7 @@ apiInstance.addLead(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **addLeadRequest** | [**AddLeadRequest**](AddLeadRequest.md)| | [optional] + **AddLeadRequest** | [**AddLeadRequest**](AddLeadRequest.md)| | [optional] ### Return type @@ -251,6 +251,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.LeadsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'limit': 100, // Number | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. 'start': 0, // Number | For pagination, the position that represents the first result for the page @@ -276,11 +277,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Number**| For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. | [optional] **start** | **Number**| For pagination, the position that represents the first result for the page | [optional] - **archivedStatus** | **String**| Filtering based on the archived status of a lead. If not provided, `All` is used. | [optional] - **ownerId** | **Number**| If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied. | [optional] - **personId** | **Number**| If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied. | [optional] - **organizationId** | **Number**| If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied. | [optional] - **filterId** | **Number**| The ID of the filter to use | [optional] + **archived_status** | **String**| Filtering based on the archived status of a lead. If not provided, `All` is used. | [optional] + **owner_id** | **Number**| If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied. | [optional] + **person_id** | **Number**| If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied. | [optional] + **organization_id** | **Number**| If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied. | [optional] + **filter_id** | **Number**| The ID of the filter to use | [optional] **sort** | **String**| 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). | [optional] ### Return type @@ -321,6 +322,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.LeadsApi(apiClient); let term = "term_example"; // String | The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'fields': "fields_example", // String | A comma-separated string array. The fields to perform the search from. Defaults to all of them. 'exactMatch': true, // Boolean | When enabled, only full exact matches against the given term are returned. It is not case sensitive. @@ -345,10 +347,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. | **fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all of them. | [optional] - **exactMatch** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] - **personId** | **Number**| Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000. | [optional] - **organizationId** | **Number**| Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000. | [optional] - **includeFields** | **String**| Supports including optional fields in the results which are not provided by default | [optional] + **exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] + **person_id** | **Number**| Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000. | [optional] + **organization_id** | **Number**| Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000. | [optional] + **include_fields** | **String**| Supports including optional fields in the results which are not provided by default | [optional] **start** | **Number**| Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] @@ -407,7 +409,7 @@ apiInstance.updateLead(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| The ID of the lead | - **updateLeadRequest** | [**UpdateLeadRequest**](UpdateLeadRequest.md)| | [optional] + **UpdateLeadRequest** | [**UpdateLeadRequest**](UpdateLeadRequest.md)| | [optional] ### Return type diff --git a/docs/LegacyTeamsApi.md b/docs/LegacyTeamsApi.md index a4a2d481..6e59a463 100644 --- a/docs/LegacyTeamsApi.md +++ b/docs/LegacyTeamsApi.md @@ -54,7 +54,7 @@ apiInstance.addTeam(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **createTeam** | [**CreateTeam**](CreateTeam.md)| | [optional] + **CreateTeam** | [**CreateTeam**](CreateTeam.md)| | [optional] ### Return type @@ -111,7 +111,7 @@ apiInstance.addTeamUser(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the team | - **addTeamUserRequest** | [**AddTeamUserRequest**](AddTeamUserRequest.md)| | [optional] + **AddTeamUserRequest** | [**AddTeamUserRequest**](AddTeamUserRequest.md)| | [optional] ### Return type @@ -168,7 +168,7 @@ apiInstance.deleteTeamUser(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the team | - **deleteTeamUserRequest** | [**DeleteTeamUserRequest**](DeleteTeamUserRequest.md)| | [optional] + **DeleteTeamUserRequest** | [**DeleteTeamUserRequest**](DeleteTeamUserRequest.md)| | [optional] ### Return type @@ -208,6 +208,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.LegacyTeamsApi(apiClient); let id = 56; // Number | The ID of the team +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'skipUsers': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | When enabled, the teams will not include IDs of member users }; @@ -225,7 +226,7 @@ apiInstance.getTeam(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the team | - **skipUsers** | [**NumberBooleanDefault0**](.md)| When enabled, the teams will not include IDs of member users | [optional] + **skip_users** | [**NumberBooleanDefault0**](.md)| When enabled, the teams will not include IDs of member users | [optional] ### Return type @@ -317,6 +318,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.LegacyTeamsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'orderBy': "'id'", // String | The field name to sort returned teams by 'skipUsers': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | When enabled, the teams will not include IDs of member users @@ -334,8 +336,8 @@ apiInstance.getTeams(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderBy** | **String**| The field name to sort returned teams by | [optional] [default to 'id'] - **skipUsers** | [**NumberBooleanDefault0**](.md)| When enabled, the teams will not include IDs of member users | [optional] + **order_by** | **String**| The field name to sort returned teams by | [optional] [default to 'id'] + **skip_users** | [**NumberBooleanDefault0**](.md)| When enabled, the teams will not include IDs of member users | [optional] ### Return type @@ -375,6 +377,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.LegacyTeamsApi(apiClient); let id = 56; // Number | The ID of the user +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'orderBy': "'id'", // String | The field name to sort returned teams by 'skipUsers': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | When enabled, the teams will not include IDs of member users @@ -393,8 +396,8 @@ apiInstance.getUserTeams(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the user | - **orderBy** | **String**| The field name to sort returned teams by | [optional] [default to 'id'] - **skipUsers** | [**NumberBooleanDefault0**](.md)| When enabled, the teams will not include IDs of member users | [optional] + **order_by** | **String**| The field name to sort returned teams by | [optional] [default to 'id'] + **skip_users** | [**NumberBooleanDefault0**](.md)| When enabled, the teams will not include IDs of member users | [optional] ### Return type @@ -451,7 +454,7 @@ apiInstance.updateTeam(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the team | - **updateTeam** | [**UpdateTeam**](UpdateTeam.md)| | [optional] + **UpdateTeam** | [**UpdateTeam**](UpdateTeam.md)| | [optional] ### Return type diff --git a/docs/ListActivitiesResponse.md b/docs/ListActivitiesResponse.md index 3d09f17a..383adfe1 100644 --- a/docs/ListActivitiesResponse.md +++ b/docs/ListActivitiesResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ActivityResponseObject]**](ActivityResponseObject.md) | The array of activities | [optional] -**additionalData** | [**ActivityDistributionDataWithAdditionalData**](ActivityDistributionDataWithAdditionalData.md) | | [optional] +**additional_data** | [**ActivityDistributionDataWithAdditionalData**](ActivityDistributionDataWithAdditionalData.md) | | [optional] diff --git a/docs/ListActivitiesResponseAllOf.md b/docs/ListActivitiesResponseAllOf.md index e439b55e..ca233bee 100644 --- a/docs/ListActivitiesResponseAllOf.md +++ b/docs/ListActivitiesResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[ActivityResponseObject]**](ActivityResponseObject.md) | The array of activities | [optional] -**additionalData** | [**ActivityDistributionDataWithAdditionalData**](ActivityDistributionDataWithAdditionalData.md) | | [optional] +**additional_data** | [**ActivityDistributionDataWithAdditionalData**](ActivityDistributionDataWithAdditionalData.md) | | [optional] diff --git a/docs/ListDealsResponse.md b/docs/ListDealsResponse.md index b498d1a6..9dc38c2c 100644 --- a/docs/ListDealsResponse.md +++ b/docs/ListDealsResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[DealNonStrict]**](DealNonStrict.md) | The array of deals | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**ListDealsResponseAllOfRelatedObjects**](ListDealsResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**ListDealsResponseAllOfRelatedObjects**](ListDealsResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/ListDealsResponseAllOf.md b/docs/ListDealsResponseAllOf.md index bdfdd9e9..d595cbbc 100644 --- a/docs/ListDealsResponseAllOf.md +++ b/docs/ListDealsResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[DealNonStrict]**](DealNonStrict.md) | The array of deals | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**ListDealsResponseAllOfRelatedObjects**](ListDealsResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**ListDealsResponseAllOfRelatedObjects**](ListDealsResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/ListFilesResponse.md b/docs/ListFilesResponse.md index 37744353..ef24f912 100644 --- a/docs/ListFilesResponse.md +++ b/docs/ListFilesResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[FileItem]**](FileItem.md) | The array of files | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/ListFilesResponseAllOf.md b/docs/ListFilesResponseAllOf.md index ac8ea1d1..442f9f99 100644 --- a/docs/ListFilesResponseAllOf.md +++ b/docs/ListFilesResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[FileItem]**](FileItem.md) | The array of files | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/ListFollowersResponse.md b/docs/ListFollowersResponse.md index 9b840229..7c666527 100644 --- a/docs/ListFollowersResponse.md +++ b/docs/ListFollowersResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ListFollowersResponseAllOfData]**](ListFollowersResponseAllOfData.md) | The list of followers | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/ListFollowersResponseAllOf.md b/docs/ListFollowersResponseAllOf.md index 323c72c7..bd09f856 100644 --- a/docs/ListFollowersResponseAllOf.md +++ b/docs/ListFollowersResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[ListFollowersResponseAllOfData]**](ListFollowersResponseAllOfData.md) | The list of followers | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/ListFollowersResponseAllOfData.md b/docs/ListFollowersResponseAllOfData.md index e0dc41ae..d7ebe3f3 100644 --- a/docs/ListFollowersResponseAllOfData.md +++ b/docs/ListFollowersResponseAllOfData.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user | [optional] +**user_id** | **Number** | The ID of the user | [optional] **id** | **Number** | The ID of the user follower | [optional] -**dealId** | **Number** | The ID of the deal which the follower was added to | [optional] -**addTime** | **String** | The date and time when the follower was added to the person | [optional] +**deal_id** | **Number** | The ID of the deal which the follower was added to | [optional] +**add_time** | **String** | The date and time when the follower was added to the person | [optional] diff --git a/docs/ListMailMessagesResponse.md b/docs/ListMailMessagesResponse.md index d666f4a4..e44e1baf 100644 --- a/docs/ListMailMessagesResponse.md +++ b/docs/ListMailMessagesResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ListMailMessagesResponseAllOfData]**](ListMailMessagesResponseAllOfData.md) | The array of mail messages | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/ListMailMessagesResponseAllOf.md b/docs/ListMailMessagesResponseAllOf.md index d768b47b..9ff6f537 100644 --- a/docs/ListMailMessagesResponseAllOf.md +++ b/docs/ListMailMessagesResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[ListMailMessagesResponseAllOfData]**](ListMailMessagesResponseAllOfData.md) | The array of mail messages | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/ListPersonProductsResponse.md b/docs/ListPersonProductsResponse.md index b66572aa..13d318af 100644 --- a/docs/ListPersonProductsResponse.md +++ b/docs/ListPersonProductsResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ListPersonProductsResponseAllOfData]**](ListPersonProductsResponseAllOfData.md) | The array of deal products | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/ListPersonProductsResponseAllOf.md b/docs/ListPersonProductsResponseAllOf.md index f1256def..4e5388cb 100644 --- a/docs/ListPersonProductsResponseAllOf.md +++ b/docs/ListPersonProductsResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[ListPersonProductsResponseAllOfData]**](ListPersonProductsResponseAllOfData.md) | The array of deal products | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/ListPersonsResponse.md b/docs/ListPersonsResponse.md index 42f70239..f5dd4729 100644 --- a/docs/ListPersonsResponse.md +++ b/docs/ListPersonsResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[PersonItem]**](PersonItem.md) | The array of persons | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**ListPersonsResponseAllOfRelatedObjects**](ListPersonsResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**ListPersonsResponseAllOfRelatedObjects**](ListPersonsResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/ListPersonsResponseAllOf.md b/docs/ListPersonsResponseAllOf.md index 3a186546..38754e82 100644 --- a/docs/ListPersonsResponseAllOf.md +++ b/docs/ListPersonsResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[PersonItem]**](PersonItem.md) | The array of persons | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**ListPersonsResponseAllOfRelatedObjects**](ListPersonsResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**ListPersonsResponseAllOfRelatedObjects**](ListPersonsResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/ListProductAdditionalData.md b/docs/ListProductAdditionalData.md index 70030dfc..95eb60dd 100644 --- a/docs/ListProductAdditionalData.md +++ b/docs/ListProductAdditionalData.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productsQuantityTotal** | **Number** | The total quantity of the products | [optional] -**productsSumTotal** | **Number** | The total sum of the products | [optional] -**productsQuantityTotalFormatted** | **String** | The total formatted quantity of the products | [optional] -**productsSumTotalFormatted** | **String** | The total formatted sum of the products | [optional] +**products_quantity_total** | **Number** | The total quantity of the products | [optional] +**products_sum_total** | **Number** | The total sum of the products | [optional] +**products_quantity_total_formatted** | **String** | The total formatted quantity of the products | [optional] +**products_sum_total_formatted** | **String** | The total formatted sum of the products | [optional] **pagination** | [**ItemSearchAdditionalDataPagination**](ItemSearchAdditionalDataPagination.md) | | [optional] diff --git a/docs/ListProductAdditionalDataAllOf.md b/docs/ListProductAdditionalDataAllOf.md index 5ddf1c93..0b2b7c50 100644 --- a/docs/ListProductAdditionalDataAllOf.md +++ b/docs/ListProductAdditionalDataAllOf.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productsQuantityTotal** | **Number** | The total quantity of the products | [optional] -**productsSumTotal** | **Number** | The total sum of the products | [optional] -**productsQuantityTotalFormatted** | **String** | The total formatted quantity of the products | [optional] -**productsSumTotalFormatted** | **String** | The total formatted sum of the products | [optional] +**products_quantity_total** | **Number** | The total quantity of the products | [optional] +**products_sum_total** | **Number** | The total sum of the products | [optional] +**products_quantity_total_formatted** | **String** | The total formatted quantity of the products | [optional] +**products_sum_total_formatted** | **String** | The total formatted sum of the products | [optional] diff --git a/docs/ListProductFilesResponse.md b/docs/ListProductFilesResponse.md index 40b1d2ba..1e2c3417 100644 --- a/docs/ListProductFilesResponse.md +++ b/docs/ListProductFilesResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ProductFileItem]**](ProductFileItem.md) | The array of files | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/ListProductFilesResponseAllOf.md b/docs/ListProductFilesResponseAllOf.md index a00c1564..15d73167 100644 --- a/docs/ListProductFilesResponseAllOf.md +++ b/docs/ListProductFilesResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[ProductFileItem]**](ProductFileItem.md) | The array of files | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/ListProductFollowersResponse.md b/docs/ListProductFollowersResponse.md index 1945066a..8c19e8b7 100644 --- a/docs/ListProductFollowersResponse.md +++ b/docs/ListProductFollowersResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ListProductFollowersResponseAllOfData]**](ListProductFollowersResponseAllOfData.md) | The list of followers | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/ListProductFollowersResponseAllOf.md b/docs/ListProductFollowersResponseAllOf.md index 5baa9317..3c78d0d9 100644 --- a/docs/ListProductFollowersResponseAllOf.md +++ b/docs/ListProductFollowersResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[ListProductFollowersResponseAllOfData]**](ListProductFollowersResponseAllOfData.md) | The list of followers | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/ListProductFollowersResponseAllOfData.md b/docs/ListProductFollowersResponseAllOfData.md index 88377754..73b24a99 100644 --- a/docs/ListProductFollowersResponseAllOfData.md +++ b/docs/ListProductFollowersResponseAllOfData.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user | [optional] +**user_id** | **Number** | The ID of the user | [optional] **id** | **Number** | The ID of the user follower | [optional] -**productId** | **Number** | The ID of the product | [optional] -**addTime** | **String** | The date and time when the follower was added to the person | [optional] +**product_id** | **Number** | The ID of the product | [optional] +**add_time** | **String** | The date and time when the follower was added to the person | [optional] diff --git a/docs/ListProductsResponse.md b/docs/ListProductsResponse.md index 9c51847c..78312dd6 100644 --- a/docs/ListProductsResponse.md +++ b/docs/ListProductsResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ProductListItem]**](ProductListItem.md) | The array of products | [optional] -**additionalData** | [**ListProductAdditionalData**](ListProductAdditionalData.md) | | [optional] -**relatedObjects** | [**ListProductsResponseAllOfRelatedObjects**](ListProductsResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**ListProductAdditionalData**](ListProductAdditionalData.md) | | [optional] +**related_objects** | [**ListProductsResponseAllOfRelatedObjects**](ListProductsResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/ListProductsResponseAllOf.md b/docs/ListProductsResponseAllOf.md index f1579e2e..de3385b7 100644 --- a/docs/ListProductsResponseAllOf.md +++ b/docs/ListProductsResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[ProductListItem]**](ProductListItem.md) | The array of products | [optional] -**additionalData** | [**ListProductAdditionalData**](ListProductAdditionalData.md) | | [optional] -**relatedObjects** | [**ListProductsResponseAllOfRelatedObjects**](ListProductsResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**ListProductAdditionalData**](ListProductAdditionalData.md) | | [optional] +**related_objects** | [**ListProductsResponseAllOfRelatedObjects**](ListProductsResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/MailMessageData.md b/docs/MailMessageData.md index 444ddfed..eedabe90 100644 --- a/docs/MailMessageData.md +++ b/docs/MailMessageData.md @@ -9,29 +9,29 @@ Name | Type | Description | Notes **to** | [**[MailParticipant]**](MailParticipant.md) | The array of mail message receiver (object) | [optional] **cc** | [**[MailParticipant]**](MailParticipant.md) | The array of mail message copies (object) | [optional] **bcc** | [**[MailParticipant]**](MailParticipant.md) | The array of mail message blind copies (object) | [optional] -**bodyUrl** | **String** | The mail message body URL | [optional] -**accountId** | **String** | The connection account ID | [optional] -**userId** | **Number** | ID of the user whom mail message will be assigned to | [optional] -**mailThreadId** | **Number** | ID of the mail message thread | [optional] +**body_url** | **String** | The mail message body URL | [optional] +**account_id** | **String** | The connection account ID | [optional] +**user_id** | **Number** | ID of the user whom mail message will be assigned to | [optional] +**mail_thread_id** | **Number** | ID of the mail message thread | [optional] **subject** | **String** | The subject of mail message | [optional] **snippet** | **String** | The snippet of mail message. Snippet length is up to 225 characters. | [optional] -**mailTrackingStatus** | **String** | The status of tracking mail message. Value is `null` if tracking is not enabled. | [optional] -**mailLinkTrackingEnabledFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the link tracking in mail message body is enabled. | [optional] -**readFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is read or not by the user | [optional] +**mail_tracking_status** | **String** | The status of tracking mail message. Value is `null` if tracking is not enabled. | [optional] +**mail_link_tracking_enabled_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the link tracking in mail message body is enabled. | [optional] +**read_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is read or not by the user | [optional] **draft** | **String** | If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise `null`. | [optional] -**draftFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is a draft or not | [optional] -**syncedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is synced with the provider or not | [optional] -**deletedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is deleted or not | [optional] -**hasBodyFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has a body or not | [optional] -**sentFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been sent or not | [optional] -**sentFromPipedriveFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been sent from Pipedrive app or not | [optional] -**smartBccFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been created by Smart Email BCC feature or not | [optional] -**messageTime** | **Date** | Creation or receival time of the mail message | [optional] -**addTime** | **Date** | The insertion into the database time of the mail message | [optional] -**updateTime** | **Date** | The updating time in the database of the mail message | [optional] -**hasAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an attachment or not | [optional] -**hasInlineAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an inline attachment or not | [optional] -**hasRealAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an attachment (which is not inline) or not | [optional] +**draft_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is a draft or not | [optional] +**synced_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is synced with the provider or not | [optional] +**deleted_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is deleted or not | [optional] +**has_body_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has a body or not | [optional] +**sent_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been sent or not | [optional] +**sent_from_pipedrive_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been sent from Pipedrive app or not | [optional] +**smart_bcc_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been created by Smart Email BCC feature or not | [optional] +**message_time** | **Date** | Creation or receival time of the mail message | [optional] +**add_time** | **Date** | The insertion into the database time of the mail message | [optional] +**update_time** | **Date** | The updating time in the database of the mail message | [optional] +**has_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an attachment or not | [optional] +**has_inline_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an inline attachment or not | [optional] +**has_real_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an attachment (which is not inline) or not | [optional] diff --git a/docs/MailMessageItemForList.md b/docs/MailMessageItemForList.md index ad694833..a945a8b9 100644 --- a/docs/MailMessageItemForList.md +++ b/docs/MailMessageItemForList.md @@ -9,38 +9,38 @@ Name | Type | Description | Notes **to** | [**[MailParticipant]**](MailParticipant.md) | The array of mail message receiver (object) | [optional] **cc** | [**[MailParticipant]**](MailParticipant.md) | The array of mail message copies (object) | [optional] **bcc** | [**[MailParticipant]**](MailParticipant.md) | The array of mail message blind copies (object) | [optional] -**bodyUrl** | **String** | The mail message body URL | [optional] -**accountId** | **String** | The connection account ID | [optional] -**userId** | **Number** | ID of the user whom mail message will be assigned to | [optional] -**mailThreadId** | **Number** | ID of the mail message thread | [optional] +**body_url** | **String** | The mail message body URL | [optional] +**account_id** | **String** | The connection account ID | [optional] +**user_id** | **Number** | ID of the user whom mail message will be assigned to | [optional] +**mail_thread_id** | **Number** | ID of the mail message thread | [optional] **subject** | **String** | The subject of mail message | [optional] **snippet** | **String** | The snippet of mail message. Snippet length is up to 225 characters. | [optional] -**mailTrackingStatus** | **String** | The status of tracking mail message. Value is `null` if tracking is not enabled. | [optional] -**mailLinkTrackingEnabledFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the link tracking in mail message body is enabled. | [optional] -**readFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is read or not by the user | [optional] +**mail_tracking_status** | **String** | The status of tracking mail message. Value is `null` if tracking is not enabled. | [optional] +**mail_link_tracking_enabled_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the link tracking in mail message body is enabled. | [optional] +**read_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is read or not by the user | [optional] **draft** | **String** | If the mail message has a draft status then the value is the mail message object as JSON formatted string, otherwise `null`. | [optional] -**draftFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is a draft or not | [optional] -**syncedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is synced with the provider or not | [optional] -**deletedFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is deleted or not | [optional] -**hasBodyFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has a body or not | [optional] -**sentFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been sent or not | [optional] -**sentFromPipedriveFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been sent from Pipedrive app or not | [optional] -**smartBccFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been created by Smart Email BCC feature or not | [optional] -**messageTime** | **Date** | Creation or receival time of the mail message | [optional] -**addTime** | **Date** | The insertion into the database time of the mail message | [optional] -**updateTime** | **Date** | The updating time in the database of the mail message | [optional] -**hasAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an attachment or not | [optional] -**hasInlineAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an inline attachment or not | [optional] -**hasRealAttachmentsFlag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an attachment (which is not inline) or not | [optional] -**nylasId** | **String** | The Mail Message ID assigned by the sync provider | [optional] -**s3Bucket** | **String** | The name of the S3 bucket | [optional] -**s3BucketPath** | **String** | The path of the S3 bucket | [optional] -**externalDeletedFlag** | **Boolean** | If the Mail Message has been deleted on the provider side or not | [optional] -**muaMessageId** | **String** | The Mail Message ID assigned by the mail user agent | [optional] -**templateId** | **Number** | The ID of the mail template | [optional] +**draft_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is a draft or not | [optional] +**synced_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is synced with the provider or not | [optional] +**deleted_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message is deleted or not | [optional] +**has_body_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has a body or not | [optional] +**sent_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been sent or not | [optional] +**sent_from_pipedrive_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been sent from Pipedrive app or not | [optional] +**smart_bcc_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has been created by Smart Email BCC feature or not | [optional] +**message_time** | **Date** | Creation or receival time of the mail message | [optional] +**add_time** | **Date** | The insertion into the database time of the mail message | [optional] +**update_time** | **Date** | The updating time in the database of the mail message | [optional] +**has_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an attachment or not | [optional] +**has_inline_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an inline attachment or not | [optional] +**has_real_attachments_flag** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md) | Whether the mail message has an attachment (which is not inline) or not | [optional] +**nylas_id** | **String** | The Mail Message ID assigned by the sync provider | [optional] +**s3_bucket** | **String** | The name of the S3 bucket | [optional] +**s3_bucket_path** | **String** | The path of the S3 bucket | [optional] +**external_deleted_flag** | **Boolean** | If the Mail Message has been deleted on the provider side or not | [optional] +**mua_message_id** | **String** | The Mail Message ID assigned by the mail user agent | [optional] +**template_id** | **Number** | The ID of the mail template | [optional] **timestamp** | **String** | The add date and time of the Mail Message | [optional] -**itemType** | **String** | The type of the data item | [optional] -**companyId** | **Number** | The ID of the company | [optional] +**item_type** | **String** | The type of the data item | [optional] +**company_id** | **Number** | The ID of the company | [optional] diff --git a/docs/MailMessageItemForListAllOf.md b/docs/MailMessageItemForListAllOf.md index a683a2ca..164bd2e2 100644 --- a/docs/MailMessageItemForListAllOf.md +++ b/docs/MailMessageItemForListAllOf.md @@ -4,14 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**nylasId** | **String** | The Mail Message ID assigned by the sync provider | [optional] -**s3Bucket** | **String** | The name of the S3 bucket | [optional] -**s3BucketPath** | **String** | The path of the S3 bucket | [optional] -**externalDeletedFlag** | **Boolean** | If the Mail Message has been deleted on the provider side or not | [optional] -**muaMessageId** | **String** | The Mail Message ID assigned by the mail user agent | [optional] -**templateId** | **Number** | The ID of the mail template | [optional] +**nylas_id** | **String** | The Mail Message ID assigned by the sync provider | [optional] +**s3_bucket** | **String** | The name of the S3 bucket | [optional] +**s3_bucket_path** | **String** | The path of the S3 bucket | [optional] +**external_deleted_flag** | **Boolean** | If the Mail Message has been deleted on the provider side or not | [optional] +**mua_message_id** | **String** | The Mail Message ID assigned by the mail user agent | [optional] +**template_id** | **Number** | The ID of the mail template | [optional] **timestamp** | **String** | The add date and time of the Mail Message | [optional] -**itemType** | **String** | The type of the data item | [optional] -**companyId** | **Number** | The ID of the company | [optional] +**item_type** | **String** | The type of the data item | [optional] +**company_id** | **Number** | The ID of the company | [optional] diff --git a/docs/MailParticipant.md b/docs/MailParticipant.md index 4b1e3a86..c7839f1b 100644 --- a/docs/MailParticipant.md +++ b/docs/MailParticipant.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | ID of the mail participant | [optional] -**emailAddress** | **String** | Mail address of the mail participant | [optional] +**email_address** | **String** | Mail address of the mail participant | [optional] **name** | **String** | Name of the mail participant | [optional] -**linkedPersonId** | **Number** | ID of the linked person to the mail message | [optional] -**linkedPersonName** | **String** | Name of the linked person to the mail message | [optional] -**mailMessagePartyId** | **Number** | ID of the mail message participant | [optional] +**linked_person_id** | **Number** | ID of the linked person to the mail message | [optional] +**linked_person_name** | **String** | Name of the linked person to the mail message | [optional] +**mail_message_party_id** | **Number** | ID of the mail message participant | [optional] diff --git a/docs/MailThreadParticipant.md b/docs/MailThreadParticipant.md index 0977c9b4..cb0f5f91 100644 --- a/docs/MailThreadParticipant.md +++ b/docs/MailThreadParticipant.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | ID of the mail thread participant | [optional] **name** | **String** | Name of the mail thread participant | [optional] -**latestSent** | **Boolean** | Whether the mail thread participant was last to send an email | [optional] -**emailAddress** | **String** | Email address of the mail thread participant | [optional] -**messageTime** | **Number** | Message time | [optional] -**linkedPersonId** | **Number** | ID of the linked person | [optional] -**linkedPersonName** | **String** | Email of the linked person | [optional] -**mailMessagePartyId** | **Number** | ID of the mail message party | [optional] -**linkedOrganizationId** | **Number** | Linked Organization ID | [optional] +**latest_sent** | **Boolean** | Whether the mail thread participant was last to send an email | [optional] +**email_address** | **String** | Email address of the mail thread participant | [optional] +**message_time** | **Number** | Message time | [optional] +**linked_person_id** | **Number** | ID of the linked person | [optional] +**linked_person_name** | **String** | Email of the linked person | [optional] +**mail_message_party_id** | **Number** | ID of the mail message party | [optional] +**linked_organization_id** | **Number** | Linked Organization ID | [optional] diff --git a/docs/MailboxApi.md b/docs/MailboxApi.md index 12d432dd..65f6f5d2 100644 --- a/docs/MailboxApi.md +++ b/docs/MailboxApi.md @@ -90,6 +90,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.MailboxApi(apiClient); let id = 56; // Number | The ID of the mail message to fetch +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'includeBody': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | Whether to include the full message body or not. `0` = Don't include, `1` = Include. }; @@ -107,7 +108,7 @@ apiInstance.getMailMessage(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the mail message to fetch | - **includeBody** | [**NumberBooleanDefault0**](.md)| Whether to include the full message body or not. `0` = Don't include, `1` = Include. | [optional] + **include_body** | [**NumberBooleanDefault0**](.md)| Whether to include the full message body or not. `0` = Don't include, `1` = Include. | [optional] ### Return type @@ -253,6 +254,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.MailboxApi(apiClient); let folder = "'inbox'"; // String | The type of folder to fetch +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -312,6 +314,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.MailboxApi(apiClient); let id = 56; // Number | The ID of the mail thread +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'dealId': 56, // Number | The ID of the deal this thread is associated with 'leadId': "leadId_example", // String | The ID of the lead this thread is associated with @@ -333,11 +336,11 @@ apiInstance.updateMailThreadDetails(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the mail thread | - **dealId** | **Number**| The ID of the deal this thread is associated with | [optional] - **leadId** | **String**| The ID of the lead this thread is associated with | [optional] - **sharedFlag** | [**NumberBoolean**](NumberBoolean.md)| Whether this thread is shared with other users in your company | [optional] - **readFlag** | [**NumberBoolean**](NumberBoolean.md)| Whether this thread is read or unread | [optional] - **archivedFlag** | [**NumberBoolean**](NumberBoolean.md)| Whether this thread is archived or not. You can only archive threads that belong to Inbox folder. Archived threads will disappear from Inbox. | [optional] + **deal_id** | **Number**| The ID of the deal this thread is associated with | [optional] + **lead_id** | **String**| The ID of the lead this thread is associated with | [optional] + **shared_flag** | [**NumberBoolean**](NumberBoolean.md)| Whether this thread is shared with other users in your company | [optional] + **read_flag** | [**NumberBoolean**](NumberBoolean.md)| Whether this thread is read or unread | [optional] + **archived_flag** | [**NumberBoolean**](NumberBoolean.md)| Whether this thread is archived or not. You can only archive threads that belong to Inbox folder. Archived threads will disappear from Inbox. | [optional] ### Return type diff --git a/docs/MeetingsApi.md b/docs/MeetingsApi.md index 4bfb35b8..75b94935 100644 --- a/docs/MeetingsApi.md +++ b/docs/MeetingsApi.md @@ -101,7 +101,7 @@ apiInstance.saveUserProviderLink(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userProviderLinkCreateRequest** | [**UserProviderLinkCreateRequest**](UserProviderLinkCreateRequest.md)| | [optional] + **UserProviderLinkCreateRequest** | [**UserProviderLinkCreateRequest**](UserProviderLinkCreateRequest.md)| | [optional] ### Return type diff --git a/docs/MergeDealsRequest.md b/docs/MergeDealsRequest.md index 2582302d..5411bdb4 100644 --- a/docs/MergeDealsRequest.md +++ b/docs/MergeDealsRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mergeWithId** | **Number** | The ID of the deal that the deal will be merged with | +**merge_with_id** | **Number** | The ID of the deal that the deal will be merged with | diff --git a/docs/MergeOrganizationsRequest.md b/docs/MergeOrganizationsRequest.md index 7699c4fc..e123eab2 100644 --- a/docs/MergeOrganizationsRequest.md +++ b/docs/MergeOrganizationsRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mergeWithId** | **Number** | The ID of the organization that the organization will be merged with | +**merge_with_id** | **Number** | The ID of the organization that the organization will be merged with | diff --git a/docs/MergePersonDealRelatedInfo.md b/docs/MergePersonDealRelatedInfo.md index 77fa53dc..e10b0698 100644 --- a/docs/MergePersonDealRelatedInfo.md +++ b/docs/MergePersonDealRelatedInfo.md @@ -4,20 +4,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] -**participantOpenDealsCount** | **Number** | The count of open participant deals related with the item | [optional] -**participantClosedDealsCount** | **Number** | The count of closed participant deals related with the item | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] +**participant_open_deals_count** | **Number** | The count of open participant deals related with the item | [optional] +**participant_closed_deals_count** | **Number** | The count of closed participant deals related with the item | [optional] diff --git a/docs/MergePersonItem.md b/docs/MergePersonItem.md index f540ed9e..5692805e 100644 --- a/docs/MergePersonItem.md +++ b/docs/MergePersonItem.md @@ -5,48 +5,48 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the person | [optional] -**companyId** | **Number** | The ID of the company related to the person | [optional] -**activeFlag** | **Boolean** | Whether the person is active or not | [optional] +**company_id** | **Number** | The ID of the company related to the person | [optional] +**active_flag** | **Boolean** | Whether the person is active or not | [optional] **phone** | [**[BasePersonItemPhone]**](BasePersonItemPhone.md) | A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ \"value\": \"12345\", \"primary\": \"true\", \"label\": \"mobile\" }]`. Please note that only `value` is required. | [optional] **email** | [**[BasePersonItemEmail]**](BasePersonItemEmail.md) | An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ \"value\": \"mail@example.com\", \"primary\": \"true\", \"label\": \"main\" } ]`. Please note that only `value` is required. | [optional] -**firstChar** | **String** | The first letter of the name of the person | [optional] -**addTime** | **String** | The date and time when the person was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] -**updateTime** | **String** | The last updated date and time of the person. Format: YYYY-MM-DD HH:MM:SS | [optional] -**visibleTo** | **String** | The visibility group ID of who can see the person | [optional] -**pictureId** | [**PictureDataWithID**](PictureDataWithID.md) | | [optional] +**first_char** | **String** | The first letter of the name of the person | [optional] +**add_time** | **String** | The date and time when the person was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] +**update_time** | **String** | The last updated date and time of the person. Format: YYYY-MM-DD HH:MM:SS | [optional] +**visible_to** | **String** | The visibility group ID of who can see the person | [optional] +**picture_id** | [**PictureDataWithID**](PictureDataWithID.md) | | [optional] **label** | **Number** | The label assigned to the person | [optional] -**orgName** | **String** | The name of the organization associated with the person | [optional] -**ownerName** | **String** | The name of the owner associated with the person | [optional] -**ccEmail** | **String** | The BCC email associated with the person | [optional] -**ownerId** | **Number** | The ID of the owner related to the person | [optional] -**orgId** | **Number** | The ID of the organization related to the person | [optional] -**mergeWhatId** | **Number** | The ID of the person with what the main person was merged | [optional] +**org_name** | **String** | The name of the organization associated with the person | [optional] +**owner_name** | **String** | The name of the owner associated with the person | [optional] +**cc_email** | **String** | The BCC email associated with the person | [optional] +**owner_id** | **Number** | The ID of the owner related to the person | [optional] +**org_id** | **Number** | The ID of the organization related to the person | [optional] +**merge_what_id** | **Number** | The ID of the person with what the main person was merged | [optional] **name** | **String** | The name of the person | [optional] -**firstName** | **String** | The first name of the person | [optional] -**lastName** | **String** | The last name of the person | [optional] -**emailMessagesCount** | **Number** | The count of email messages related to the person | [optional] -**activitiesCount** | **Number** | The count of activities related to the person | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the person | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the person | [optional] -**filesCount** | **Number** | The count of files related to the person | [optional] -**notesCount** | **Number** | The count of notes related to the person | [optional] -**followersCount** | **Number** | The count of followers related to the person | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the person | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the person | [optional] -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] -**participantOpenDealsCount** | **Number** | The count of open participant deals related with the item | [optional] -**participantClosedDealsCount** | **Number** | The count of closed participant deals related with the item | [optional] +**first_name** | **String** | The first name of the person | [optional] +**last_name** | **String** | The last name of the person | [optional] +**email_messages_count** | **Number** | The count of email messages related to the person | [optional] +**activities_count** | **Number** | The count of activities related to the person | [optional] +**done_activities_count** | **Number** | The count of done activities related to the person | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the person | [optional] +**files_count** | **Number** | The count of files related to the person | [optional] +**notes_count** | **Number** | The count of notes related to the person | [optional] +**followers_count** | **Number** | The count of followers related to the person | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the person | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the person | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] +**participant_open_deals_count** | **Number** | The count of open participant deals related with the item | [optional] +**participant_closed_deals_count** | **Number** | The count of closed participant deals related with the item | [optional] diff --git a/docs/MergePersonsRequest.md b/docs/MergePersonsRequest.md index 08b4dd8b..917130b6 100644 --- a/docs/MergePersonsRequest.md +++ b/docs/MergePersonsRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mergeWithId** | **Number** | The ID of the person that will not be overwritten. This person’s data will be prioritized in case of conflict with the other person. | +**merge_with_id** | **Number** | The ID of the person that will not be overwritten. This person’s data will be prioritized in case of conflict with the other person. | diff --git a/docs/MessageObject.md b/docs/MessageObject.md index 64c3d3d1..aee97c93 100644 --- a/docs/MessageObject.md +++ b/docs/MessageObject.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The ID of the message | -**channelId** | **String** | The channel ID as in the provider | -**senderId** | **String** | The ID of the provider's user that sent the message | -**conversationId** | **String** | The ID of the conversation | +**channel_id** | **String** | The channel ID as in the provider | +**sender_id** | **String** | The ID of the provider's user that sent the message | +**conversation_id** | **String** | The ID of the conversation | **message** | **String** | The body of the message | **status** | **String** | The status of the message | -**createdAt** | **Date** | The date and time when the message was created in the provider, in UTC. Format: YYYY-MM-DD HH:MM | -**replyBy** | **Date** | The date and time when the message can no longer receive a reply, in UTC. Format: YYYY-MM-DD HH:MM | [optional] -**conversationLink** | **String** | A URL that can open the conversation in the provider's side | [optional] +**created_at** | **Date** | The date and time when the message was created in the provider, in UTC. Format: YYYY-MM-DD HH:MM | +**reply_by** | **Date** | The date and time when the message can no longer receive a reply, in UTC. Format: YYYY-MM-DD HH:MM | [optional] +**conversation_link** | **String** | A URL that can open the conversation in the provider's side | [optional] **attachments** | [**[MessageObjectAttachments]**](MessageObjectAttachments.md) | The list of attachments available in the message | [optional] diff --git a/docs/MessageObjectAttachments.md b/docs/MessageObjectAttachments.md index 8c1b9229..637c5246 100644 --- a/docs/MessageObjectAttachments.md +++ b/docs/MessageObjectAttachments.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **name** | **String** | The name of the attachment | [optional] **size** | **Number** | The size of the attachment | [optional] **url** | **String** | A URL to the file | -**previewUrl** | **String** | A URL to a preview picture of the file | [optional] -**linkExpires** | **Boolean** | If true, it will use the getMessageById endpoint for fetching updated attachment's urls. Find out more [here](https://pipedrive.readme.io/docs/implementing-messaging-app-extension) | [optional] [default to false] +**preview_url** | **String** | A URL to a preview picture of the file | [optional] +**link_expires** | **Boolean** | If true, it will use the getMessageById endpoint for fetching updated attachment's urls. Find out more [here](https://pipedrive.readme.io/docs/implementing-messaging-app-extension) | [optional] [default to false] diff --git a/docs/NewDeal.md b/docs/NewDeal.md index bbee54bf..8a5fd4c3 100644 --- a/docs/NewDeal.md +++ b/docs/NewDeal.md @@ -8,23 +8,23 @@ Name | Type | Description | Notes **value** | **String** | The value of the deal. If omitted, value will be set to 0. | [optional] **label** | **[Number]** | The array of the labels IDs. | [optional] **currency** | **String** | The currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user. | [optional] -**userId** | **Number** | The ID of the user which will be the owner of the created deal. If not provided, the user making the request will be used. | [optional] -**personId** | **Number** | The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless `org_id` is specified. | [optional] -**orgId** | **Number** | The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified. | [optional] -**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] -**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] +**user_id** | **Number** | The ID of the user which will be the owner of the created deal. If not provided, the user making the request will be used. | [optional] +**person_id** | **Number** | The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless `org_id` is specified. | [optional] +**org_id** | **Number** | The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified. | [optional] +**pipeline_id** | **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] +**stage_id** | **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] **status** | **String** | open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open. | [optional] -**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this deal. If omitted, `origin_id` will be set to null. | [optional] +**origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this deal. If omitted, `origin_id` will be set to null. | [optional] **channel** | **Number** | The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company. You can fetch allowed values with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. If omitted, channel will be set to null. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] -**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] -**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] -**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] -**closeTime** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**expectedCloseDate** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] +**add_time** | **String** | The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**won_time** | **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] +**lost_time** | **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] +**close_time** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**expected_close_date** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional] **probability** | **Number** | The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled. | [optional] -**lostReason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the deal. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**lost_reason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the deal. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] diff --git a/docs/NewDealParameters.md b/docs/NewDealParameters.md index ff80ff0e..f95e005e 100644 --- a/docs/NewDealParameters.md +++ b/docs/NewDealParameters.md @@ -7,16 +7,16 @@ Name | Type | Description | Notes **value** | **String** | The value of the deal. If omitted, value will be set to 0. | [optional] **label** | **[Number]** | The array of the labels IDs. | [optional] **currency** | **String** | The currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user. | [optional] -**userId** | **Number** | The ID of the user which will be the owner of the created deal. If not provided, the user making the request will be used. | [optional] -**personId** | **Number** | The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless `org_id` is specified. | [optional] -**orgId** | **Number** | The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified. | [optional] -**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] -**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] +**user_id** | **Number** | The ID of the user which will be the owner of the created deal. If not provided, the user making the request will be used. | [optional] +**person_id** | **Number** | The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless `org_id` is specified. | [optional] +**org_id** | **Number** | The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified. | [optional] +**pipeline_id** | **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] +**stage_id** | **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] **status** | **String** | open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open. | [optional] -**originId** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this deal. If omitted, `origin_id` will be set to null. | [optional] +**origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this deal. If omitted, `origin_id` will be set to null. | [optional] **channel** | **Number** | The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company. You can fetch allowed values with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. If omitted, channel will be set to null. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] -**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] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] +**add_time** | **String** | The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/docs/NewDealProduct.md b/docs/NewDealProduct.md index 8c794576..b4c6115b 100644 --- a/docs/NewDealProduct.md +++ b/docs/NewDealProduct.md @@ -4,21 +4,21 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productId** | **Number** | The ID of the product to use | [optional] -**itemPrice** | **Number** | The price at which this product will be added to the deal | [optional] +**product_id** | **Number** | The ID of the product to use | [optional] +**item_price** | **Number** | The price at which this product will be added to the deal | [optional] **quantity** | **Number** | How many items of this product will be added to the deal | [optional] **discount** | **Number** | The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage | [optional] [default to 0] -**discountType** | **String** | The type of the discount's value | [optional] [default to 'percentage'] +**discount_type** | **String** | The type of the discount's value | [optional] [default to 'percentage'] **duration** | **Number** | The duration of the product | [optional] [default to 1] -**durationUnit** | [**DealProductUnitDuration**](DealProductUnitDuration.md) | The unit duration of the product | [optional] -**productVariationId** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] +**duration_unit** | [**DealProductUnitDuration**](DealProductUnitDuration.md) | The unit duration of the product | [optional] +**product_variation_id** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] **comments** | **String** | A textual comment associated with this product-deal attachment | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] -**taxMethod** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount | [optional] -**enabledFlag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] -**billingFrequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] -**billingFrequencyCycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] -**billingStartDate** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] +**tax_method** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount | [optional] +**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] +**billing_frequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] +**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] +**billing_start_date** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] diff --git a/docs/NewDealProductAllOf.md b/docs/NewDealProductAllOf.md index fd5d4f29..f58a7657 100644 --- a/docs/NewDealProductAllOf.md +++ b/docs/NewDealProductAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**billingFrequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] +**billing_frequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] diff --git a/docs/NewDealProductAllOf1.md b/docs/NewDealProductAllOf1.md index f5a4ab58..9606528b 100644 --- a/docs/NewDealProductAllOf1.md +++ b/docs/NewDealProductAllOf1.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**billingFrequencyCycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] +**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] diff --git a/docs/NewDealProductAllOf2.md b/docs/NewDealProductAllOf2.md index ac529901..97093ed0 100644 --- a/docs/NewDealProductAllOf2.md +++ b/docs/NewDealProductAllOf2.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**billingStartDate** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] +**billing_start_date** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] diff --git a/docs/NewFollowerResponseData.md b/docs/NewFollowerResponseData.md index 34676ffa..629dda43 100644 --- a/docs/NewFollowerResponseData.md +++ b/docs/NewFollowerResponseData.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user that was added as follower | [optional] +**user_id** | **Number** | The ID of the user that was added as follower | [optional] **id** | **Number** | The ID of the follower | [optional] -**productId** | **Number** | The ID of the product | [optional] -**addTime** | **String** | The follower creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] +**product_id** | **Number** | The ID of the product | [optional] +**add_time** | **String** | The follower creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/docs/NewGoal.md b/docs/NewGoal.md index 625885ea..d0db06e8 100644 --- a/docs/NewGoal.md +++ b/docs/NewGoal.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **title** | **String** | The title of the goal | [optional] **assignee** | **Object** | Who this goal is assigned to. It requires the following JSON structure: `{ \"id\": \"1\", \"type\": \"person\" }`. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team. | **type** | **Object** | The type of the goal. It requires the following JSON structure: `{ \"name\": \"deals_started\", \"params\": { \"pipeline_id\": [1, 2], \"activity_type_id\": [9] } }`. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. The `pipeline_id` and `activity_type_id` need to be given as an array of integers. To track the goal in all pipelines, set `pipeline_id` as `null` and similarly, to track the goal for all activities, set `activity_type_id` as `null`.” | -**expectedOutcome** | **Object** | The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: `{ \"target\": \"50\", \"tracking_metric\": \"quantity\" }` or `{ \"target\": \"50\", \"tracking_metric\": \"sum\", \"currency_id\": 1 }`. `currency_id` should only be added to `sum` type of goals. | +**expected_outcome** | **Object** | The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: `{ \"target\": \"50\", \"tracking_metric\": \"quantity\" }` or `{ \"target\": \"50\", \"tracking_metric\": \"sum\", \"currency_id\": 1 }`. `currency_id` should only be added to `sum` type of goals. | **duration** | **Object** | The date when the goal starts and ends. It requires the following JSON structure: `{ \"start\": \"2019-01-01\", \"end\": \"2022-12-31\" }`. Date in format of YYYY-MM-DD. \"end\" can be set to `null` for an infinite, open-ended goal. | **interval** | **String** | The interval of the goal | diff --git a/docs/NewOrganization.md b/docs/NewOrganization.md index 0bb6c316..81d6907e 100644 --- a/docs/NewOrganization.md +++ b/docs/NewOrganization.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the organization | -**addTime** | **String** | The optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] -**ownerId** | **Number** | The ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used. | [optional] +**add_time** | **String** | The optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**owner_id** | **Number** | The ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used. | [optional] **label** | **Number** | The ID of the label. | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the organization. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the organization. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] diff --git a/docs/NewOrganizationAllOf.md b/docs/NewOrganizationAllOf.md index 42f2b3e6..43edd5a5 100644 --- a/docs/NewOrganizationAllOf.md +++ b/docs/NewOrganizationAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the organization | -**addTime** | **String** | The optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/docs/NewPerson.md b/docs/NewPerson.md index 14d5e322..225f55d8 100644 --- a/docs/NewPerson.md +++ b/docs/NewPerson.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the person | -**ownerId** | **Number** | The ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used. | [optional] -**orgId** | **Number** | The ID of the organization this person will belong to | [optional] +**owner_id** | **Number** | The ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used. | [optional] +**org_id** | **Number** | The ID of the organization this person will belong to | [optional] **email** | [**[BasicPersonEmail]**](BasicPersonEmail.md) | An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ \"value\": \"mail@example.com\", \"primary\": \"true\", \"label\": \"main\" }]`. Please note that only `value` is required. | [optional] **phone** | [**[BasePersonItemPhone]**](BasePersonItemPhone.md) | A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ \"value\": \"12345\", \"primary\": \"true\", \"label\": \"mobile\" }]`. Please note that only `value` is required. | [optional] **label** | **Number** | The ID of the label. | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the person. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] -**marketingStatus** | [**MarketingStatus**](MarketingStatus.md) | If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table> | [optional] -**addTime** | **String** | The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the person. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**marketing_status** | [**MarketingStatus**](MarketingStatus.md) | If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table> | [optional] +**add_time** | **String** | The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/docs/NewProductField.md b/docs/NewProductField.md index 00627754..d3955d6c 100644 --- a/docs/NewProductField.md +++ b/docs/NewProductField.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the field | **options** | **[Object]** | When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{\"label\":\"red\"}, {\"label\":\"blue\"}, {\"label\":\"lilac\"}]` | [optional] -**fieldType** | **String** | The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table> | +**field_type** | **String** | The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table> | diff --git a/docs/Note.md b/docs/Note.md index 1a3b40f5..71c0ee44 100644 --- a/docs/Note.md +++ b/docs/Note.md @@ -5,15 +5,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | **String** | The content of the note in HTML format. Subject to sanitization on the back-end. | [optional] -**leadId** | **String** | The ID of the lead the note will be attached to | [optional] -**dealId** | **Number** | The ID of the deal the note will be attached to | [optional] -**personId** | **Number** | The ID of the person the note will be attached to | [optional] -**orgId** | **Number** | The ID of the organization the note will be attached to | [optional] -**userId** | **Number** | The ID of the user who will be marked as the author of the note. Only an admin can change the author. | [optional] -**addTime** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] -**pinnedToLeadFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to lead pinning state (`lead_id` is also required) | [optional] -**pinnedToDealFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to deal pinning state (`deal_id` is also required) | [optional] -**pinnedToOrganizationFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to organization pinning state (`org_id` is also required) | [optional] -**pinnedToPersonFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to person pinning state (`person_id` is also required) | [optional] +**lead_id** | **String** | The ID of the lead the note will be attached to | [optional] +**deal_id** | **Number** | The ID of the deal the note will be attached to | [optional] +**person_id** | **Number** | The ID of the person the note will be attached to | [optional] +**org_id** | **Number** | The ID of the organization the note will be attached to | [optional] +**user_id** | **Number** | The ID of the user who will be marked as the author of the note. Only an admin can change the author. | [optional] +**add_time** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**pinned_to_lead_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to lead pinning state (`lead_id` is also required) | [optional] +**pinned_to_deal_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to deal pinning state (`deal_id` is also required) | [optional] +**pinned_to_organization_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to organization pinning state (`org_id` is also required) | [optional] +**pinned_to_person_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to person pinning state (`person_id` is also required) | [optional] diff --git a/docs/NoteConnectToParams.md b/docs/NoteConnectToParams.md index 93d84211..5acf9384 100644 --- a/docs/NoteConnectToParams.md +++ b/docs/NoteConnectToParams.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**leadId** | **String** | The ID of the lead the note will be attached to | [optional] -**dealId** | **Number** | The ID of the deal the note will be attached to | [optional] -**personId** | **Number** | The ID of the person the note will be attached to | [optional] -**orgId** | **Number** | The ID of the organization the note will be attached to | [optional] +**lead_id** | **String** | The ID of the lead the note will be attached to | [optional] +**deal_id** | **Number** | The ID of the deal the note will be attached to | [optional] +**person_id** | **Number** | The ID of the person the note will be attached to | [optional] +**org_id** | **Number** | The ID of the organization the note will be attached to | [optional] diff --git a/docs/NoteCreatorUser.md b/docs/NoteCreatorUser.md index 40845ef8..1200c108 100644 --- a/docs/NoteCreatorUser.md +++ b/docs/NoteCreatorUser.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **String** | The email of the note creator | [optional] -**iconUrl** | **String** | The URL of the note creator avatar picture | [optional] -**isYou** | **Boolean** | Whether the note is created by you or not | [optional] +**icon_url** | **String** | The URL of the note creator avatar picture | [optional] +**is_you** | **Boolean** | Whether the note is created by you or not | [optional] **name** | **String** | The name of the note creator | [optional] diff --git a/docs/NoteField.md b/docs/NoteField.md index ba89ebfa..0d5b7b3c 100644 --- a/docs/NoteField.md +++ b/docs/NoteField.md @@ -7,11 +7,11 @@ Name | Type | Description | Notes **id** | **Number** | The ID of the field | [optional] **key** | **String** | The key of the field | [optional] **name** | **String** | The name of the field | [optional] -**fieldType** | [**FieldTypeAsString**](FieldTypeAsString.md) | | [optional] -**activeFlag** | **Boolean** | The active flag of the field | [optional] -**editFlag** | **Boolean** | The edit flag of the field | [optional] -**bulkEditAllowed** | **Boolean** | Not used | [optional] -**mandatoryFlag** | **Boolean** | Whether or not the field is mandatory | [optional] +**field_type** | [**FieldTypeAsString**](FieldTypeAsString.md) | | [optional] +**active_flag** | **Boolean** | The active flag of the field | [optional] +**edit_flag** | **Boolean** | The edit flag of the field | [optional] +**bulk_edit_allowed** | **Boolean** | Not used | [optional] +**mandatory_flag** | **Boolean** | Whether or not the field is mandatory | [optional] **options** | [**[NoteFieldOptions]**](NoteFieldOptions.md) | The options of the field. When there are no options, `null` is returned. | [optional] diff --git a/docs/NoteFieldsResponse.md b/docs/NoteFieldsResponse.md index 086b6dbe..f026af53 100644 --- a/docs/NoteFieldsResponse.md +++ b/docs/NoteFieldsResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[NoteField]**](NoteField.md) | | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/NoteFieldsResponseAllOf.md b/docs/NoteFieldsResponseAllOf.md index dabeaa7d..10662735 100644 --- a/docs/NoteFieldsResponseAllOf.md +++ b/docs/NoteFieldsResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[NoteField]**](NoteField.md) | | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/NoteParams.md b/docs/NoteParams.md index debcd7a6..fb3b515c 100644 --- a/docs/NoteParams.md +++ b/docs/NoteParams.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user who will be marked as the author of the note. Only an admin can change the author. | [optional] -**addTime** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] -**pinnedToLeadFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to lead pinning state (`lead_id` is also required) | [optional] -**pinnedToDealFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to deal pinning state (`deal_id` is also required) | [optional] -**pinnedToOrganizationFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to organization pinning state (`org_id` is also required) | [optional] -**pinnedToPersonFlag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to person pinning state (`person_id` is also required) | [optional] +**user_id** | **Number** | The ID of the user who will be marked as the author of the note. Only an admin can change the author. | [optional] +**add_time** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**pinned_to_lead_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to lead pinning state (`lead_id` is also required) | [optional] +**pinned_to_deal_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to deal pinning state (`deal_id` is also required) | [optional] +**pinned_to_organization_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to organization pinning state (`org_id` is also required) | [optional] +**pinned_to_person_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to person pinning state (`person_id` is also required) | [optional] diff --git a/docs/NotesApi.md b/docs/NotesApi.md index b47ac58e..5b5d2f04 100644 --- a/docs/NotesApi.md +++ b/docs/NotesApi.md @@ -56,7 +56,7 @@ apiInstance.addNote(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **addNoteRequest** | [**AddNoteRequest**](AddNoteRequest.md)| | [optional] + **AddNoteRequest** | [**AddNoteRequest**](AddNoteRequest.md)| | [optional] ### Return type @@ -113,7 +113,7 @@ apiInstance.addNoteComment(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the note | - **commentPostPutObject** | [**CommentPostPutObject**](CommentPostPutObject.md)| | [optional] + **CommentPostPutObject** | [**CommentPostPutObject**](CommentPostPutObject.md)| | [optional] ### Return type @@ -369,6 +369,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.NotesApi(apiClient); let id = 56; // Number | The ID of the note +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -427,6 +428,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.NotesApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'userId': 56, // Number | The ID of the user whose notes to fetch. If omitted, notes by all users will be returned. 'leadId': "leadId_example", // String | The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned. @@ -456,20 +458,20 @@ apiInstance.getNotes(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Number**| The ID of the user whose notes to fetch. If omitted, notes by all users will be returned. | [optional] - **leadId** | **String**| The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned. | [optional] - **dealId** | **Number**| The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned. | [optional] - **personId** | **Number**| The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned. | [optional] - **orgId** | **Number**| The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned. | [optional] + **user_id** | **Number**| The ID of the user whose notes to fetch. If omitted, notes by all users will be returned. | [optional] + **lead_id** | **String**| The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned. | [optional] + **deal_id** | **Number**| The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned. | [optional] + **person_id** | **Number**| The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned. | [optional] + **org_id** | **Number**| The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned. | [optional] **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] **sort** | **String**| 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). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`. | [optional] - **startDate** | **Date**| The date in format of YYYY-MM-DD from which notes to fetch | [optional] - **endDate** | **Date**| The date in format of YYYY-MM-DD until which notes to fetch to | [optional] - **pinnedToLeadFlag** | [**NumberBoolean**](.md)| If set, the results are filtered by note to lead pinning state | [optional] - **pinnedToDealFlag** | [**NumberBoolean**](.md)| If set, the results are filtered by note to deal pinning state | [optional] - **pinnedToOrganizationFlag** | [**NumberBoolean**](.md)| If set, the results are filtered by note to organization pinning state | [optional] - **pinnedToPersonFlag** | [**NumberBoolean**](.md)| If set, the results are filtered by note to person pinning state | [optional] + **start_date** | **Date**| The date in format of YYYY-MM-DD from which notes to fetch | [optional] + **end_date** | **Date**| The date in format of YYYY-MM-DD until which notes to fetch to | [optional] + **pinned_to_lead_flag** | [**NumberBoolean**](.md)| If set, the results are filtered by note to lead pinning state | [optional] + **pinned_to_deal_flag** | [**NumberBoolean**](.md)| If set, the results are filtered by note to deal pinning state | [optional] + **pinned_to_organization_flag** | [**NumberBoolean**](.md)| If set, the results are filtered by note to organization pinning state | [optional] + **pinned_to_person_flag** | [**NumberBoolean**](.md)| If set, the results are filtered by note to person pinning state | [optional] ### Return type @@ -528,7 +530,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the note | **commentId** | **String**| The ID of the comment | - **commentPostPutObject** | [**CommentPostPutObject**](CommentPostPutObject.md)| | [optional] + **CommentPostPutObject** | [**CommentPostPutObject**](CommentPostPutObject.md)| | [optional] ### Return type @@ -585,7 +587,7 @@ apiInstance.updateNote(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the note | - **note** | [**Note**](Note.md)| | [optional] + **Note** | [**Note**](Note.md)| | [optional] ### Return type diff --git a/docs/OrgAndOwnerId.md b/docs/OrgAndOwnerId.md index 9bf7bc16..79c7d038 100644 --- a/docs/OrgAndOwnerId.md +++ b/docs/OrgAndOwnerId.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ownerId** | [**Owner**](Owner.md) | | [optional] -**orgId** | [**RelationshipOrganizationInfoItemWithActiveFlag**](RelationshipOrganizationInfoItemWithActiveFlag.md) | | [optional] +**owner_id** | [**Owner**](Owner.md) | | [optional] +**org_id** | [**RelationshipOrganizationInfoItemWithActiveFlag**](RelationshipOrganizationInfoItemWithActiveFlag.md) | | [optional] diff --git a/docs/OrganizationAddressInfo.md b/docs/OrganizationAddressInfo.md index d199c82d..27d3152c 100644 --- a/docs/OrganizationAddressInfo.md +++ b/docs/OrganizationAddressInfo.md @@ -5,15 +5,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **address** | **String** | The full address of the organization | [optional] -**addressSubpremise** | **String** | The sub-premise of the organization location | [optional] -**addressStreetNumber** | **String** | The street number of the organization location | [optional] -**addressRoute** | **String** | The route of the organization location | [optional] -**addressSublocality** | **String** | The sub-locality of the organization location | [optional] -**addressLocality** | **String** | The locality of the organization location | [optional] -**addressAdminAreaLevel1** | **String** | The level 1 admin area of the organization location | [optional] -**addressAdminAreaLevel2** | **String** | The level 2 admin area of the organization location | [optional] -**addressCountry** | **String** | The country of the organization location | [optional] -**addressPostalCode** | **String** | The postal code of the organization location | [optional] -**addressFormattedAddress** | **String** | The formatted organization location | [optional] +**address_subpremise** | **String** | The sub-premise of the organization location | [optional] +**address_street_number** | **String** | The street number of the organization location | [optional] +**address_route** | **String** | The route of the organization location | [optional] +**address_sublocality** | **String** | The sub-locality of the organization location | [optional] +**address_locality** | **String** | The locality of the organization location | [optional] +**address_admin_area_level_1** | **String** | The level 1 admin area of the organization location | [optional] +**address_admin_area_level_2** | **String** | The level 2 admin area of the organization location | [optional] +**address_country** | **String** | The country of the organization location | [optional] +**address_postal_code** | **String** | The postal code of the organization location | [optional] +**address_formatted_address** | **String** | The formatted organization location | [optional] diff --git a/docs/OrganizationCountAndAddressInfo.md b/docs/OrganizationCountAndAddressInfo.md index c6b6999c..ad979051 100644 --- a/docs/OrganizationCountAndAddressInfo.md +++ b/docs/OrganizationCountAndAddressInfo.md @@ -4,24 +4,24 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**emailMessagesCount** | **Number** | The count of email messages related to the organization | [optional] -**peopleCount** | **Number** | The count of persons related to the organization | [optional] -**activitiesCount** | **Number** | The count of activities related to the organization | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the organization | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the organization | [optional] -**filesCount** | **Number** | The count of files related to the organization | [optional] -**notesCount** | **Number** | The count of notes related to the organization | [optional] -**followersCount** | **Number** | The count of followers related to the organization | [optional] +**email_messages_count** | **Number** | The count of email messages related to the organization | [optional] +**people_count** | **Number** | The count of persons related to the organization | [optional] +**activities_count** | **Number** | The count of activities related to the organization | [optional] +**done_activities_count** | **Number** | The count of done activities related to the organization | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the organization | [optional] +**files_count** | **Number** | The count of files related to the organization | [optional] +**notes_count** | **Number** | The count of notes related to the organization | [optional] +**followers_count** | **Number** | The count of followers related to the organization | [optional] **address** | **String** | The full address of the organization | [optional] -**addressSubpremise** | **String** | The sub-premise of the organization location | [optional] -**addressStreetNumber** | **String** | The street number of the organization location | [optional] -**addressRoute** | **String** | The route of the organization location | [optional] -**addressSublocality** | **String** | The sub-locality of the organization location | [optional] -**addressLocality** | **String** | The locality of the organization location | [optional] -**addressAdminAreaLevel1** | **String** | The level 1 admin area of the organization location | [optional] -**addressAdminAreaLevel2** | **String** | The level 2 admin area of the organization location | [optional] -**addressCountry** | **String** | The country of the organization location | [optional] -**addressPostalCode** | **String** | The postal code of the organization location | [optional] -**addressFormattedAddress** | **String** | The formatted organization location | [optional] +**address_subpremise** | **String** | The sub-premise of the organization location | [optional] +**address_street_number** | **String** | The street number of the organization location | [optional] +**address_route** | **String** | The route of the organization location | [optional] +**address_sublocality** | **String** | The sub-locality of the organization location | [optional] +**address_locality** | **String** | The locality of the organization location | [optional] +**address_admin_area_level_1** | **String** | The level 1 admin area of the organization location | [optional] +**address_admin_area_level_2** | **String** | The level 2 admin area of the organization location | [optional] +**address_country** | **String** | The country of the organization location | [optional] +**address_postal_code** | **String** | The postal code of the organization location | [optional] +**address_formatted_address** | **String** | The formatted organization location | [optional] diff --git a/docs/OrganizationCountInfo.md b/docs/OrganizationCountInfo.md index 739a007b..30e522a5 100644 --- a/docs/OrganizationCountInfo.md +++ b/docs/OrganizationCountInfo.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**emailMessagesCount** | **Number** | The count of email messages related to the organization | [optional] -**peopleCount** | **Number** | The count of persons related to the organization | [optional] -**activitiesCount** | **Number** | The count of activities related to the organization | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the organization | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the organization | [optional] -**filesCount** | **Number** | The count of files related to the organization | [optional] -**notesCount** | **Number** | The count of notes related to the organization | [optional] -**followersCount** | **Number** | The count of followers related to the organization | [optional] +**email_messages_count** | **Number** | The count of email messages related to the organization | [optional] +**people_count** | **Number** | The count of persons related to the organization | [optional] +**activities_count** | **Number** | The count of activities related to the organization | [optional] +**done_activities_count** | **Number** | The count of done activities related to the organization | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the organization | [optional] +**files_count** | **Number** | The count of files related to the organization | [optional] +**notes_count** | **Number** | The count of notes related to the organization | [optional] +**followers_count** | **Number** | The count of followers related to the organization | [optional] diff --git a/docs/OrganizationData.md b/docs/OrganizationData.md index adabd962..b7b38d21 100644 --- a/docs/OrganizationData.md +++ b/docs/OrganizationData.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the organization associated with the item | [optional] -**peopleCount** | **Number** | The number of people connected with the organization that is associated with the item | [optional] -**ownerId** | **Number** | The ID of the owner of the organization that is associated with the item | [optional] +**people_count** | **Number** | The number of people connected with the organization that is associated with the item | [optional] +**owner_id** | **Number** | The ID of the owner of the organization that is associated with the item | [optional] **address** | **String** | The address of the organization | [optional] -**ccEmail** | **String** | The BCC email of the organization associated with the item | [optional] +**cc_email** | **String** | The BCC email of the organization associated with the item | [optional] diff --git a/docs/OrganizationDataWithId.md b/docs/OrganizationDataWithId.md index cc93c72d..27f2b50d 100644 --- a/docs/OrganizationDataWithId.md +++ b/docs/OrganizationDataWithId.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the organization associated with the item | [optional] **name** | **String** | The name of the organization associated with the item | [optional] -**peopleCount** | **Number** | The number of people connected with the organization that is associated with the item | [optional] -**ownerId** | **Number** | The ID of the owner of the organization that is associated with the item | [optional] +**people_count** | **Number** | The number of people connected with the organization that is associated with the item | [optional] +**owner_id** | **Number** | The ID of the owner of the organization that is associated with the item | [optional] **address** | **String** | The address of the organization | [optional] -**ccEmail** | **String** | The BCC email of the organization associated with the item | [optional] +**cc_email** | **String** | The BCC email of the organization associated with the item | [optional] diff --git a/docs/OrganizationDataWithIdAndActiveFlag.md b/docs/OrganizationDataWithIdAndActiveFlag.md index 70487a7c..8e1a6351 100644 --- a/docs/OrganizationDataWithIdAndActiveFlag.md +++ b/docs/OrganizationDataWithIdAndActiveFlag.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**activeFlag** | **Boolean** | Whether the associated organization is active or not | [optional] +**active_flag** | **Boolean** | Whether the associated organization is active or not | [optional] **id** | **Number** | The ID of the organization associated with the item | [optional] **name** | **String** | The name of the organization associated with the item | [optional] -**peopleCount** | **Number** | The number of people connected with the organization that is associated with the item | [optional] -**ownerId** | **Number** | The ID of the owner of the organization that is associated with the item | [optional] +**people_count** | **Number** | The number of people connected with the organization that is associated with the item | [optional] +**owner_id** | **Number** | The ID of the owner of the organization that is associated with the item | [optional] **address** | **String** | The address of the organization | [optional] -**ccEmail** | **String** | The BCC email of the organization associated with the item | [optional] +**cc_email** | **String** | The BCC email of the organization associated with the item | [optional] diff --git a/docs/OrganizationDataWithIdAndActiveFlagAllOf.md b/docs/OrganizationDataWithIdAndActiveFlagAllOf.md index 92a8774e..3ff99d79 100644 --- a/docs/OrganizationDataWithIdAndActiveFlagAllOf.md +++ b/docs/OrganizationDataWithIdAndActiveFlagAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**activeFlag** | **Boolean** | Whether the associated organization is active or not | [optional] +**active_flag** | **Boolean** | Whether the associated organization is active or not | [optional] diff --git a/docs/OrganizationDetailsGetResponse.md b/docs/OrganizationDetailsGetResponse.md index 80731627..d46436c0 100644 --- a/docs/OrganizationDetailsGetResponse.md +++ b/docs/OrganizationDetailsGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**OrganizationItem**](OrganizationItem.md) | | [optional] -**additionalData** | [**OrganizationDetailsGetResponseAllOfAdditionalData**](OrganizationDetailsGetResponseAllOfAdditionalData.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**OrganizationDetailsGetResponseAllOfAdditionalData**](OrganizationDetailsGetResponseAllOfAdditionalData.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationDetailsGetResponseAllOf.md b/docs/OrganizationDetailsGetResponseAllOf.md index 74b684e4..fe6540ba 100644 --- a/docs/OrganizationDetailsGetResponseAllOf.md +++ b/docs/OrganizationDetailsGetResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**OrganizationItem**](OrganizationItem.md) | | [optional] -**additionalData** | [**OrganizationDetailsGetResponseAllOfAdditionalData**](OrganizationDetailsGetResponseAllOfAdditionalData.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**OrganizationDetailsGetResponseAllOfAdditionalData**](OrganizationDetailsGetResponseAllOfAdditionalData.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationDetailsGetResponseAllOfAdditionalData.md b/docs/OrganizationDetailsGetResponseAllOfAdditionalData.md index dcb1ec01..766ca9d5 100644 --- a/docs/OrganizationDetailsGetResponseAllOfAdditionalData.md +++ b/docs/OrganizationDetailsGetResponseAllOfAdditionalData.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **followers** | [**RelatedFollowerData**](RelatedFollowerData.md) | | [optional] -**dropboxEmail** | **String** | Dropbox email for the organization | [optional] +**dropbox_email** | **String** | Dropbox email for the organization | [optional] diff --git a/docs/OrganizationFieldsApi.md b/docs/OrganizationFieldsApi.md index 57f8901b..2ca3e294 100644 --- a/docs/OrganizationFieldsApi.md +++ b/docs/OrganizationFieldsApi.md @@ -52,7 +52,7 @@ apiInstance.addOrganizationField(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fieldCreateRequest** | [**FieldCreateRequest**](FieldCreateRequest.md)| | [optional] + **FieldCreateRequest** | [**FieldCreateRequest**](FieldCreateRequest.md)| | [optional] ### Return type @@ -250,6 +250,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationFieldsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -325,7 +326,7 @@ apiInstance.updateOrganizationField(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the field | - **fieldUpdateRequest** | [**FieldUpdateRequest**](FieldUpdateRequest.md)| | [optional] + **FieldUpdateRequest** | [**FieldUpdateRequest**](FieldUpdateRequest.md)| | [optional] ### Return type diff --git a/docs/OrganizationFlowResponse.md b/docs/OrganizationFlowResponse.md index 1d2ee232..45c2e6a2 100644 --- a/docs/OrganizationFlowResponse.md +++ b/docs/OrganizationFlowResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[OrganizationFlowResponseAllOfData]**](OrganizationFlowResponseAllOfData.md) | | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**OrganizationFlowResponseAllOfRelatedObjects**](OrganizationFlowResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**OrganizationFlowResponseAllOfRelatedObjects**](OrganizationFlowResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationFlowResponseAllOf.md b/docs/OrganizationFlowResponseAllOf.md index ab43f82c..6896e16e 100644 --- a/docs/OrganizationFlowResponseAllOf.md +++ b/docs/OrganizationFlowResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[OrganizationFlowResponseAllOfData]**](OrganizationFlowResponseAllOfData.md) | | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**OrganizationFlowResponseAllOfRelatedObjects**](OrganizationFlowResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**OrganizationFlowResponseAllOfRelatedObjects**](OrganizationFlowResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationFollowerItem.md b/docs/OrganizationFollowerItem.md index 3b431fbc..a0803f4f 100644 --- a/docs/OrganizationFollowerItem.md +++ b/docs/OrganizationFollowerItem.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orgId** | **Number** | The ID of the organization | [optional] -**userId** | **Number** | The user ID of the follower related to the item | [optional] +**org_id** | **Number** | The ID of the organization | [optional] +**user_id** | **Number** | The user ID of the follower related to the item | [optional] **id** | **Number** | The ID of the follower | [optional] -**addTime** | **Date** | The date and time of adding the follower to the item | [optional] +**add_time** | **Date** | The date and time of adding the follower to the item | [optional] diff --git a/docs/OrganizationFollowerItemAllOf.md b/docs/OrganizationFollowerItemAllOf.md index ee658a8d..e021eedf 100644 --- a/docs/OrganizationFollowerItemAllOf.md +++ b/docs/OrganizationFollowerItemAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orgId** | **Number** | The ID of the organization | [optional] +**org_id** | **Number** | The ID of the organization | [optional] diff --git a/docs/OrganizationFollowersListResponse.md b/docs/OrganizationFollowersListResponse.md index 36a84e37..840aa562 100644 --- a/docs/OrganizationFollowersListResponse.md +++ b/docs/OrganizationFollowersListResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the request was successful or not | [optional] **data** | [**[OrganizationFollowerItem]**](OrganizationFollowerItem.md) | The array of followers | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/OrganizationItem.md b/docs/OrganizationItem.md index 2758ac85..d0cc65d0 100644 --- a/docs/OrganizationItem.md +++ b/docs/OrganizationItem.md @@ -5,53 +5,53 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the organization | [optional] -**companyId** | **Number** | The ID of the company related to the organization | [optional] -**ownerId** | [**Owner**](Owner.md) | | [optional] +**company_id** | **Number** | The ID of the company related to the organization | [optional] +**owner_id** | [**Owner**](Owner.md) | | [optional] **name** | **String** | The name of the organization | [optional] -**activeFlag** | **Boolean** | Whether the organization is active or not | [optional] -**pictureId** | [**PictureDataWithValue**](PictureDataWithValue.md) | | [optional] -**countryCode** | **String** | The country code of the organization | [optional] -**firstChar** | **String** | The first character of the organization name | [optional] -**addTime** | **String** | The creation date and time of the organization | [optional] -**updateTime** | **String** | The last updated date and time of the organization | [optional] -**visibleTo** | **String** | The visibility group ID of who can see the organization | [optional] +**active_flag** | **Boolean** | Whether the organization is active or not | [optional] +**picture_id** | [**PictureDataWithValue**](PictureDataWithValue.md) | | [optional] +**country_code** | **String** | The country code of the organization | [optional] +**first_char** | **String** | The first character of the organization name | [optional] +**add_time** | **String** | The creation date and time of the organization | [optional] +**update_time** | **String** | The last updated date and time of the organization | [optional] +**visible_to** | **String** | The visibility group ID of who can see the organization | [optional] **label** | **Number** | The label assigned to the organization | [optional] -**ownerName** | **String** | The name of the organization owner | [optional] -**ccEmail** | **String** | The BCC email associated with the organization | [optional] -**emailMessagesCount** | **Number** | The count of email messages related to the organization | [optional] -**peopleCount** | **Number** | The count of persons related to the organization | [optional] -**activitiesCount** | **Number** | The count of activities related to the organization | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the organization | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the organization | [optional] -**filesCount** | **Number** | The count of files related to the organization | [optional] -**notesCount** | **Number** | The count of notes related to the organization | [optional] -**followersCount** | **Number** | The count of followers related to the organization | [optional] +**owner_name** | **String** | The name of the organization owner | [optional] +**cc_email** | **String** | The BCC email associated with the organization | [optional] +**email_messages_count** | **Number** | The count of email messages related to the organization | [optional] +**people_count** | **Number** | The count of persons related to the organization | [optional] +**activities_count** | **Number** | The count of activities related to the organization | [optional] +**done_activities_count** | **Number** | The count of done activities related to the organization | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the organization | [optional] +**files_count** | **Number** | The count of files related to the organization | [optional] +**notes_count** | **Number** | The count of notes related to the organization | [optional] +**followers_count** | **Number** | The count of followers related to the organization | [optional] **address** | **String** | The full address of the organization | [optional] -**addressSubpremise** | **String** | The sub-premise of the organization location | [optional] -**addressStreetNumber** | **String** | The street number of the organization location | [optional] -**addressRoute** | **String** | The route of the organization location | [optional] -**addressSublocality** | **String** | The sub-locality of the organization location | [optional] -**addressLocality** | **String** | The locality of the organization location | [optional] -**addressAdminAreaLevel1** | **String** | The level 1 admin area of the organization location | [optional] -**addressAdminAreaLevel2** | **String** | The level 2 admin area of the organization location | [optional] -**addressCountry** | **String** | The country of the organization location | [optional] -**addressPostalCode** | **String** | The postal code of the organization location | [optional] -**addressFormattedAddress** | **String** | The formatted organization location | [optional] -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] -**editName** | **Boolean** | If the company ID of the organization and company ID of the request is same or not | [optional] -**lastActivity** | **Object** | Please refer to response schema of <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivity\">Activity</a> | [optional] -**nextActivity** | **Object** | Please refer to response schema of <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivity\">Activity</a> | [optional] +**address_subpremise** | **String** | The sub-premise of the organization location | [optional] +**address_street_number** | **String** | The street number of the organization location | [optional] +**address_route** | **String** | The route of the organization location | [optional] +**address_sublocality** | **String** | The sub-locality of the organization location | [optional] +**address_locality** | **String** | The locality of the organization location | [optional] +**address_admin_area_level_1** | **String** | The level 1 admin area of the organization location | [optional] +**address_admin_area_level_2** | **String** | The level 2 admin area of the organization location | [optional] +**address_country** | **String** | The country of the organization location | [optional] +**address_postal_code** | **String** | The postal code of the organization location | [optional] +**address_formatted_address** | **String** | The formatted organization location | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] +**edit_name** | **Boolean** | If the company ID of the organization and company ID of the request is same or not | [optional] +**last_activity** | **Object** | Please refer to response schema of <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivity\">Activity</a> | [optional] +**next_activity** | **Object** | Please refer to response schema of <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivity\">Activity</a> | [optional] diff --git a/docs/OrganizationItemAllOf.md b/docs/OrganizationItemAllOf.md index 0d50217b..1e8731ef 100644 --- a/docs/OrganizationItemAllOf.md +++ b/docs/OrganizationItemAllOf.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**lastActivity** | **Object** | Please refer to response schema of <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivity\">Activity</a> | [optional] -**nextActivity** | **Object** | Please refer to response schema of <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivity\">Activity</a> | [optional] +**last_activity** | **Object** | Please refer to response schema of <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivity\">Activity</a> | [optional] +**next_activity** | **Object** | Please refer to response schema of <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivity\">Activity</a> | [optional] diff --git a/docs/OrganizationPostResponse.md b/docs/OrganizationPostResponse.md index 0bfd3a1d..27560354 100644 --- a/docs/OrganizationPostResponse.md +++ b/docs/OrganizationPostResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**BaseOrganizationItemWithEditNameFlag**](BaseOrganizationItemWithEditNameFlag.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationPostResponseAllOf.md b/docs/OrganizationPostResponseAllOf.md index cb21df50..86d35947 100644 --- a/docs/OrganizationPostResponseAllOf.md +++ b/docs/OrganizationPostResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**BaseOrganizationItemWithEditNameFlag**](BaseOrganizationItemWithEditNameFlag.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationRelationship.md b/docs/OrganizationRelationship.md index 52143388..d03e370d 100644 --- a/docs/OrganizationRelationship.md +++ b/docs/OrganizationRelationship.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orgId** | **Number** | The ID of the base organization for the returned calculated values | [optional] +**org_id** | **Number** | The ID of the base organization for the returned calculated values | [optional] **type** | **String** | The type of organization relationship | [optional] -**relOwnerOrgId** | **Number** | The owner of this relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter. | [optional] -**relLinkedOrgId** | **Number** | The linked organization in this relationship. If type is `parent`, then the linked organization is the daughter. | [optional] +**rel_owner_org_id** | **Number** | The owner of this relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter. | [optional] +**rel_linked_org_id** | **Number** | The linked organization in this relationship. If type is `parent`, then the linked organization is the daughter. | [optional] diff --git a/docs/OrganizationRelationshipDetails.md b/docs/OrganizationRelationshipDetails.md index 7da4f42c..2bd4bf2a 100644 --- a/docs/OrganizationRelationshipDetails.md +++ b/docs/OrganizationRelationshipDetails.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the organization relationship | [optional] **type** | **String** | The type of the relationship | [optional] -**relOwnerOrgId** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] -**relLinkedOrgId** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] -**addTime** | **String** | The creation date and time of the relationship | [optional] -**updateTime** | **String** | The last updated date and time of the relationship | [optional] -**activeFlag** | **String** | Whether the relationship is active or not | [optional] -**calculatedType** | **String** | The calculated type of the relationship with the linked organization | [optional] -**calculatedRelatedOrgId** | **Number** | The ID of the linked organization | [optional] -**relatedOrganizationName** | **String** | The name of the linked organization | [optional] +**rel_owner_org_id** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] +**rel_linked_org_id** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] +**add_time** | **String** | The creation date and time of the relationship | [optional] +**update_time** | **String** | The last updated date and time of the relationship | [optional] +**active_flag** | **String** | Whether the relationship is active or not | [optional] +**calculated_type** | **String** | The calculated type of the relationship with the linked organization | [optional] +**calculated_related_org_id** | **Number** | The ID of the linked organization | [optional] +**related_organization_name** | **String** | The name of the linked organization | [optional] diff --git a/docs/OrganizationRelationshipGetResponse.md b/docs/OrganizationRelationshipGetResponse.md index 946ebba1..195d346b 100644 --- a/docs/OrganizationRelationshipGetResponse.md +++ b/docs/OrganizationRelationshipGetResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**OrganizationRelationshipWithCalculatedFields**](OrganizationRelationshipWithCalculatedFields.md) | | [optional] -**relatedObjects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationRelationshipGetResponseAllOf.md b/docs/OrganizationRelationshipGetResponseAllOf.md index 6db45f4e..1c84374e 100644 --- a/docs/OrganizationRelationshipGetResponseAllOf.md +++ b/docs/OrganizationRelationshipGetResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**OrganizationRelationshipWithCalculatedFields**](OrganizationRelationshipWithCalculatedFields.md) | | [optional] -**relatedObjects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationRelationshipPostResponse.md b/docs/OrganizationRelationshipPostResponse.md index afb1c62d..b493260a 100644 --- a/docs/OrganizationRelationshipPostResponse.md +++ b/docs/OrganizationRelationshipPostResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**BaseOrganizationRelationshipItem**](BaseOrganizationRelationshipItem.md) | | [optional] -**relatedObjects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationRelationshipPostResponseAllOf.md b/docs/OrganizationRelationshipPostResponseAllOf.md index 41cf332a..bf50b866 100644 --- a/docs/OrganizationRelationshipPostResponseAllOf.md +++ b/docs/OrganizationRelationshipPostResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**BaseOrganizationRelationshipItem**](BaseOrganizationRelationshipItem.md) | | [optional] -**relatedObjects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationRelationshipUpdateResponse.md b/docs/OrganizationRelationshipUpdateResponse.md index 862cb9e8..557d54dc 100644 --- a/docs/OrganizationRelationshipUpdateResponse.md +++ b/docs/OrganizationRelationshipUpdateResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**BaseOrganizationRelationshipItem**](BaseOrganizationRelationshipItem.md) | | [optional] -**relatedObjects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**AllOrganizationRelationshipsGetResponseAllOfRelatedObjects**](AllOrganizationRelationshipsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationRelationshipWithCalculatedFields.md b/docs/OrganizationRelationshipWithCalculatedFields.md index 20809cba..f30e72d5 100644 --- a/docs/OrganizationRelationshipWithCalculatedFields.md +++ b/docs/OrganizationRelationshipWithCalculatedFields.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the organization relationship | [optional] **type** | **String** | The type of the relationship | [optional] -**relOwnerOrgId** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] -**relLinkedOrgId** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] -**addTime** | **String** | The creation date and time of the relationship | [optional] -**updateTime** | **String** | The last updated date and time of the relationship | [optional] -**activeFlag** | **String** | Whether the relationship is active or not | [optional] -**calculatedType** | **String** | The calculated type of the relationship with the linked organization | [optional] -**calculatedRelatedOrgId** | **Number** | The ID of the linked organization | [optional] +**rel_owner_org_id** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] +**rel_linked_org_id** | [**RelationshipOrganizationInfoItem**](RelationshipOrganizationInfoItem.md) | | [optional] +**add_time** | **String** | The creation date and time of the relationship | [optional] +**update_time** | **String** | The last updated date and time of the relationship | [optional] +**active_flag** | **String** | Whether the relationship is active or not | [optional] +**calculated_type** | **String** | The calculated type of the relationship with the linked organization | [optional] +**calculated_related_org_id** | **Number** | The ID of the linked organization | [optional] diff --git a/docs/OrganizationRelationshipsApi.md b/docs/OrganizationRelationshipsApi.md index 3c681d63..58669e54 100644 --- a/docs/OrganizationRelationshipsApi.md +++ b/docs/OrganizationRelationshipsApi.md @@ -51,7 +51,7 @@ apiInstance.addOrganizationRelationship(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **addOrganizationRelationshipRequest** | [**AddOrganizationRelationshipRequest**](AddOrganizationRelationshipRequest.md)| | [optional] + **AddOrganizationRelationshipRequest** | [**AddOrganizationRelationshipRequest**](AddOrganizationRelationshipRequest.md)| | [optional] ### Return type @@ -144,6 +144,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationRelationshipsApi(apiClient); let id = 56; // Number | The ID of the organization relationship +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'orgId': 56 // Number | The ID of the base organization for the returned calculated values }; @@ -161,7 +162,7 @@ apiInstance.getOrganizationRelationship(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the organization relationship | - **orgId** | **Number**| The ID of the base organization for the returned calculated values | [optional] + **org_id** | **Number**| The ID of the base organization for the returned calculated values | [optional] ### Return type @@ -214,7 +215,7 @@ apiInstance.getOrganizationRelationships(orgId).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orgId** | **Number**| The ID of the organization to get relationships for | + **org_id** | **Number**| The ID of the organization to get relationships for | ### Return type @@ -271,7 +272,7 @@ apiInstance.updateOrganizationRelationship(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the organization relationship | - **organizationRelationship** | [**OrganizationRelationship**](OrganizationRelationship.md)| | [optional] + **OrganizationRelationship** | [**OrganizationRelationship**](OrganizationRelationship.md)| | [optional] ### Return type diff --git a/docs/OrganizationSearchItem.md b/docs/OrganizationSearchItem.md index 8dd758a2..b2972e5c 100644 --- a/docs/OrganizationSearchItem.md +++ b/docs/OrganizationSearchItem.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultScore** | **Number** | Search result relevancy | [optional] +**result_score** | **Number** | Search result relevancy | [optional] **item** | [**OrganizationSearchItemItem**](OrganizationSearchItemItem.md) | | [optional] diff --git a/docs/OrganizationSearchItemItem.md b/docs/OrganizationSearchItemItem.md index 61595aaa..45a611ad 100644 --- a/docs/OrganizationSearchItemItem.md +++ b/docs/OrganizationSearchItemItem.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes **type** | **String** | The type of the item | [optional] **name** | **String** | The name of the organization | [optional] **address** | **String** | The address of the organization | [optional] -**visibleTo** | **Number** | The visibility of the organization | [optional] +**visible_to** | **Number** | The visibility of the organization | [optional] **owner** | [**DealSearchItemItemOwner**](DealSearchItemItemOwner.md) | | [optional] -**customFields** | **[String]** | Custom fields | [optional] +**custom_fields** | **[String]** | Custom fields | [optional] **notes** | **[String]** | An array of notes | [optional] diff --git a/docs/OrganizationSearchResponse.md b/docs/OrganizationSearchResponse.md index f1293f76..923b6252 100644 --- a/docs/OrganizationSearchResponse.md +++ b/docs/OrganizationSearchResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**OrganizationSearchResponseAllOfData**](OrganizationSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/OrganizationSearchResponseAllOf.md b/docs/OrganizationSearchResponseAllOf.md index f0fa9915..84fa6e5e 100644 --- a/docs/OrganizationSearchResponseAllOf.md +++ b/docs/OrganizationSearchResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**OrganizationSearchResponseAllOfData**](OrganizationSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/OrganizationUpdateResponse.md b/docs/OrganizationUpdateResponse.md index bf3c05bf..fcbd9597 100644 --- a/docs/OrganizationUpdateResponse.md +++ b/docs/OrganizationUpdateResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**BaseOrganizationItem**](BaseOrganizationItem.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationUpdateResponseAllOf.md b/docs/OrganizationUpdateResponseAllOf.md index 3489faeb..0bb1da6a 100644 --- a/docs/OrganizationUpdateResponseAllOf.md +++ b/docs/OrganizationUpdateResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**BaseOrganizationItem**](BaseOrganizationItem.md) | | [optional] -**relatedObjects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**AllOrganizationsGetResponseAllOfRelatedObjects**](AllOrganizationsGetResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/OrganizationsApi.md b/docs/OrganizationsApi.md index 565b181c..0339a77d 100644 --- a/docs/OrganizationsApi.md +++ b/docs/OrganizationsApi.md @@ -66,7 +66,7 @@ apiInstance.addOrganization(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **newOrganization** | [**NewOrganization**](NewOrganization.md)| | [optional] + **NewOrganization** | [**NewOrganization**](NewOrganization.md)| | [optional] ### Return type @@ -123,7 +123,7 @@ apiInstance.addOrganizationFollower(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the organization | - **addOrganizationFollowerRequest** | [**AddOrganizationFollowerRequest**](AddOrganizationFollowerRequest.md)| | [optional] + **AddOrganizationFollowerRequest** | [**AddOrganizationFollowerRequest**](AddOrganizationFollowerRequest.md)| | [optional] ### Return type @@ -231,7 +231,7 @@ apiInstance.deleteOrganizationFollower(id, followerId).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the organization | - **followerId** | **Number**| The ID of the follower | + **follower_id** | **Number**| The ID of the follower | ### Return type @@ -377,6 +377,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationsApi(apiClient); let id = 56; // Number | The ID of the organization +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -440,6 +441,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationsApi(apiClient); let id = 56; // Number | The ID of the organization +// snake_case as well as camelCase is supported for naming opts properties 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 @@ -499,6 +501,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationsApi(apiClient); let id = 56; // Number | The ID of the organization +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -524,7 +527,7 @@ Name | Type | Description | Notes **limit** | **Number**| Items shown per page | [optional] **status** | **String**| Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. | [optional] [default to 'all_not_deleted'] **sort** | **String**| 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). | [optional] - **onlyPrimaryAssociation** | [**NumberBoolean**](.md)| If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization. | [optional] + **only_primary_association** | [**NumberBoolean**](.md)| If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization. | [optional] ### Return type @@ -564,6 +567,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationsApi(apiClient); let id = 56; // Number | The ID of the organization +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -678,6 +682,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationsApi(apiClient); let id = 56; // Number | The ID of the organization +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -737,6 +742,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationsApi(apiClient); let id = 56; // Number | The ID of the organization +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -796,6 +802,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationsApi(apiClient); let id = 56; // Number | The ID of the organization +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -818,7 +825,7 @@ Name | Type | Description | Notes **id** | **Number**| The ID of the organization | **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] - **allChanges** | **String**| Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates. | [optional] + **all_changes** | **String**| Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates. | [optional] **items** | **String**| A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document). | [optional] ### Return type @@ -911,6 +918,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'userId': 56, // Number | If supplied, only organizations owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied. 'filterId': 56, // Number | The ID of the filter to use @@ -932,9 +940,9 @@ apiInstance.getOrganizations(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Number**| If supplied, only organizations owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied. | [optional] - **filterId** | **Number**| The ID of the filter to use | [optional] - **firstChar** | **String**| If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive) | [optional] + **user_id** | **Number**| If supplied, only organizations owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied. | [optional] + **filter_id** | **Number**| The ID of the filter to use | [optional] + **first_char** | **String**| If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive) | [optional] **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] **sort** | **String**| 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). | [optional] @@ -976,6 +984,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page 'limit': 100, // Number | 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. @@ -1001,8 +1010,8 @@ Name | Type | Description | Notes **limit** | **Number**| 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. | [optional] **since** | **String**| 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. | [optional] **until** | **String**| 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. | [optional] - **ownerId** | **Number**| If supplied, only organizations owned by the given user will be returned | [optional] - **firstChar** | **String**| If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive) | [optional] + **owner_id** | **Number**| If supplied, only organizations owned by the given user will be returned | [optional] + **first_char** | **String**| If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive) | [optional] ### Return type @@ -1059,7 +1068,7 @@ apiInstance.mergeOrganizations(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the organization | - **mergeOrganizationsRequest** | [**MergeOrganizationsRequest**](MergeOrganizationsRequest.md)| | [optional] + **MergeOrganizationsRequest** | [**MergeOrganizationsRequest**](MergeOrganizationsRequest.md)| | [optional] ### Return type @@ -1099,6 +1108,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.OrganizationsApi(apiClient); let term = "term_example"; // String | The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'fields': "fields_example", // String | A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields here. 'exactMatch': true, // Boolean | When enabled, only full exact matches against the given term are returned. It is not case sensitive. @@ -1120,7 +1130,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. | **fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. | [optional] - **exactMatch** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] + **exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] **start** | **Number**| Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] @@ -1179,7 +1189,7 @@ apiInstance.updateOrganization(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the organization | - **updateOrganization** | [**UpdateOrganization**](UpdateOrganization.md)| | [optional] + **UpdateOrganization** | [**UpdateOrganization**](UpdateOrganization.md)| | [optional] ### Return type diff --git a/docs/OrganizationsCollectionResponseObject.md b/docs/OrganizationsCollectionResponseObject.md index 7e422834..519c65bd 100644 --- a/docs/OrganizationsCollectionResponseObject.md +++ b/docs/OrganizationsCollectionResponseObject.md @@ -5,25 +5,25 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **address** | **String** | The full address of the organization | [optional] -**addressSubpremise** | **String** | The sub-premise of the organization location | [optional] -**addressStreetNumber** | **String** | The street number of the organization location | [optional] -**addressRoute** | **String** | The route of the organization location | [optional] -**addressSublocality** | **String** | The sub-locality of the organization location | [optional] -**addressLocality** | **String** | The locality of the organization location | [optional] -**addressAdminAreaLevel1** | **String** | The level 1 admin area of the organization location | [optional] -**addressAdminAreaLevel2** | **String** | The level 2 admin area of the organization location | [optional] -**addressCountry** | **String** | The country of the organization location | [optional] -**addressPostalCode** | **String** | The postal code of the organization location | [optional] -**addressFormattedAddress** | **String** | The formatted organization location | [optional] +**address_subpremise** | **String** | The sub-premise of the organization location | [optional] +**address_street_number** | **String** | The street number of the organization location | [optional] +**address_route** | **String** | The route of the organization location | [optional] +**address_sublocality** | **String** | The sub-locality of the organization location | [optional] +**address_locality** | **String** | The locality of the organization location | [optional] +**address_admin_area_level_1** | **String** | The level 1 admin area of the organization location | [optional] +**address_admin_area_level_2** | **String** | The level 2 admin area of the organization location | [optional] +**address_country** | **String** | The country of the organization location | [optional] +**address_postal_code** | **String** | The postal code of the organization location | [optional] +**address_formatted_address** | **String** | The formatted organization location | [optional] **id** | **Number** | The ID of the organization | [optional] -**activeFlag** | **Boolean** | Whether the organization is active or not | [optional] -**ownerId** | **Number** | The ID of the owner | [optional] +**active_flag** | **Boolean** | Whether the organization is active or not | [optional] +**owner_id** | **Number** | The ID of the owner | [optional] **name** | **String** | The name of the organization | [optional] -**updateTime** | **String** | The last updated date and time of the organization. Format: YYYY-MM-DD HH:MM:SS | [optional] -**deleteTime** | **String** | The date and time this organization was deleted. Format: YYYY-MM-DD HH:MM:SS | [optional] -**addTime** | **String** | The date and time when the organization was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] -**visibleTo** | **String** | The visibility group ID of who can see the organization | [optional] +**update_time** | **String** | The last updated date and time of the organization. Format: YYYY-MM-DD HH:MM:SS | [optional] +**delete_time** | **String** | The date and time this organization was deleted. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The date and time when the organization was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] +**visible_to** | **String** | The visibility group ID of who can see the organization | [optional] **label** | **Number** | The label assigned to the organization | [optional] -**ccEmail** | **String** | The BCC email associated with the organization | [optional] +**cc_email** | **String** | The BCC email associated with the organization | [optional] diff --git a/docs/OrganizationsCollectionResponseObjectAllOf.md b/docs/OrganizationsCollectionResponseObjectAllOf.md index 13a41b90..f9af7b04 100644 --- a/docs/OrganizationsCollectionResponseObjectAllOf.md +++ b/docs/OrganizationsCollectionResponseObjectAllOf.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the organization | [optional] -**activeFlag** | **Boolean** | Whether the organization is active or not | [optional] -**ownerId** | **Number** | The ID of the owner | [optional] +**active_flag** | **Boolean** | Whether the organization is active or not | [optional] +**owner_id** | **Number** | The ID of the owner | [optional] **name** | **String** | The name of the organization | [optional] -**updateTime** | **String** | The last updated date and time of the organization. Format: YYYY-MM-DD HH:MM:SS | [optional] -**deleteTime** | **String** | The date and time this organization was deleted. Format: YYYY-MM-DD HH:MM:SS | [optional] -**addTime** | **String** | The date and time when the organization was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] -**visibleTo** | **String** | The visibility group ID of who can see the organization | [optional] +**update_time** | **String** | The last updated date and time of the organization. Format: YYYY-MM-DD HH:MM:SS | [optional] +**delete_time** | **String** | The date and time this organization was deleted. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The date and time when the organization was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] +**visible_to** | **String** | The visibility group ID of who can see the organization | [optional] **label** | **Number** | The label assigned to the organization | [optional] -**ccEmail** | **String** | The BCC email associated with the organization | [optional] +**cc_email** | **String** | The BCC email associated with the organization | [optional] diff --git a/docs/Owner.md b/docs/Owner.md index 93b0fcf3..79ea81ed 100644 --- a/docs/Owner.md +++ b/docs/Owner.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **id** | **Number** | The ID of the user | [optional] **name** | **String** | The name of the user | [optional] **email** | **String** | The email of the user | [optional] -**hasPic** | **Number** | Whether the user has picture or not. 0 = No picture, 1 = Has picture. | [optional] -**picHash** | **String** | The user picture hash | [optional] -**activeFlag** | **Boolean** | Whether the user is active or not | [optional] +**has_pic** | **Number** | Whether the user has picture or not. 0 = No picture, 1 = Has picture. | [optional] +**pic_hash** | **String** | The user picture hash | [optional] +**active_flag** | **Boolean** | Whether the user is active or not | [optional] **value** | **Number** | The ID of the owner | [optional] diff --git a/docs/PaginationDetails.md b/docs/PaginationDetails.md index 43e54704..52cd0be2 100644 --- a/docs/PaginationDetails.md +++ b/docs/PaginationDetails.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start** | **Number** | Pagination start | [optional] **limit** | **Number** | Items shown per page | [optional] -**moreItemsInCollection** | **Boolean** | If there are more list items in the collection than displayed or not | [optional] -**nextStart** | **Number** | Next pagination start | [optional] +**more_items_in_collection** | **Boolean** | If there are more list items in the collection than displayed or not | [optional] +**next_start** | **Number** | Next pagination start | [optional] diff --git a/docs/PaginationDetailsAllOf.md b/docs/PaginationDetailsAllOf.md index 57c1848d..984af467 100644 --- a/docs/PaginationDetailsAllOf.md +++ b/docs/PaginationDetailsAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**nextStart** | **Number** | Next pagination start | [optional] +**next_start** | **Number** | Next pagination start | [optional] diff --git a/docs/Params.md b/docs/Params.md index 6d302b96..0f821a9f 100644 --- a/docs/Params.md +++ b/docs/Params.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pipelineId** | **[Number]** | The IDs of pipelines of the goal | [optional] -**activityTypeId** | **[Number]** | The IDs of activity types of the goal | [optional] +**pipeline_id** | **[Number]** | The IDs of pipelines of the goal | [optional] +**activity_type_id** | **[Number]** | The IDs of activity types of the goal | [optional] diff --git a/docs/ParticipantsChangelog.md b/docs/ParticipantsChangelog.md index cf3047f1..49421d50 100644 --- a/docs/ParticipantsChangelog.md +++ b/docs/ParticipantsChangelog.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the request was successful or not | [optional] **data** | [**[ParticipantsChangelogItem]**](ParticipantsChangelogItem.md) | The array of participant changelog | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] diff --git a/docs/ParticipantsChangelogItem.md b/docs/ParticipantsChangelogItem.md index 5867507d..5123783c 100644 --- a/docs/ParticipantsChangelogItem.md +++ b/docs/ParticipantsChangelogItem.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**actorUserId** | **Number** | The ID of the user | [optional] -**personId** | **Number** | The ID of the person | [optional] +**actor_user_id** | **Number** | The ID of the user | [optional] +**person_id** | **Number** | The ID of the person | [optional] **action** | **String** | Deal participant action type | [optional] **time** | **String** | The deal participant action log time | [optional] diff --git a/docs/PaymentItem.md b/docs/PaymentItem.md index 6f5ee6a0..2a7efb4e 100644 --- a/docs/PaymentItem.md +++ b/docs/PaymentItem.md @@ -5,18 +5,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the payment | [optional] -**subscriptionId** | **Number** | The ID of the subscription this payment is associated with | [optional] -**dealId** | **Number** | The ID of the deal this payment is associated with | [optional] -**isActive** | **Boolean** | The payment status | [optional] +**subscription_id** | **Number** | The ID of the subscription this payment is associated with | [optional] +**deal_id** | **Number** | The ID of the deal this payment is associated with | [optional] +**is_active** | **Boolean** | The payment status | [optional] **amount** | **Number** | The payment amount | [optional] **currency** | **String** | The currency of the payment | [optional] -**changeAmount** | **Number** | The difference between the amount of the current payment and the previous payment. The value can be either positive or negative. | [optional] -**dueAt** | **Date** | The date when payment occurs | [optional] -**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] +**change_amount** | **Number** | The difference between the amount of the current payment and the previous payment. The value can be either positive or negative. | [optional] +**due_at** | **Date** | The date when payment occurs | [optional] +**revenue_movement_type** | **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] +**payment_type** | **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** | **Date** | The creation time of the payment | [optional] -**updateTime** | **Date** | The update time of the payment | [optional] +**add_time** | **Date** | The creation time of the payment | [optional] +**update_time** | **Date** | The update time of the payment | [optional] diff --git a/docs/PermissionSetsApi.md b/docs/PermissionSetsApi.md index e96b7db8..11f1f036 100644 --- a/docs/PermissionSetsApi.md +++ b/docs/PermissionSetsApi.md @@ -87,6 +87,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PermissionSetsApi(apiClient); let id = "id_example"; // String | The ID of the permission set +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -145,6 +146,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PermissionSetsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'app': "app_example" // String | The app to filter the permission sets by }; diff --git a/docs/PermissionSetsItem.md b/docs/PermissionSetsItem.md index c30cb599..48e6610d 100644 --- a/docs/PermissionSetsItem.md +++ b/docs/PermissionSetsItem.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **description** | **String** | The description of the permission set | [optional] **app** | **String** | The app that permission set belongs to | [optional] **type** | **String** | The type of permission set | [optional] -**assignmentCount** | **Number** | The number of users assigned to this permission set | [optional] +**assignment_count** | **Number** | The number of users assigned to this permission set | [optional] diff --git a/docs/PersonCountAndEmailInfo.md b/docs/PersonCountAndEmailInfo.md index e53d60b2..1aaaa67e 100644 --- a/docs/PersonCountAndEmailInfo.md +++ b/docs/PersonCountAndEmailInfo.md @@ -4,14 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**emailMessagesCount** | **Number** | The count of email messages related to the person | [optional] -**activitiesCount** | **Number** | The count of activities related to the person | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the person | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the person | [optional] -**filesCount** | **Number** | The count of files related to the person | [optional] -**notesCount** | **Number** | The count of notes related to the person | [optional] -**followersCount** | **Number** | The count of followers related to the person | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the person | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the person | [optional] +**email_messages_count** | **Number** | The count of email messages related to the person | [optional] +**activities_count** | **Number** | The count of activities related to the person | [optional] +**done_activities_count** | **Number** | The count of done activities related to the person | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the person | [optional] +**files_count** | **Number** | The count of files related to the person | [optional] +**notes_count** | **Number** | The count of notes related to the person | [optional] +**followers_count** | **Number** | The count of followers related to the person | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the person | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the person | [optional] diff --git a/docs/PersonCountEmailDealAndActivityInfo.md b/docs/PersonCountEmailDealAndActivityInfo.md index eba0c223..1fbd57b6 100644 --- a/docs/PersonCountEmailDealAndActivityInfo.md +++ b/docs/PersonCountEmailDealAndActivityInfo.md @@ -4,27 +4,27 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**emailMessagesCount** | **Number** | The count of email messages related to the person | [optional] -**activitiesCount** | **Number** | The count of activities related to the person | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the person | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the person | [optional] -**filesCount** | **Number** | The count of files related to the person | [optional] -**notesCount** | **Number** | The count of notes related to the person | [optional] -**followersCount** | **Number** | The count of followers related to the person | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the person | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the person | [optional] -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] +**email_messages_count** | **Number** | The count of email messages related to the person | [optional] +**activities_count** | **Number** | The count of activities related to the person | [optional] +**done_activities_count** | **Number** | The count of done activities related to the person | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the person | [optional] +**files_count** | **Number** | The count of files related to the person | [optional] +**notes_count** | **Number** | The count of notes related to the person | [optional] +**followers_count** | **Number** | The count of followers related to the person | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the person | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the person | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] diff --git a/docs/PersonCountInfo.md b/docs/PersonCountInfo.md index 94cf0a40..9eb37fe7 100644 --- a/docs/PersonCountInfo.md +++ b/docs/PersonCountInfo.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**emailMessagesCount** | **Number** | The count of email messages related to the person | [optional] -**activitiesCount** | **Number** | The count of activities related to the person | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the person | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the person | [optional] -**filesCount** | **Number** | The count of files related to the person | [optional] -**notesCount** | **Number** | The count of notes related to the person | [optional] -**followersCount** | **Number** | The count of followers related to the person | [optional] +**email_messages_count** | **Number** | The count of email messages related to the person | [optional] +**activities_count** | **Number** | The count of activities related to the person | [optional] +**done_activities_count** | **Number** | The count of done activities related to the person | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the person | [optional] +**files_count** | **Number** | The count of files related to the person | [optional] +**notes_count** | **Number** | The count of notes related to the person | [optional] +**followers_count** | **Number** | The count of followers related to the person | [optional] diff --git a/docs/PersonData.md b/docs/PersonData.md index fed1a9ed..4a242195 100644 --- a/docs/PersonData.md +++ b/docs/PersonData.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **name** | **String** | The name of the person associated with the item | [optional] **email** | [**[PersonDataEmail]**](PersonDataEmail.md) | The emails of the person associated with the item | [optional] **phone** | [**[PersonDataPhone]**](PersonDataPhone.md) | The phone numbers of the person associated with the item | [optional] -**ownerId** | **Number** | The ID of the owner of the person that is associated with the item | [optional] +**owner_id** | **Number** | The ID of the owner of the person that is associated with the item | [optional] diff --git a/docs/PersonDataWithActiveFlag.md b/docs/PersonDataWithActiveFlag.md index c8dea4d7..e3110388 100644 --- a/docs/PersonDataWithActiveFlag.md +++ b/docs/PersonDataWithActiveFlag.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**activeFlag** | **Boolean** | Whether the associated person is active or not | [optional] +**active_flag** | **Boolean** | Whether the associated person is active or not | [optional] **id** | **Number** | The ID of the person associated with the item | [optional] **name** | **String** | The name of the person associated with the item | [optional] **email** | [**[PersonDataEmail]**](PersonDataEmail.md) | The emails of the person associated with the item | [optional] **phone** | [**[PersonDataPhone]**](PersonDataPhone.md) | The phone numbers of the person associated with the item | [optional] -**ownerId** | **Number** | The ID of the owner of the person that is associated with the item | [optional] +**owner_id** | **Number** | The ID of the owner of the person that is associated with the item | [optional] diff --git a/docs/PersonDataWithActiveFlagAllOf.md b/docs/PersonDataWithActiveFlagAllOf.md index f03b4fe2..f49259e1 100644 --- a/docs/PersonDataWithActiveFlagAllOf.md +++ b/docs/PersonDataWithActiveFlagAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**activeFlag** | **Boolean** | Whether the associated person is active or not | [optional] +**active_flag** | **Boolean** | Whether the associated person is active or not | [optional] diff --git a/docs/PersonFieldsApi.md b/docs/PersonFieldsApi.md index 81f70516..59248177 100644 --- a/docs/PersonFieldsApi.md +++ b/docs/PersonFieldsApi.md @@ -52,7 +52,7 @@ apiInstance.addPersonField(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **fieldCreateRequest** | [**FieldCreateRequest**](FieldCreateRequest.md)| | [optional] + **FieldCreateRequest** | [**FieldCreateRequest**](FieldCreateRequest.md)| | [optional] ### Return type @@ -250,6 +250,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonFieldsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -325,7 +326,7 @@ apiInstance.updatePersonField(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the field | - **fieldUpdateRequest** | [**FieldUpdateRequest**](FieldUpdateRequest.md)| | [optional] + **FieldUpdateRequest** | [**FieldUpdateRequest**](FieldUpdateRequest.md)| | [optional] ### Return type diff --git a/docs/PersonFlowResponse.md b/docs/PersonFlowResponse.md index bd5910fe..45ae9877 100644 --- a/docs/PersonFlowResponse.md +++ b/docs/PersonFlowResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[PersonFlowResponseAllOfData]**](PersonFlowResponseAllOfData.md) | | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**DealFlowResponseAllOfRelatedObjects**](DealFlowResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**DealFlowResponseAllOfRelatedObjects**](DealFlowResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/PersonFlowResponseAllOf.md b/docs/PersonFlowResponseAllOf.md index a3aa0f8f..2eb5c983 100644 --- a/docs/PersonFlowResponseAllOf.md +++ b/docs/PersonFlowResponseAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[PersonFlowResponseAllOfData]**](PersonFlowResponseAllOfData.md) | | [optional] -**additionalData** | [**AdditionalData**](AdditionalData.md) | | [optional] -**relatedObjects** | [**DealFlowResponseAllOfRelatedObjects**](DealFlowResponseAllOfRelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](AdditionalData.md) | | [optional] +**related_objects** | [**DealFlowResponseAllOfRelatedObjects**](DealFlowResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/PersonItem.md b/docs/PersonItem.md index 152f3be7..a98fb747 100644 --- a/docs/PersonItem.md +++ b/docs/PersonItem.md @@ -5,45 +5,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the person | [optional] -**companyId** | **Number** | The ID of the company related to the person | [optional] -**activeFlag** | **Boolean** | Whether the person is active or not | [optional] +**company_id** | **Number** | The ID of the company related to the person | [optional] +**active_flag** | **Boolean** | Whether the person is active or not | [optional] **phone** | [**[BasePersonItemPhone]**](BasePersonItemPhone.md) | A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ \"value\": \"12345\", \"primary\": \"true\", \"label\": \"mobile\" }]`. Please note that only `value` is required. | [optional] **email** | [**[BasePersonItemEmail]**](BasePersonItemEmail.md) | An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ \"value\": \"mail@example.com\", \"primary\": \"true\", \"label\": \"main\" } ]`. Please note that only `value` is required. | [optional] -**firstChar** | **String** | The first letter of the name of the person | [optional] -**addTime** | **String** | The date and time when the person was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] -**updateTime** | **String** | The last updated date and time of the person. Format: YYYY-MM-DD HH:MM:SS | [optional] -**visibleTo** | **String** | The visibility group ID of who can see the person | [optional] -**pictureId** | [**PictureDataWithID**](PictureDataWithID.md) | | [optional] +**first_char** | **String** | The first letter of the name of the person | [optional] +**add_time** | **String** | The date and time when the person was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] +**update_time** | **String** | The last updated date and time of the person. Format: YYYY-MM-DD HH:MM:SS | [optional] +**visible_to** | **String** | The visibility group ID of who can see the person | [optional] +**picture_id** | [**PictureDataWithID**](PictureDataWithID.md) | | [optional] **label** | **Number** | The label assigned to the person | [optional] -**orgName** | **String** | The name of the organization associated with the person | [optional] -**ownerName** | **String** | The name of the owner associated with the person | [optional] -**ccEmail** | **String** | The BCC email associated with the person | [optional] -**ownerId** | [**Owner**](Owner.md) | | [optional] -**orgId** | [**RelationshipOrganizationInfoItemWithActiveFlag**](RelationshipOrganizationInfoItemWithActiveFlag.md) | | [optional] +**org_name** | **String** | The name of the organization associated with the person | [optional] +**owner_name** | **String** | The name of the owner associated with the person | [optional] +**cc_email** | **String** | The BCC email associated with the person | [optional] +**owner_id** | [**Owner**](Owner.md) | | [optional] +**org_id** | [**RelationshipOrganizationInfoItemWithActiveFlag**](RelationshipOrganizationInfoItemWithActiveFlag.md) | | [optional] **name** | **String** | The name of the person | [optional] -**firstName** | **String** | The first name of the person | [optional] -**lastName** | **String** | The last name of the person | [optional] -**emailMessagesCount** | **Number** | The count of email messages related to the person | [optional] -**activitiesCount** | **Number** | The count of activities related to the person | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the person | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the person | [optional] -**filesCount** | **Number** | The count of files related to the person | [optional] -**notesCount** | **Number** | The count of notes related to the person | [optional] -**followersCount** | **Number** | The count of followers related to the person | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the person | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the person | [optional] -**openDealsCount** | **Number** | The count of open deals related with the item | [optional] -**relatedOpenDealsCount** | **Number** | The count of related open deals related with the item | [optional] -**closedDealsCount** | **Number** | The count of closed deals related with the item | [optional] -**relatedClosedDealsCount** | **Number** | The count of related closed deals related with the item | [optional] -**wonDealsCount** | **Number** | The count of won deals related with the item | [optional] -**relatedWonDealsCount** | **Number** | The count of related won deals related with the item | [optional] -**lostDealsCount** | **Number** | The count of lost deals related with the item | [optional] -**relatedLostDealsCount** | **Number** | The count of related lost deals related with the item | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] +**first_name** | **String** | The first name of the person | [optional] +**last_name** | **String** | The last name of the person | [optional] +**email_messages_count** | **Number** | The count of email messages related to the person | [optional] +**activities_count** | **Number** | The count of activities related to the person | [optional] +**done_activities_count** | **Number** | The count of done activities related to the person | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the person | [optional] +**files_count** | **Number** | The count of files related to the person | [optional] +**notes_count** | **Number** | The count of notes related to the person | [optional] +**followers_count** | **Number** | The count of followers related to the person | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the person | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the person | [optional] +**open_deals_count** | **Number** | The count of open deals related with the item | [optional] +**related_open_deals_count** | **Number** | The count of related open deals related with the item | [optional] +**closed_deals_count** | **Number** | The count of closed deals related with the item | [optional] +**related_closed_deals_count** | **Number** | The count of related closed deals related with the item | [optional] +**won_deals_count** | **Number** | The count of won deals related with the item | [optional] +**related_won_deals_count** | **Number** | The count of related won deals related with the item | [optional] +**lost_deals_count** | **Number** | The count of lost deals related with the item | [optional] +**related_lost_deals_count** | **Number** | The count of related lost deals related with the item | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] diff --git a/docs/PersonListProduct.md b/docs/PersonListProduct.md index 3bbb9133..3506dddc 100644 --- a/docs/PersonListProduct.md +++ b/docs/PersonListProduct.md @@ -5,21 +5,21 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the product | [optional] -**companyId** | **Number** | The ID of the company | [optional] +**company_id** | **Number** | The ID of the company | [optional] **name** | **String** | The name of the product | [optional] **code** | **String** | The product code | [optional] **description** | **String** | The description of the product | [optional] **unit** | **String** | The unit in which this product is sold | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] **category** | **String** | The category of the product | [optional] -**activeFlag** | **Boolean** | Whether this product will be made active or not | [optional] [default to true] +**active_flag** | **Boolean** | Whether this product will be made active or not | [optional] [default to true] **selectable** | **Boolean** | Whether this product can be selected in deals or not | [optional] [default to true] -**firstChar** | **String** | The first letter of the product name | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers (private)</td></tr><tr><td>`3`</td><td>Entire company (shared)</td></tr></table> | [optional] -**ownerId** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional] -**filesCount** | **Number** | The count of files | [optional] -**addTime** | **String** | The date and time when the product was added to the deal | [optional] -**updateTime** | **String** | The date and time when the product was updated to the deal | [optional] -**dealId** | **Number** | The ID of the deal | [optional] +**first_char** | **String** | The first letter of the product name | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers (private)</td></tr><tr><td>`3`</td><td>Entire company (shared)</td></tr></table> | [optional] +**owner_id** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional] +**files_count** | **Number** | The count of files | [optional] +**add_time** | **String** | The date and time when the product was added to the deal | [optional] +**update_time** | **String** | The date and time when the product was updated to the deal | [optional] +**deal_id** | **Number** | The ID of the deal | [optional] diff --git a/docs/PersonNameCountAndEmailInfo.md b/docs/PersonNameCountAndEmailInfo.md index ba51e304..e133da09 100644 --- a/docs/PersonNameCountAndEmailInfo.md +++ b/docs/PersonNameCountAndEmailInfo.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the person | [optional] -**firstName** | **String** | The first name of the person | [optional] -**lastName** | **String** | The last name of the person | [optional] -**emailMessagesCount** | **Number** | The count of email messages related to the person | [optional] -**activitiesCount** | **Number** | The count of activities related to the person | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the person | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the person | [optional] -**filesCount** | **Number** | The count of files related to the person | [optional] -**notesCount** | **Number** | The count of notes related to the person | [optional] -**followersCount** | **Number** | The count of followers related to the person | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the person | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the person | [optional] +**first_name** | **String** | The first name of the person | [optional] +**last_name** | **String** | The last name of the person | [optional] +**email_messages_count** | **Number** | The count of email messages related to the person | [optional] +**activities_count** | **Number** | The count of activities related to the person | [optional] +**done_activities_count** | **Number** | The count of done activities related to the person | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the person | [optional] +**files_count** | **Number** | The count of files related to the person | [optional] +**notes_count** | **Number** | The count of notes related to the person | [optional] +**followers_count** | **Number** | The count of followers related to the person | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the person | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the person | [optional] diff --git a/docs/PersonNameCountAndEmailInfoWithIds.md b/docs/PersonNameCountAndEmailInfoWithIds.md index fe36dabb..3614a813 100644 --- a/docs/PersonNameCountAndEmailInfoWithIds.md +++ b/docs/PersonNameCountAndEmailInfoWithIds.md @@ -4,20 +4,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ownerId** | **Number** | The ID of the owner related to the person | [optional] -**orgId** | **Number** | The ID of the organization related to the person | [optional] -**mergeWhatId** | **Number** | The ID of the person with what the main person was merged | [optional] +**owner_id** | **Number** | The ID of the owner related to the person | [optional] +**org_id** | **Number** | The ID of the organization related to the person | [optional] +**merge_what_id** | **Number** | The ID of the person with what the main person was merged | [optional] **name** | **String** | The name of the person | [optional] -**firstName** | **String** | The first name of the person | [optional] -**lastName** | **String** | The last name of the person | [optional] -**emailMessagesCount** | **Number** | The count of email messages related to the person | [optional] -**activitiesCount** | **Number** | The count of activities related to the person | [optional] -**doneActivitiesCount** | **Number** | The count of done activities related to the person | [optional] -**undoneActivitiesCount** | **Number** | The count of undone activities related to the person | [optional] -**filesCount** | **Number** | The count of files related to the person | [optional] -**notesCount** | **Number** | The count of notes related to the person | [optional] -**followersCount** | **Number** | The count of followers related to the person | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the person | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the person | [optional] +**first_name** | **String** | The first name of the person | [optional] +**last_name** | **String** | The last name of the person | [optional] +**email_messages_count** | **Number** | The count of email messages related to the person | [optional] +**activities_count** | **Number** | The count of activities related to the person | [optional] +**done_activities_count** | **Number** | The count of done activities related to the person | [optional] +**undone_activities_count** | **Number** | The count of undone activities related to the person | [optional] +**files_count** | **Number** | The count of files related to the person | [optional] +**notes_count** | **Number** | The count of notes related to the person | [optional] +**followers_count** | **Number** | The count of followers related to the person | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the person | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the person | [optional] diff --git a/docs/PersonNameCountAndEmailInfoWithIdsAllOf.md b/docs/PersonNameCountAndEmailInfoWithIdsAllOf.md index fb9e957c..0670fa5b 100644 --- a/docs/PersonNameCountAndEmailInfoWithIdsAllOf.md +++ b/docs/PersonNameCountAndEmailInfoWithIdsAllOf.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ownerId** | **Number** | The ID of the owner related to the person | [optional] -**orgId** | **Number** | The ID of the organization related to the person | [optional] -**mergeWhatId** | **Number** | The ID of the person with what the main person was merged | [optional] +**owner_id** | **Number** | The ID of the owner related to the person | [optional] +**org_id** | **Number** | The ID of the organization related to the person | [optional] +**merge_what_id** | **Number** | The ID of the person with what the main person was merged | [optional] diff --git a/docs/PersonNameInfo.md b/docs/PersonNameInfo.md index 99b255fb..0640a05e 100644 --- a/docs/PersonNameInfo.md +++ b/docs/PersonNameInfo.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the person | [optional] -**firstName** | **String** | The first name of the person | [optional] -**lastName** | **String** | The last name of the person | [optional] +**first_name** | **String** | The first name of the person | [optional] +**last_name** | **String** | The last name of the person | [optional] diff --git a/docs/PersonNameInfoWithOrgAndOwnerId.md b/docs/PersonNameInfoWithOrgAndOwnerId.md index ad255ef5..d179a366 100644 --- a/docs/PersonNameInfoWithOrgAndOwnerId.md +++ b/docs/PersonNameInfoWithOrgAndOwnerId.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ownerId** | [**Owner**](Owner.md) | | [optional] -**orgId** | [**RelationshipOrganizationInfoItemWithActiveFlag**](RelationshipOrganizationInfoItemWithActiveFlag.md) | | [optional] +**owner_id** | [**Owner**](Owner.md) | | [optional] +**org_id** | [**RelationshipOrganizationInfoItemWithActiveFlag**](RelationshipOrganizationInfoItemWithActiveFlag.md) | | [optional] **name** | **String** | The name of the person | [optional] -**firstName** | **String** | The first name of the person | [optional] -**lastName** | **String** | The last name of the person | [optional] +**first_name** | **String** | The first name of the person | [optional] +**last_name** | **String** | The last name of the person | [optional] diff --git a/docs/PersonSearchItem.md b/docs/PersonSearchItem.md index 00766f9e..a3f5d400 100644 --- a/docs/PersonSearchItem.md +++ b/docs/PersonSearchItem.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultScore** | **Number** | Search result relevancy | [optional] +**result_score** | **Number** | Search result relevancy | [optional] **item** | [**PersonSearchItemItem**](PersonSearchItemItem.md) | | [optional] diff --git a/docs/PersonSearchItemItem.md b/docs/PersonSearchItemItem.md index 6fca5311..f1b88cdd 100644 --- a/docs/PersonSearchItemItem.md +++ b/docs/PersonSearchItemItem.md @@ -9,10 +9,10 @@ Name | Type | Description | Notes **name** | **String** | The name of the person | [optional] **phones** | **[String]** | An array of phone numbers | [optional] **emails** | **[String]** | An array of email addresses | [optional] -**visibleTo** | **Number** | The visibility of the person | [optional] +**visible_to** | **Number** | The visibility of the person | [optional] **owner** | [**PersonSearchItemItemOwner**](PersonSearchItemItemOwner.md) | | [optional] **organization** | [**PersonSearchItemItemOrganization**](PersonSearchItemItemOrganization.md) | | [optional] -**customFields** | **[String]** | Custom fields | [optional] +**custom_fields** | **[String]** | Custom fields | [optional] **notes** | **[String]** | An array of notes | [optional] diff --git a/docs/PersonSearchResponse.md b/docs/PersonSearchResponse.md index 9d1e6cb2..97cfd289 100644 --- a/docs/PersonSearchResponse.md +++ b/docs/PersonSearchResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**PersonSearchResponseAllOfData**](PersonSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/PersonSearchResponseAllOf.md b/docs/PersonSearchResponseAllOf.md index a31c36dd..69322159 100644 --- a/docs/PersonSearchResponseAllOf.md +++ b/docs/PersonSearchResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**PersonSearchResponseAllOfData**](PersonSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/PersonsApi.md b/docs/PersonsApi.md index a5f19c03..c51ed7ea 100644 --- a/docs/PersonsApi.md +++ b/docs/PersonsApi.md @@ -68,7 +68,7 @@ apiInstance.addPerson(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **newPerson** | [**NewPerson**](NewPerson.md)| | [optional] + **NewPerson** | [**NewPerson**](NewPerson.md)| | [optional] ### Return type @@ -125,7 +125,7 @@ apiInstance.addPersonFollower(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the person | - **addPersonFollowerRequest** | [**AddPersonFollowerRequest**](AddPersonFollowerRequest.md)| | [optional] + **AddPersonFollowerRequest** | [**AddPersonFollowerRequest**](AddPersonFollowerRequest.md)| | [optional] ### Return type @@ -166,6 +166,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonsApi(apiClient); let id = 56; // Number | The ID of the person let file = "/path/to/file"; // File | One image supplied in the multipart/form-data encoding +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'cropX': 56, // Number | X coordinate to where start cropping form (in pixels) 'cropY': 56, // Number | Y coordinate to where start cropping form (in pixels) @@ -187,10 +188,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the person | **file** | **File**| One image supplied in the multipart/form-data encoding | - **cropX** | **Number**| X coordinate to where start cropping form (in pixels) | [optional] - **cropY** | **Number**| Y coordinate to where start cropping form (in pixels) | [optional] - **cropWidth** | **Number**| The width of the cropping area (in pixels) | [optional] - **cropHeight** | **Number**| The height of the cropping area (in pixels) | [optional] + **crop_x** | **Number**| X coordinate to where start cropping form (in pixels) | [optional] + **crop_y** | **Number**| Y coordinate to where start cropping form (in pixels) | [optional] + **crop_width** | **Number**| The width of the cropping area (in pixels) | [optional] + **crop_height** | **Number**| The height of the cropping area (in pixels) | [optional] ### Return type @@ -298,7 +299,7 @@ apiInstance.deletePersonFollower(id, followerId).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the person | - **followerId** | **Number**| The ID of the follower | + **follower_id** | **Number**| The ID of the follower | ### Return type @@ -497,6 +498,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonsApi(apiClient); let id = 56; // Number | The ID of the person +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -560,6 +562,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonsApi(apiClient); let id = 56; // Number | The ID of the person +// snake_case as well as camelCase is supported for naming opts properties 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 @@ -619,6 +622,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonsApi(apiClient); let id = 56; // Number | The ID of the person +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -682,6 +686,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonsApi(apiClient); let id = 56; // Number | The ID of the person +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -796,6 +801,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonsApi(apiClient); let id = 56; // Number | The ID of the person +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -855,6 +861,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonsApi(apiClient); let id = 56; // Number | The ID of the person +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -914,6 +921,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonsApi(apiClient); let id = 56; // Number | The ID of the person +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -936,7 +944,7 @@ Name | Type | Description | Notes **id** | **Number**| The ID of the person | **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] - **allChanges** | **String**| Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates. | [optional] + **all_changes** | **String**| Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates. | [optional] **items** | **String**| A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change). | [optional] ### Return type @@ -1029,6 +1037,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'userId': 56, // Number | If supplied, only persons owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied. 'filterId': 56, // Number | The ID of the filter to use @@ -1050,9 +1059,9 @@ apiInstance.getPersons(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Number**| If supplied, only persons owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied. | [optional] - **filterId** | **Number**| The ID of the filter to use | [optional] - **firstChar** | **String**| If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive) | [optional] + **user_id** | **Number**| If supplied, only persons owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied. | [optional] + **filter_id** | **Number**| The ID of the filter to use | [optional] + **first_char** | **String**| If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive) | [optional] **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] **sort** | **String**| 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). | [optional] @@ -1094,6 +1103,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page 'limit': 100, // Number | 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. @@ -1119,8 +1129,8 @@ Name | Type | Description | Notes **limit** | **Number**| 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. | [optional] **since** | **String**| 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. | [optional] **until** | **String**| 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. | [optional] - **ownerId** | **Number**| If supplied, only persons owned by the given user will be returned | [optional] - **firstChar** | **String**| If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive) | [optional] + **owner_id** | **Number**| If supplied, only persons owned by the given user will be returned | [optional] + **first_char** | **String**| If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive) | [optional] ### Return type @@ -1177,7 +1187,7 @@ apiInstance.mergePersons(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the person | - **mergePersonsRequest** | [**MergePersonsRequest**](MergePersonsRequest.md)| | [optional] + **MergePersonsRequest** | [**MergePersonsRequest**](MergePersonsRequest.md)| | [optional] ### Return type @@ -1217,6 +1227,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PersonsApi(apiClient); let term = "term_example"; // String | The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'fields': "fields_example", // String | A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields here. 'exactMatch': true, // Boolean | When enabled, only full exact matches against the given term are returned. It is not case sensitive. @@ -1240,9 +1251,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. | **fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. | [optional] - **exactMatch** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] - **organizationId** | **Number**| Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000. | [optional] - **includeFields** | **String**| Supports including optional fields in the results which are not provided by default | [optional] + **exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] + **organization_id** | **Number**| Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000. | [optional] + **include_fields** | **String**| Supports including optional fields in the results which are not provided by default | [optional] **start** | **Number**| Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] @@ -1301,7 +1312,7 @@ apiInstance.updatePerson(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the person | - **updatePerson** | [**UpdatePerson**](UpdatePerson.md)| | [optional] + **UpdatePerson** | [**UpdatePerson**](UpdatePerson.md)| | [optional] ### Return type diff --git a/docs/PersonsCollectionResponseObject.md b/docs/PersonsCollectionResponseObject.md index c856a7d9..dffb668c 100644 --- a/docs/PersonsCollectionResponseObject.md +++ b/docs/PersonsCollectionResponseObject.md @@ -5,18 +5,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the person | [optional] -**activeFlag** | **Boolean** | Whether the person is active or not | [optional] -**ownerId** | **Number** | The ID of the owner related to the person | [optional] -**orgId** | **Number** | The ID of the organization related to the person | [optional] +**active_flag** | **Boolean** | Whether the person is active or not | [optional] +**owner_id** | **Number** | The ID of the owner related to the person | [optional] +**org_id** | **Number** | The ID of the organization related to the person | [optional] **name** | **String** | The name of the person | [optional] **email** | [**[BasicPersonEmail]**](BasicPersonEmail.md) | An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ \"value\": \"mail@example.com\", \"primary\": \"true\", \"label\": \"main\" }]`. Please note that only `value` is required. | [optional] **phone** | [**[BasePersonItemPhone]**](BasePersonItemPhone.md) | A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ \"value\": \"12345\", \"primary\": \"true\", \"label\": \"mobile\" }]`. Please note that only `value` is required. | [optional] -**updateTime** | **String** | The last updated date and time of the person. Format: YYYY-MM-DD HH:MM:SS | [optional] -**deleteTime** | **String** | The date and time this person was deleted. Format: YYYY-MM-DD HH:MM:SS | [optional] -**addTime** | **String** | The date and time when the person was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] -**visibleTo** | **String** | The visibility group ID of who can see the person | [optional] -**pictureId** | **Number** | The ID of the picture associated with the item | [optional] +**update_time** | **String** | The last updated date and time of the person. Format: YYYY-MM-DD HH:MM:SS | [optional] +**delete_time** | **String** | The date and time this person was deleted. Format: YYYY-MM-DD HH:MM:SS | [optional] +**add_time** | **String** | The date and time when the person was added/created. Format: YYYY-MM-DD HH:MM:SS | [optional] +**visible_to** | **String** | The visibility group ID of who can see the person | [optional] +**picture_id** | **Number** | The ID of the picture associated with the item | [optional] **label** | **Number** | The label assigned to the person | [optional] -**ccEmail** | **String** | The BCC email associated with the person | [optional] +**cc_email** | **String** | The BCC email associated with the person | [optional] diff --git a/docs/PictureData.md b/docs/PictureData.md index 9e86f600..7b4d30d2 100644 --- a/docs/PictureData.md +++ b/docs/PictureData.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**itemType** | **String** | The type of item the picture is related to | [optional] -**itemId** | **Number** | The ID of related item | [optional] -**activeFlag** | **Boolean** | Whether the associated picture is active or not | [optional] -**addTime** | **String** | The add time of the picture | [optional] -**updateTime** | **String** | The update time of the picture | [optional] -**addedByUserId** | **Number** | The ID of the user who added the picture | [optional] +**item_type** | **String** | The type of item the picture is related to | [optional] +**item_id** | **Number** | The ID of related item | [optional] +**active_flag** | **Boolean** | Whether the associated picture is active or not | [optional] +**add_time** | **String** | The add time of the picture | [optional] +**update_time** | **String** | The update time of the picture | [optional] +**added_by_user_id** | **Number** | The ID of the user who added the picture | [optional] **pictures** | [**PictureDataPictures**](PictureDataPictures.md) | | [optional] diff --git a/docs/PictureDataPictures.md b/docs/PictureDataPictures.md index 68427e18..76b029a9 100644 --- a/docs/PictureDataPictures.md +++ b/docs/PictureDataPictures.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_128** | **String** | The URL of the 128*128 picture | [optional] -**_512** | **String** | The URL of the 512*512 picture | [optional] +**128** | **String** | The URL of the 128*128 picture | [optional] +**512** | **String** | The URL of the 512*512 picture | [optional] diff --git a/docs/PictureDataWithID.md b/docs/PictureDataWithID.md index a7702630..8f1fc6f4 100644 --- a/docs/PictureDataWithID.md +++ b/docs/PictureDataWithID.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the picture associated with the item | [optional] -**itemType** | **String** | The type of item the picture is related to | [optional] -**itemId** | **Number** | The ID of related item | [optional] -**activeFlag** | **Boolean** | Whether the associated picture is active or not | [optional] -**addTime** | **String** | The add time of the picture | [optional] -**updateTime** | **String** | The update time of the picture | [optional] -**addedByUserId** | **Number** | The ID of the user who added the picture | [optional] +**item_type** | **String** | The type of item the picture is related to | [optional] +**item_id** | **Number** | The ID of related item | [optional] +**active_flag** | **Boolean** | Whether the associated picture is active or not | [optional] +**add_time** | **String** | The add time of the picture | [optional] +**update_time** | **String** | The update time of the picture | [optional] +**added_by_user_id** | **Number** | The ID of the user who added the picture | [optional] **pictures** | [**PictureDataPictures**](PictureDataPictures.md) | | [optional] diff --git a/docs/PictureDataWithValue.md b/docs/PictureDataWithValue.md index 18e934c5..b84f16b2 100644 --- a/docs/PictureDataWithValue.md +++ b/docs/PictureDataWithValue.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **Number** | The ID of the picture associated with the item | [optional] -**itemType** | **String** | The type of item the picture is related to | [optional] -**itemId** | **Number** | The ID of related item | [optional] -**activeFlag** | **Boolean** | Whether the associated picture is active or not | [optional] -**addTime** | **String** | The add time of the picture | [optional] -**updateTime** | **String** | The update time of the picture | [optional] -**addedByUserId** | **Number** | The ID of the user who added the picture | [optional] +**item_type** | **String** | The type of item the picture is related to | [optional] +**item_id** | **Number** | The ID of related item | [optional] +**active_flag** | **Boolean** | Whether the associated picture is active or not | [optional] +**add_time** | **String** | The add time of the picture | [optional] +**update_time** | **String** | The update time of the picture | [optional] +**added_by_user_id** | **Number** | The ID of the user who added the picture | [optional] **pictures** | [**PictureDataPictures**](PictureDataPictures.md) | | [optional] diff --git a/docs/Pipeline.md b/docs/Pipeline.md index 451cadd6..918c4dc9 100644 --- a/docs/Pipeline.md +++ b/docs/Pipeline.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the pipeline | [optional] -**dealProbability** | [**NumberBoolean**](NumberBoolean.md) | Whether deal probability is disabled or enabled for this pipeline | [optional] -**orderNr** | **Number** | Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline. | [optional] +**deal_probability** | [**NumberBoolean**](NumberBoolean.md) | Whether deal probability is disabled or enabled for this pipeline | [optional] +**order_nr** | **Number** | Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline. | [optional] **active** | [**NumberBoolean**](NumberBoolean.md) | Whether this pipeline will be made inactive (hidden) or active | [optional] diff --git a/docs/PipelineDetails.md b/docs/PipelineDetails.md index 2d01bf97..82787100 100644 --- a/docs/PipelineDetails.md +++ b/docs/PipelineDetails.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the pipeline | [optional] **name** | **String** | The name of the pipeline | [optional] -**urlTitle** | **String** | The pipeline title displayed in the URL | [optional] -**orderNr** | **Number** | Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline. | [optional] +**url_title** | **String** | The pipeline title displayed in the URL | [optional] +**order_nr** | **Number** | Defines the order of pipelines. First order (`order_nr=0`) is the default pipeline. | [optional] **active** | **Boolean** | Whether this pipeline will be made inactive (hidden) or active | [optional] -**dealProbability** | **Boolean** | Whether deal probability is disabled or enabled for this pipeline | [optional] -**addTime** | **String** | The pipeline creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The pipeline update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**deal_probability** | **Boolean** | Whether deal probability is disabled or enabled for this pipeline | [optional] +**add_time** | **String** | The pipeline creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The pipeline update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] **selected** | **Boolean** | A boolean that shows if the pipeline is selected from a filter or not | [optional] -**dealsSummary** | [**DealSummary**](DealSummary.md) | | [optional] +**deals_summary** | [**DealSummary**](DealSummary.md) | | [optional] diff --git a/docs/PipelineDetailsAllOf.md b/docs/PipelineDetailsAllOf.md index 70b2981f..8b4e6012 100644 --- a/docs/PipelineDetailsAllOf.md +++ b/docs/PipelineDetailsAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dealsSummary** | [**DealSummary**](DealSummary.md) | | [optional] +**deals_summary** | [**DealSummary**](DealSummary.md) | | [optional] diff --git a/docs/PipelinesApi.md b/docs/PipelinesApi.md index db1b54e2..0677f6f1 100644 --- a/docs/PipelinesApi.md +++ b/docs/PipelinesApi.md @@ -54,7 +54,7 @@ apiInstance.addPipeline(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **pipeline** | [**Pipeline**](Pipeline.md)| | [optional] + **Pipeline** | [**Pipeline**](Pipeline.md)| | [optional] ### Return type @@ -147,6 +147,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PipelinesApi(apiClient); let id = 56; // Number | The ID of the pipeline +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'totalsConvertCurrency': "totalsConvertCurrency_example" // String | The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. }; @@ -164,7 +165,7 @@ apiInstance.getPipeline(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the pipeline | - **totalsConvertCurrency** | **String**| The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. | [optional] + **totals_convert_currency** | **String**| The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. | [optional] ### Return type @@ -206,6 +207,7 @@ let apiInstance = new Pipedrive.PipelinesApi(apiClient); let id = 56; // Number | The ID of the pipeline let startDate = new Date("2013-10-20"); // Date | The start of the period. Date in format of YYYY-MM-DD. let endDate = new Date("2013-10-20"); // Date | The end of the period. Date in format of YYYY-MM-DD. +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'userId': 56 // Number | The ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used. }; @@ -223,9 +225,9 @@ apiInstance.getPipelineConversionStatistics(id, startDate, endDate, opts).then(( Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the pipeline | - **startDate** | **Date**| The start of the period. Date in format of YYYY-MM-DD. | - **endDate** | **Date**| The end of the period. Date in format of YYYY-MM-DD. | - **userId** | **Number**| The ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used. | [optional] + **start_date** | **Date**| The start of the period. Date in format of YYYY-MM-DD. | + **end_date** | **Date**| The end of the period. Date in format of YYYY-MM-DD. | + **user_id** | **Number**| The ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used. | [optional] ### Return type @@ -265,6 +267,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.PipelinesApi(apiClient); let id = 56; // Number | The ID of the pipeline +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'filterId': 56, // Number | If supplied, only deals matching the given filter will be returned 'userId': 56, // Number | If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned. @@ -289,14 +292,14 @@ apiInstance.getPipelineDeals(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the pipeline | - **filterId** | **Number**| If supplied, only deals matching the given filter will be returned | [optional] - **userId** | **Number**| If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned. | [optional] + **filter_id** | **Number**| If supplied, only deals matching the given filter will be returned | [optional] + **user_id** | **Number**| If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned. | [optional] **everyone** | [**NumberBoolean**](.md)| If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned | [optional] - **stageId** | **Number**| If supplied, only deals within the given stage will be returned | [optional] + **stage_id** | **Number**| If supplied, only deals within the given stage will be returned | [optional] **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] - **getSummary** | [**NumberBoolean**](.md)| Whether to include a summary of the pipeline in the `additional_data` or not | [optional] - **totalsConvertCurrency** | **String**| The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled. | [optional] + **get_summary** | [**NumberBoolean**](.md)| Whether to include a summary of the pipeline in the `additional_data` or not | [optional] + **totals_convert_currency** | **String**| The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled. | [optional] ### Return type @@ -338,6 +341,7 @@ let apiInstance = new Pipedrive.PipelinesApi(apiClient); let id = 56; // Number | The ID of the pipeline let startDate = new Date("2013-10-20"); // Date | The start of the period. Date in format of YYYY-MM-DD. let endDate = new Date("2013-10-20"); // Date | The end of the period. Date in format of YYYY-MM-DD. +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'userId': 56 // Number | The ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used. }; @@ -355,9 +359,9 @@ apiInstance.getPipelineMovementStatistics(id, startDate, endDate, opts).then((da Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the pipeline | - **startDate** | **Date**| The start of the period. Date in format of YYYY-MM-DD. | - **endDate** | **Date**| The end of the period. Date in format of YYYY-MM-DD. | - **userId** | **Number**| The ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used. | [optional] + **start_date** | **Date**| The start of the period. Date in format of YYYY-MM-DD. | + **end_date** | **Date**| The end of the period. Date in format of YYYY-MM-DD. | + **user_id** | **Number**| The ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used. | [optional] ### Return type @@ -463,7 +467,7 @@ apiInstance.updatePipeline(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the pipeline | - **pipeline** | [**Pipeline**](Pipeline.md)| | [optional] + **Pipeline** | [**Pipeline**](Pipeline.md)| | [optional] ### Return type diff --git a/docs/PostDealParticipants.md b/docs/PostDealParticipants.md index 316f34d2..8bc3beea 100644 --- a/docs/PostDealParticipants.md +++ b/docs/PostDealParticipants.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the request was successful or not | [optional] **data** | [**PersonItem**](PersonItem.md) | The object of participant | [optional] -**relatedObjects** | [**PostDealParticipantsRelatedObjects**](PostDealParticipantsRelatedObjects.md) | | [optional] +**related_objects** | [**PostDealParticipantsRelatedObjects**](PostDealParticipantsRelatedObjects.md) | | [optional] diff --git a/docs/PostRoleAssignmentAllOfData.md b/docs/PostRoleAssignmentAllOfData.md index d63edaba..236a955e 100644 --- a/docs/PostRoleAssignmentAllOfData.md +++ b/docs/PostRoleAssignmentAllOfData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user that was added to the role | [optional] -**roleId** | **Number** | The ID of the role the user was added to | [optional] +**user_id** | **Number** | The ID of the user that was added to the role | [optional] +**role_id** | **Number** | The ID of the role the user was added to | [optional] diff --git a/docs/PostRoleSettingsAllOfData.md b/docs/PostRoleSettingsAllOfData.md index 91ecfad2..493ba327 100644 --- a/docs/PostRoleSettingsAllOfData.md +++ b/docs/PostRoleSettingsAllOfData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the role | [optional] -**dealDefaultVisibility** | **Number** | The setting | [optional] +**deal_default_visibility** | **Number** | The setting | [optional] diff --git a/docs/ProductAttachementFields.md b/docs/ProductAttachementFields.md index d1c13750..bf26a6f5 100644 --- a/docs/ProductAttachementFields.md +++ b/docs/ProductAttachementFields.md @@ -5,15 +5,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the deal-product (the ID of the product attached to the deal) | [optional] -**companyId** | **Number** | The ID of the company | [optional] -**dealId** | **Number** | The ID of the deal | [optional] -**productId** | **Number** | The ID of the product | [optional] -**durationUnit** | **String** | The type of the duration. (For example hourly, daily, etc.) | [optional] +**company_id** | **Number** | The ID of the company | [optional] +**deal_id** | **Number** | The ID of the deal | [optional] +**product_id** | **Number** | The ID of the product | [optional] +**duration_unit** | **String** | The type of the duration. (For example hourly, daily, etc.) | [optional] **sum** | **Number** | The sum of all the products attached to the deal | [optional] **currency** | **String** | The currency associated with the deal product | [optional] -**addTime** | **String** | The date and time when the product was added to the deal | [optional] -**lastEdit** | **String** | The date and time when the deal product was last edited | [optional] -**activeFlag** | **Boolean** | Whether the product is active or not | [optional] +**add_time** | **String** | The date and time when the product was added to the deal | [optional] +**last_edit** | **String** | The date and time when the deal product was last edited | [optional] +**active_flag** | **Boolean** | Whether the product is active or not | [optional] **tax** | **Number** | The product tax | [optional] **name** | **String** | The product name | [optional] diff --git a/docs/ProductAttachmentDetails.md b/docs/ProductAttachmentDetails.md index d48f782f..d06af0a3 100644 --- a/docs/ProductAttachmentDetails.md +++ b/docs/ProductAttachmentDetails.md @@ -4,29 +4,29 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productId** | **Number** | The ID of the product | [optional] -**itemPrice** | **Number** | The price at which this product will be added to the deal | [optional] +**product_id** | **Number** | The ID of the product | [optional] +**item_price** | **Number** | The price at which this product will be added to the deal | [optional] **quantity** | **Number** | Quantity – e.g. how many items of this product will be added to the deal | [optional] **discount** | **Number** | The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage | [optional] [default to 0] -**discountType** | **String** | The type of the discount's value | [optional] [default to 'percentage'] +**discount_type** | **String** | The type of the discount's value | [optional] [default to 'percentage'] **duration** | **Number** | The duration of the product. If omitted, will be set to 1 | [optional] [default to 1] -**durationUnit** | **String** | The type of the duration. (For example hourly, daily, etc.) | [optional] -**productVariationId** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] +**duration_unit** | **String** | The type of the duration. (For example hourly, daily, etc.) | [optional] +**product_variation_id** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] **comments** | **String** | A textual comment associated with this product-deal attachment | [optional] **tax** | **Number** | The product tax | [optional] -**taxMethod** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional] -**enabledFlag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] -**billingFrequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] -**billingFrequencyCycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] -**billingStartDate** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] +**tax_method** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional] +**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] +**billing_frequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] +**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] +**billing_start_date** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] **id** | **Number** | The ID of the deal-product (the ID of the product attached to the deal) | [optional] -**companyId** | **Number** | The ID of the company | [optional] -**dealId** | **Number** | The ID of the deal | [optional] +**company_id** | **Number** | The ID of the company | [optional] +**deal_id** | **Number** | The ID of the deal | [optional] **sum** | **Number** | The sum of all the products attached to the deal | [optional] **currency** | **String** | The currency associated with the deal product | [optional] -**addTime** | **String** | The date and time when the product was added to the deal | [optional] -**lastEdit** | **String** | The date and time when the deal product was last edited | [optional] -**activeFlag** | **Boolean** | Whether the product is active or not | [optional] +**add_time** | **String** | The date and time when the product was added to the deal | [optional] +**last_edit** | **String** | The date and time when the deal product was last edited | [optional] +**active_flag** | **Boolean** | Whether the product is active or not | [optional] **name** | **String** | The product name | [optional] diff --git a/docs/ProductBaseDeal.md b/docs/ProductBaseDeal.md index 0813fa0a..db52c293 100644 --- a/docs/ProductBaseDeal.md +++ b/docs/ProductBaseDeal.md @@ -5,47 +5,47 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the deal | [optional] -**companyId** | **Number** | The ID of the company | [optional] -**creatorUserId** | **Number** | The ID of the deal creator | [optional] -**userId** | **Number** | The ID of the user | [optional] -**personId** | **Number** | The ID of the person associated with the deal | [optional] -**orgId** | **Number** | The ID of the organization associated with the deal | [optional] -**stageId** | **Number** | The ID of the deal stage | [optional] +**company_id** | **Number** | The ID of the company | [optional] +**creator_user_id** | **Number** | The ID of the deal creator | [optional] +**user_id** | **Number** | The ID of the user | [optional] +**person_id** | **Number** | The ID of the person associated with the deal | [optional] +**org_id** | **Number** | The ID of the organization associated with the deal | [optional] +**stage_id** | **Number** | The ID of the deal stage | [optional] **title** | **String** | The title of the deal | [optional] **value** | **Number** | The value of the deal | [optional] **currency** | **String** | The currency associated with the deal | [optional] -**addTime** | **String** | The creation date and time of the deal | [optional] -**firstAddTime** | **String** | The first creation date and time of the deal | [optional] -**updateTime** | **String** | The last updated date and time of the deal | [optional] -**stageChangeTime** | **String** | The last updated date and time of the deal stage | [optional] +**add_time** | **String** | The creation date and time of the deal | [optional] +**first_add_time** | **String** | The first creation date and time of the deal | [optional] +**update_time** | **String** | The last updated date and time of the deal | [optional] +**stage_change_time** | **String** | The last updated date and time of the deal stage | [optional] **active** | **Boolean** | Whether the deal is active or not | [optional] **deleted** | **Boolean** | Whether the deal is deleted or not | [optional] **status** | **String** | The status of the deal | [optional] **probability** | **Number** | The success probability percentage of the deal | [optional] -**nextActivityDate** | **String** | The date of the next activity associated with the deal | [optional] -**nextActivityTime** | **String** | The time of the next activity associated with the deal | [optional] -**nextActivityId** | **Number** | The ID of the next activity associated with the deal | [optional] -**lastActivityId** | **Number** | The ID of the last activity associated with the deal | [optional] -**lastActivityDate** | **String** | The date of the last activity associated with the deal | [optional] -**lostReason** | **String** | The reason for losing the deal | [optional] -**visibleTo** | **String** | The visibility of the deal | [optional] -**closeTime** | **String** | The date and time of closing the deal | [optional] -**pipelineId** | **Number** | The ID of the pipeline associated with the deal | [optional] -**wonTime** | **String** | The date and time of changing the deal status as won | [optional] -**firstWonTime** | **String** | The date and time of the first time changing the deal status as won | [optional] -**lostTime** | **String** | The date and time of changing the deal status as lost | [optional] -**productsCount** | **Number** | The number of products associated with the deal | [optional] -**filesCount** | **Number** | The number of files associated with the deal | [optional] -**notesCount** | **Number** | The number of notes associated with the deal | [optional] -**followersCount** | **Number** | The number of followers associated with the deal | [optional] -**emailMessagesCount** | **Number** | The number of emails associated with the deal | [optional] -**activitiesCount** | **Number** | The number of activities associated with the deal | [optional] -**doneActivitiesCount** | **Number** | The number of completed activities associated with the deal | [optional] -**undoneActivitiesCount** | **Number** | The number of incomplete activities associated with the deal | [optional] -**participantsCount** | **Number** | The number of participants associated with the deal | [optional] -**expectedCloseDate** | **Date** | The expected close date of the deal | [optional] -**lastIncomingMailTime** | **String** | The date and time of the last incoming email associated with the deal | [optional] -**lastOutgoingMailTime** | **String** | The date and time of the last outgoing email associated with the deal | [optional] +**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] +**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] +**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] +**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] +**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] +**lost_reason** | **String** | The reason for losing the deal | [optional] +**visible_to** | **String** | The visibility of the deal | [optional] +**close_time** | **String** | The date and time of closing the deal | [optional] +**pipeline_id** | **Number** | The ID of the pipeline associated with the deal | [optional] +**won_time** | **String** | The date and time of changing the deal status as won | [optional] +**first_won_time** | **String** | The date and time of the first time changing the deal status as won | [optional] +**lost_time** | **String** | The date and time of changing the deal status as lost | [optional] +**products_count** | **Number** | The number of products associated with the deal | [optional] +**files_count** | **Number** | The number of files associated with the deal | [optional] +**notes_count** | **Number** | The number of notes associated with the deal | [optional] +**followers_count** | **Number** | The number of followers associated with the deal | [optional] +**email_messages_count** | **Number** | The number of emails associated with the deal | [optional] +**activities_count** | **Number** | The number of activities associated with the deal | [optional] +**done_activities_count** | **Number** | The number of completed activities associated with the deal | [optional] +**undone_activities_count** | **Number** | The number of incomplete activities associated with the deal | [optional] +**participants_count** | **Number** | The number of participants associated with the deal | [optional] +**expected_close_date** | **Date** | The expected close date of the deal | [optional] +**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the deal | [optional] +**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the deal | [optional] **label** | **String** | The label or multiple labels assigned to the deal | [optional] diff --git a/docs/ProductField.md b/docs/ProductField.md index ff10820a..c4e44eb9 100644 --- a/docs/ProductField.md +++ b/docs/ProductField.md @@ -6,23 +6,23 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the field | **options** | **[Object]** | When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{\"label\":\"red\"}, {\"label\":\"blue\"}, {\"label\":\"lilac\"}]` | [optional] -**fieldType** | **String** | The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table> | +**field_type** | **String** | The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table> | **id** | **Number** | The ID of the product field | [optional] **key** | **String** | The key of the product field | [optional] -**orderNr** | **Number** | The position (index) of the product field in the detail view | [optional] -**addTime** | **String** | The product field creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] -**updateTime** | **String** | The product field last update time. Format: YYYY-MM-DD HH:MM:SS | [optional] -**lastUpdatedByUserId** | **Number** | The ID of the last user to update the product field | [optional] -**createdByUserId** | **Number** | The ID of the user who created the product field | [optional] -**activeFlag** | **Boolean** | Whether or not the product field is currently active | [optional] -**editFlag** | **Boolean** | Whether or not the product field name and metadata is editable | [optional] -**addVisibleFlag** | **Boolean** | Whether or not the product field is visible in the Add Product Modal | [optional] -**importantFlag** | **Boolean** | Whether or not the product field is marked as important | [optional] -**bulkEditAllowed** | **Boolean** | Whether or not the product field data can be edited | [optional] -**searchableFlag** | **Boolean** | Whether or not the product field is searchable | [optional] -**filteringAllowed** | **Boolean** | Whether or not the product field value can be used when filtering searches | [optional] -**sortableFlag** | **Boolean** | Whether or not the product field is sortable | [optional] -**mandatoryFlag** | **Boolean** | Whether or not the product field is mandatory when creating products | [optional] +**order_nr** | **Number** | The position (index) of the product field in the detail view | [optional] +**add_time** | **String** | The product field creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] +**update_time** | **String** | The product field last update time. Format: YYYY-MM-DD HH:MM:SS | [optional] +**last_updated_by_user_id** | **Number** | The ID of the last user to update the product field | [optional] +**created_by_user_id** | **Number** | The ID of the user who created the product field | [optional] +**active_flag** | **Boolean** | Whether or not the product field is currently active | [optional] +**edit_flag** | **Boolean** | Whether or not the product field name and metadata is editable | [optional] +**add_visible_flag** | **Boolean** | Whether or not the product field is visible in the Add Product Modal | [optional] +**important_flag** | **Boolean** | Whether or not the product field is marked as important | [optional] +**bulk_edit_allowed** | **Boolean** | Whether or not the product field data can be edited | [optional] +**searchable_flag** | **Boolean** | Whether or not the product field is searchable | [optional] +**filtering_allowed** | **Boolean** | Whether or not the product field value can be used when filtering searches | [optional] +**sortable_flag** | **Boolean** | Whether or not the product field is sortable | [optional] +**mandatory_flag** | **Boolean** | Whether or not the product field is mandatory when creating products | [optional] diff --git a/docs/ProductFieldAllOf.md b/docs/ProductFieldAllOf.md index 6396b471..fb34fe92 100644 --- a/docs/ProductFieldAllOf.md +++ b/docs/ProductFieldAllOf.md @@ -6,19 +6,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the product field | [optional] **key** | **String** | The key of the product field | [optional] -**orderNr** | **Number** | The position (index) of the product field in the detail view | [optional] -**addTime** | **String** | The product field creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] -**updateTime** | **String** | The product field last update time. Format: YYYY-MM-DD HH:MM:SS | [optional] -**lastUpdatedByUserId** | **Number** | The ID of the last user to update the product field | [optional] -**createdByUserId** | **Number** | The ID of the user who created the product field | [optional] -**activeFlag** | **Boolean** | Whether or not the product field is currently active | [optional] -**editFlag** | **Boolean** | Whether or not the product field name and metadata is editable | [optional] -**addVisibleFlag** | **Boolean** | Whether or not the product field is visible in the Add Product Modal | [optional] -**importantFlag** | **Boolean** | Whether or not the product field is marked as important | [optional] -**bulkEditAllowed** | **Boolean** | Whether or not the product field data can be edited | [optional] -**searchableFlag** | **Boolean** | Whether or not the product field is searchable | [optional] -**filteringAllowed** | **Boolean** | Whether or not the product field value can be used when filtering searches | [optional] -**sortableFlag** | **Boolean** | Whether or not the product field is sortable | [optional] -**mandatoryFlag** | **Boolean** | Whether or not the product field is mandatory when creating products | [optional] +**order_nr** | **Number** | The position (index) of the product field in the detail view | [optional] +**add_time** | **String** | The product field creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] +**update_time** | **String** | The product field last update time. Format: YYYY-MM-DD HH:MM:SS | [optional] +**last_updated_by_user_id** | **Number** | The ID of the last user to update the product field | [optional] +**created_by_user_id** | **Number** | The ID of the user who created the product field | [optional] +**active_flag** | **Boolean** | Whether or not the product field is currently active | [optional] +**edit_flag** | **Boolean** | Whether or not the product field name and metadata is editable | [optional] +**add_visible_flag** | **Boolean** | Whether or not the product field is visible in the Add Product Modal | [optional] +**important_flag** | **Boolean** | Whether or not the product field is marked as important | [optional] +**bulk_edit_allowed** | **Boolean** | Whether or not the product field data can be edited | [optional] +**searchable_flag** | **Boolean** | Whether or not the product field is searchable | [optional] +**filtering_allowed** | **Boolean** | Whether or not the product field value can be used when filtering searches | [optional] +**sortable_flag** | **Boolean** | Whether or not the product field is sortable | [optional] +**mandatory_flag** | **Boolean** | Whether or not the product field is mandatory when creating products | [optional] diff --git a/docs/ProductFieldsApi.md b/docs/ProductFieldsApi.md index af13f644..be8eb774 100644 --- a/docs/ProductFieldsApi.md +++ b/docs/ProductFieldsApi.md @@ -52,7 +52,7 @@ apiInstance.addProductField(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **newProductField** | [**NewProductField**](NewProductField.md)| | [optional] + **NewProductField** | [**NewProductField**](NewProductField.md)| | [optional] ### Return type @@ -250,6 +250,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.ProductFieldsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -325,7 +326,7 @@ apiInstance.updateProductField(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the product field | - **updateProductField** | [**UpdateProductField**](UpdateProductField.md)| | [optional] + **UpdateProductField** | [**UpdateProductField**](UpdateProductField.md)| | [optional] ### Return type diff --git a/docs/ProductFileItem.md b/docs/ProductFileItem.md index afa327e0..494deac1 100644 --- a/docs/ProductFileItem.md +++ b/docs/ProductFileItem.md @@ -5,17 +5,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the file | [optional] -**productId** | **Number** | The ID of the product associated with the file | [optional] -**addTime** | **String** | The UTC date time when the file was uploaded. Format: YYYY-MM-DD HH:MM:SS | [optional] -**updateTime** | **String** | The UTC date time when the file was last updated. Format: YYYY-MM-DD HH:MM:SS | [optional] -**fileName** | **String** | The original name of the file | [optional] -**fileSize** | **Number** | The size of the file in bytes | [optional] -**activeFlag** | **Boolean** | Whether the user is active or not. | [optional] -**inlineFlag** | **Boolean** | Whether the file was uploaded as inline or not | [optional] -**remoteLocation** | **String** | The location type to send the file to. Only googledrive is supported at the moment. | [optional] -**remoteId** | **String** | The ID of the remote item | [optional] -**s3Bucket** | **String** | The location of the cloud storage | [optional] -**productName** | **String** | The name of the product associated with the file | [optional] +**product_id** | **Number** | The ID of the product associated with the file | [optional] +**add_time** | **String** | The UTC date time when the file was uploaded. Format: YYYY-MM-DD HH:MM:SS | [optional] +**update_time** | **String** | The UTC date time when the file was last updated. Format: YYYY-MM-DD HH:MM:SS | [optional] +**file_name** | **String** | The original name of the file | [optional] +**file_size** | **Number** | The size of the file in bytes | [optional] +**active_flag** | **Boolean** | Whether the user is active or not. | [optional] +**inline_flag** | **Boolean** | Whether the file was uploaded as inline or not | [optional] +**remote_location** | **String** | The location type to send the file to. Only googledrive is supported at the moment. | [optional] +**remote_id** | **String** | The ID of the remote item | [optional] +**s3_bucket** | **String** | The location of the cloud storage | [optional] +**product_name** | **String** | The name of the product associated with the file | [optional] **url** | **String** | The URL to download the file | [optional] **name** | **String** | The visible name of the file | [optional] **description** | **String** | The description of the file | [optional] diff --git a/docs/ProductListItem.md b/docs/ProductListItem.md index e314f9a0..e668a256 100644 --- a/docs/ProductListItem.md +++ b/docs/ProductListItem.md @@ -5,27 +5,27 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the deal-product (the ID of the product attached to the deal) | [optional] -**dealId** | **Number** | The ID of the deal | [optional] -**orderNr** | **Number** | The order number of the product | [optional] -**productId** | **Number** | The ID of the product | [optional] -**productVariationId** | **Number** | The ID of the product variation | [optional] -**itemPrice** | **Number** | The price value of the product | [optional] +**deal_id** | **Number** | The ID of the deal | [optional] +**order_nr** | **Number** | The order number of the product | [optional] +**product_id** | **Number** | The ID of the product | [optional] +**product_variation_id** | **Number** | The ID of the product variation | [optional] +**item_price** | **Number** | The price value of the product | [optional] **discount** | **Number** | The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage | [optional] [default to 0] -**discountType** | **String** | The type of the discount's value | [optional] [default to 'percentage'] +**discount_type** | **String** | The type of the discount's value | [optional] [default to 'percentage'] **duration** | **Number** | The duration of the product | [optional] -**durationUnit** | **String** | The type of the duration. (For example hourly, daily, etc.) | [optional] +**duration_unit** | **String** | The type of the duration. (For example hourly, daily, etc.) | [optional] **sum** | **Number** | The sum of all the products attached to the deal | [optional] **currency** | **String** | The currency associated with the deal product | [optional] -**enabledFlag** | **Boolean** | Whether the product is enabled or not | [optional] -**addTime** | **String** | The date and time when the product was added to the deal | [optional] -**lastEdit** | **String** | The date and time when the deal product was last edited | [optional] +**enabled_flag** | **Boolean** | Whether the product is enabled or not | [optional] +**add_time** | **String** | The date and time when the product was added to the deal | [optional] +**last_edit** | **String** | The date and time when the deal product was last edited | [optional] **comments** | **String** | The comments of the product | [optional] -**activeFlag** | **Boolean** | Whether the product is active or not | [optional] +**active_flag** | **Boolean** | Whether the product is active or not | [optional] **tax** | **Number** | The product tax | [optional] -**taxMethod** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional] +**tax_method** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional] **name** | **String** | The product name | [optional] -**sumFormatted** | **String** | The formatted sum of the product | [optional] -**quantityFormatted** | **String** | The formatted quantity of the product | [optional] +**sum_formatted** | **String** | The formatted sum of the product | [optional] +**quantity_formatted** | **String** | The formatted quantity of the product | [optional] **quantity** | **Number** | The quantity of the product | [optional] **product** | [**ProductWithArrayPrices**](ProductWithArrayPrices.md) | | [optional] diff --git a/docs/ProductRequest.md b/docs/ProductRequest.md index c776e988..0f729c5c 100644 --- a/docs/ProductRequest.md +++ b/docs/ProductRequest.md @@ -7,10 +7,10 @@ Name | Type | Description | Notes **code** | **String** | The product code | [optional] **unit** | **String** | The unit in which this product is sold | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] -**activeFlag** | **Boolean** | Whether this product will be made active or not | [optional] [default to true] +**active_flag** | **Boolean** | Whether this product will be made active or not | [optional] [default to true] **selectable** | **Boolean** | Whether this product can be selected in deals or not | [optional] [default to true] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] -**ownerId** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**owner_id** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional] **prices** | **[Object]** | An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional] diff --git a/docs/ProductResponse.md b/docs/ProductResponse.md index 948373c2..13611e27 100644 --- a/docs/ProductResponse.md +++ b/docs/ProductResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**ProductWithArrayPrices**](ProductWithArrayPrices.md) | | [optional] -**relatedObjects** | [**GetActivitiesResponse200RelatedObjects**](GetActivitiesResponse200RelatedObjects.md) | | [optional] +**related_objects** | [**GetActivitiesResponse200RelatedObjects**](GetActivitiesResponse200RelatedObjects.md) | | [optional] diff --git a/docs/ProductSearchItem.md b/docs/ProductSearchItem.md index 8bfdafdb..a10d2e55 100644 --- a/docs/ProductSearchItem.md +++ b/docs/ProductSearchItem.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultScore** | **Number** | Search result relevancy | [optional] +**result_score** | **Number** | Search result relevancy | [optional] **item** | [**ProductSearchItemItem**](ProductSearchItemItem.md) | | [optional] diff --git a/docs/ProductSearchItemItem.md b/docs/ProductSearchItemItem.md index a0b1f86f..7be190be 100644 --- a/docs/ProductSearchItemItem.md +++ b/docs/ProductSearchItemItem.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes **type** | **String** | The type of the item | [optional] **name** | **String** | The name of the product | [optional] **code** | **Number** | The code of the product | [optional] -**visibleTo** | **Number** | The visibility of the product | [optional] +**visible_to** | **Number** | The visibility of the product | [optional] **owner** | [**ProductSearchItemItemOwner**](ProductSearchItemItemOwner.md) | | [optional] -**customFields** | **[String]** | The custom fields | [optional] +**custom_fields** | **[String]** | The custom fields | [optional] diff --git a/docs/ProductSearchResponse.md b/docs/ProductSearchResponse.md index 3dcd64ec..8d4fb85b 100644 --- a/docs/ProductSearchResponse.md +++ b/docs/ProductSearchResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**ProductSearchResponseAllOfData**](ProductSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/ProductSearchResponseAllOf.md b/docs/ProductSearchResponseAllOf.md index c5a1fd82..d4f394c9 100644 --- a/docs/ProductSearchResponseAllOf.md +++ b/docs/ProductSearchResponseAllOf.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**ProductSearchResponseAllOfData**](ProductSearchResponseAllOfData.md) | | [optional] -**additionalData** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] +**additional_data** | [**ItemSearchAdditionalData**](ItemSearchAdditionalData.md) | | [optional] diff --git a/docs/ProductWithArrayPrices.md b/docs/ProductWithArrayPrices.md index 08b71b84..9a935afd 100644 --- a/docs/ProductWithArrayPrices.md +++ b/docs/ProductWithArrayPrices.md @@ -9,12 +9,12 @@ Name | Type | Description | Notes **code** | **String** | The product code | [optional] **unit** | **String** | The unit in which this product is sold | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] -**activeFlag** | **Boolean** | Whether this product is active or not | [optional] [default to true] +**active_flag** | **Boolean** | Whether this product is active or not | [optional] [default to true] **selectable** | **Boolean** | Whether this product is selected in deals or not | [optional] [default to true] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | Visibility of the product | [optional] -**ownerId** | **Object** | Information about the Pipedrive user who owns the product | [optional] -**billingFrequency** | **String** | Only available in Advanced and above plans How often a customer is billed for access to a service or product | [optional] [default to 'one-time'] -**billingFrequencyCycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field is always `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | Visibility of the product | [optional] +**owner_id** | **Object** | Information about the Pipedrive user who owns the product | [optional] +**billing_frequency** | **String** | Only available in Advanced and above plans How often a customer is billed for access to a service or product | [optional] [default to 'one-time'] +**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field is always `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] **prices** | **[Object]** | Array of objects, each containing: currency (string), price (number), cost (number, optional), overhead_cost (number, optional) | [optional] diff --git a/docs/ProductsApi.md b/docs/ProductsApi.md index 160eaab0..155ba6ca 100644 --- a/docs/ProductsApi.md +++ b/docs/ProductsApi.md @@ -58,7 +58,7 @@ apiInstance.addProduct(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **addProductRequestBody** | [**AddProductRequestBody**](AddProductRequestBody.md)| | [optional] + **AddProductRequestBody** | [**AddProductRequestBody**](AddProductRequestBody.md)| | [optional] ### Return type @@ -115,7 +115,7 @@ apiInstance.addProductFollower(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the product | - **addProductFollowerRequest** | [**AddProductFollowerRequest**](AddProductFollowerRequest.md)| | [optional] + **AddProductFollowerRequest** | [**AddProductFollowerRequest**](AddProductFollowerRequest.md)| | [optional] ### Return type @@ -223,7 +223,7 @@ apiInstance.deleteProductFollower(id, followerId).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the product | - **followerId** | **Number**| The ID of the relationship between the follower and the product | + **follower_id** | **Number**| The ID of the relationship between the follower and the product | ### Return type @@ -316,6 +316,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.ProductsApi(apiClient); let id = 56; // Number | The ID of the product +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -377,6 +378,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.ProductsApi(apiClient); let id = 56; // Number | The ID of the product +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56, // Number | Items shown per page @@ -438,6 +440,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.ProductsApi(apiClient); let id = 56; // Number | The ID of the product +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -549,6 +552,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.ProductsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'userId': 56, // Number | If supplied, only products owned by the given user will be returned 'filterId': 56, // Number | The ID of the filter to use @@ -571,11 +575,11 @@ apiInstance.getProducts(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Number**| If supplied, only products owned by the given user will be returned | [optional] - **filterId** | **Number**| The ID of the filter to use | [optional] + **user_id** | **Number**| If supplied, only products owned by the given user will be returned | [optional] + **filter_id** | **Number**| The ID of the filter to use | [optional] **ids** | [**[Number]**](Number.md)| An array of integers with the IDs of the products that should be returned in the response | [optional] - **firstChar** | **String**| If supplied, only products whose name starts with the specified letter will be returned (case-insensitive) | [optional] - **getSummary** | **Boolean**| If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property | [optional] + **first_char** | **String**| If supplied, only products whose name starts with the specified letter will be returned (case-insensitive) | [optional] + **get_summary** | **Boolean**| If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property | [optional] **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] @@ -617,6 +621,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.ProductsApi(apiClient); let term = "term_example"; // String | The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'fields': "fields_example", // String | A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields here. 'exactMatch': true, // Boolean | When enabled, only full exact matches against the given term are returned. It is not case sensitive. @@ -639,8 +644,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. | **fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. | [optional] - **exactMatch** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] - **includeFields** | **String**| Supports including optional fields in the results which are not provided by default | [optional] + **exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | [optional] + **include_fields** | **String**| Supports including optional fields in the results which are not provided by default | [optional] **start** | **Number**| Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] @@ -699,7 +704,7 @@ apiInstance.updateProduct(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the product | - **updateProductRequestBody** | [**UpdateProductRequestBody**](UpdateProductRequestBody.md)| | [optional] + **UpdateProductRequestBody** | [**UpdateProductRequestBody**](UpdateProductRequestBody.md)| | [optional] ### Return type diff --git a/docs/ProductsResponse.md b/docs/ProductsResponse.md index 716d16a9..794f02f1 100644 --- a/docs/ProductsResponse.md +++ b/docs/ProductsResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**[ProductResponse]**](ProductResponse.md) | Array containing data for all products | [optional] -**additionalData** | [**AdditionalData**](.md) | | [optional] -**relatedObjects** | [**GetActivitiesResponse200RelatedObjects**](GetActivitiesResponse200RelatedObjects.md) | | [optional] +**additional_data** | [**AdditionalData**](.md) | | [optional] +**related_objects** | [**GetActivitiesResponse200RelatedObjects**](GetActivitiesResponse200RelatedObjects.md) | | [optional] diff --git a/docs/ProjectBoardObject.md b/docs/ProjectBoardObject.md index ba78b57d..82fa0175 100644 --- a/docs/ProjectBoardObject.md +++ b/docs/ProjectBoardObject.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the project board | [optional] **name** | **String** | Name of a project board | [optional] -**orderNr** | **Number** | The order of a board | [optional] -**addTime** | **String** | The creation date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The update date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**order_nr** | **Number** | The order of a board | [optional] +**add_time** | **String** | The creation date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The update date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] diff --git a/docs/ProjectGroupsObject.md b/docs/ProjectGroupsObject.md index 215e3355..8d8ac3cd 100644 --- a/docs/ProjectGroupsObject.md +++ b/docs/ProjectGroupsObject.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | ID of the group | [optional] **name** | **String** | Name of the group | [optional] -**orderNr** | **Number** | Order number of the group | [optional] +**order_nr** | **Number** | Order number of the group | [optional] diff --git a/docs/ProjectMandatoryObjectFragment.md b/docs/ProjectMandatoryObjectFragment.md index 10004b60..f9ff7f56 100644 --- a/docs/ProjectMandatoryObjectFragment.md +++ b/docs/ProjectMandatoryObjectFragment.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The title of the project | [optional] -**boardId** | **Number** | The ID of the board this project is associated with | [optional] -**phaseId** | **Number** | The ID of the phase this project is associated with | [optional] +**board_id** | **Number** | The ID of the board this project is associated with | [optional] +**phase_id** | **Number** | The ID of the phase this project is associated with | [optional] diff --git a/docs/ProjectNotChangeableObjectFragment.md b/docs/ProjectNotChangeableObjectFragment.md index 69310e89..b7fe8cd6 100644 --- a/docs/ProjectNotChangeableObjectFragment.md +++ b/docs/ProjectNotChangeableObjectFragment.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**addTime** | **String** | The creation date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The update date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**statusChangeTime** | **String** | The status changed date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**archiveTime** | **String** | The archived date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. If not archived then 'null'. | [optional] +**add_time** | **String** | The creation date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The update date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**status_change_time** | **String** | The status changed date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**archive_time** | **String** | The archived date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. If not archived then 'null'. | [optional] diff --git a/docs/ProjectObjectFragment.md b/docs/ProjectObjectFragment.md index a894a479..acd7d13a 100644 --- a/docs/ProjectObjectFragment.md +++ b/docs/ProjectObjectFragment.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **description** | **String** | The description of the project | [optional] **status** | **String** | The status of the project | [optional] -**ownerId** | **Number** | The ID of a project owner | [optional] -**startDate** | **Date** | The start date of the project. Format: YYYY-MM-DD. | [optional] -**endDate** | **Date** | The end date of the project. Format: YYYY-MM-DD. | [optional] -**dealIds** | **[Number]** | An array of IDs of the deals this project is associated with | [optional] -**orgId** | **Number** | The ID of the organization this project is associated with | [optional] -**personId** | **Number** | The ID of the person this project is associated with | [optional] +**owner_id** | **Number** | The ID of a project owner | [optional] +**start_date** | **Date** | The start date of the project. Format: YYYY-MM-DD. | [optional] +**end_date** | **Date** | The end date of the project. Format: YYYY-MM-DD. | [optional] +**deal_ids** | **[Number]** | An array of IDs of the deals this project is associated with | [optional] +**org_id** | **Number** | The ID of the organization this project is associated with | [optional] +**person_id** | **Number** | The ID of the person this project is associated with | [optional] **labels** | **[Number]** | An array of IDs of the labels this project has | [optional] diff --git a/docs/ProjectPhaseObject.md b/docs/ProjectPhaseObject.md index 4da5f5e2..8166a5db 100644 --- a/docs/ProjectPhaseObject.md +++ b/docs/ProjectPhaseObject.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the project phase | [optional] **name** | **String** | Name of a project phase | [optional] -**boardId** | **Number** | The ID of the project board this phase is linked to | [optional] -**orderNr** | **Number** | The order of a phase | [optional] -**addTime** | **String** | The creation date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The update date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**board_id** | **Number** | The ID of the project board this phase is linked to | [optional] +**order_nr** | **Number** | The order of a phase | [optional] +**add_time** | **String** | The creation date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The update date and time of the board in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] diff --git a/docs/ProjectPlanItemObject.md b/docs/ProjectPlanItemObject.md index 4caaf420..f458b99e 100644 --- a/docs/ProjectPlanItemObject.md +++ b/docs/ProjectPlanItemObject.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**itemId** | **Number** | ID of plan item (either activity or task ID) | [optional] -**itemType** | **String** | Type of a plan item (task / activity) | [optional] -**phaseId** | **Number** | The ID of the board this project is associated with. If null then plan item is not in any phase. | [optional] -**groupId** | **Number** | The ID of the board this project is associated with. If null then plan item is not in any group. | [optional] +**item_id** | **Number** | ID of plan item (either activity or task ID) | [optional] +**item_type** | **String** | Type of a plan item (task / activity) | [optional] +**phase_id** | **Number** | The ID of the board this project is associated with. If null then plan item is not in any phase. | [optional] +**group_id** | **Number** | The ID of the board this project is associated with. If null then plan item is not in any group. | [optional] diff --git a/docs/ProjectPostObject.md b/docs/ProjectPostObject.md index 9cbe779f..649e437f 100644 --- a/docs/ProjectPostObject.md +++ b/docs/ProjectPostObject.md @@ -5,17 +5,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The title of the project | -**boardId** | **Number** | The ID of a project board | -**phaseId** | **Number** | The ID of a phase on a project board | +**board_id** | **Number** | The ID of a project board | +**phase_id** | **Number** | The ID of a phase on a project board | **description** | **String** | The description of the project | [optional] **status** | **String** | The status of the project | [optional] -**ownerId** | **Number** | The ID of a project owner | [optional] -**startDate** | **Date** | The start date of the project. Format: YYYY-MM-DD. | [optional] -**endDate** | **Date** | The end date of the project. Format: YYYY-MM-DD. | [optional] -**dealIds** | **[Number]** | An array of IDs of the deals this project is associated with | [optional] -**orgId** | **Number** | The ID of the organization this project is associated with | [optional] -**personId** | **Number** | The ID of the person this project is associated with | [optional] +**owner_id** | **Number** | The ID of a project owner | [optional] +**start_date** | **Date** | The start date of the project. Format: YYYY-MM-DD. | [optional] +**end_date** | **Date** | The end date of the project. Format: YYYY-MM-DD. | [optional] +**deal_ids** | **[Number]** | An array of IDs of the deals this project is associated with | [optional] +**org_id** | **Number** | The ID of the organization this project is associated with | [optional] +**person_id** | **Number** | The ID of the person this project is associated with | [optional] **labels** | **[Number]** | An array of IDs of the labels this project has | [optional] -**templateId** | **Number** | The ID of the template the project will be based on | [optional] +**template_id** | **Number** | The ID of the template the project will be based on | [optional] diff --git a/docs/ProjectPostObjectAllOf.md b/docs/ProjectPostObjectAllOf.md index 50f87f69..babe5f19 100644 --- a/docs/ProjectPostObjectAllOf.md +++ b/docs/ProjectPostObjectAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**templateId** | **Number** | The ID of the template the project will be based on | [optional] +**template_id** | **Number** | The ID of the template the project will be based on | [optional] diff --git a/docs/ProjectPutObject.md b/docs/ProjectPutObject.md index 59744b9d..aa5e1d03 100644 --- a/docs/ProjectPutObject.md +++ b/docs/ProjectPutObject.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The title of the project | [optional] -**boardId** | **Number** | The ID of the board this project is associated with | [optional] -**phaseId** | **Number** | The ID of the phase this project is associated with | [optional] +**board_id** | **Number** | The ID of the board this project is associated with | [optional] +**phase_id** | **Number** | The ID of the phase this project is associated with | [optional] **description** | **String** | The description of the project | [optional] **status** | **String** | The status of the project | [optional] -**ownerId** | **Number** | The ID of a project owner | [optional] -**startDate** | **Date** | The start date of the project. Format: YYYY-MM-DD. | [optional] -**endDate** | **Date** | The end date of the project. Format: YYYY-MM-DD. | [optional] -**dealIds** | **[Number]** | An array of IDs of the deals this project is associated with | [optional] -**orgId** | **Number** | The ID of the organization this project is associated with | [optional] -**personId** | **Number** | The ID of the person this project is associated with | [optional] +**owner_id** | **Number** | The ID of a project owner | [optional] +**start_date** | **Date** | The start date of the project. Format: YYYY-MM-DD. | [optional] +**end_date** | **Date** | The end date of the project. Format: YYYY-MM-DD. | [optional] +**deal_ids** | **[Number]** | An array of IDs of the deals this project is associated with | [optional] +**org_id** | **Number** | The ID of the organization this project is associated with | [optional] +**person_id** | **Number** | The ID of the person this project is associated with | [optional] **labels** | **[Number]** | An array of IDs of the labels this project has | [optional] diff --git a/docs/ProjectPutPlanItemBodyObject.md b/docs/ProjectPutPlanItemBodyObject.md index d6c8f98b..256dc8b1 100644 --- a/docs/ProjectPutPlanItemBodyObject.md +++ b/docs/ProjectPutPlanItemBodyObject.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**phaseId** | **Number** | The ID of a phase on a project board | [optional] -**groupId** | **Number** | The ID of a group on a project board | [optional] +**phase_id** | **Number** | The ID of a phase on a project board | [optional] +**group_id** | **Number** | The ID of a group on a project board | [optional] diff --git a/docs/ProjectResponseObject.md b/docs/ProjectResponseObject.md index 8ef50e7d..89d14560 100644 --- a/docs/ProjectResponseObject.md +++ b/docs/ProjectResponseObject.md @@ -6,20 +6,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the project, generated when the task was created | [optional] **title** | **String** | The title of the project | [optional] -**boardId** | **Number** | The ID of the board this project is associated with | [optional] -**phaseId** | **Number** | The ID of the phase this project is associated with | [optional] +**board_id** | **Number** | The ID of the board this project is associated with | [optional] +**phase_id** | **Number** | The ID of the phase this project is associated with | [optional] **description** | **String** | The description of the project | [optional] **status** | **String** | The status of the project | [optional] -**ownerId** | **Number** | The ID of a project owner | [optional] -**startDate** | **Date** | The start date of the project. Format: YYYY-MM-DD. | [optional] -**endDate** | **Date** | The end date of the project. Format: YYYY-MM-DD. | [optional] -**dealIds** | **[Number]** | An array of IDs of the deals this project is associated with | [optional] -**orgId** | **Number** | The ID of the organization this project is associated with | [optional] -**personId** | **Number** | The ID of the person this project is associated with | [optional] +**owner_id** | **Number** | The ID of a project owner | [optional] +**start_date** | **Date** | The start date of the project. Format: YYYY-MM-DD. | [optional] +**end_date** | **Date** | The end date of the project. Format: YYYY-MM-DD. | [optional] +**deal_ids** | **[Number]** | An array of IDs of the deals this project is associated with | [optional] +**org_id** | **Number** | The ID of the organization this project is associated with | [optional] +**person_id** | **Number** | The ID of the person this project is associated with | [optional] **labels** | **[Number]** | An array of IDs of the labels this project has | [optional] -**addTime** | **String** | The creation date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The update date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**statusChangeTime** | **String** | The status changed date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**archiveTime** | **String** | The archived date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. If not archived then 'null'. | [optional] +**add_time** | **String** | The creation date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The update date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**status_change_time** | **String** | The status changed date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**archive_time** | **String** | The archived date and time of the project in UTC. Format: YYYY-MM-DD HH:MM:SS. If not archived then 'null'. | [optional] diff --git a/docs/ProjectTemplatesApi.md b/docs/ProjectTemplatesApi.md index 29bc9f5c..8942fbcf 100644 --- a/docs/ProjectTemplatesApi.md +++ b/docs/ProjectTemplatesApi.md @@ -87,6 +87,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.ProjectTemplatesApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page 'limit': 500 // Number | For pagination, the limit of entries to be returned. If not provided, up to 500 items will be returned. diff --git a/docs/ProjectsApi.md b/docs/ProjectsApi.md index eb6df0f6..9ab864c0 100644 --- a/docs/ProjectsApi.md +++ b/docs/ProjectsApi.md @@ -60,7 +60,7 @@ apiInstance.addProject(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **projectPostObject** | [**ProjectPostObject**](ProjectPostObject.md)| | [optional] + **ProjectPostObject** | [**ProjectPostObject**](ProjectPostObject.md)| | [optional] ### Return type @@ -470,6 +470,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.ProjectsApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page 'limit': 100, // Number | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. @@ -493,10 +494,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] **limit** | **Number**| For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. | [optional] - **filterId** | **Number**| The ID of the filter to use | [optional] + **filter_id** | **Number**| The ID of the filter to use | [optional] **status** | **String**| If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned. | [optional] - **phaseId** | **Number**| If supplied, only projects in specified phase are returned | [optional] - **includeArchived** | **Boolean**| If supplied with `true` then archived projects are also included in the response. By default only not archived projects are returned. | [optional] + **phase_id** | **Number**| If supplied, only projects in specified phase are returned | [optional] + **include_archived** | **Boolean**| If supplied with `true` then archived projects are also included in the response. By default only not archived projects are returned. | [optional] ### Return type @@ -598,7 +599,7 @@ apiInstance.getProjectsPhases(boardId).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **boardId** | **Number**| ID of the board for which phases are requested | + **board_id** | **Number**| ID of the board for which phases are requested | ### Return type @@ -657,7 +658,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the project | **activityId** | **Number**| The ID of the activity | - **projectPutPlanItemBodyObject** | [**ProjectPutPlanItemBodyObject**](ProjectPutPlanItemBodyObject.md)| | [optional] + **ProjectPutPlanItemBodyObject** | [**ProjectPutPlanItemBodyObject**](ProjectPutPlanItemBodyObject.md)| | [optional] ### Return type @@ -716,7 +717,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the project | **taskId** | **Number**| The ID of the task | - **projectPutPlanItemBodyObject** | [**ProjectPutPlanItemBodyObject**](ProjectPutPlanItemBodyObject.md)| | [optional] + **ProjectPutPlanItemBodyObject** | [**ProjectPutPlanItemBodyObject**](ProjectPutPlanItemBodyObject.md)| | [optional] ### Return type @@ -773,7 +774,7 @@ apiInstance.updateProject(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the project | - **projectPutObject** | [**ProjectPutObject**](ProjectPutObject.md)| | [optional] + **ProjectPutObject** | [**ProjectPutObject**](ProjectPutObject.md)| | [optional] ### Return type diff --git a/docs/PutRolePipelinesBody.md b/docs/PutRolePipelinesBody.md index 38511a97..27afe196 100644 --- a/docs/PutRolePipelinesBody.md +++ b/docs/PutRolePipelinesBody.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**visiblePipelineIds** | **Object** | The pipeline IDs to make the pipelines visible (add) and/or hidden (remove) for the specified role. It requires the following JSON structure: `{ \"add\": \"[1]\", \"remove\": \"[3, 4]\" }`. | +**visible_pipeline_ids** | **Object** | The pipeline IDs to make the pipelines visible (add) and/or hidden (remove) for the specified role. It requires the following JSON structure: `{ \"add\": \"[1]\", \"remove\": \"[3, 4]\" }`. | diff --git a/docs/RecentDataProduct.md b/docs/RecentDataProduct.md index b5497934..7cb4066e 100644 --- a/docs/RecentDataProduct.md +++ b/docs/RecentDataProduct.md @@ -11,14 +11,14 @@ Name | Type | Description | Notes **unit** | **String** | The unit in which this product is sold | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] **category** | **String** | The category of the product | [optional] -**activeFlag** | **Boolean** | Whether this product will be made active or not | [optional] +**active_flag** | **Boolean** | Whether this product will be made active or not | [optional] **selectable** | **Boolean** | Whether this product can be selected in deals or not | [optional] -**firstChar** | **String** | The first letter of the product name | [optional] -**visibleTo** | **Number** | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. | [optional] -**ownerId** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, authorized user ID will be used. | [optional] -**filesCount** | **Number** | The count of files | [optional] -**addTime** | **String** | The date and time when the product was added to the deal | [optional] -**updateTime** | **String** | The date and time when the product was updated to the deal | [optional] +**first_char** | **String** | The first letter of the product name | [optional] +**visible_to** | **Number** | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. | [optional] +**owner_id** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, authorized user ID will be used. | [optional] +**files_count** | **Number** | The count of files | [optional] +**add_time** | **String** | The date and time when the product was added to the deal | [optional] +**update_time** | **String** | The date and time when the product was updated to the deal | [optional] **prices** | **[Object]** | Array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional] diff --git a/docs/RecentsApi.md b/docs/RecentsApi.md index 75d82b47..642c5290 100644 --- a/docs/RecentsApi.md +++ b/docs/RecentsApi.md @@ -32,6 +32,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.RecentsApi(apiClient); let sinceTimestamp = "sinceTimestamp_example"; // String | The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS. +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'items': "items_example", // String | Multiple selection of item types to include in the query (optional) 'start': 0, // Number | Pagination start @@ -50,7 +51,7 @@ apiInstance.getRecents(sinceTimestamp, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **sinceTimestamp** | **String**| The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS. | + **since_timestamp** | **String**| The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS. | **items** | **String**| Multiple selection of item types to include in the query (optional) | [optional] **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] diff --git a/docs/RelatedDealDataDEALID.md b/docs/RelatedDealDataDEALID.md index 3e286f16..a22c4b37 100644 --- a/docs/RelatedDealDataDEALID.md +++ b/docs/RelatedDealDataDEALID.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **status** | **String** | The status of the deal associated with the item | [optional] **value** | **Number** | The value of the deal that is associated with the item | [optional] **currency** | **String** | The currency of the deal value | [optional] -**stageId** | **Number** | The ID of the stage the deal is currently at | [optional] -**pipelineId** | **Number** | The ID of the pipeline the deal is in | [optional] +**stage_id** | **Number** | The ID of the stage the deal is currently at | [optional] +**pipeline_id** | **Number** | The ID of the pipeline the deal is in | [optional] diff --git a/docs/RelatedOrganizationName.md b/docs/RelatedOrganizationName.md index fc7ec656..f22601ed 100644 --- a/docs/RelatedOrganizationName.md +++ b/docs/RelatedOrganizationName.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**relatedOrganizationName** | **String** | The name of the linked organization | [optional] +**related_organization_name** | **String** | The name of the linked organization | [optional] diff --git a/docs/RelationshipOrganizationInfoItem.md b/docs/RelationshipOrganizationInfoItem.md index 5c7fb346..5a074a54 100644 --- a/docs/RelationshipOrganizationInfoItem.md +++ b/docs/RelationshipOrganizationInfoItem.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the organization associated with the item | [optional] -**peopleCount** | **Number** | The number of people connected with the organization that is associated with the item | [optional] -**ownerId** | **Number** | The ID of the owner of the organization that is associated with the item | [optional] +**people_count** | **Number** | The number of people connected with the organization that is associated with the item | [optional] +**owner_id** | **Number** | The ID of the owner of the organization that is associated with the item | [optional] **address** | **String** | The address of the organization | [optional] -**ccEmail** | **String** | The BCC email of the organization associated with the item | [optional] +**cc_email** | **String** | The BCC email of the organization associated with the item | [optional] **value** | **Number** | The ID of the organization | [optional] diff --git a/docs/RelationshipOrganizationInfoItemWithActiveFlag.md b/docs/RelationshipOrganizationInfoItemWithActiveFlag.md index c6ef4000..e7614230 100644 --- a/docs/RelationshipOrganizationInfoItemWithActiveFlag.md +++ b/docs/RelationshipOrganizationInfoItemWithActiveFlag.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the organization associated with the item | [optional] -**peopleCount** | **Number** | The number of people connected with the organization that is associated with the item | [optional] -**ownerId** | **Number** | The ID of the owner of the organization that is associated with the item | [optional] +**people_count** | **Number** | The number of people connected with the organization that is associated with the item | [optional] +**owner_id** | **Number** | The ID of the owner of the organization that is associated with the item | [optional] **address** | **String** | The address of the organization | [optional] -**ccEmail** | **String** | The BCC email of the organization associated with the item | [optional] +**cc_email** | **String** | The BCC email of the organization associated with the item | [optional] **value** | **Number** | The ID of the organization | [optional] -**activeFlag** | **Boolean** | Whether the associated organization is active or not | [optional] +**active_flag** | **Boolean** | Whether the associated organization is active or not | [optional] diff --git a/docs/RequiredPostProjectParameters.md b/docs/RequiredPostProjectParameters.md index 11cc32fc..e28a6365 100644 --- a/docs/RequiredPostProjectParameters.md +++ b/docs/RequiredPostProjectParameters.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The title of the project | -**boardId** | **Number** | The ID of a project board | -**phaseId** | **Number** | The ID of a phase on a project board | +**board_id** | **Number** | The ID of a project board | +**phase_id** | **Number** | The ID of a phase on a project board | diff --git a/docs/RequiredPostTaskParameters.md b/docs/RequiredPostTaskParameters.md index 6d4b74dc..07928fbb 100644 --- a/docs/RequiredPostTaskParameters.md +++ b/docs/RequiredPostTaskParameters.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The title of the task | -**projectId** | **Number** | The ID of a project | +**project_id** | **Number** | The ID of a project | diff --git a/docs/ResponseCallLogObject.md b/docs/ResponseCallLogObject.md index 080457a3..2e2453f8 100644 --- a/docs/ResponseCallLogObject.md +++ b/docs/ResponseCallLogObject.md @@ -4,23 +4,23 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users. | [optional] -**activityId** | **Number** | If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity. | [optional] +**user_id** | **Number** | The ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users. | [optional] +**activity_id** | **Number** | If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity. | [optional] **subject** | **String** | The name of the activity this call is attached to | [optional] **duration** | **String** | The duration of the call in seconds | [optional] **outcome** | **String** | Describes the outcome of the call | -**fromPhoneNumber** | **String** | The number that made the call | [optional] -**toPhoneNumber** | **String** | The number called | -**startTime** | **Date** | The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. | -**endTime** | **Date** | The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. | -**personId** | **Number** | The ID of the person this call is associated with | [optional] -**orgId** | **Number** | The ID of the organization this call is associated with | [optional] -**dealId** | **Number** | The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] -**leadId** | **String** | The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] +**from_phone_number** | **String** | The number that made the call | [optional] +**to_phone_number** | **String** | The number called | +**start_time** | **Date** | The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. | +**end_time** | **Date** | The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. | +**person_id** | **Number** | The ID of the person this call is associated with | [optional] +**org_id** | **Number** | The ID of the organization this call is associated with | [optional] +**deal_id** | **Number** | The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] +**lead_id** | **String** | The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] **note** | **String** | The note for the call log in HTML format | [optional] **id** | **String** | The call log ID, generated when the call log was created | [optional] -**hasRecording** | **Boolean** | If the call log has an audio recording attached, the value should be true | [optional] -**companyId** | **Number** | The company ID of the owner of the call log | [optional] +**has_recording** | **Boolean** | If the call log has an audio recording attached, the value should be true | [optional] +**company_id** | **Number** | The company ID of the owner of the call log | [optional] diff --git a/docs/ResponseCallLogObjectAllOf.md b/docs/ResponseCallLogObjectAllOf.md index 257b730a..619cb7a0 100644 --- a/docs/ResponseCallLogObjectAllOf.md +++ b/docs/ResponseCallLogObjectAllOf.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The call log ID, generated when the call log was created | [optional] -**hasRecording** | **Boolean** | If the call log has an audio recording attached, the value should be true | [optional] -**companyId** | **Number** | The company ID of the owner of the call log | [optional] +**has_recording** | **Boolean** | If the call log has an audio recording attached, the value should be true | [optional] +**company_id** | **Number** | The company ID of the owner of the call log | [optional] diff --git a/docs/RoleAssignment.md b/docs/RoleAssignment.md index 4cf0e426..a81c0df4 100644 --- a/docs/RoleAssignment.md +++ b/docs/RoleAssignment.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**parentRoleId** | **Number** | The ID of the parent role | [optional] +**parent_role_id** | **Number** | The ID of the parent role | [optional] **name** | **String** | The name of the role | [optional] -**userId** | **Number** | The user ID | [optional] -**roleId** | **Number** | The role ID | [optional] -**activeFlag** | **Boolean** | Whether the role is active or not | [optional] +**user_id** | **Number** | The user ID | [optional] +**role_id** | **Number** | The role ID | [optional] +**active_flag** | **Boolean** | Whether the role is active or not | [optional] **type** | **String** | The assignment type | [optional] diff --git a/docs/RoleAssignmentAllOf.md b/docs/RoleAssignmentAllOf.md index 323196e0..60071662 100644 --- a/docs/RoleAssignmentAllOf.md +++ b/docs/RoleAssignmentAllOf.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The user ID | [optional] -**roleId** | **Number** | The role ID | [optional] -**activeFlag** | **Boolean** | Whether the role is active or not | [optional] +**user_id** | **Number** | The user ID | [optional] +**role_id** | **Number** | The role ID | [optional] +**active_flag** | **Boolean** | Whether the role is active or not | [optional] **type** | **String** | The assignment type | [optional] diff --git a/docs/RoleSettings.md b/docs/RoleSettings.md index c339496d..4875a4ba 100644 --- a/docs/RoleSettings.md +++ b/docs/RoleSettings.md @@ -4,14 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dealDefaultVisibility** | **Number** | The default visibility level of the deals for the role | [optional] -**leadDefaultVisibility** | **Number** | The default visibility level of the leads for the role | [optional] -**orgDefaultVisibility** | **Number** | The default visibility level of the organizations for the role | [optional] -**personDefaultVisibility** | **Number** | The default visibility level of the people for the role | [optional] -**productDefaultVisibility** | **Number** | The default visibility level of the products for the role | [optional] -**dealAccessLevel** | **Number** | The access level of the deals for the role (only for default role) | [optional] -**orgAccessLevel** | **Number** | The access level of the organizations for the role (only for default role) | [optional] -**personAccessLevel** | **Number** | The access level of the people for the role (only for default role) | [optional] -**productAccessLevel** | **Number** | The access level of the products for the role (only for default role) | [optional] +**deal_default_visibility** | **Number** | The default visibility level of the deals for the role | [optional] +**lead_default_visibility** | **Number** | The default visibility level of the leads for the role | [optional] +**org_default_visibility** | **Number** | The default visibility level of the organizations for the role | [optional] +**person_default_visibility** | **Number** | The default visibility level of the people for the role | [optional] +**product_default_visibility** | **Number** | The default visibility level of the products for the role | [optional] +**deal_access_level** | **Number** | The access level of the deals for the role (only for default role) | [optional] +**org_access_level** | **Number** | The access level of the organizations for the role (only for default role) | [optional] +**person_access_level** | **Number** | The access level of the people for the role (only for default role) | [optional] +**product_access_level** | **Number** | The access level of the products for the role (only for default role) | [optional] diff --git a/docs/RolesAdditionalDataPagination.md b/docs/RolesAdditionalDataPagination.md index 5907ea40..aeb68a96 100644 --- a/docs/RolesAdditionalDataPagination.md +++ b/docs/RolesAdditionalDataPagination.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **start** | **Number** | Pagination start | [optional] **limit** | **Number** | Items shown per page | [optional] -**moreItemsInCollection** | **Boolean** | Whether there are more list items in the collection than displayed | [optional] +**more_items_in_collection** | **Boolean** | Whether there are more list items in the collection than displayed | [optional] diff --git a/docs/RolesApi.md b/docs/RolesApi.md index b72ebf0d..07a0ad3e 100644 --- a/docs/RolesApi.md +++ b/docs/RolesApi.md @@ -60,7 +60,7 @@ apiInstance.addOrUpdateRoleSetting(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the role | - **addOrUpdateRoleSettingRequest** | [**AddOrUpdateRoleSettingRequest**](AddOrUpdateRoleSettingRequest.md)| | [optional] + **AddOrUpdateRoleSettingRequest** | [**AddOrUpdateRoleSettingRequest**](AddOrUpdateRoleSettingRequest.md)| | [optional] ### Return type @@ -115,7 +115,7 @@ apiInstance.addRole(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **addRole** | [**AddRole**](AddRole.md)| | [optional] + **AddRole** | [**AddRole**](AddRole.md)| | [optional] ### Return type @@ -172,7 +172,7 @@ apiInstance.addRoleAssignment(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the role | - **addRoleAssignmentRequest** | [**AddRoleAssignmentRequest**](AddRoleAssignmentRequest.md)| | [optional] + **AddRoleAssignmentRequest** | [**AddRoleAssignmentRequest**](AddRoleAssignmentRequest.md)| | [optional] ### Return type @@ -282,7 +282,7 @@ apiInstance.deleteRoleAssignment(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the role | - **deleteRoleAssignmentRequest** | [**DeleteRoleAssignmentRequest**](DeleteRoleAssignmentRequest.md)| | [optional] + **DeleteRoleAssignmentRequest** | [**DeleteRoleAssignmentRequest**](DeleteRoleAssignmentRequest.md)| | [optional] ### Return type @@ -375,6 +375,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.RolesApi(apiClient); let id = 56; // Number | The ID of the role +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -434,6 +435,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.RolesApi(apiClient); let id = 56; // Number | The ID of the role +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'visible': true // Boolean | Whether to return the visible or hidden pipelines for the role }; @@ -543,6 +545,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.RolesApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -618,7 +621,7 @@ apiInstance.updateRole(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the role | - **baseRole** | [**BaseRole**](BaseRole.md)| | [optional] + **BaseRole** | [**BaseRole**](BaseRole.md)| | [optional] ### Return type @@ -675,7 +678,7 @@ apiInstance.updateRolePipelines(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the role | - **putRolePipelinesBody** | [**PutRolePipelinesBody**](PutRolePipelinesBody.md)| | [optional] + **PutRolePipelinesBody** | [**PutRolePipelinesBody**](PutRolePipelinesBody.md)| | [optional] ### Return type diff --git a/docs/SinglePermissionSetsItem.md b/docs/SinglePermissionSetsItem.md index 9897aef8..1cec9241 100644 --- a/docs/SinglePermissionSetsItem.md +++ b/docs/SinglePermissionSetsItem.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **description** | **String** | The description of the permission set | [optional] **app** | **String** | The app that permission set belongs to | [optional] **type** | **String** | The type of permission set | [optional] -**assignmentCount** | **Number** | The number of users assigned to this permission set | [optional] +**assignment_count** | **Number** | The number of users assigned to this permission set | [optional] **contents** | **[String]** | A permission assigned to this permission set | [optional] diff --git a/docs/Stage.md b/docs/Stage.md index 42dee8f9..8fda1485 100644 --- a/docs/Stage.md +++ b/docs/Stage.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the stage | [optional] -**pipelineId** | **Number** | The ID of the pipeline to add stage to | [optional] -**dealProbability** | **Number** | The success probability percentage of the deal. Used/shown when deal weighted values are used. | [optional] -**rottenFlag** | **Boolean** | Whether deals in this stage can become rotten | [optional] -**rottenDays** | **Number** | The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. | [optional] +**pipeline_id** | **Number** | The ID of the pipeline to add stage to | [optional] +**deal_probability** | **Number** | The success probability percentage of the deal. Used/shown when deal weighted values are used. | [optional] +**rotten_flag** | **Boolean** | Whether deals in this stage can become rotten | [optional] +**rotten_days** | **Number** | The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. | [optional] diff --git a/docs/StageConversions.md b/docs/StageConversions.md index 65a57985..cd53272e 100644 --- a/docs/StageConversions.md +++ b/docs/StageConversions.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**fromStageId** | **Number** | The stage ID from where conversion starts | [optional] -**toStageId** | **Number** | The stage ID to where conversion ends | [optional] -**conversionRate** | **Number** | The conversion rate | [optional] +**from_stage_id** | **Number** | The stage ID from where conversion starts | [optional] +**to_stage_id** | **Number** | The stage ID to where conversion ends | [optional] +**conversion_rate** | **Number** | The conversion rate | [optional] diff --git a/docs/StageDetails.md b/docs/StageDetails.md index c723d0e6..da9a2390 100644 --- a/docs/StageDetails.md +++ b/docs/StageDetails.md @@ -5,15 +5,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the stage | [optional] -**orderNr** | **Number** | Defines the order of the stage | [optional] +**order_nr** | **Number** | Defines the order of the stage | [optional] **name** | **String** | The name of the stage | [optional] -**activeFlag** | **Boolean** | Whether the stage is active or deleted | [optional] -**dealProbability** | **Number** | The success probability percentage of the deal. Used/shown when the deal weighted values are used. | [optional] -**pipelineId** | **Number** | The ID of the pipeline to add the stage to | [optional] -**rottenFlag** | **Boolean** | Whether deals in this stage can become rotten | [optional] -**rottenDays** | **Number** | The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. | [optional] -**addTime** | **String** | The stage creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The stage update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**dealsSummary** | [**DealSummary**](DealSummary.md) | | [optional] +**active_flag** | **Boolean** | Whether the stage is active or deleted | [optional] +**deal_probability** | **Number** | The success probability percentage of the deal. Used/shown when the deal weighted values are used. | [optional] +**pipeline_id** | **Number** | The ID of the pipeline to add the stage to | [optional] +**rotten_flag** | **Boolean** | Whether deals in this stage can become rotten | [optional] +**rotten_days** | **Number** | The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. | [optional] +**add_time** | **String** | The stage creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The stage update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**deals_summary** | [**DealSummary**](DealSummary.md) | | [optional] diff --git a/docs/StageWithPipelineInfo.md b/docs/StageWithPipelineInfo.md index db85a642..b162022b 100644 --- a/docs/StageWithPipelineInfo.md +++ b/docs/StageWithPipelineInfo.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the stage | [optional] -**orderNr** | **Number** | Defines the order of the stage | [optional] +**order_nr** | **Number** | Defines the order of the stage | [optional] **name** | **String** | The name of the stage | [optional] -**activeFlag** | **Boolean** | Whether the stage is active or deleted | [optional] -**dealProbability** | **Number** | The success probability percentage of the deal. Used/shown when the deal weighted values are used. | [optional] -**pipelineId** | **Number** | The ID of the pipeline to add the stage to | [optional] -**rottenFlag** | **Boolean** | Whether deals in this stage can become rotten | [optional] -**rottenDays** | **Number** | The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. | [optional] -**addTime** | **String** | The stage creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The stage update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**pipelineName** | **String** | The name of the pipeline | [optional] -**pipelineDealProbability** | **Boolean** | The pipeline deal probability. When `true`, overrides the stage probability. | [optional] +**active_flag** | **Boolean** | Whether the stage is active or deleted | [optional] +**deal_probability** | **Number** | The success probability percentage of the deal. Used/shown when the deal weighted values are used. | [optional] +**pipeline_id** | **Number** | The ID of the pipeline to add the stage to | [optional] +**rotten_flag** | **Boolean** | Whether deals in this stage can become rotten | [optional] +**rotten_days** | **Number** | The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. | [optional] +**add_time** | **String** | The stage creation time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The stage update time. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**pipeline_name** | **String** | The name of the pipeline | [optional] +**pipeline_deal_probability** | **Boolean** | The pipeline deal probability. When `true`, overrides the stage probability. | [optional] diff --git a/docs/StageWithPipelineInfoAllOf.md b/docs/StageWithPipelineInfoAllOf.md index 213b202a..16e395ff 100644 --- a/docs/StageWithPipelineInfoAllOf.md +++ b/docs/StageWithPipelineInfoAllOf.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pipelineName** | **String** | The name of the pipeline | [optional] -**pipelineDealProbability** | **Boolean** | The pipeline deal probability. When `true`, overrides the stage probability. | [optional] +**pipeline_name** | **String** | The name of the pipeline | [optional] +**pipeline_deal_probability** | **Boolean** | The pipeline deal probability. When `true`, overrides the stage probability. | [optional] diff --git a/docs/StagesApi.md b/docs/StagesApi.md index f73cf611..2735d21b 100644 --- a/docs/StagesApi.md +++ b/docs/StagesApi.md @@ -53,7 +53,7 @@ apiInstance.addStage(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **stage** | [**Stage**](Stage.md)| | [optional] + **Stage** | [**Stage**](Stage.md)| | [optional] ### Return type @@ -199,6 +199,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.StagesApi(apiClient); let id = 56; // Number | The ID of the stage +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'everyone': new Pipedrive.NumberBoolean() // NumberBoolean | If `everyone=1` is provided, deals summary will return deals owned by every user }; @@ -256,6 +257,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.StagesApi(apiClient); let id = 56; // Number | The ID of the stage +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'filterId': 56, // Number | If supplied, only deals matching the given filter will be returned 'userId': 56, // Number | If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned. @@ -277,8 +279,8 @@ apiInstance.getStageDeals(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the stage | - **filterId** | **Number**| If supplied, only deals matching the given filter will be returned | [optional] - **userId** | **Number**| If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned. | [optional] + **filter_id** | **Number**| If supplied, only deals matching the given filter will be returned | [optional] + **user_id** | **Number**| If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned. | [optional] **everyone** | [**NumberBoolean**](.md)| If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned | [optional] **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] @@ -320,6 +322,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.StagesApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'pipelineId': 56, // Number | The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched. 'start': 0, // Number | Pagination start @@ -338,7 +341,7 @@ apiInstance.getStages(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **pipelineId** | **Number**| The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched. | [optional] + **pipeline_id** | **Number**| The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched. | [optional] **start** | **Number**| Pagination start | [optional] [default to 0] **limit** | **Number**| Items shown per page | [optional] @@ -397,7 +400,7 @@ apiInstance.updateStage(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the stage | - **updateStageRequest** | [**UpdateStageRequest**](UpdateStageRequest.md)| | [optional] + **UpdateStageRequest** | [**UpdateStageRequest**](UpdateStageRequest.md)| | [optional] ### Return type diff --git a/docs/SubRole.md b/docs/SubRole.md index e62d8646..cc48fb02 100644 --- a/docs/SubRole.md +++ b/docs/SubRole.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**parentRoleId** | **Number** | The ID of the parent role | [optional] +**parent_role_id** | **Number** | The ID of the parent role | [optional] **name** | **String** | The name of the role | [optional] **id** | **Number** | The ID of the role | [optional] -**activeFlag** | **Boolean** | Whether the role is active or not | [optional] -**assignmentCount** | **String** | The number of users assigned to this role | [optional] -**subRoleCount** | **String** | The number of sub-roles | [optional] +**active_flag** | **Boolean** | Whether the role is active or not | [optional] +**assignment_count** | **String** | The number of users assigned to this role | [optional] +**sub_role_count** | **String** | The number of sub-roles | [optional] diff --git a/docs/SubRoleAllOf.md b/docs/SubRoleAllOf.md index 8c7e05dc..a6bfeba2 100644 --- a/docs/SubRoleAllOf.md +++ b/docs/SubRoleAllOf.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the role | [optional] -**activeFlag** | **Boolean** | Whether the role is active or not | [optional] -**assignmentCount** | **String** | The number of users assigned to this role | [optional] -**subRoleCount** | **String** | The number of sub-roles | [optional] +**active_flag** | **Boolean** | Whether the role is active or not | [optional] +**assignment_count** | **String** | The number of users assigned to this role | [optional] +**sub_role_count** | **String** | The number of sub-roles | [optional] diff --git a/docs/SubscriptionInstallmentCreateRequest.md b/docs/SubscriptionInstallmentCreateRequest.md index 6eeb1d00..1139e1d4 100644 --- a/docs/SubscriptionInstallmentCreateRequest.md +++ b/docs/SubscriptionInstallmentCreateRequest.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dealId** | **Number** | The ID of the deal this installment subscription is associated with | +**deal_id** | **Number** | The ID of the deal this installment subscription is associated with | **currency** | **String** | The currency of the installment subscription. Accepts a 3-character currency code. | **payments** | **[Object]** | Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD). | -**updateDealValue** | **Boolean** | Indicates that the deal value must be set to the installment subscription's total value | [optional] +**update_deal_value** | **Boolean** | Indicates that the deal value must be set to the installment subscription's total value | [optional] diff --git a/docs/SubscriptionInstallmentUpdateRequest.md b/docs/SubscriptionInstallmentUpdateRequest.md index e2a59171..1edeac51 100644 --- a/docs/SubscriptionInstallmentUpdateRequest.md +++ b/docs/SubscriptionInstallmentUpdateRequest.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **payments** | **[Object]** | Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with a explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD). | -**updateDealValue** | **Boolean** | Indicates that the deal value must be set to installment subscription's total value | [optional] +**update_deal_value** | **Boolean** | Indicates that the deal value must be set to installment subscription's total value | [optional] diff --git a/docs/SubscriptionItem.md b/docs/SubscriptionItem.md index 609b818d..d6a57127 100644 --- a/docs/SubscriptionItem.md +++ b/docs/SubscriptionItem.md @@ -5,20 +5,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the subscription | [optional] -**userId** | **Number** | The ID of the user who created the subscription | [optional] -**dealId** | **Number** | The ID of the deal this subscription is associated with | [optional] +**user_id** | **Number** | The ID of the user who created the subscription | [optional] +**deal_id** | **Number** | The ID of the deal this subscription is associated with | [optional] **description** | **String** | The description of the recurring subscription | [optional] -**isActive** | **Boolean** | The subscription status | [optional] -**cyclesCount** | **Number** | Shows how many payments a recurring subscription has | [optional] -**cycleAmount** | **Number** | The amount of each payment | [optional] +**is_active** | **Boolean** | The subscription status | [optional] +**cycles_count** | **Number** | Shows how many payments a recurring subscription has | [optional] +**cycle_amount** | **Number** | The amount of each payment | [optional] **infinite** | **Boolean** | Indicates that the recurring subscription will last until it is manually canceled or deleted | [optional] **currency** | **String** | The currency of the subscription | [optional] -**cadenceType** | **String** | The interval between payments | [optional] -**startDate** | **Date** | The start date of the recurring subscription | [optional] -**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** | **Date** | The creation time of the subscription | [optional] -**updateTime** | **Date** | The update time of the subscription | [optional] +**cadence_type** | **String** | The interval between payments | [optional] +**start_date** | **Date** | The start date of the recurring subscription | [optional] +**end_date** | **Date** | The end date of the subscription | [optional] +**lifetime_value** | **Number** | The total value of all payments | [optional] +**final_status** | **String** | The final status of the subscription | [optional] +**add_time** | **Date** | The creation time of the subscription | [optional] +**update_time** | **Date** | The update time of the subscription | [optional] diff --git a/docs/SubscriptionRecurringCancelRequest.md b/docs/SubscriptionRecurringCancelRequest.md index d0a163ca..9aa9dc9a 100644 --- a/docs/SubscriptionRecurringCancelRequest.md +++ b/docs/SubscriptionRecurringCancelRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**endDate** | **Date** | The subscription termination date. All payments after the specified date will be deleted. The end_date of the subscription will be set to the due date of the payment to follow the specified date. Default value is the current date. | [optional] +**end_date** | **Date** | The subscription termination date. All payments after the specified date will be deleted. The end_date of the subscription will be set to the due date of the payment to follow the specified date. Default value is the current date. | [optional] diff --git a/docs/SubscriptionRecurringCreateRequest.md b/docs/SubscriptionRecurringCreateRequest.md index 0a88bb2f..73d159a3 100644 --- a/docs/SubscriptionRecurringCreateRequest.md +++ b/docs/SubscriptionRecurringCreateRequest.md @@ -4,16 +4,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dealId** | **Number** | The ID of the deal this recurring subscription is associated with | +**deal_id** | **Number** | The ID of the deal this recurring subscription is associated with | **currency** | **String** | The currency of the recurring subscription. Accepts a 3-character currency code. | **description** | **String** | The description of the recurring subscription | [optional] -**cadenceType** | **String** | The interval between payments | -**cyclesCount** | **Number** | Shows how many payments the subscription has. Note that one field must be set: `cycles_count` or `infinite`. If `cycles_count` is set, then `cycle_amount` and `start_date` are also required. | [optional] -**cycleAmount** | **Number** | The amount of each payment | -**startDate** | **Date** | The start date of the recurring subscription. Format: YYYY-MM-DD | +**cadence_type** | **String** | The interval between payments | +**cycles_count** | **Number** | Shows how many payments the subscription has. Note that one field must be set: `cycles_count` or `infinite`. If `cycles_count` is set, then `cycle_amount` and `start_date` are also required. | [optional] +**cycle_amount** | **Number** | The amount of each payment | +**start_date** | **Date** | The start date of the recurring subscription. Format: YYYY-MM-DD | **infinite** | **Boolean** | This indicates that the recurring subscription will last until it's manually canceled or deleted. Note that only one field must be set: `cycles_count` or `infinite`. | [optional] **payments** | **[Object]** | Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD). | [optional] -**updateDealValue** | **Boolean** | Indicates that the deal value must be set to recurring subscription's MRR value | [optional] +**update_deal_value** | **Boolean** | Indicates that the deal value must be set to recurring subscription's MRR value | [optional] diff --git a/docs/SubscriptionRecurringUpdateRequest.md b/docs/SubscriptionRecurringUpdateRequest.md index d976e964..561202cd 100644 --- a/docs/SubscriptionRecurringUpdateRequest.md +++ b/docs/SubscriptionRecurringUpdateRequest.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **description** | **String** | The description of the recurring subscription | [optional] -**cycleAmount** | **Number** | The amount of each payment | [optional] +**cycle_amount** | **Number** | The amount of each payment | [optional] **payments** | **[Object]** | Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD). | [optional] -**updateDealValue** | **Boolean** | Indicates that the deal value must be set to recurring subscription's MRR value | [optional] -**effectiveDate** | **Date** | All payments after that date will be affected. Format: YYYY-MM-DD | +**update_deal_value** | **Boolean** | Indicates that the deal value must be set to recurring subscription's MRR value | [optional] +**effective_date** | **Date** | All payments after that date will be affected. Format: YYYY-MM-DD | diff --git a/docs/SubscriptionsApi.md b/docs/SubscriptionsApi.md index bf0c3a99..a35b5c31 100644 --- a/docs/SubscriptionsApi.md +++ b/docs/SubscriptionsApi.md @@ -55,7 +55,7 @@ apiInstance.addRecurringSubscription(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscriptionRecurringCreateRequest** | [**SubscriptionRecurringCreateRequest**](SubscriptionRecurringCreateRequest.md)| | [optional] + **SubscriptionRecurringCreateRequest** | [**SubscriptionRecurringCreateRequest**](SubscriptionRecurringCreateRequest.md)| | [optional] ### Return type @@ -110,7 +110,7 @@ apiInstance.addSubscriptionInstallment(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscriptionInstallmentCreateRequest** | [**SubscriptionInstallmentCreateRequest**](SubscriptionInstallmentCreateRequest.md)| | [optional] + **SubscriptionInstallmentCreateRequest** | [**SubscriptionInstallmentCreateRequest**](SubscriptionInstallmentCreateRequest.md)| | [optional] ### Return type @@ -167,7 +167,7 @@ apiInstance.cancelRecurringSubscription(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the subscription | - **subscriptionRecurringCancelRequest** | [**SubscriptionRecurringCancelRequest**](SubscriptionRecurringCancelRequest.md)| | [optional] + **SubscriptionRecurringCancelRequest** | [**SubscriptionRecurringCancelRequest**](SubscriptionRecurringCancelRequest.md)| | [optional] ### Return type @@ -436,7 +436,7 @@ apiInstance.updateRecurringSubscription(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the subscription | - **subscriptionRecurringUpdateRequest** | [**SubscriptionRecurringUpdateRequest**](SubscriptionRecurringUpdateRequest.md)| | [optional] + **SubscriptionRecurringUpdateRequest** | [**SubscriptionRecurringUpdateRequest**](SubscriptionRecurringUpdateRequest.md)| | [optional] ### Return type @@ -493,7 +493,7 @@ apiInstance.updateSubscriptionInstallment(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the subscription | - **subscriptionInstallmentUpdateRequest** | [**SubscriptionInstallmentUpdateRequest**](SubscriptionInstallmentUpdateRequest.md)| | [optional] + **SubscriptionInstallmentUpdateRequest** | [**SubscriptionInstallmentUpdateRequest**](SubscriptionInstallmentUpdateRequest.md)| | [optional] ### Return type diff --git a/docs/TaskMandatoryObjectFragment.md b/docs/TaskMandatoryObjectFragment.md index b871f4d7..3d8dcff0 100644 --- a/docs/TaskMandatoryObjectFragment.md +++ b/docs/TaskMandatoryObjectFragment.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The title of the task | [optional] -**projectId** | **Number** | The ID of the project this task is associated with | [optional] +**project_id** | **Number** | The ID of the project this task is associated with | [optional] diff --git a/docs/TaskNotChangeableObjectFragment.md b/docs/TaskNotChangeableObjectFragment.md index b3ecd826..f79acc9d 100644 --- a/docs/TaskNotChangeableObjectFragment.md +++ b/docs/TaskNotChangeableObjectFragment.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**creatorId** | **Number** | The creator of a task | [optional] -**addTime** | **String** | The creation date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The update date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**markedAsDoneTime** | **String** | The marked as done date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**creator_id** | **Number** | The creator of a task | [optional] +**add_time** | **String** | The creation date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The update date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**marked_as_done_time** | **String** | The marked as done date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] diff --git a/docs/TaskObjectFragment.md b/docs/TaskObjectFragment.md index c82e958e..aef63426 100644 --- a/docs/TaskObjectFragment.md +++ b/docs/TaskObjectFragment.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **description** | **String** | The description of the task | [optional] -**parentTaskId** | **Number** | The ID of a parent task. Can not be ID of a task which is already a subtask. | [optional] -**assigneeId** | **Number** | The ID of the user who will be the assignee of the task | [optional] +**parent_task_id** | **Number** | The ID of a parent task. Can not be ID of a task which is already a subtask. | [optional] +**assignee_id** | **Number** | The ID of the user who will be the assignee of the task | [optional] **done** | [**NumberBoolean**](NumberBoolean.md) | Whether the task is done or not. 0 = Not done, 1 = Done. | [optional] -**dueDate** | **Date** | The due date of the task. Format: YYYY-MM-DD. | [optional] +**due_date** | **Date** | The due date of the task. Format: YYYY-MM-DD. | [optional] diff --git a/docs/TaskPostObject.md b/docs/TaskPostObject.md index 3fc37e8b..330ead18 100644 --- a/docs/TaskPostObject.md +++ b/docs/TaskPostObject.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The title of the task | -**projectId** | **Number** | The ID of a project | +**project_id** | **Number** | The ID of a project | **description** | **String** | The description of the task | [optional] -**parentTaskId** | **Number** | The ID of a parent task. Can not be ID of a task which is already a subtask. | [optional] -**assigneeId** | **Number** | The ID of the user who will be the assignee of the task | [optional] +**parent_task_id** | **Number** | The ID of a parent task. Can not be ID of a task which is already a subtask. | [optional] +**assignee_id** | **Number** | The ID of the user who will be the assignee of the task | [optional] **done** | [**NumberBoolean**](NumberBoolean.md) | Whether the task is done or not. 0 = Not done, 1 = Done. | [optional] -**dueDate** | **Date** | The due date of the task. Format: YYYY-MM-DD. | [optional] +**due_date** | **Date** | The due date of the task. Format: YYYY-MM-DD. | [optional] diff --git a/docs/TaskPutObject.md b/docs/TaskPutObject.md index 82256cc7..4be97832 100644 --- a/docs/TaskPutObject.md +++ b/docs/TaskPutObject.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The title of the task | [optional] -**projectId** | **Number** | The ID of the project this task is associated with | [optional] +**project_id** | **Number** | The ID of the project this task is associated with | [optional] **description** | **String** | The description of the task | [optional] -**parentTaskId** | **Number** | The ID of a parent task. Can not be ID of a task which is already a subtask. | [optional] -**assigneeId** | **Number** | The ID of the user who will be the assignee of the task | [optional] +**parent_task_id** | **Number** | The ID of a parent task. Can not be ID of a task which is already a subtask. | [optional] +**assignee_id** | **Number** | The ID of the user who will be the assignee of the task | [optional] **done** | [**NumberBoolean**](NumberBoolean.md) | Whether the task is done or not. 0 = Not done, 1 = Done. | [optional] -**dueDate** | **Date** | The due date of the task. Format: YYYY-MM-DD. | [optional] +**due_date** | **Date** | The due date of the task. Format: YYYY-MM-DD. | [optional] diff --git a/docs/TaskResponseObject.md b/docs/TaskResponseObject.md index 4743de44..ecbfafa0 100644 --- a/docs/TaskResponseObject.md +++ b/docs/TaskResponseObject.md @@ -6,15 +6,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | The ID of the task, generated when the task was created | [optional] **title** | **String** | The title of the task | [optional] -**projectId** | **Number** | The ID of the project this task is associated with | [optional] +**project_id** | **Number** | The ID of the project this task is associated with | [optional] **description** | **String** | The description of the task | [optional] -**parentTaskId** | **Number** | The ID of a parent task. Can not be ID of a task which is already a subtask. | [optional] -**assigneeId** | **Number** | The ID of the user who will be the assignee of the task | [optional] +**parent_task_id** | **Number** | The ID of a parent task. Can not be ID of a task which is already a subtask. | [optional] +**assignee_id** | **Number** | The ID of the user who will be the assignee of the task | [optional] **done** | [**NumberBoolean**](NumberBoolean.md) | Whether the task is done or not. 0 = Not done, 1 = Done. | [optional] -**dueDate** | **Date** | The due date of the task. Format: YYYY-MM-DD. | [optional] -**creatorId** | **Number** | The creator of a task | [optional] -**addTime** | **String** | The creation date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The update date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**markedAsDoneTime** | **String** | The marked as done date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**due_date** | **Date** | The due date of the task. Format: YYYY-MM-DD. | [optional] +**creator_id** | **Number** | The creator of a task | [optional] +**add_time** | **String** | The creation date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The update date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**marked_as_done_time** | **String** | The marked as done date and time of the task in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] diff --git a/docs/TasksApi.md b/docs/TasksApi.md index 011d4c9c..de75e689 100644 --- a/docs/TasksApi.md +++ b/docs/TasksApi.md @@ -51,7 +51,7 @@ apiInstance.addTask(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **taskPostObject** | [**TaskPostObject**](TaskPostObject.md)| | [optional] + **TaskPostObject** | [**TaskPostObject**](TaskPostObject.md)| | [optional] ### Return type @@ -196,6 +196,7 @@ let oauth2 = apiClient.authentications['oauth2']; oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.TasksApi(apiClient); +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page 'limit': 500, // Number | For pagination, the limit of entries to be returned. If not provided, up to 500 items will be returned. @@ -219,9 +220,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] **limit** | **Number**| For pagination, the limit of entries to be returned. If not provided, up to 500 items will be returned. | [optional] - **assigneeId** | **Number**| If supplied, only tasks that are assigned to this user are returned | [optional] - **projectId** | **Number**| If supplied, only tasks that are assigned to this project are returned | [optional] - **parentTaskId** | **Number**| If `null` is supplied then only parent tasks are returned. If integer is supplied then only subtasks of a specific task are returned. By default all tasks are returned. | [optional] + **assignee_id** | **Number**| If supplied, only tasks that are assigned to this user are returned | [optional] + **project_id** | **Number**| If supplied, only tasks that are assigned to this project are returned | [optional] + **parent_task_id** | **Number**| If `null` is supplied then only parent tasks are returned. If integer is supplied then only subtasks of a specific task are returned. By default all tasks are returned. | [optional] **done** | [**NumberBoolean**](.md)| Whether the task is done or not. `0` = Not done, `1` = Done. If not omitted then returns both done and not done tasks. | [optional] ### Return type @@ -279,7 +280,7 @@ apiInstance.updateTask(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the task | - **taskPutObject** | [**TaskPutObject**](TaskPutObject.md)| | [optional] + **TaskPutObject** | [**TaskPutObject**](TaskPutObject.md)| | [optional] ### Return type diff --git a/docs/TemplateObject.md b/docs/TemplateObject.md index 0f7751e4..a3eb0b01 100644 --- a/docs/TemplateObject.md +++ b/docs/TemplateObject.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **id** | **Number** | The ID of a template | [optional] **title** | **String** | The title of a template | [optional] **description** | **String** | The description of a template | [optional] -**projectsBoardId** | **Number** | The ID of the project board this template is associated with | [optional] -**ownerId** | **Number** | The ID of a template owner | [optional] -**addTime** | **String** | The creation date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The update date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**projects_board_id** | **Number** | The ID of the project board this template is associated with | [optional] +**owner_id** | **Number** | The ID of a template owner | [optional] +**add_time** | **String** | The creation date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The update date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] diff --git a/docs/TemplateResponseObject.md b/docs/TemplateResponseObject.md index 206e88ca..15b535f4 100644 --- a/docs/TemplateResponseObject.md +++ b/docs/TemplateResponseObject.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **id** | **Number** | The ID of a template | [optional] **title** | **String** | The title of a template | [optional] **description** | **String** | The description of a template | [optional] -**projectsBoardId** | **Number** | The ID of the project board this template is associated with | [optional] -**ownerId** | **Number** | The ID of a template owner | [optional] -**addTime** | **String** | The creation date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**updateTime** | **String** | The update date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**projects_board_id** | **Number** | The ID of the project board this template is associated with | [optional] +**owner_id** | **Number** | The ID of a template owner | [optional] +**add_time** | **String** | The creation date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**update_time** | **String** | The update date and time of the template in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] diff --git a/docs/UpdateActivityResponse200.md b/docs/UpdateActivityResponse200.md index ed0a8de1..1a0e15d0 100644 --- a/docs/UpdateActivityResponse200.md +++ b/docs/UpdateActivityResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**ActivityResponseObject**](ActivityResponseObject.md) | | [optional] -**relatedObjects** | [**AddActivityResponse200RelatedObjects**](AddActivityResponse200RelatedObjects.md) | | [optional] +**related_objects** | [**AddActivityResponse200RelatedObjects**](AddActivityResponse200RelatedObjects.md) | | [optional] diff --git a/docs/UpdateDealParameters.md b/docs/UpdateDealParameters.md index 6aa1f9b0..be63a339 100644 --- a/docs/UpdateDealParameters.md +++ b/docs/UpdateDealParameters.md @@ -7,14 +7,14 @@ Name | Type | Description | Notes **value** | **String** | The value of the deal. | [optional] **label** | **[Number]** | Array of the deal labels IDs. | [optional] **currency** | **String** | The currency of the deal. Accepts a 3-character currency code. | [optional] -**userId** | **Number** | The ID of the user which will be the new owner of the deal. | [optional] -**personId** | **Number** | The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. | [optional] -**orgId** | **Number** | The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. | [optional] -**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] -**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] +**user_id** | **Number** | The ID of the user which will be the new owner of the deal. | [optional] +**person_id** | **Number** | The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. | [optional] +**org_id** | **Number** | The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. | [optional] +**pipeline_id** | **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] +**stage_id** | **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] **status** | **String** | open = Open, won = Won, lost = Lost, deleted = Deleted. | [optional] **channel** | **Number** | The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company which you can fetch with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] diff --git a/docs/UpdateDealProduct.md b/docs/UpdateDealProduct.md index 0e9fd378..6209e162 100644 --- a/docs/UpdateDealProduct.md +++ b/docs/UpdateDealProduct.md @@ -4,21 +4,21 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productId** | **Number** | The ID of the product to use | [optional] -**itemPrice** | **Number** | The price at which this product will be added to the deal | [optional] +**product_id** | **Number** | The ID of the product to use | [optional] +**item_price** | **Number** | The price at which this product will be added to the deal | [optional] **quantity** | **Number** | How many items of this product will be added to the deal | [optional] **discount** | **Number** | The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage | [optional] [default to 0] -**discountType** | **String** | The type of the discount's value | [optional] [default to 'percentage'] +**discount_type** | **String** | The type of the discount's value | [optional] [default to 'percentage'] **duration** | **Number** | The duration of the product | [optional] [default to 1] -**durationUnit** | [**DealProductUnitDuration**](DealProductUnitDuration.md) | The unit duration of the product | [optional] -**productVariationId** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] +**duration_unit** | [**DealProductUnitDuration**](DealProductUnitDuration.md) | The unit duration of the product | [optional] +**product_variation_id** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] **comments** | **String** | A textual comment associated with this product-deal attachment | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] -**taxMethod** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount | [optional] -**enabledFlag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] -**billingFrequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] -**billingFrequencyCycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] -**billingStartDate** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] +**tax_method** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount | [optional] +**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true] +**billing_frequency** | [**BillingFrequency**](BillingFrequency.md) | | [optional] +**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] +**billing_start_date** | **String** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional] diff --git a/docs/UpdateDealRequest.md b/docs/UpdateDealRequest.md index bd4ae925..c8a7843a 100644 --- a/docs/UpdateDealRequest.md +++ b/docs/UpdateDealRequest.md @@ -8,21 +8,21 @@ Name | Type | Description | Notes **value** | **String** | The value of the deal. | [optional] **label** | **[Number]** | Array of the deal labels IDs. | [optional] **currency** | **String** | The currency of the deal. Accepts a 3-character currency code. | [optional] -**userId** | **Number** | The ID of the user which will be the new owner of the deal. | [optional] -**personId** | **Number** | The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. | [optional] -**orgId** | **Number** | The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. | [optional] -**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] -**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] +**user_id** | **Number** | The ID of the user which will be the new owner of the deal. | [optional] +**person_id** | **Number** | The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. | [optional] +**org_id** | **Number** | The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. | [optional] +**pipeline_id** | **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] +**stage_id** | **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] **status** | **String** | open = Open, won = Won, lost = Lost, deleted = Deleted. | [optional] **channel** | **Number** | The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company which you can fetch with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] -**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] -**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] -**closeTime** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] -**expectedCloseDate** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**won_time** | **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] +**lost_time** | **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] +**close_time** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] +**expected_close_date** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional] **probability** | **Number** | The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled. | [optional] -**lostReason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the deal. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**lost_reason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the deal. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] diff --git a/docs/UpdateLeadRequest.md b/docs/UpdateLeadRequest.md index de21dbcd..e55de2cc 100644 --- a/docs/UpdateLeadRequest.md +++ b/docs/UpdateLeadRequest.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **title** | **String** | The name of the lead | [optional] -**ownerId** | **Number** | The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used. | [optional] -**labelIds** | **[String]** | The IDs of the lead labels which will be associated with the lead | [optional] -**personId** | **Number** | The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both. | [optional] -**organizationId** | **Number** | The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both. | [optional] -**isArchived** | **Boolean** | A flag indicating whether the lead is archived or not | [optional] +**owner_id** | **Number** | The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used. | [optional] +**label_ids** | **[String]** | The IDs of the lead labels which will be associated with the lead | [optional] +**person_id** | **Number** | The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both. | [optional] +**organization_id** | **Number** | The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both. | [optional] +**is_archived** | **Boolean** | A flag indicating whether the lead is archived or not | [optional] **value** | [**LeadValue**](LeadValue.md) | | [optional] -**expectedCloseDate** | **Date** | The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD. | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] -**wasSeen** | **Boolean** | A flag indicating whether the lead was seen by someone in the Pipedrive UI | [optional] +**expected_close_date** | **Date** | The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD. | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**was_seen** | **Boolean** | A flag indicating whether the lead was seen by someone in the Pipedrive UI | [optional] **channel** | **Number** | The ID of Marketing channel this lead was created from. Provided value must be one of the channels configured for your company which you can fetch with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. | [optional] -**channelId** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] +**channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] diff --git a/docs/UpdateOrganization.md b/docs/UpdateOrganization.md index 9f553da8..0f736b24 100644 --- a/docs/UpdateOrganization.md +++ b/docs/UpdateOrganization.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the organization | [optional] -**ownerId** | **Number** | The ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used. | [optional] +**owner_id** | **Number** | The ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used. | [optional] **label** | **Number** | The ID of the label. | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the organization. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the organization. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] diff --git a/docs/UpdatePerson.md b/docs/UpdatePerson.md index c3e5cb88..7b5c55e4 100644 --- a/docs/UpdatePerson.md +++ b/docs/UpdatePerson.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the person | [optional] -**ownerId** | **Number** | The ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used. | [optional] -**orgId** | **Number** | The ID of the organization this person will belong to | [optional] +**owner_id** | **Number** | The ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used. | [optional] +**org_id** | **Number** | The ID of the organization this person will belong to | [optional] **email** | [**[BasicPersonEmail]**](BasicPersonEmail.md) | An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ \"value\": \"mail@example.com\", \"primary\": \"true\", \"label\": \"main\" }]`. Please note that only `value` is required. | [optional] **phone** | [**[BasePersonItemPhone]**](BasePersonItemPhone.md) | A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ \"value\": \"12345\", \"primary\": \"true\", \"label\": \"mobile\" }]`. Please note that only `value` is required. | [optional] **label** | **Number** | The ID of the label. | [optional] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the person. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] -**marketingStatus** | [**MarketingStatus**](MarketingStatus.md) | If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table> | [optional] -**addTime** | **String** | The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the person. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**marketing_status** | [**MarketingStatus**](MarketingStatus.md) | If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table> | [optional] +**add_time** | **String** | The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] diff --git a/docs/UpdatePersonResponse.md b/docs/UpdatePersonResponse.md index 4501cc90..d6e8134f 100644 --- a/docs/UpdatePersonResponse.md +++ b/docs/UpdatePersonResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**PersonItem**](PersonItem.md) | | [optional] -**relatedObjects** | [**ListProductsResponseAllOfRelatedObjects**](ListProductsResponseAllOfRelatedObjects.md) | | [optional] +**related_objects** | [**ListProductsResponseAllOfRelatedObjects**](ListProductsResponseAllOfRelatedObjects.md) | | [optional] diff --git a/docs/UpdateProductRequestBody.md b/docs/UpdateProductRequestBody.md index 51724f07..b099100d 100644 --- a/docs/UpdateProductRequestBody.md +++ b/docs/UpdateProductRequestBody.md @@ -8,12 +8,12 @@ Name | Type | Description | Notes **code** | **String** | The product code | [optional] **unit** | **String** | The unit in which this product is sold | [optional] **tax** | **Number** | The tax percentage | [optional] [default to 0] -**activeFlag** | **Boolean** | Whether this product will be made active or not | [optional] [default to true] +**active_flag** | **Boolean** | Whether this product will be made active or not | [optional] [default to true] **selectable** | **Boolean** | Whether this product can be selected in deals or not | [optional] [default to true] -**visibleTo** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] -**ownerId** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional] +**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] +**owner_id** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional] **prices** | **[Object]** | An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional] -**billingFrequency** | [**BillingFrequency1**](BillingFrequency1.md) | | [optional] -**billingFrequencyCycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] +**billing_frequency** | [**BillingFrequency1**](BillingFrequency1.md) | | [optional] +**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] diff --git a/docs/UpdateProductResponse.md b/docs/UpdateProductResponse.md index b83a528f..39720531 100644 --- a/docs/UpdateProductResponse.md +++ b/docs/UpdateProductResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | If the response is successful or not | [optional] **data** | [**ProductWithArrayPrices**](ProductWithArrayPrices.md) | | [optional] -**relatedObjects** | [**GetActivitiesResponse200RelatedObjects**](GetActivitiesResponse200RelatedObjects.md) | | [optional] +**related_objects** | [**GetActivitiesResponse200RelatedObjects**](GetActivitiesResponse200RelatedObjects.md) | | [optional] diff --git a/docs/UpdateProjectResponse200.md b/docs/UpdateProjectResponse200.md index 2c2e2b7a..276b872e 100644 --- a/docs/UpdateProjectResponse200.md +++ b/docs/UpdateProjectResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**ProjectResponseObject**](ProjectResponseObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/UpdateStageRequest.md b/docs/UpdateStageRequest.md index 3854ab74..d97584f9 100644 --- a/docs/UpdateStageRequest.md +++ b/docs/UpdateStageRequest.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The name of the stage | [optional] -**pipelineId** | **Number** | The ID of the pipeline to add stage to | [optional] -**dealProbability** | **Number** | The success probability percentage of the deal. Used/shown when deal weighted values are used. | [optional] -**rottenFlag** | **Boolean** | Whether deals in this stage can become rotten | [optional] -**rottenDays** | **Number** | The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. | [optional] -**orderNr** | **Number** | An order number for this stage. Order numbers should be used to order the stages in the pipeline. | [optional] +**pipeline_id** | **Number** | The ID of the pipeline to add stage to | [optional] +**deal_probability** | **Number** | The success probability percentage of the deal. Used/shown when deal weighted values are used. | [optional] +**rotten_flag** | **Boolean** | Whether deals in this stage can become rotten | [optional] +**rotten_days** | **Number** | The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. | [optional] +**order_nr** | **Number** | An order number for this stage. Order numbers should be used to order the stages in the pipeline. | [optional] diff --git a/docs/UpdateStageRequestAllOf.md b/docs/UpdateStageRequestAllOf.md index 0484d750..add02f0f 100644 --- a/docs/UpdateStageRequestAllOf.md +++ b/docs/UpdateStageRequestAllOf.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderNr** | **Number** | An order number for this stage. Order numbers should be used to order the stages in the pipeline. | [optional] +**order_nr** | **Number** | An order number for this stage. Order numbers should be used to order the stages in the pipeline. | [optional] diff --git a/docs/UpdateTaskResponse200.md b/docs/UpdateTaskResponse200.md index 09ca6800..5808bb11 100644 --- a/docs/UpdateTaskResponse200.md +++ b/docs/UpdateTaskResponse200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**TaskResponseObject**](TaskResponseObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/UpdateTeam.md b/docs/UpdateTeam.md index a71e1a08..dda8a0a0 100644 --- a/docs/UpdateTeam.md +++ b/docs/UpdateTeam.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The team name | [optional] **description** | **String** | The team description | [optional] -**managerId** | **Number** | The team manager ID | [optional] +**manager_id** | **Number** | The team manager ID | [optional] **users** | **[Number]** | The list of user IDs | [optional] -**activeFlag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is active | [optional] -**deletedFlag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is deleted | [optional] +**active_flag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is active | [optional] +**deleted_flag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is deleted | [optional] diff --git a/docs/UpdateTeamAllOf.md b/docs/UpdateTeamAllOf.md index 93d3ee29..e395079e 100644 --- a/docs/UpdateTeamAllOf.md +++ b/docs/UpdateTeamAllOf.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**activeFlag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is active | [optional] -**deletedFlag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is deleted | [optional] +**active_flag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is active | [optional] +**deleted_flag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is deleted | [optional] diff --git a/docs/UpdateTeamWithAdditionalProperties.md b/docs/UpdateTeamWithAdditionalProperties.md index 084047be..24e36367 100644 --- a/docs/UpdateTeamWithAdditionalProperties.md +++ b/docs/UpdateTeamWithAdditionalProperties.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The team name | [optional] **description** | **String** | The team description | [optional] -**managerId** | **Number** | The team manager ID | [optional] +**manager_id** | **Number** | The team manager ID | [optional] **users** | **[Number]** | The list of user IDs | [optional] -**activeFlag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is active | [optional] -**deletedFlag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is deleted | [optional] -**addTime** | **String** | The team creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] -**createdByUserId** | **Number** | The ID of the user who created the team | [optional] +**active_flag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is active | [optional] +**deleted_flag** | [**NumberBoolean**](NumberBoolean.md) | Flag that indicates whether the team is deleted | [optional] +**add_time** | **String** | The team creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] +**created_by_user_id** | **Number** | The ID of the user who created the team | [optional] diff --git a/docs/UpdateUserRequest.md b/docs/UpdateUserRequest.md index 594dd981..767a4d65 100644 --- a/docs/UpdateUserRequest.md +++ b/docs/UpdateUserRequest.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**activeFlag** | **Boolean** | Whether the user is active or not. `false` = Not activated, `true` = Activated | +**active_flag** | **Boolean** | Whether the user is active or not. `false` = Not activated, `true` = Activated | diff --git a/docs/UpdatedActivityPlanItem200.md b/docs/UpdatedActivityPlanItem200.md index 3144b418..99b2b70b 100644 --- a/docs/UpdatedActivityPlanItem200.md +++ b/docs/UpdatedActivityPlanItem200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**ProjectPlanItemObject**](ProjectPlanItemObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/UpdatedTaskPlanItem200.md b/docs/UpdatedTaskPlanItem200.md index e0c65cae..4d8ef2e3 100644 --- a/docs/UpdatedTaskPlanItem200.md +++ b/docs/UpdatedTaskPlanItem200.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **Boolean** | | [optional] **data** | [**ProjectPlanItemObject**](ProjectPlanItemObject.md) | | [optional] -**additionalData** | **Object** | | [optional] +**additional_data** | **Object** | | [optional] diff --git a/docs/UserAccess.md b/docs/UserAccess.md index 724f3523..3f480798 100644 --- a/docs/UserAccess.md +++ b/docs/UserAccess.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **app** | **String** | | [optional] **admin** | **Boolean** | | [optional] -**permissionSetId** | **String** | | [optional] +**permission_set_id** | **String** | | [optional] diff --git a/docs/UserAssignmentToPermissionSet.md b/docs/UserAssignmentToPermissionSet.md index a9ec98d1..a229266f 100644 --- a/docs/UserAssignmentToPermissionSet.md +++ b/docs/UserAssignmentToPermissionSet.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Number** | The ID of the user in the permission set | [optional] -**permissionSetId** | **String** | The ID of the permission set | [optional] +**user_id** | **Number** | The ID of the user in the permission set | [optional] +**permission_set_id** | **String** | The ID of the permission set | [optional] **name** | **String** | The name of the permission set | [optional] diff --git a/docs/UserData.md b/docs/UserData.md index baf2a6fe..41bd5591 100644 --- a/docs/UserData.md +++ b/docs/UserData.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **Number** | The ID of the user | [optional] **name** | **String** | The name of the user | [optional] **email** | **String** | The email of the user | [optional] -**hasPic** | **Number** | Whether the user has picture or not. 0 = No picture, 1 = Has picture. | [optional] -**picHash** | **String** | The user picture hash | [optional] -**activeFlag** | **Boolean** | Whether the user is active or not | [optional] +**has_pic** | **Number** | Whether the user has picture or not. 0 = No picture, 1 = Has picture. | [optional] +**pic_hash** | **String** | The user picture hash | [optional] +**active_flag** | **Boolean** | Whether the user is active or not | [optional] diff --git a/docs/UserDataWithId.md b/docs/UserDataWithId.md index 12989128..01c3ffb6 100644 --- a/docs/UserDataWithId.md +++ b/docs/UserDataWithId.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **Number** | The ID of the user | [optional] **name** | **String** | The name of the user | [optional] **email** | **String** | The email of the user | [optional] -**hasPic** | **Number** | Whether the user has picture or not. 0 = No picture, 1 = Has picture. | [optional] -**picHash** | **String** | The user picture hash | [optional] -**activeFlag** | **Boolean** | Whether the user is active or not | [optional] +**has_pic** | **Number** | Whether the user has picture or not. 0 = No picture, 1 = Has picture. | [optional] +**pic_hash** | **String** | The user picture hash | [optional] +**active_flag** | **Boolean** | Whether the user is active or not | [optional] diff --git a/docs/UserPermissionsItem.md b/docs/UserPermissionsItem.md index 9de4867a..a2da20c8 100644 --- a/docs/UserPermissionsItem.md +++ b/docs/UserPermissionsItem.md @@ -4,36 +4,36 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**canAddCustomFields** | **Boolean** | If the user can add custom fields | [optional] -**canAddProducts** | **Boolean** | If the user can add products | [optional] -**canAddProspectsAsLeads** | **Boolean** | If the user can add prospects as leads | [optional] -**canBulkEditItems** | **Boolean** | If the user can bulk edit items | [optional] -**canChangeVisibilityOfItems** | **Boolean** | If the user can change visibility of items | [optional] -**canConvertDealsToLeads** | **Boolean** | If the user can convert deals to leads | [optional] -**canCreateOwnWorkflow** | **Boolean** | If the user can create workflows | [optional] -**canDeleteActivities** | **Boolean** | If the user can delete activities | [optional] -**canDeleteCustomFields** | **Boolean** | If the user can delete custom fields | [optional] -**canDeleteDeals** | **Boolean** | If the user can delete deals | [optional] -**canEditCustomFields** | **Boolean** | If the user can edit custom fields | [optional] -**canEditDealsClosedDate** | **Boolean** | If the user can edit deals' closed date | [optional] -**canEditProducts** | **Boolean** | If the user can edit products | [optional] -**canEditSharedFilters** | **Boolean** | If the user can edit shared filters | [optional] -**canExportDataFromLists** | **Boolean** | If the user can export data from item lists | [optional] -**canFollowOtherUsers** | **Boolean** | If the user can follow other users | [optional] -**canMergeDeals** | **Boolean** | If the user can merge deals | [optional] -**canMergeOrganizations** | **Boolean** | If the user can merge organizations | [optional] -**canMergePeople** | **Boolean** | If the user can merge people | [optional] -**canModifyLabels** | **Boolean** | If the user can modify labels | [optional] -**canSeeCompanyWideStatistics** | **Boolean** | If the user can see company-wide statistics | [optional] -**canSeeDealsListSummary** | **Boolean** | If the user can see the summary on the deals page | [optional] -**canSeeHiddenItemsNames** | **Boolean** | If the user can see the names of hidden items | [optional] -**canSeeOtherUsers** | **Boolean** | If the user can see other users | [optional] -**canSeeOtherUsersStatistics** | **Boolean** | If the user can see other users' statistics | [optional] -**canSeeSecurityDashboard** | **Boolean** | If the user can see security dashboard | [optional] -**canShareFilters** | **Boolean** | If the user can share filters | [optional] -**canShareInsights** | **Boolean** | If the user can share insights | [optional] -**canUseApi** | **Boolean** | If the user can use API | [optional] -**canUseEmailTracking** | **Boolean** | If the user can use email tracking | [optional] -**canUseImport** | **Boolean** | If the user can use import | [optional] +**can_add_custom_fields** | **Boolean** | If the user can add custom fields | [optional] +**can_add_products** | **Boolean** | If the user can add products | [optional] +**can_add_prospects_as_leads** | **Boolean** | If the user can add prospects as leads | [optional] +**can_bulk_edit_items** | **Boolean** | If the user can bulk edit items | [optional] +**can_change_visibility_of_items** | **Boolean** | If the user can change visibility of items | [optional] +**can_convert_deals_to_leads** | **Boolean** | If the user can convert deals to leads | [optional] +**can_create_own_workflow** | **Boolean** | If the user can create workflows | [optional] +**can_delete_activities** | **Boolean** | If the user can delete activities | [optional] +**can_delete_custom_fields** | **Boolean** | If the user can delete custom fields | [optional] +**can_delete_deals** | **Boolean** | If the user can delete deals | [optional] +**can_edit_custom_fields** | **Boolean** | If the user can edit custom fields | [optional] +**can_edit_deals_closed_date** | **Boolean** | If the user can edit deals' closed date | [optional] +**can_edit_products** | **Boolean** | If the user can edit products | [optional] +**can_edit_shared_filters** | **Boolean** | If the user can edit shared filters | [optional] +**can_export_data_from_lists** | **Boolean** | If the user can export data from item lists | [optional] +**can_follow_other_users** | **Boolean** | If the user can follow other users | [optional] +**can_merge_deals** | **Boolean** | If the user can merge deals | [optional] +**can_merge_organizations** | **Boolean** | If the user can merge organizations | [optional] +**can_merge_people** | **Boolean** | If the user can merge people | [optional] +**can_modify_labels** | **Boolean** | If the user can modify labels | [optional] +**can_see_company_wide_statistics** | **Boolean** | If the user can see company-wide statistics | [optional] +**can_see_deals_list_summary** | **Boolean** | If the user can see the summary on the deals page | [optional] +**can_see_hidden_items_names** | **Boolean** | If the user can see the names of hidden items | [optional] +**can_see_other_users** | **Boolean** | If the user can see other users | [optional] +**can_see_other_users_statistics** | **Boolean** | If the user can see other users' statistics | [optional] +**can_see_security_dashboard** | **Boolean** | If the user can see security dashboard | [optional] +**can_share_filters** | **Boolean** | If the user can share filters | [optional] +**can_share_insights** | **Boolean** | If the user can share insights | [optional] +**can_use_api** | **Boolean** | If the user can use API | [optional] +**can_use_email_tracking** | **Boolean** | If the user can use email tracking | [optional] +**can_use_import** | **Boolean** | If the user can use import | [optional] diff --git a/docs/UserProviderLinkCreateRequest.md b/docs/UserProviderLinkCreateRequest.md index 187086ba..86eb1267 100644 --- a/docs/UserProviderLinkCreateRequest.md +++ b/docs/UserProviderLinkCreateRequest.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userProviderId** | **String** | Unique identifier linking a user to the installed integration. Generated by the integration. | -**userId** | **Number** | Pipedrive user ID | -**companyId** | **Number** | Pipedrive company ID | -**marketplaceClientId** | **String** | Pipedrive Marketplace client ID of the installed integration | +**user_provider_id** | **String** | Unique identifier linking a user to the installed integration. Generated by the integration. | +**user_id** | **Number** | Pipedrive user ID | +**company_id** | **Number** | Pipedrive company ID | +**marketplace_client_id** | **String** | Pipedrive Marketplace client ID of the installed integration | diff --git a/docs/UserSettingsItem.md b/docs/UserSettingsItem.md index 40d44d43..1105b4fe 100644 --- a/docs/UserSettingsItem.md +++ b/docs/UserSettingsItem.md @@ -4,15 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**marketplaceAllowCustomInstallUrl** | **Boolean** | If the vendors are allowed to install custom Marketplace apps with functionality and content in the Pipedrive UI or not | [optional] -**marketplaceAppExtensionsVendor** | **Boolean** | If the vendors are allowed to extend their Marketplace apps with functionality and content in the Pipedrive UI or not | [optional] -**marketplaceTeam** | **Boolean** | If the vendors are allowed to be part of the Marketplace team or not | [optional] -**listLimit** | **Number** | The number of results shown in list by default | [optional] -**betaApp** | **Boolean** | Whether beta app is enabled | [optional] -**preventSalesphoneCalltoOverride** | **Boolean** | Prevent salesphone call to override | [optional] -**fileUploadDestination** | **String** | The destination of file upload | [optional] -**calltoLinkSyntax** | **String** | The call to link syntax | [optional] -**autofillDealExpectedCloseDate** | **Boolean** | Whether the expected close date of the deal is filled automatically or not | [optional] -**personDuplicateCondition** | **String** | Allow the vendors to duplicate a person | [optional] +**marketplace_allow_custom_install_url** | **Boolean** | If the vendors are allowed to install custom Marketplace apps with functionality and content in the Pipedrive UI or not | [optional] +**marketplace_app_extensions_vendor** | **Boolean** | If the vendors are allowed to extend their Marketplace apps with functionality and content in the Pipedrive UI or not | [optional] +**marketplace_team** | **Boolean** | If the vendors are allowed to be part of the Marketplace team or not | [optional] +**list_limit** | **Number** | The number of results shown in list by default | [optional] +**beta_app** | **Boolean** | Whether beta app is enabled | [optional] +**prevent_salesphone_callto_override** | **Boolean** | Prevent salesphone call to override | [optional] +**file_upload_destination** | **String** | The destination of file upload | [optional] +**callto_link_syntax** | **String** | The call to link syntax | [optional] +**autofill_deal_expected_close_date** | **Boolean** | Whether the expected close date of the deal is filled automatically or not | [optional] +**person_duplicate_condition** | **String** | Allow the vendors to duplicate a person | [optional] diff --git a/docs/UsersApi.md b/docs/UsersApi.md index 4d0167b1..3d773291 100644 --- a/docs/UsersApi.md +++ b/docs/UsersApi.md @@ -56,7 +56,7 @@ apiInstance.addUser(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **addUserRequest** | [**AddUserRequest**](AddUserRequest.md)| | [optional] + **AddUserRequest** | [**AddUserRequest**](AddUserRequest.md)| | [optional] ### Return type @@ -96,6 +96,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.UsersApi(apiClient); let term = "term_example"; // String | The search term to look for +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'searchByEmail': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | When enabled, the term will only be matched against email addresses of users. Default: `false`. }; @@ -113,7 +114,7 @@ apiInstance.findUsersByName(term, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **term** | **String**| The search term to look for | - **searchByEmail** | [**NumberBooleanDefault0**](.md)| When enabled, the term will only be matched against email addresses of users. Default: `false`. | [optional] + **search_by_email** | [**NumberBooleanDefault0**](.md)| When enabled, the term will only be matched against email addresses of users. Default: `false`. | [optional] ### Return type @@ -361,6 +362,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Pipedrive.UsersApi(apiClient); let id = 56; // Number | The ID of the user +// snake_case as well as camelCase is supported for naming opts properties let opts = { 'start': 0, // Number | Pagination start 'limit': 56 // Number | Items shown per page @@ -539,7 +541,7 @@ apiInstance.updateUser(id, opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| The ID of the user | - **updateUserRequest** | [**UpdateUserRequest**](UpdateUserRequest.md)| | [optional] + **UpdateUserRequest** | [**UpdateUserRequest**](UpdateUserRequest.md)| | [optional] ### Return type diff --git a/docs/WebhooksApi.md b/docs/WebhooksApi.md index 89148d06..e0c90d56 100644 --- a/docs/WebhooksApi.md +++ b/docs/WebhooksApi.md @@ -49,7 +49,7 @@ apiInstance.addWebhook(opts).then((data) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **addWebhookRequest** | [**AddWebhookRequest**](AddWebhookRequest.md)| | [optional] + **AddWebhookRequest** | [**AddWebhookRequest**](AddWebhookRequest.md)| | [optional] ### Return type