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

The documentation of this gem is troubling #31

Open
Nowaker opened this issue Jan 12, 2016 · 2 comments
Open

The documentation of this gem is troubling #31

Nowaker opened this issue Jan 12, 2016 · 2 comments
Assignees

Comments

@Nowaker
Copy link

Nowaker commented Jan 12, 2016

Pretty simple code: @base.deals.create name: lead.email, contact_id: contact.id, stage_id: stage_id, tags_joined_by_comma: 'vk-onboarding'

There's absolutely no documentation on how to add tags to deal, leads and contacts. I found tags_joined_by_comma in one of the tickets. I found tag_list in a different one. None of this works.

The documentation of this gem is troubling. Also, I can pass any garbage (e.g. tag_list which doesn't look to be supported) and that field is silently ignored. The API should throw an exception when an unmatched parameter is found (if you use Rails on the backend, it'd be config.action_controller.action_on_unpermitted_parameters = :raise).

@iaintshine
Copy link
Contributor

Hi @Nowaker,

what version of the official client library do you use ? Once you have a client instantiated it's as simple as calling:

client.deals.create(contact_id: test_contact.id,
                    name: "test deal",
                    value: 100,
                    currency: "USD",
                    tags: ["test_1", "test_2"])

@Nowaker Nowaker changed the title Can't create a deal with tag The documentation of this gem is troubling Feb 26, 2016
@Nowaker
Copy link
Author

Nowaker commented Feb 26, 2016

I've changed a title of this issue to drag your focus to the real problem. Stripe API gem is a perfection, this one is just the opposite.

@iaintshine iaintshine added this to the version 1.2 milestone Feb 26, 2016
@iaintshine iaintshine self-assigned this Feb 26, 2016
@efedasz efedasz removed this from the version 1.2 milestone Oct 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants