lib/hello_sign/api/signature_request.rb in hellosign-ruby-sdk-3.2.8 vs lib/hello_sign/api/signature_request.rb in hellosign-ruby-sdk-3.2.9
- old
+ new
@@ -135,11 +135,12 @@
# * :name (String) Sender' name
# * :email_address (String) Sender's email address
# * :order (Integer) The order the signer is required to sign in
# * :pin (Integer) The 4- to 12-character access code that will secure this signer's signature page. You must have a business plan to use this feature.
# @option opts [Array<Hash>] ccs The email addresses CC destinations. Required when a CC role exists for the Template.
- # @option opts [Array<Hash>] custom_fields The value to fill in for the custom field with the name of CustomFieldName. Required when a CustomField exists in the Template.
+ # @option opts [Hash] custom_fields (deprecated) The value to fill in for the custom field with the name of CustomFieldName.
+ # @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present in the template. Only specify this when NOT specifying custom_fields by hash (the old way).
# @option opts [Integer] ux_version sets the version of the signer page to use
#
# @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
# @example
# signature_request = @client.send_signature_request_with_template(
@@ -320,10 +321,11 @@
# * :name (String) Sender' name
# * :email_address (String) Sender's email address
# * :order (Integer) The order the signer is required to sign in
# * :pin (Integer) The 4- to 12-character access code that will secure this signer's signature page. You must have a business plan to use this feature.
# @option opts [Hash] ccs The email address of the CC filling the role of RoleName. Required when a CC role exists for the Template.
- # @option opts [Hash] custom_fields The value to fill in for custom field with the name of CustomFieldName. Required when a CustomField exists in the Template.
+ # @option opts [Hash] custom_fields (deprecated) The value to fill in for custom field with the name of CustomFieldName.
+ # @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present in the template. Only specify this when NOT specifying custom_fields by hash (the old way)
# @option opts [Integer] ux_version sets the version of the signer page to use
#
# @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
# @example
# request = @client.create_embedded_signature_request_with_template(