Skip to content

The documentation of this gem is troubling #31

Open

Description

@Nowaker

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).

Activity

  1. bmista commented on Feb 25, 2016

    @bmista
    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"])
  2. changed the title [-]Can't create a deal with tag[/-] [+]The documentation of this gem is troubling[/+] on Feb 26, 2016
  3. Nowaker commented on Feb 26, 2016

    @Nowaker
    Author

    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.

  4. added this to the milestone on Feb 26, 2016
  5. self-assigned this
    on Feb 26, 2016
  6. removed this from the milestone on Oct 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions