dropbox-sign 1.6.1 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +15 -5
  4. data/VERSION +1 -1
  5. data/docs/AccountResponseQuotas.md +1 -1
  6. data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -1
  7. data/docs/FaxApi.md +364 -0
  8. data/docs/FaxGetResponse.md +11 -0
  9. data/docs/FaxListResponse.md +11 -0
  10. data/docs/FaxResponse.md +20 -0
  11. data/docs/FaxResponseTransmission.md +12 -0
  12. data/docs/FaxSendRequest.md +18 -0
  13. data/docs/OAuthTokenRefreshRequest.md +2 -0
  14. data/docs/SignatureRequestApi.md +1 -1
  15. data/docs/SignatureRequestResponse.md +1 -1
  16. data/docs/SignatureRequestResponseDataValueInitials.md +1 -0
  17. data/docs/SignatureRequestResponseDataValueSignature.md +1 -0
  18. data/docs/SubWhiteLabelingOptions.md +12 -12
  19. data/docs/TemplateApi.md +3 -3
  20. data/docs/TemplateResponse.md +3 -2
  21. data/docs/TemplateResponseDocumentFormFieldBase.md +0 -1
  22. data/docs/TemplateResponseDocumentFormFieldCheckbox.md +1 -0
  23. data/docs/TemplateResponseDocumentFormFieldDateSigned.md +1 -0
  24. data/docs/TemplateResponseDocumentFormFieldDropdown.md +1 -0
  25. data/docs/TemplateResponseDocumentFormFieldHyperlink.md +1 -0
  26. data/docs/TemplateResponseDocumentFormFieldInitials.md +1 -0
  27. data/docs/TemplateResponseDocumentFormFieldRadio.md +1 -0
  28. data/docs/TemplateResponseDocumentFormFieldSignature.md +1 -0
  29. data/docs/TemplateResponseDocumentFormFieldText.md +1 -0
  30. data/examples/FaxDelete.rb +14 -0
  31. data/examples/FaxFiles.rb +17 -0
  32. data/examples/FaxGet.rb +17 -0
  33. data/examples/FaxList.rb +18 -0
  34. data/examples/FaxSend.rb +25 -0
  35. data/lib/dropbox-sign/api/fax_api.rb +495 -0
  36. data/lib/dropbox-sign/api/o_auth_api.rb +28 -0
  37. data/lib/dropbox-sign/api/signature_request_api.rb +2 -2
  38. data/lib/dropbox-sign/api/template_api.rb +2 -2
  39. data/lib/dropbox-sign/models/account_response_quotas.rb +1 -1
  40. data/lib/dropbox-sign/models/api_app_response_o_auth.rb +2 -1
  41. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +10 -7
  42. data/lib/dropbox-sign/models/fax_get_response.rb +263 -0
  43. data/lib/dropbox-sign/models/fax_list_response.rb +267 -0
  44. data/lib/dropbox-sign/models/fax_response.rb +403 -0
  45. data/lib/dropbox-sign/models/fax_response_transmission.rb +312 -0
  46. data/lib/dropbox-sign/models/fax_send_request.rb +345 -0
  47. data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +26 -4
  48. data/lib/dropbox-sign/models/signature_request_response.rb +10 -7
  49. data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +2 -1
  50. data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +16 -4
  51. data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +16 -4
  52. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +12 -12
  53. data/lib/dropbox-sign/models/template_response.rb +27 -16
  54. data/lib/dropbox-sign/models/template_response_document.rb +1 -2
  55. data/lib/dropbox-sign/models/template_response_document_form_field_base.rb +4 -16
  56. data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +16 -4
  57. data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +16 -4
  58. data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +16 -4
  59. data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +16 -4
  60. data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +16 -4
  61. data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +20 -4
  62. data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +16 -4
  63. data/lib/dropbox-sign/models/template_response_document_form_field_text.rb +17 -5
  64. data/lib/dropbox-sign/version.rb +1 -1
  65. data/lib/dropbox-sign.rb +6 -0
  66. data/openapi-config.yaml +1 -1
  67. data/openapi-sdk.yaml +821 -98
  68. data/run-build +9 -0
  69. data/test_fixtures/ApiAppCreateRequest.json +10 -10
  70. data/test_fixtures/ApiAppGetResponse.json +18 -3
  71. data/test_fixtures/ApiAppListResponse.json +7 -1
  72. data/test_fixtures/ApiAppUpdateRequest.json +11 -11
  73. data/test_fixtures/BulkSendJobGetResponse.json +9 -0
  74. data/test_fixtures/FaxGetResponse.json +31 -0
  75. data/test_fixtures/FaxListResponse.json +39 -0
  76. data/test_fixtures/FaxSendRequest.json +14 -0
  77. data/test_fixtures/FaxSendResponse.json +16 -0
  78. data/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json +7 -1
  79. data/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json +7 -1
  80. data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +7 -1
  81. data/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +7 -1
  82. data/test_fixtures/SignatureRequestGetResponse.json +11 -1
  83. data/test_fixtures/SignatureRequestListResponse.json +9 -1
  84. data/test_fixtures/SignatureRequestSendRequest.json +5 -1
  85. data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +7 -1
  86. data/test_fixtures/TeamGetResponse.json +5 -0
  87. data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +5 -0
  88. data/test_fixtures/TemplateCreateRequest.json +5 -0
  89. data/test_fixtures/TemplateGetResponse.json +34 -479
  90. data/test_fixtures/TemplateListResponse.json +43 -6
  91. data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +5 -0
  92. data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +5 -0
  93. data/test_fixtures/UnclaimedDraftCreateRequest.json +5 -0
  94. metadata +29 -8
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a3cb41913278d9c7c079a351cd4d65e136ed0fdbd666b9a20d3849a9c0a055df
4
- data.tar.gz: d8bf984f6fcf37534a384f3aac7f84c79bf869b17153cbde84e0691f295fff62
3
+ metadata.gz: 0e64c9f5e87bb51e133c06c546b9eb4747739867caf0cd4e062d74a17e052762
4
+ data.tar.gz: f698e9b93152e1cbee38194acb69b64d64697a7d93fa9dc72b3cc45cf58ec2cd
5
5
  SHA512:
6
- metadata.gz: a4bbe3ea8f55471f3cfb28fdde518cf07e624877dc5fdb8248984e453ba735bddd0322a0510315a59be10c751a5e33bfbd92de5f8fa6b6e00ff211476b977491
7
- data.tar.gz: a2eb4aa246b94d4002d18ff3910a754db5f89c048d2ec461179164895f78c243ca27d8a023ee6d2540642525c4097fb1755b50ac0e374cafe0b144097b151825
6
+ metadata.gz: ef5f4840f660e312d30b0b6d6bc27c36341fc37ae675a63856a374bc3deb28f21ddc8fa79f72b9e41997d23ceefe73e1b0cd763070a95f7f9fc9e2c31ac5587d
7
+ data.tar.gz: 69e9db06937df1c18f78246c5e8a180da82ac20865a1c4658868e8d6dc50c8276f64d60b588402d88cd1d05876b256cfa1be1035ac6fbe6774faa415f516ca7a
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- dropbox-sign (1.6.1)
4
+ dropbox-sign (1.8.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -25,7 +25,7 @@ directory that corresponds to the file you want updated.
25
25
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
26
26
 
27
27
  - API version: 3.0.0
28
- - Package version: 1.6.1
28
+ - Package version: 1.8.0
29
29
  - Generator version: 7.8.0
30
30
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
31
31
 
@@ -47,15 +47,15 @@ gem build dropbox-sign.gemspec
47
47
  Then install the gem locally:
48
48
 
49
49
  ```shell
50
- gem install ./dropbox-sign-1.6.1.gem
50
+ gem install ./dropbox-sign-1.8.0.gem
51
51
  ```
52
52
 
53
- (for development, run `gem install --dev ./dropbox-sign-1.6.1.gem` to install the development dependencies)
53
+ (for development, run `gem install --dev ./dropbox-sign-1.8.0.gem` to install the development dependencies)
54
54
 
55
55
 
56
56
  Finally add this to the Gemfile:
57
57
 
58
- gem 'dropbox-sign', '~> 1.6.1'
58
+ gem 'dropbox-sign', '~> 1.8.0'
59
59
 
60
60
  ### Install from Git
61
61
 
@@ -121,6 +121,11 @@ All URIs are relative to *https://api.hellosign.com/v3*
121
121
  |*Dropbox::Sign::BulkSendJobApi* | [**bulk_send_job_list**](docs/BulkSendJobApi.md#bulk_send_job_list) | **GET** /bulk_send_job/list | List Bulk Send Jobs |
122
122
  |*Dropbox::Sign::EmbeddedApi* | [**embedded_edit_url**](docs/EmbeddedApi.md#embedded_edit_url) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL |
123
123
  |*Dropbox::Sign::EmbeddedApi* | [**embedded_sign_url**](docs/EmbeddedApi.md#embedded_sign_url) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL |
124
+ |*Dropbox::Sign::FaxApi* | [**fax_delete**](docs/FaxApi.md#fax_delete) | **DELETE** /fax/{fax_id} | Delete Fax |
125
+ |*Dropbox::Sign::FaxApi* | [**fax_files**](docs/FaxApi.md#fax_files) | **GET** /fax/files/{fax_id} | List Fax Files |
126
+ |*Dropbox::Sign::FaxApi* | [**fax_get**](docs/FaxApi.md#fax_get) | **GET** /fax/{fax_id} | Get Fax |
127
+ |*Dropbox::Sign::FaxApi* | [**fax_list**](docs/FaxApi.md#fax_list) | **GET** /fax/list | Lists Faxes |
128
+ |*Dropbox::Sign::FaxApi* | [**fax_send**](docs/FaxApi.md#fax_send) | **POST** /fax/send | Send Fax |
124
129
  |*Dropbox::Sign::FaxLineApi* | [**fax_line_add_user**](docs/FaxLineApi.md#fax_line_add_user) | **PUT** /fax_line/add_user | Add Fax Line User |
125
130
  |*Dropbox::Sign::FaxLineApi* | [**fax_line_area_code_get**](docs/FaxLineApi.md#fax_line_area_code_get) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes |
126
131
  |*Dropbox::Sign::FaxLineApi* | [**fax_line_create**](docs/FaxLineApi.md#fax_line_create) | **POST** /fax_line/create | Purchase Fax Line |
@@ -158,7 +163,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
158
163
  |*Dropbox::Sign::TeamApi* | [**team_sub_teams**](docs/TeamApi.md#team_sub_teams) | **GET** /team/sub_teams/{team_id} | List Sub Teams |
159
164
  |*Dropbox::Sign::TeamApi* | [**team_update**](docs/TeamApi.md#team_update) | **PUT** /team | Update Team |
160
165
  |*Dropbox::Sign::TemplateApi* | [**template_add_user**](docs/TemplateApi.md#template_add_user) | **POST** /template/add_user/{template_id} | Add User to Template |
161
- |*Dropbox::Sign::TemplateApi* | [**template_create**](docs/TemplateApi.md#template_create) | **POST** /template/create | Create Template |
166
+ |*Dropbox::Sign::TemplateApi* | [**template_create**](docs/TemplateApi.md#template_create) | **POST** /template/create | Create Template |
162
167
  |*Dropbox::Sign::TemplateApi* | [**template_create_embedded_draft**](docs/TemplateApi.md#template_create_embedded_draft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft |
163
168
  |*Dropbox::Sign::TemplateApi* | [**template_delete**](docs/TemplateApi.md#template_delete) | **POST** /template/delete/{template_id} | Delete Template |
164
169
  |*Dropbox::Sign::TemplateApi* | [**template_files**](docs/TemplateApi.md#template_files) | **GET** /template/files/{template_id} | Get Template Files |
@@ -210,6 +215,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
210
215
  - [Dropbox::Sign::EventCallbackRequest](docs/EventCallbackRequest.md)
211
216
  - [Dropbox::Sign::EventCallbackRequestEvent](docs/EventCallbackRequestEvent.md)
212
217
  - [Dropbox::Sign::EventCallbackRequestEventMetadata](docs/EventCallbackRequestEventMetadata.md)
218
+ - [Dropbox::Sign::FaxGetResponse](docs/FaxGetResponse.md)
213
219
  - [Dropbox::Sign::FaxLineAddUserRequest](docs/FaxLineAddUserRequest.md)
214
220
  - [Dropbox::Sign::FaxLineAreaCodeGetCountryEnum](docs/FaxLineAreaCodeGetCountryEnum.md)
215
221
  - [Dropbox::Sign::FaxLineAreaCodeGetProvinceEnum](docs/FaxLineAreaCodeGetProvinceEnum.md)
@@ -221,6 +227,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
221
227
  - [Dropbox::Sign::FaxLineRemoveUserRequest](docs/FaxLineRemoveUserRequest.md)
222
228
  - [Dropbox::Sign::FaxLineResponse](docs/FaxLineResponse.md)
223
229
  - [Dropbox::Sign::FaxLineResponseFaxLine](docs/FaxLineResponseFaxLine.md)
230
+ - [Dropbox::Sign::FaxListResponse](docs/FaxListResponse.md)
231
+ - [Dropbox::Sign::FaxResponse](docs/FaxResponse.md)
232
+ - [Dropbox::Sign::FaxResponseTransmission](docs/FaxResponseTransmission.md)
233
+ - [Dropbox::Sign::FaxSendRequest](docs/FaxSendRequest.md)
224
234
  - [Dropbox::Sign::FileResponse](docs/FileResponse.md)
225
235
  - [Dropbox::Sign::FileResponseDataUri](docs/FileResponseDataUri.md)
226
236
  - [Dropbox::Sign::ListInfoResponse](docs/ListInfoResponse.md)
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.6.1
1
+ 1.8.0
@@ -10,6 +10,6 @@ Details concerning remaining monthly quotas.
10
10
  | `documents_left` | ```Integer``` | Signature requests remaining. | |
11
11
  | `templates_total` | ```Integer``` | Total API templates allowed. | |
12
12
  | `templates_left` | ```Integer``` | API templates remaining. | |
13
- | `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | |
13
+ | `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | |
14
14
  | `num_fax_pages_left` | ```Integer``` | Number of fax pages left | |
15
15
 
@@ -13,7 +13,7 @@
13
13
  | `original_title` | ```String``` | Default Label for account. | |
14
14
  | `subject` | ```String``` | The subject in the email that was initially sent to the signers. | |
15
15
  | `message` | ```String``` | The custom message in the email that was initially sent to the signers. | |
16
- | `metadata` | ```Object``` | The metadata attached to the signature request. | |
16
+ | `metadata` | ```Hash<String, Object>``` | The metadata attached to the signature request. | |
17
17
  | `created_at` | ```Integer``` | Time the signature request was created. | |
18
18
  | `expires_at` | ```Integer``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | |
19
19
  | `is_complete` | ```Boolean``` | Whether or not the SignatureRequest has been fully executed by all signers. | |
data/docs/FaxApi.md ADDED
@@ -0,0 +1,364 @@
1
+ # Dropbox::Sign::FaxApi
2
+
3
+ All URIs are relative to *https://api.hellosign.com/v3*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [`fax_delete`](FaxApi.md#fax_delete) | **DELETE** `/fax/{fax_id}` | Delete Fax |
8
+ | [`fax_files`](FaxApi.md#fax_files) | **GET** `/fax/files/{fax_id}` | List Fax Files |
9
+ | [`fax_get`](FaxApi.md#fax_get) | **GET** `/fax/{fax_id}` | Get Fax |
10
+ | [`fax_list`](FaxApi.md#fax_list) | **GET** `/fax/list` | Lists Faxes |
11
+ | [`fax_send`](FaxApi.md#fax_send) | **POST** `/fax/send` | Send Fax |
12
+
13
+
14
+ ## `fax_delete`
15
+
16
+ > `fax_delete(fax_id)`
17
+
18
+ Delete Fax
19
+
20
+ Deletes the specified Fax from the system.
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require "dropbox-sign"
26
+
27
+ Dropbox::Sign.configure do |config|
28
+ # Configure HTTP basic authorization: api_key
29
+ config.username = "YOUR_API_KEY"
30
+ end
31
+
32
+ fax_api = Dropbox::Sign::FaxApi.new
33
+
34
+ begin
35
+ fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967")
36
+ rescue Dropbox::Sign::ApiError => e
37
+ puts "Exception when calling Dropbox Sign API: #{e}"
38
+ end
39
+
40
+ ```
41
+
42
+ #### Using the `fax_delete_with_http_info` variant
43
+
44
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
45
+
46
+ > `<Array(nil, Integer, Hash)> fax_delete_with_http_info(fax_id)`
47
+
48
+ ```ruby
49
+ begin
50
+ # Delete Fax
51
+ data, status_code, headers = api_instance.fax_delete_with_http_info(fax_id)
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => nil
55
+ rescue Dropbox::Sign::ApiError => e
56
+ puts "Error when calling FaxApi->fax_delete_with_http_info: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ | Name | Type | Description | Notes |
63
+ | ---- | ---- | ----------- | ----- |
64
+ | `fax_id` | **String** | Fax ID | |
65
+
66
+ ### Return type
67
+
68
+ nil (empty response body)
69
+
70
+ ### Authorization
71
+
72
+ [api_key](../README.md#api_key)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: Not defined
77
+ - **Accept**: application/json
78
+
79
+
80
+ ## `fax_files`
81
+
82
+ > `File fax_files(fax_id)`
83
+
84
+ List Fax Files
85
+
86
+ Returns list of fax files
87
+
88
+ ### Examples
89
+
90
+ ```ruby
91
+ require "dropbox-sign"
92
+
93
+ Dropbox::Sign.configure do |config|
94
+ # Configure HTTP basic authorization: api_key
95
+ config.username = "YOUR_API_KEY"
96
+ end
97
+
98
+ fax_api = Dropbox::Sign::FaxApi.new
99
+
100
+ faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
101
+
102
+ begin
103
+ file_bin = fax_api.fax_files(data)
104
+ FileUtils.cp(file_bin.path, "path/to/file.pdf")
105
+ rescue Dropbox::Sign::ApiError => e
106
+ puts "Exception when calling Dropbox Sign API: #{e}"
107
+ end
108
+
109
+ ```
110
+
111
+ #### Using the `fax_files_with_http_info` variant
112
+
113
+ This returns an Array which contains the response data, status code and headers.
114
+
115
+ > `<Array(File, Integer, Hash)> fax_files_with_http_info(fax_id)`
116
+
117
+ ```ruby
118
+ begin
119
+ # List Fax Files
120
+ data, status_code, headers = api_instance.fax_files_with_http_info(fax_id)
121
+ p status_code # => 2xx
122
+ p headers # => { ... }
123
+ p data # => File
124
+ rescue Dropbox::Sign::ApiError => e
125
+ puts "Error when calling FaxApi->fax_files_with_http_info: #{e}"
126
+ end
127
+ ```
128
+
129
+ ### Parameters
130
+
131
+ | Name | Type | Description | Notes |
132
+ | ---- | ---- | ----------- | ----- |
133
+ | `fax_id` | **String** | Fax ID | |
134
+
135
+ ### Return type
136
+
137
+ **File**
138
+
139
+ ### Authorization
140
+
141
+ [api_key](../README.md#api_key)
142
+
143
+ ### HTTP request headers
144
+
145
+ - **Content-Type**: Not defined
146
+ - **Accept**: application/pdf, application/json
147
+
148
+
149
+ ## `fax_get`
150
+
151
+ > `<FaxGetResponse> fax_get(fax_id)`
152
+
153
+ Get Fax
154
+
155
+ Returns information about fax
156
+
157
+ ### Examples
158
+
159
+ ```ruby
160
+ require "dropbox-sign"
161
+
162
+ Dropbox::Sign.configure do |config|
163
+ # Configure HTTP basic authorization: api_key
164
+ config.username = "YOUR_API_KEY"
165
+ end
166
+
167
+ fax_api = Dropbox::Sign::FaxApi.new
168
+
169
+ fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
170
+
171
+ begin
172
+ result = fax_api.fax_get(fax_id)
173
+ p result
174
+ rescue Dropbox::Sign::ApiError => e
175
+ puts "Exception when calling Dropbox Sign API: #{e}"
176
+ end
177
+
178
+ ```
179
+
180
+ #### Using the `fax_get_with_http_info` variant
181
+
182
+ This returns an Array which contains the response data, status code and headers.
183
+
184
+ > `<Array(<FaxGetResponse>, Integer, Hash)> fax_get_with_http_info(fax_id)`
185
+
186
+ ```ruby
187
+ begin
188
+ # Get Fax
189
+ data, status_code, headers = api_instance.fax_get_with_http_info(fax_id)
190
+ p status_code # => 2xx
191
+ p headers # => { ... }
192
+ p data # => <FaxGetResponse>
193
+ rescue Dropbox::Sign::ApiError => e
194
+ puts "Error when calling FaxApi->fax_get_with_http_info: #{e}"
195
+ end
196
+ ```
197
+
198
+ ### Parameters
199
+
200
+ | Name | Type | Description | Notes |
201
+ | ---- | ---- | ----------- | ----- |
202
+ | `fax_id` | **String** | Fax ID | |
203
+
204
+ ### Return type
205
+
206
+ [**FaxGetResponse**](FaxGetResponse.md)
207
+
208
+ ### Authorization
209
+
210
+ [api_key](../README.md#api_key)
211
+
212
+ ### HTTP request headers
213
+
214
+ - **Content-Type**: Not defined
215
+ - **Accept**: application/json
216
+
217
+
218
+ ## `fax_list`
219
+
220
+ > `<FaxListResponse> fax_list(opts)`
221
+
222
+ Lists Faxes
223
+
224
+ Returns properties of multiple faxes
225
+
226
+ ### Examples
227
+
228
+ ```ruby
229
+ require "dropbox-sign"
230
+
231
+ Dropbox::Sign.configure do |config|
232
+ # Configure HTTP basic authorization: api_key
233
+ config.username = "YOUR_API_KEY"
234
+ end
235
+
236
+ fax_api = Dropbox::Sign::FaxApi.new
237
+
238
+ page = 1
239
+ page_size = 2
240
+
241
+ begin
242
+ result = fax_api.fax_list({ page: page, page_size: page_size })
243
+ p result
244
+ rescue Dropbox::Sign::ApiError => e
245
+ puts "Exception when calling Dropbox Sign API: #{e}"
246
+ end
247
+
248
+ ```
249
+
250
+ #### Using the `fax_list_with_http_info` variant
251
+
252
+ This returns an Array which contains the response data, status code and headers.
253
+
254
+ > `<Array(<FaxListResponse>, Integer, Hash)> fax_list_with_http_info(opts)`
255
+
256
+ ```ruby
257
+ begin
258
+ # Lists Faxes
259
+ data, status_code, headers = api_instance.fax_list_with_http_info(opts)
260
+ p status_code # => 2xx
261
+ p headers # => { ... }
262
+ p data # => <FaxListResponse>
263
+ rescue Dropbox::Sign::ApiError => e
264
+ puts "Error when calling FaxApi->fax_list_with_http_info: #{e}"
265
+ end
266
+ ```
267
+
268
+ ### Parameters
269
+
270
+ | Name | Type | Description | Notes |
271
+ | ---- | ---- | ----------- | ----- |
272
+ | `page` | **Integer** | Page | [optional][default to 1] |
273
+ | `page_size` | **Integer** | Page size | [optional][default to 20] |
274
+
275
+ ### Return type
276
+
277
+ [**FaxListResponse**](FaxListResponse.md)
278
+
279
+ ### Authorization
280
+
281
+ [api_key](../README.md#api_key)
282
+
283
+ ### HTTP request headers
284
+
285
+ - **Content-Type**: Not defined
286
+ - **Accept**: application/json
287
+
288
+
289
+ ## `fax_send`
290
+
291
+ > `<FaxGetResponse> fax_send(fax_send_request)`
292
+
293
+ Send Fax
294
+
295
+ Action to prepare and send a fax
296
+
297
+ ### Examples
298
+
299
+ ```ruby
300
+ require "dropbox-sign"
301
+
302
+ Dropbox::Sign.configure do |config|
303
+ # Configure HTTP basic authorization: api_key
304
+ config.username = "YOUR_API_KEY"
305
+ end
306
+
307
+ fax_api = Dropbox::Sign::FaxApi.new
308
+
309
+ data = Dropbox::Sign::FaxSendRequest.new
310
+ data.files = [File.new("example_signature_request.pdf", "r")]
311
+ data.test_mode = true
312
+ data.recipient = "16690000001"
313
+ data.sender = "16690000000"
314
+ data.cover_page_to = "Jill Fax"
315
+ data.cover_page_message = "I'm sending you a fax!"
316
+ data.cover_page_from = "Faxer Faxerson"
317
+ data.title = "This is what the fax is about!"
318
+
319
+ begin
320
+ result = fax_api.fax_send(data)
321
+ p result
322
+ rescue Dropbox::Sign::ApiError => e
323
+ puts "Exception when calling Dropbox Sign API: #{e}"
324
+ end
325
+
326
+ ```
327
+
328
+ #### Using the `fax_send_with_http_info` variant
329
+
330
+ This returns an Array which contains the response data, status code and headers.
331
+
332
+ > `<Array(<FaxGetResponse>, Integer, Hash)> fax_send_with_http_info(fax_send_request)`
333
+
334
+ ```ruby
335
+ begin
336
+ # Send Fax
337
+ data, status_code, headers = api_instance.fax_send_with_http_info(fax_send_request)
338
+ p status_code # => 2xx
339
+ p headers # => { ... }
340
+ p data # => <FaxGetResponse>
341
+ rescue Dropbox::Sign::ApiError => e
342
+ puts "Error when calling FaxApi->fax_send_with_http_info: #{e}"
343
+ end
344
+ ```
345
+
346
+ ### Parameters
347
+
348
+ | Name | Type | Description | Notes |
349
+ | ---- | ---- | ----------- | ----- |
350
+ | `fax_send_request` | [**FaxSendRequest**](FaxSendRequest.md) | | |
351
+
352
+ ### Return type
353
+
354
+ [**FaxGetResponse**](FaxGetResponse.md)
355
+
356
+ ### Authorization
357
+
358
+ [api_key](../README.md#api_key)
359
+
360
+ ### HTTP request headers
361
+
362
+ - **Content-Type**: application/json, multipart/form-data
363
+ - **Accept**: application/json
364
+
@@ -0,0 +1,11 @@
1
+ # Dropbox::Sign::FaxGetResponse
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `fax`<sup>*_required_</sup> | [```FaxResponse```](FaxResponse.md) | | |
10
+ | `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
11
+
@@ -0,0 +1,11 @@
1
+ # Dropbox::Sign::FaxListResponse
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `faxes`<sup>*_required_</sup> | [```Array<FaxResponse>```](FaxResponse.md) | | |
10
+ | `list_info`<sup>*_required_</sup> | [```ListInfoResponse```](ListInfoResponse.md) | | |
11
+
@@ -0,0 +1,20 @@
1
+ # Dropbox::Sign::FaxResponse
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `fax_id`<sup>*_required_</sup> | ```String``` | Fax ID | |
10
+ | `title`<sup>*_required_</sup> | ```String``` | Fax Title | |
11
+ | `original_title`<sup>*_required_</sup> | ```String``` | Fax Original Title | |
12
+ | `metadata`<sup>*_required_</sup> | ```Hash<String, Object>``` | Fax Metadata | |
13
+ | `created_at`<sup>*_required_</sup> | ```Integer``` | Fax Created At Timestamp | |
14
+ | `sender`<sup>*_required_</sup> | ```String``` | Fax Sender Email | |
15
+ | `files_url`<sup>*_required_</sup> | ```String``` | Fax Files URL | |
16
+ | `transmissions`<sup>*_required_</sup> | [```Array<FaxResponseTransmission>```](FaxResponseTransmission.md) | Fax Transmissions List | |
17
+ | `subject` | ```String``` | Fax Subject | |
18
+ | `message` | ```String``` | Fax Message | |
19
+ | `final_copy_uri` | ```String``` | The path where the completed document can be downloaded | |
20
+
@@ -0,0 +1,12 @@
1
+ # Dropbox::Sign::FaxResponseTransmission
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `recipient`<sup>*_required_</sup> | ```String``` | Fax Transmission Recipient | |
10
+ | `status_code`<sup>*_required_</sup> | ```String``` | Fax Transmission Status Code | |
11
+ | `sent_at` | ```Integer``` | Fax Transmission Sent Timestamp | |
12
+
@@ -0,0 +1,18 @@
1
+ # Dropbox::Sign::FaxSendRequest
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `recipient`<sup>*_required_</sup> | ```String``` | Fax Send To Recipient | |
10
+ | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | |
11
+ | `files` | ```Array<File>``` | Fax File to Send | |
12
+ | `file_urls` | ```Array<String>``` | Fax File URL to Send | |
13
+ | `test_mode` | ```Boolean``` | API Test Mode Setting | [default to false] |
14
+ | `cover_page_to` | ```String``` | Fax Cover Page for Recipient | |
15
+ | `cover_page_from` | ```String``` | Fax Cover Page for Sender | |
16
+ | `cover_page_message` | ```String``` | Fax Cover Page Message | |
17
+ | `title` | ```String``` | Fax Title | |
18
+
@@ -8,4 +8,6 @@
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `grant_type`<sup>*_required_</sup> | ```String``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] |
10
10
  | `refresh_token`<sup>*_required_</sup> | ```String``` | The token provided when you got the expired access token. | |
11
+ | `client_id` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | |
12
+ | `client_secret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | |
11
13
 
@@ -249,7 +249,7 @@ end
249
249
 
250
250
  Cancel Incomplete Signature Request
251
251
 
252
- Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
252
+ Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
253
253
 
254
254
  ### Examples
255
255
 
@@ -13,7 +13,7 @@ Contains information about a signature request.
13
13
  | `original_title` | ```String``` | Default Label for account. | |
14
14
  | `subject` | ```String``` | The subject in the email that was initially sent to the signers. | |
15
15
  | `message` | ```String``` | The custom message in the email that was initially sent to the signers. | |
16
- | `metadata` | ```Object``` | The metadata attached to the signature request. | |
16
+ | `metadata` | ```Hash<String, Object>``` | The metadata attached to the signature request. | |
17
17
  | `created_at` | ```Integer``` | Time the signature request was created. | |
18
18
  | `expires_at` | ```Integer``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | |
19
19
  | `is_complete` | ```Boolean``` | Whether or not the SignatureRequest has been fully executed by all signers. | |
@@ -8,4 +8,5 @@
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `type` | ```String``` | An input field for initials | [default to 'initials'] |
10
10
  | `value` | ```String``` | The value of the form field. | |
11
+ | `is_signed` | ```Boolean``` | This field contains the boolean true if the field is signed. | |
11
12
 
@@ -8,4 +8,5 @@
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `type` | ```String``` | A signature input field | [default to 'signature'] |
10
10
  | `value` | ```String``` | The value of the form field. | |
11
+ | `is_signed` | ```Boolean``` | This field contains the boolean true if the field is signed. | |
11
12
 
@@ -8,19 +8,19 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r
8
8
 
9
9
  | Name | Type | Description | Notes |
10
10
  | ---- | ---- | ----------- | ----- |
11
- | `header_background_color` | ```String``` | | [default to '#1A1A1A'] |
11
+ | `header_background_color` | ```String``` | | [default to '#1a1a1a'] |
12
12
  | `legal_version` | ```String``` | | [default to 'terms1'] |
13
- | `link_color` | ```String``` | | [default to '#00B3E6'] |
14
- | `page_background_color` | ```String``` | | [default to '#F7F8F9'] |
15
- | `primary_button_color` | ```String``` | | [default to '#00B3E6'] |
16
- | `primary_button_color_hover` | ```String``` | | [default to '#00B3E6'] |
17
- | `primary_button_text_color` | ```String``` | | [default to '#FFFFFF'] |
18
- | `primary_button_text_color_hover` | ```String``` | | [default to '#FFFFFF'] |
19
- | `secondary_button_color` | ```String``` | | [default to '#FFFFFF'] |
20
- | `secondary_button_color_hover` | ```String``` | | [default to '#FFFFFF'] |
21
- | `secondary_button_text_color` | ```String``` | | [default to '#00B3E6'] |
22
- | `secondary_button_text_color_hover` | ```String``` | | [default to '#00B3E6'] |
13
+ | `link_color` | ```String``` | | [default to '#0061FE'] |
14
+ | `page_background_color` | ```String``` | | [default to '#f7f8f9'] |
15
+ | `primary_button_color` | ```String``` | | [default to '#0061FE'] |
16
+ | `primary_button_color_hover` | ```String``` | | [default to '#0061FE'] |
17
+ | `primary_button_text_color` | ```String``` | | [default to '#ffffff'] |
18
+ | `primary_button_text_color_hover` | ```String``` | | [default to '#ffffff'] |
19
+ | `secondary_button_color` | ```String``` | | [default to '#ffffff'] |
20
+ | `secondary_button_color_hover` | ```String``` | | [default to '#ffffff'] |
21
+ | `secondary_button_text_color` | ```String``` | | [default to '#0061FE'] |
22
+ | `secondary_button_text_color_hover` | ```String``` | | [default to '#0061FE'] |
23
23
  | `text_color1` | ```String``` | | [default to '#808080'] |
24
- | `text_color2` | ```String``` | | [default to '#FFFFFF'] |
24
+ | `text_color2` | ```String``` | | [default to '#ffffff'] |
25
25
  | `reset_to_default` | ```Boolean``` | Resets white labeling options to defaults. Only useful when updating an API App. | |
26
26
 
data/docs/TemplateApi.md CHANGED
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [`template_add_user`](TemplateApi.md#template_add_user) | **POST** `/template/add_user/{template_id}` | Add User to Template |
8
- | [`template_create`](TemplateApi.md#template_create) | **POST** `/template/create` | Create Template |
8
+ | [`template_create`](TemplateApi.md#template_create) | **POST** `/template/create` | Create Template |
9
9
  | [`template_create_embedded_draft`](TemplateApi.md#template_create_embedded_draft) | **POST** `/template/create_embedded_draft` | Create Embedded Template Draft |
10
10
  | [`template_delete`](TemplateApi.md#template_delete) | **POST** `/template/delete/{template_id}` | Delete Template |
11
11
  | [`template_files`](TemplateApi.md#template_files) | **GET** `/template/files/{template_id}` | Get Template Files |
@@ -97,7 +97,7 @@ end
97
97
 
98
98
  > `<TemplateCreateResponse> template_create(template_create_request)`
99
99
 
100
- Create Template
100
+ Create Template
101
101
 
102
102
  Creates a template that can then be used.
103
103
 
@@ -164,7 +164,7 @@ This returns an Array which contains the response data, status code and headers.
164
164
 
165
165
  ```ruby
166
166
  begin
167
- # Create Template
167
+ # Create Template
168
168
  data, status_code, headers = api_instance.template_create_with_http_info(template_create_request)
169
169
  p status_code # => 2xx
170
170
  p headers # => { ... }