hellosign / hellosign-ruby-sdk

A Ruby SDK for HelloSign's API
MIT License
52 stars 61 forks source link

Add 'role' to mandatory field in signature_request (for each entry in the 'signers' array) #5

Closed AlexeyMK closed 10 years ago

AlexeyMK commented 10 years ago

In my experience, 'role' is mandatory, and you use it in your examples (https://www.hellosign.com/api/embeddedSigningExample), but it's not included in the comments above the function description.

Also, it would be nice to have a better sense of which of those fields are optional and which are not (for example, client_id is optional but the comment doesn't document it, only the code).

AlexeyMK commented 10 years ago

Also, it would be great if role was included in the response to creating a signature request, in each of the signatures. Not a huge deal, but the easiest way to correlate them for me.

https://www.hellosign.com/api/embeddedSigningExample

asolberg commented 10 years ago

The signers[role] parameter is only relevant for using templates. You said role is not included in the comment blocks but it actually is if you look under create_embedded_signature_request_with_template and send_signature_request_with_template you'll see the 'role' parameter listed there. Regarding the idea of returning role in the response and documenting which parameters are mandatory vs. optional, that's good feedback, we'll consider adding that in the future.

AlexeyMK commented 10 years ago

Good point re: role - that clarifies a lot, thank you!