hellosign-api 1.0.6 → 1.0.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +11 -5
  3. data/lib/hello_sign/version.rb +1 -1
  4. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4666b6681f4d92b608c07eb22db61bdbd466fb797d83ddd2cd56319ba0607569
4
- data.tar.gz: bad67e806000fc4c2c7f33af059c4f92795bec1c1e00382001c9f008bc965a15
3
+ metadata.gz: 962547ff97880375f9e56a5fd00b3fb34bd20007929e6574f94ffba7e731ccf0
4
+ data.tar.gz: 915e99bd963ac37bfd12ed99f5ba85ced15610039dff9e852aadf4c1a1f5ce6f
5
5
  SHA512:
6
- metadata.gz: c04af622689d244d0a3290af96f2c68e1fe25c033a3567157706a4e66ea46f3d342cf856fd7235eb58bf574f48c8decb18cce69e509ee1bb74c5eafe771a2297
7
- data.tar.gz: 64726079c3b8832a85290dc87869cc41132969fb6668ae4a3738c7a64c0a3cdbf78d7eab660b66639beec164b77f594d1d09fe14cd850fb58d1cdbf9a76b78c2
6
+ metadata.gz: 88b69a7d887ea2398b4ab13cabef08d8a02a59ea7748abb8fee18e88ed600568d4ebac9f4647d8816c1a4dfd619d05b02dd126893461b01918452f30edce7271
7
+ data.tar.gz: c61a04e926e1b6cd464c3cc0f4c89be069393ea1e235302d15f19a3b542ec2d1f7735ff0a21ce1e348e792ff1dd707f75341d6796087368382006dcafebe6c12
data/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Add this line to your application's Gemfile:
6
6
 
7
- gem 'hellosign'
7
+ gem 'hellosign-api'
8
8
 
9
9
  And then execute:
10
10
 
@@ -27,6 +27,7 @@ end
27
27
  ```
28
28
 
29
29
  ## Usage
30
+
30
31
  When you have configured your app like above, you can start using it:
31
32
 
32
33
  ```ruby
@@ -41,13 +42,16 @@ signature_request = HelloSign.get_signature_request signature_request_id: '42383
41
42
  ```
42
43
 
43
44
  If you need to authenticate for multiple users and you want a separated client for them, you can run:
45
+
44
46
  ```ruby
45
47
  client2 = HelloSign::Client.new api_key: 'your_user_api_key'
46
48
  user_account = client2.get_account
47
49
  ```
50
+
48
51
  ### Specifying files
49
52
 
50
53
  When using request endpoints that send files, such as a signature request, you can specify files either as
54
+
51
55
  1. A string representing the path
52
56
  2. A Ruby File Object (File.open, then assign to a variable)
53
57
  3. A Rails ActionDispatch::Http::UploadedFile
@@ -60,16 +64,17 @@ from the root of your project run <code>rake spec</code>.
60
64
  ## Additional notes
61
65
 
62
66
  ## Warnings
67
+
63
68
  Any warnings returned from the API can be accessed by using the 'warnings' accessor on a returned object or list:
64
69
 
65
- ````ruby
70
+ ```ruby
66
71
  my_signature_requests = client.get_signature_requests
67
72
  puts my_signature_requests.warnings
68
- ````
73
+ ```
69
74
 
70
75
  and will give output of warnings in the following format (as an array of hashes):
71
76
 
72
- ````
77
+ ```
73
78
  [
74
79
  [0] {
75
80
  "warning_msg" => "Parameter hodor was ignored. Hodor.",
@@ -80,9 +85,10 @@ and will give output of warnings in the following format (as an array of hashes)
80
85
  "warning_name" => "unconfirmed"
81
86
  }
82
87
  ]
83
- ````
88
+ ```
84
89
 
85
90
  ### Local callbacks
91
+
86
92
  We do not allow app callbacks (event or OAuth) to be set to localhost. However it is still possible to test callbacks against a local server. Tunneling services such as ngrok (http://ngrok.com) can help you set this up.
87
93
 
88
94
  ## License
@@ -21,5 +21,5 @@
21
21
  # SOFTWARE.
22
22
 
23
23
  module HelloSign
24
- VERSION = '1.0.6'
24
+ VERSION = '1.0.7'.freeze
25
25
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: hellosign-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.6
4
+ version: 1.0.7
5
5
  platform: ruby
6
6
  authors:
7
7
  - HelloSign, Aubrey Holland
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-04-04 00:00:00.000000000 Z
11
+ date: 2022-06-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
221
221
  - !ruby/object:Gem::Version
222
222
  version: '0'
223
223
  requirements: []
224
- rubygems_version: 3.2.32
224
+ rubygems_version: 3.3.7
225
225
  signing_key:
226
226
  specification_version: 4
227
227
  summary: A Ruby SDK for the HelloSign API.