hellosign-ruby-sdk 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27defe774dc5edc27189e7e7035ea4eba0ae8378
-  data.tar.gz: 7c3e32790e3d0c1b402aa4f7cb66d4d96ed8afcd
+  metadata.gz: a385289e3cf44bf369dd47ddfebc38cac0c92f85
+  data.tar.gz: cb4e117e1514387c2ae5d9b90c70303a2d56441f
 SHA512:
-  metadata.gz: fe008cbea3e86b187794b687d5d67875e6c7463a0ea9fb0e1c427d23db3ed831c5b962f1d40815841ff24e3c079649654b420033b4aa292a3d17942ac0bdb3ef
-  data.tar.gz: 337c05db297b5955dfa85162e4eabd6f18b639cc42f9665bd8e2de957ac2c94e5ce99111aff767123e538b2d8354154936755c9d252f4112b765d103cfaa3143
+  metadata.gz: c9b21616f1202c91af28b220f4155ccb1b53edab87a1eb2f8aebf530b78d7230d76d0c9e85f5deb2091507fb47e11e28891feb963e1e04f0a98f7e610e3f20ca
+  data.tar.gz: 92d814dc38788bf034ebc28b84afe10bde5aed0ffd926a803deba54da8552461f2b3e8155b679d1342197c384746207d567c7c2f006ad9d3ae25a0d3ed886230

data/CONTRIBUTING.md

@@ -38,5 +38,5 @@ always necessary to create a new issue ticket.
 
 * [General GitHub documentation](http://help.github.com/)
 * [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
-* [HelloSign API documentation](https://www.hellosign.com/api/documentation)
+* [HelloSign API documentation](https://app.hellosign.com/api/documentation)
 * [HelloSign API HipChat room](https://www.hipchat.com/gq4BMFKt1)

data/README.md

@@ -1,7 +1,7 @@
 # HelloSign Ruby SDK
 
 In addition to this readme, checkout our quickstart guide here:
-https://www.hellosign.com/api/gettingStarted#QuickStart
+https://app.hellosign.com/api/documentation#QuickStart
 
 ## Installation
 
@@ -15,8 +15,8 @@ And then execute:
 
 ## Configuration
 
-Create a config block. At a minimum you'll want to set your [API Key](https://www.hellosign.com/home/myAccount/current_tab/integrations#api) but depending on your usage you'll possibly
-want to set your app's [Client ID](https://www.hellosign.com/oauth/createAppForm) and [Client Secret](https://www.hellosign.com/oauth/createAppForm). In Rails you can place it in `config/initializers/hello_sign.rb`
+Create a config block. At a minimum you'll want to set your [API Key](https://app.hellosign.com/home/myAccount/current_tab/integrations#api) but depending on your usage you'll possibly
+want to set your app's [Client ID](https://app.hellosign.com/oauth/createAppForm) and [Client Secret](https://app.hellosign.com/oauth/createAppForm). In Rails you can place it in `config/initializers/hello_sign.rb`
 
 ```ruby
 require 'hello_sign'

data/lib/hello_sign/api/account.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # Contains all the api calls for the Account resource.
-    # Take a look at our {https://www.hellosign.com/api/reference#Account account api document}
+    # Take a look at our {https://app.hellosign.com/api/reference#Account account api document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/api/api_app.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # Contains all the api calls for the ApiApp resource.
-    # Take a look at our {https://www.hellosign.com/api/reference#Team team api document}
+    # Take a look at our {https://app.hellosign.com/api/reference#Team team api document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/api/embedded.rb

@@ -1,8 +1,8 @@
 #
 # The MIT License (MIT)
-# 
+#
 # Copyright (C) 2014 hellosign.com
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
@@ -28,7 +28,7 @@ module HelloSign
     #
     # HelloSign allows you to embed the signing page on your site in an iFrame
     # without the need for the end-user to create a HelloSign account.
-    # Take a look at our {https://www.hellosign.com/api/embeddedSigningWalkthrough embedded signing walkthrough}
+    # Take a look at our {https://app.hellosign.com/api/embeddedSigningWalkthrough embedded signing walkthrough}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/api/signature_request.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # Contains all the api about the SignatureRequest resource.
-    # Take a look at our {https://www.hellosign.com/api/reference#SignatureRequest signature request api document}
+    # Take a look at our {https://app.hellosign.com/api/reference#SignatureRequest signature request api document}
     # for more information about this.
     #
     # @author [hellosign]
@@ -274,7 +274,7 @@ module HelloSign
       # If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
       # Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
       # @option opts [Integer] test_mode (0) Whether this is a test, the signature request will not be legally binding if set to 1.
-      # @option opts [String] client_id Client id of the app you're using to create this embedded signature request. Visit our  {https://www.hellosign.com/api/reference#Embedded embedded page} page to learn more about this parameter.
+      # @option opts [String] client_id Client id of the app you're using to create this embedded signature request. Visit our  {https://app.hellosign.com/api/reference#Embedded embedded page} page to learn more about this parameter.
       # @option opts [Array<String>] files Use files to indicate the uploaded file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
       # @option opts [Array<String>] file_urls Use file_urls to have HelloSign download the file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
       # @option opts [String] title The title you want to assign to the SignatureRequest.
@@ -329,7 +329,7 @@ module HelloSign
       # Creates a new SignatureRequest based on the given Template to be signed in an embedded iFrame.
       # Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
       # @option opts [Integer] test_mode (0) Whether this is a test, the signature request will not be legally binding if set to 1.
-      # @option opts [String] client_id Client id of the app you're using to create this embedded signature request. Visit our  {https://www.hellosign.com/api/reference#Embedded embedded page} page to learn more about this parameter.
+      # @option opts [String] client_id Client id of the app you're using to create this embedded signature request. Visit our  {https://app.hellosign.com/api/reference#Embedded embedded page} page to learn more about this parameter.
       # @option opts [String] template_id The id of the Template to use when creating the SignatureRequest.
       # @option opts [String] title The title you want to assign to the SignatureRequest.
       # @option opts [String] subject The subject in the email that will be sent to the signers.
@@ -388,6 +388,12 @@ module HelloSign
 
         HelloSign::Resource::SignatureRequest.new post('/signature_request/create_embedded_with_template', :body => opts)
       end
+
+      def update_signature_request(opts)
+        signature_request_id = opts.delete(:signature_request_id)
+        path = "/signature_request/update/#{signature_request_id}"
+        HelloSign::Resource::SignatureRequest.new post(path, :body => opts)
+      end
     end
   end
 end

data/lib/hello_sign/api/team.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # Contains all the api calls for the Team resource.
-    # Take a look at our {https://www.hellosign.com/api/reference#Team team api document}
+    # Take a look at our {https://app.hellosign.com/api/reference#Team team api document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/api/template.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # Contains all the api calls for the Template resource.
-    # Take a look at our {https://www.hellosign.com/api/templatesAndApiWalkthrough template form api document}
+    # Take a look at our {https://app.hellosign.com/api/embeddedTemplatesWalkthrough template form api document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/api/unclaimed_draft.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # Contains all the api calls for the UnclaimedDraft resource.
-    # Take a look at our {https://www.hellosign.com/api/reference#UnclaimedDraft unclaimed draft document}
+    # Take a look at our {https://app.hellosign.com/api/reference#UnclaimedDraft unclaimed draft document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/resource/account.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # Contains information about an account and its settings.
-    # Take a look at our {https://www.hellosign.com/api/reference#Account account resource document}
+    # Take a look at our {https://app.hellosign.com/api/reference#Account account resource document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/resource/api_app.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # Contains information about an team and its members.
-    # Take a look at our {https://www.hellosign.com/api/reference#ApiApp API Application resource document}
+    # Take a look at our {https://app.hellosign.com/api/reference#ApiApp API Application resource document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/resource/embedded.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # An object that contains necessary information to set up embedded signing.
-    # Take a look at our {https://www.hellosign.com/api/reference#Embedded account resource document}
+    # Take a look at our {https://app.hellosign.com/api/reference#Embedded account resource document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/resource/signature_request.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # Contains information regarding documents that need to be signed
-    # Take a look at our {https://www.hellosign.com/api/reference#SignatureRequest signature request resource document}
+    # Take a look at our {https://app.hellosign.com/api/reference#SignatureRequest signature request resource document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/resource/team.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # Contains information about an team and its members.
-    # Take a look at our {https://www.hellosign.com/api/reference#Team team resource document}
+    # Take a look at our {https://app.hellosign.com/api/reference#Team team resource document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/resource/template.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # Contains information about the templates you and your team have created
-    # Take a look at our {https://www.hellosign.com/api/reference#Template Template resource document}
+    # Take a look at our {https://app.hellosign.com/api/reference#Template Template resource document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/resource/template_draft.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # A group of documents that a user can take ownership of by going to the claim URL
-    # Take a look at our {https://www.hellosign.com/api/reference}
+    # Take a look at our {https://app.hellosign.com/api/reference}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/resource/unclaimed_draft.rb

@@ -27,7 +27,7 @@ module HelloSign
 
     #
     # A group of documents that a user can take ownership of by going to the claim URL
-    # Take a look at our {https://www.hellosign.com/api/reference#UnclaimedDraft unclaimed draft resource document}
+    # Take a look at our {https://app.hellosign.com/api/reference#UnclaimedDraft unclaimed draft resource document}
     # for more information about this.
     #
     # @author [hellosign]

data/lib/hello_sign/version.rb

@@ -23,5 +23,5 @@
 #
 
 module HelloSign
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'
 end

data/spec/hello_sign/api/signature_request_spec.rb

@@ -176,4 +176,23 @@ describe HelloSign::Api::SignatureRequest do
       expect(a_post('/signature_request/create_embedded_with_template')).to have_been_made
     end
   end
+
+  describe '#update_signature_request' do
+    before do
+      stub_post('/signature_request/update/1', 'signature_request')
+      @signature_request = HelloSign.update_signature_request(
+        :signature_request_id => '1',
+        :signature_id => 'signature_id',
+        :email_address => 'updated_signer_email_address@example.com'
+        )
+    end
+
+    it 'should get the correct resource' do
+      expect(a_post('/signature_request/update/1')).to have_been_made
+    end
+
+    it 'should return a Signature Request' do
+      expect(@signature_request).to be_a HelloSign::Resource::SignatureRequest
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -6,9 +6,9 @@
 
 #
 # The MIT License (MIT)
-# 
+#
 # Copyright (C) 2014 hellosign.com
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hellosign-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - HelloSign
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler