Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GRAL-4098 fix parameters naming in the docs: camelCase to snake_case #530

Closed
wants to merge 1 commit into from
Closed

GRAL-4098 fix parameters naming in the docs: camelCase to snake_case #530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 9 additions & 7 deletions docs/ActivitiesApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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]

Expand Down Expand Up @@ -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

Expand Down
60 changes: 30 additions & 30 deletions docs/ActivityCollectionResponseObject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]


Loading
Loading