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.

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

Issue With Documentation of ActivityResponseObject #501

Closed
vinayakBharadwaj1 opened this issue Nov 24, 2023 · 2 comments
Closed

Issue With Documentation of ActivityResponseObject #501

vinayakBharadwaj1 opened this issue Nov 24, 2023 · 2 comments

Comments

@vinayakBharadwaj1
Copy link

The documentation for the Pipedrive Node.js client library indicates that the response fields in the ActivityResponseObject are in camelCase, but the actual response uses snake_case for all fields.

Affected Module/Client Library:
Node.js client library for Pipedrive

Affected Endpoint:
Endpoint: /v1/activities

Fields in Question:
All fields in the ActivityResponseObject

Actual Response:
All fields in the actual response are in snake_case.

Expected Behavior:
The documentation for the Node.js client library should accurately represent the case of the response fields to avoid confusion for developers integrating with the API.

Additional Information:

Client Library Documentation Link: [https://github.com/pipedrive/client-nodejs/blob/master/docs/ActivitiesApi.md#getActivities]
Response Documentation Link: [https://github.com/pipedrive/client-nodejs/blob/master/docs/ActivityResponseObject.md]

@florolf1
Copy link

florolf1 commented Apr 3, 2024

This is also the case with every RequestObject. Typescript doesn't really work either. I see no advantage in using the NodeJS client. Version 22.5 is now available and it still doesn't work. Even in the app examples the node client is not used except for authentication.

@siirimangus
Copy link
Contributor

Hey, @vinayakBharadwaj1, the documentation issue is now fixed in v22.9.0. Thank you for noticing and reporting!

@florolf1 , could you please open a separate issue for the "Typescript doesn't really work either." and elaborate more about the problem you are facing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants