hellosign-ruby-sdk 3.2.3 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a15c6fd53e6356e765dc9e98c18f4734be46a4f6
-  data.tar.gz: 7545ff742d56f048ccf740af257676083dae32a4
+  metadata.gz: e380990f36888628927e0232c6c0b7e9f2a13bba
+  data.tar.gz: e636e1d7a0a7f39f074b490a0d9f04aa1e662947
 SHA512:
-  metadata.gz: 93239a02a409fd5f6fb50eeedfc35756768a1d0a2b00885448643d322832948e2db1538def4f099f22f56cff3291cce3b808b8aba150ceab1b5eb5f6f05fe285
-  data.tar.gz: 535ebc040e4d27cd15eac41d6e4b2d48ce20681be3f179c18f2e4da1a8e0037bdac31e83fab19457af4a3eddbc984c9c05ae037ebd1343d4684ca39257f00157
+  metadata.gz: 61b7d9b4974815af4906cfee7679ca9e85f10808e79db665c7261047483fe6576b99f7824ba4059408d8cc44ca7010a636052decee4262258e3a1c38626dd382
+  data.tar.gz: 795d36640edab7dc61d2ba9d570b291a5958a01bbab1dac4d20c66135d855cf2e127ec4672b8f667bf649dd36449afa14ef594e9cdf47f1fd60439d7014a4893

data/lib/hello_sign/api/signature_request.rb

@@ -37,6 +37,7 @@ module HelloSign
       #
       # Retrieves a Signature Request with the given ID.
       # @option opts [String] signature_request_id The id of the SignatureRequest to retrieve.
+      # @option opts [Integer] ux_version sets the version of the signer page to use
       #
       # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest object
       #
@@ -44,12 +45,16 @@ module HelloSign
       #   signature_request = @client.get_signature_request :signature_request_id => 'fa5c8a0b0f492d768749333ad6fcc214c111e967'
       #
       def get_signature_request(opts)
-        HelloSign::Resource::SignatureRequest.new get("/signature_request/#{opts[:signature_request_id]}")
+          path = "/signature_request/#{opts[:signature_request_id]}"
+          query = create_query_string(opts, [:ux_version])
+          path += query
+        HelloSign::Resource::SignatureRequest.new get(path)
       end
 
       #
       # Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on.
       # @option opts [Integer] page (1) Which page number of the Template List to return.
+      # @option opts [Integer] ux_version sets the version of the signer page to use
       #
       # @return [HelloSign::Resource::ResourceArray]
       #
@@ -58,8 +63,8 @@ module HelloSign
       #
       def get_signature_requests(opts={})
         path = '/signature_request/list'
-        path += opts[:page] ? "?page=#{opts[:page]}" : ''
-        path += opts[:page_size] ? "&page_size=#{opts[:page_size]}" : ''
+        query = create_query_string(opts, [:page, :page_size, :ux_version])
+        path += query
         HelloSign::Resource::ResourceArray.new get(path, opts), 'signature_requests',  HelloSign::Resource::SignatureRequest
       end
 
@@ -131,6 +136,7 @@ module HelloSign
       #   * :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 [Integer] ux_version sets the version of the signer page to use
       #
       # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
       # @example
@@ -202,6 +208,7 @@ module HelloSign
       # Sends an email to the signer reminding them to sign the signature request.
       # @option opts [String] signature_request_id The id of the SignatureRequest to send a reminder for.
       # @option opts [String] email_address The email address of the signer to send a reminder to.
+      # @option opts [Integer] ux_version sets the version of the signer page to use
       #
       # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
       # @example
@@ -258,6 +265,7 @@ module HelloSign
       #   * :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<String>] cc_email_addresses The email addresses that should be CCed.
       # @option opts [String] form_fields_per_document
+      # @option opts [Integer] ux_version sets the version of the signer page to use
       #
       # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
       # @example
@@ -312,6 +320,8 @@ module HelloSign
       #   * :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 [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(

data/lib/hello_sign/client.rb

@@ -248,6 +248,27 @@ module HelloSign
       end
     end
 
+    # Takes options given to an API endpoint as a hash, plus an array of parameters (as symbols), and creates a
+    # query string out of any listed parameters present (that also have values)
+
+    def create_query_string(opts, parameterList)
+        result = ""
+        is_first = true
+        parameterList.each do |param|
+            if (opts.has_key?(param) && opts[param])
+                if (!is_first)
+                    result += "&"
+                end
+                is_first = false
+                result += "#{param}=#{opts[param]}"
+            end
+        end
+        if (result.length > 0)
+            result = "?" + result
+        end
+        result
+    end
+
     def prepare_signers(opts)
       prepare opts, :signers
     end

data/lib/hello_sign/version.rb

@@ -23,5 +23,5 @@
 #
 
 module HelloSign
-  VERSION = '3.2.3'
+  VERSION = '3.2.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hellosign-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.2.4
 platform: ruby
 authors:
 - HelloSign
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler