dropbox-sign 1.1.2 → 1.4.1
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.
- checksums.yaml +4 -4
- data/Gemfile.lock +6 -3
- data/README.md +9 -4
- data/VERSION +1 -1
- data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -0
- data/docs/EmbeddedEditUrlRequest.md +1 -1
- data/docs/EventCallbackRequestEvent.md +1 -1
- data/docs/OAuthApi.md +0 -16
- data/docs/SignatureRequestApi.md +11 -10
- data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestCreateEmbeddedRequest.md +4 -4
- data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestResponse.md +2 -0
- data/docs/SignatureRequestSendRequest.md +5 -4
- data/docs/SignatureRequestSendWithTemplateRequest.md +2 -1
- data/docs/SignatureRequestUpdateRequest.md +2 -2
- data/docs/SubAttachment.md +1 -1
- data/docs/SubCustomField.md +1 -1
- data/docs/SubFieldOptions.md +1 -1
- data/docs/SubFormFieldsPerDocumentBase.md +2 -2
- data/docs/SubFormFieldsPerDocumentDateSigned.md +2 -0
- data/docs/SubFormFieldsPerDocumentDropdown.md +2 -0
- data/docs/SubFormFieldsPerDocumentFontEnum.md +9 -0
- data/docs/SubFormFieldsPerDocumentHyperlink.md +2 -0
- data/docs/SubFormFieldsPerDocumentText.md +4 -1
- data/docs/SubFormFieldsPerDocumentTextMerge.md +2 -0
- data/docs/SubSignatureRequestGroupedSigners.md +1 -1
- data/docs/SubSignatureRequestSigner.md +1 -1
- data/docs/SubSignatureRequestTemplateSigner.md +1 -1
- data/docs/SubSigningOptions.md +1 -1
- data/docs/SubWhiteLabelingOptions.md +1 -1
- data/docs/TeamAddMemberRequest.md +1 -1
- data/docs/TeamRemoveMemberRequest.md +2 -2
- data/docs/TemplateAddUserRequest.md +2 -2
- data/docs/TemplateApi.md +106 -3
- data/docs/TemplateCreateEmbeddedDraftRequest.md +2 -2
- data/docs/TemplateCreateRequest.md +27 -0
- data/docs/TemplateCreateResponse.md +11 -0
- data/docs/TemplateCreateResponseTemplate.md +10 -0
- data/docs/TemplateResponseDocument.md +1 -1
- data/docs/TemplateResponseDocumentStaticFieldBase.md +1 -1
- data/docs/UnclaimedDraftApi.md +3 -3
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +4 -4
- data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +4 -3
- data/docs/UnclaimedDraftCreateRequest.md +2 -2
- data/examples/OauthTokenGenerate.rb +0 -8
- data/examples/OauthTokenRefresh.rb +0 -8
- data/examples/SignatureRequestEdit.rb +58 -0
- data/examples/SignatureRequestEditEmbedded.rb +48 -0
- data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +41 -0
- data/examples/SignatureRequestEditWithTemplate.rb +52 -0
- data/examples/TemplateCreate.rb +49 -0
- data/lib/dropbox-sign/api/api_app_api.rb +1 -1
- data/lib/dropbox-sign/api/signature_request_api.rb +17 -14
- data/lib/dropbox-sign/api/team_api.rb +1 -1
- data/lib/dropbox-sign/api/template_api.rb +112 -0
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +6 -6
- data/lib/dropbox-sign/event_callback_helper.rb +1 -1
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +13 -1
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +1 -1
- data/lib/dropbox-sign/models/event_callback_request_event.rb +2 -7
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +4 -4
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_response.rb +28 -4
- data/lib/dropbox-sign/models/signature_request_send_request.rb +18 -5
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +15 -2
- data/lib/dropbox-sign/models/signature_request_update_request.rb +2 -2
- data/lib/dropbox-sign/models/sub_attachment.rb +1 -1
- data/lib/dropbox-sign/models/sub_custom_field.rb +1 -1
- data/lib/dropbox-sign/models/sub_field_options.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +2 -2
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +62 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +62 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +54 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +62 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +52 -5
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +62 -4
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +1 -1
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +1 -1
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +1 -1
- data/lib/dropbox-sign/models/sub_signing_options.rb +1 -1
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +1 -1
- data/lib/dropbox-sign/models/team_add_member_request.rb +1 -1
- data/lib/dropbox-sign/models/team_remove_member_request.rb +2 -2
- data/lib/dropbox-sign/models/template_add_user_request.rb +2 -2
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +2 -2
- data/lib/dropbox-sign/models/template_create_request.rb +509 -0
- data/lib/dropbox-sign/models/template_create_response.rb +263 -0
- data/lib/dropbox-sign/models/template_create_response_template.rb +252 -0
- data/lib/dropbox-sign/models/template_response_document.rb +1 -1
- data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +1 -1
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +4 -4
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +20 -7
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +2 -2
- data/lib/dropbox-sign/version.rb +1 -1
- data/lib/dropbox-sign.rb +4 -0
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +1010 -499
- data/spec/event_callback_helper_spec.rb +17 -3
- data/templates/event_callback_helper.mustache +1 -1
- data/test_fixtures/EventCallbackHelper_AccountCallbacks.json +82 -0
- data/test_fixtures/{EventCallbackHelper.json → EventCallbackHelper_AppCallbacks.json} +8 -4
- data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +6 -2
- data/test_fixtures/SignatureRequestSendRequest.json +20 -8
- data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +1 -0
- data/test_fixtures/SubFormFieldsPerDocument.json +8 -4
- data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +3 -1
- data/test_fixtures/TemplateCreateRequest.json +120 -0
- data/test_fixtures/TemplateCreateResponse.json +7 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +3 -1
- data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +2 -1
- data/test_fixtures/UnclaimedDraftCreateRequest.json +3 -1
- metadata +27 -11
@@ -0,0 +1,49 @@
|
|
1
|
+
require "dropbox-sign"
|
2
|
+
|
3
|
+
Dropbox::Sign.configure do |config|
|
4
|
+
# Configure HTTP basic authorization: api_key
|
5
|
+
config.username = "YOUR_API_KEY"
|
6
|
+
|
7
|
+
# or, configure Bearer (JWT) authorization: oauth2
|
8
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
9
|
+
end
|
10
|
+
|
11
|
+
template_api = Dropbox::Sign::TemplateApi.new
|
12
|
+
|
13
|
+
role_1 = Dropbox::Sign::SubTemplateRole.new
|
14
|
+
role_1.name = "Client"
|
15
|
+
role_1.order = 0
|
16
|
+
|
17
|
+
role_2 = Dropbox::Sign::SubTemplateRole.new
|
18
|
+
role_2.name = "Witness"
|
19
|
+
role_2.order = 1
|
20
|
+
|
21
|
+
merge_field_1 = Dropbox::Sign::SubMergeField.new
|
22
|
+
merge_field_1.name = "Full Name"
|
23
|
+
merge_field_1.type = "text"
|
24
|
+
|
25
|
+
merge_field_2 = Dropbox::Sign::SubMergeField.new
|
26
|
+
merge_field_2.name = "Is Registered?"
|
27
|
+
merge_field_2.type = "checkbox"
|
28
|
+
|
29
|
+
field_options = Dropbox::Sign::SubFieldOptions.new
|
30
|
+
field_options.date_format = "DD - MM - YYYY"
|
31
|
+
|
32
|
+
data = Dropbox::Sign::TemplateCreateRequest.new
|
33
|
+
data.client_id = "37dee8d8440c66d54cfa05d92c160882"
|
34
|
+
data.files = [File.new("example_signature_request.pdf", "r")]
|
35
|
+
data.title = "Test Template"
|
36
|
+
data.subject = "Please sign this document"
|
37
|
+
data.message = "For your approval"
|
38
|
+
data.signer_roles = [role_1, role_2]
|
39
|
+
data.cc_roles = ["Manager"]
|
40
|
+
data.merge_fields = [merge_field_1, merge_field_2]
|
41
|
+
data.field_options = field_options
|
42
|
+
data.test_mode = true
|
43
|
+
|
44
|
+
begin
|
45
|
+
result = template_api.template_create(data)
|
46
|
+
p result
|
47
|
+
rescue Dropbox::Sign::ApiError => e
|
48
|
+
puts "Exception when calling Dropbox Sign API: #{e}"
|
49
|
+
end
|
@@ -96,7 +96,7 @@ module Dropbox::Sign
|
|
96
96
|
begin
|
97
97
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
98
98
|
rescue Dropbox::Sign::ApiError => e
|
99
|
-
if e.code ===
|
99
|
+
if e.code === 201
|
100
100
|
body = @api_client.convert_to_type(
|
101
101
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
102
102
|
"Dropbox::Sign::ApiAppGetResponse"
|
@@ -23,7 +23,7 @@ module Dropbox::Sign
|
|
23
23
|
@api_client = api_client
|
24
24
|
end
|
25
25
|
# Embedded Bulk Send with Template
|
26
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE
|
26
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
|
27
27
|
# @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest]
|
28
28
|
# @param [Hash] opts the optional parameters
|
29
29
|
# @return [BulkSendJobSendResponse]
|
@@ -33,7 +33,7 @@ module Dropbox::Sign
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# Embedded Bulk Send with Template
|
36
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE
|
36
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
|
37
37
|
# @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest]
|
38
38
|
# @param [Hash] opts the optional parameters
|
39
39
|
# @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers
|
@@ -132,7 +132,7 @@ module Dropbox::Sign
|
|
132
132
|
end
|
133
133
|
|
134
134
|
# Bulk Send with Template
|
135
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE
|
135
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
|
136
136
|
# @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest]
|
137
137
|
# @param [Hash] opts the optional parameters
|
138
138
|
# @return [BulkSendJobSendResponse]
|
@@ -142,7 +142,7 @@ module Dropbox::Sign
|
|
142
142
|
end
|
143
143
|
|
144
144
|
# Bulk Send with Template
|
145
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE
|
145
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
|
146
146
|
# @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest]
|
147
147
|
# @param [Hash] opts the optional parameters
|
148
148
|
# @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers
|
@@ -241,7 +241,7 @@ module Dropbox::Sign
|
|
241
241
|
end
|
242
242
|
|
243
243
|
# Cancel Incomplete Signature Request
|
244
|
-
# 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
|
244
|
+
# 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]`.
|
245
245
|
# @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel.
|
246
246
|
# @param [Hash] opts the optional parameters
|
247
247
|
# @return [nil]
|
@@ -251,7 +251,7 @@ module Dropbox::Sign
|
|
251
251
|
end
|
252
252
|
|
253
253
|
# Cancel Incomplete Signature Request
|
254
|
-
# 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
|
254
|
+
# 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]`.
|
255
255
|
# @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel.
|
256
256
|
# @param [Hash] opts the optional parameters
|
257
257
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -308,7 +308,7 @@ module Dropbox::Sign
|
|
308
308
|
end
|
309
309
|
|
310
310
|
# Create Embedded Signature Request
|
311
|
-
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. 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.
|
311
|
+
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. 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 Dropbox Sign.
|
312
312
|
# @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest]
|
313
313
|
# @param [Hash] opts the optional parameters
|
314
314
|
# @return [SignatureRequestGetResponse]
|
@@ -318,7 +318,7 @@ module Dropbox::Sign
|
|
318
318
|
end
|
319
319
|
|
320
320
|
# Create Embedded Signature Request
|
321
|
-
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. 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.
|
321
|
+
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. 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 Dropbox Sign.
|
322
322
|
# @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest]
|
323
323
|
# @param [Hash] opts the optional parameters
|
324
324
|
# @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
|
@@ -417,7 +417,7 @@ module Dropbox::Sign
|
|
417
417
|
end
|
418
418
|
|
419
419
|
# Create Embedded Signature Request with Template
|
420
|
-
# Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame.
|
420
|
+
# Creates a new SignatureRequest based on the given Template(s) 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 Dropbox Sign.
|
421
421
|
# @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest]
|
422
422
|
# @param [Hash] opts the optional parameters
|
423
423
|
# @return [SignatureRequestGetResponse]
|
@@ -427,7 +427,7 @@ module Dropbox::Sign
|
|
427
427
|
end
|
428
428
|
|
429
429
|
# Create Embedded Signature Request with Template
|
430
|
-
# Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame.
|
430
|
+
# Creates a new SignatureRequest based on the given Template(s) 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 Dropbox Sign.
|
431
431
|
# @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest]
|
432
432
|
# @param [Hash] opts the optional parameters
|
433
433
|
# @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
|
@@ -724,6 +724,7 @@ module Dropbox::Sign
|
|
724
724
|
# Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
|
725
725
|
# @param signature_request_id [String] The id of the SignatureRequest to retrieve.
|
726
726
|
# @param [Hash] opts the optional parameters
|
727
|
+
# @option opts [Integer] :force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (default to 1)
|
727
728
|
# @return [FileResponse]
|
728
729
|
def signature_request_files_as_file_url(signature_request_id, opts = {})
|
729
730
|
data, _status_code, _headers = signature_request_files_as_file_url_with_http_info(signature_request_id, opts)
|
@@ -734,6 +735,7 @@ module Dropbox::Sign
|
|
734
735
|
# Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
|
735
736
|
# @param signature_request_id [String] The id of the SignatureRequest to retrieve.
|
736
737
|
# @param [Hash] opts the optional parameters
|
738
|
+
# @option opts [Integer] :force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.
|
737
739
|
# @return [Array<(FileResponse, Integer, Hash)>] FileResponse data, response status code and response headers
|
738
740
|
def signature_request_files_as_file_url_with_http_info(signature_request_id, opts = {})
|
739
741
|
if @api_client.config.debugging
|
@@ -748,6 +750,7 @@ module Dropbox::Sign
|
|
748
750
|
|
749
751
|
# query parameters
|
750
752
|
query_params = opts[:query_params] || {}
|
753
|
+
query_params[:'force_download'] = opts[:'force_download'] if !opts[:'force_download'].nil?
|
751
754
|
|
752
755
|
# header parameters
|
753
756
|
header_params = opts[:header_params] || {}
|
@@ -1103,7 +1106,7 @@ module Dropbox::Sign
|
|
1103
1106
|
end
|
1104
1107
|
|
1105
1108
|
# Send Request Reminder
|
1106
|
-
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE
|
1109
|
+
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
|
1107
1110
|
# @param signature_request_id [String] The id of the SignatureRequest to send a reminder for.
|
1108
1111
|
# @param signature_request_remind_request [SignatureRequestRemindRequest]
|
1109
1112
|
# @param [Hash] opts the optional parameters
|
@@ -1114,7 +1117,7 @@ module Dropbox::Sign
|
|
1114
1117
|
end
|
1115
1118
|
|
1116
1119
|
# Send Request Reminder
|
1117
|
-
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE
|
1120
|
+
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
|
1118
1121
|
# @param signature_request_id [String] The id of the SignatureRequest to send a reminder for.
|
1119
1122
|
# @param signature_request_remind_request [SignatureRequestRemindRequest]
|
1120
1123
|
# @param [Hash] opts the optional parameters
|
@@ -1503,7 +1506,7 @@ module Dropbox::Sign
|
|
1503
1506
|
end
|
1504
1507
|
|
1505
1508
|
# Update Signature Request
|
1506
|
-
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. **NOTE
|
1509
|
+
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
|
1507
1510
|
# @param signature_request_id [String] The id of the SignatureRequest to update.
|
1508
1511
|
# @param signature_request_update_request [SignatureRequestUpdateRequest]
|
1509
1512
|
# @param [Hash] opts the optional parameters
|
@@ -1514,7 +1517,7 @@ module Dropbox::Sign
|
|
1514
1517
|
end
|
1515
1518
|
|
1516
1519
|
# Update Signature Request
|
1517
|
-
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. **NOTE
|
1520
|
+
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
|
1518
1521
|
# @param signature_request_id [String] The id of the SignatureRequest to update.
|
1519
1522
|
# @param signature_request_update_request [SignatureRequestUpdateRequest]
|
1520
1523
|
# @param [Hash] opts the optional parameters
|
@@ -756,7 +756,7 @@ module Dropbox::Sign
|
|
756
756
|
begin
|
757
757
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
758
758
|
rescue Dropbox::Sign::ApiError => e
|
759
|
-
if e.code ===
|
759
|
+
if e.code === 201
|
760
760
|
body = @api_client.convert_to_type(
|
761
761
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
762
762
|
"Dropbox::Sign::TeamGetResponse"
|
@@ -137,6 +137,115 @@ module Dropbox::Sign
|
|
137
137
|
return data, status_code, headers
|
138
138
|
end
|
139
139
|
|
140
|
+
# Create Template
|
141
|
+
# Creates a template that can then be used.
|
142
|
+
# @param template_create_request [TemplateCreateRequest]
|
143
|
+
# @param [Hash] opts the optional parameters
|
144
|
+
# @return [TemplateCreateResponse]
|
145
|
+
def template_create(template_create_request, opts = {})
|
146
|
+
data, _status_code, _headers = template_create_with_http_info(template_create_request, opts)
|
147
|
+
data
|
148
|
+
end
|
149
|
+
|
150
|
+
# Create Template
|
151
|
+
# Creates a template that can then be used.
|
152
|
+
# @param template_create_request [TemplateCreateRequest]
|
153
|
+
# @param [Hash] opts the optional parameters
|
154
|
+
# @return [Array<(TemplateCreateResponse, Integer, Hash)>] TemplateCreateResponse data, response status code and response headers
|
155
|
+
def template_create_with_http_info(template_create_request, opts = {})
|
156
|
+
if @api_client.config.debugging
|
157
|
+
@api_client.config.logger.debug 'Calling API: TemplateApi.template_create ...'
|
158
|
+
end
|
159
|
+
# verify the required parameter 'template_create_request' is set
|
160
|
+
if @api_client.config.client_side_validation && template_create_request.nil?
|
161
|
+
fail ArgumentError, "Missing the required parameter 'template_create_request' when calling TemplateApi.template_create"
|
162
|
+
end
|
163
|
+
# resource path
|
164
|
+
local_var_path = '/template/create'
|
165
|
+
|
166
|
+
# query parameters
|
167
|
+
query_params = opts[:query_params] || {}
|
168
|
+
|
169
|
+
# header parameters
|
170
|
+
header_params = opts[:header_params] || {}
|
171
|
+
# HTTP header 'Accept' (if needed)
|
172
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
173
|
+
# HTTP header 'Content-Type'
|
174
|
+
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
175
|
+
if !content_type.nil?
|
176
|
+
header_params['Content-Type'] = content_type
|
177
|
+
end
|
178
|
+
|
179
|
+
post_body = {}
|
180
|
+
form_params = opts[:form_params] || {}
|
181
|
+
result = @api_client.generate_form_data(
|
182
|
+
template_create_request,
|
183
|
+
Dropbox::Sign::TemplateCreateRequest.openapi_types
|
184
|
+
)
|
185
|
+
|
186
|
+
# form parameters
|
187
|
+
if result[:has_file]
|
188
|
+
form_params = opts[:form_params] || result[:params]
|
189
|
+
header_params['Content-Type'] = 'multipart/form-data'
|
190
|
+
else
|
191
|
+
# http body (model)
|
192
|
+
post_body = opts[:debug_body] || result[:params]
|
193
|
+
end
|
194
|
+
|
195
|
+
# return_type
|
196
|
+
return_type = opts[:debug_return_type] || 'TemplateCreateResponse'
|
197
|
+
|
198
|
+
# auth_names
|
199
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
200
|
+
|
201
|
+
new_options = opts.merge(
|
202
|
+
:operation => :"TemplateApi.template_create",
|
203
|
+
:header_params => header_params,
|
204
|
+
:query_params => query_params,
|
205
|
+
:form_params => form_params,
|
206
|
+
:body => post_body,
|
207
|
+
:auth_names => auth_names,
|
208
|
+
:return_type => return_type
|
209
|
+
)
|
210
|
+
|
211
|
+
begin
|
212
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
213
|
+
rescue Dropbox::Sign::ApiError => e
|
214
|
+
if e.code === 200
|
215
|
+
body = @api_client.convert_to_type(
|
216
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
217
|
+
"Dropbox::Sign::TemplateCreateResponse"
|
218
|
+
)
|
219
|
+
|
220
|
+
fail ApiError.new(:code => e.code,
|
221
|
+
:response_headers => e.response_headers,
|
222
|
+
:response_body => body),
|
223
|
+
e.message
|
224
|
+
end
|
225
|
+
|
226
|
+
range_code = "4XX".split('').first
|
227
|
+
range_code_left = "#{range_code}00".to_i
|
228
|
+
range_code_right = "#{range_code}99".to_i
|
229
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
230
|
+
body = @api_client.convert_to_type(
|
231
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
232
|
+
"Dropbox::Sign::ErrorResponse"
|
233
|
+
)
|
234
|
+
|
235
|
+
fail ApiError.new(:code => e.code,
|
236
|
+
:response_headers => e.response_headers,
|
237
|
+
:response_body => body),
|
238
|
+
e.message
|
239
|
+
end
|
240
|
+
|
241
|
+
end
|
242
|
+
|
243
|
+
if @api_client.config.debugging
|
244
|
+
@api_client.config.logger.debug "API called: TemplateApi#template_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
245
|
+
end
|
246
|
+
return data, status_code, headers
|
247
|
+
end
|
248
|
+
|
140
249
|
# Create Embedded Template Draft
|
141
250
|
# The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
|
142
251
|
# @param template_create_embedded_draft_request [TemplateCreateEmbeddedDraftRequest]
|
@@ -512,6 +621,7 @@ module Dropbox::Sign
|
|
512
621
|
# Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
|
513
622
|
# @param template_id [String] The id of the template files to retrieve.
|
514
623
|
# @param [Hash] opts the optional parameters
|
624
|
+
# @option opts [Integer] :force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (default to 1)
|
515
625
|
# @return [FileResponse]
|
516
626
|
def template_files_as_file_url(template_id, opts = {})
|
517
627
|
data, _status_code, _headers = template_files_as_file_url_with_http_info(template_id, opts)
|
@@ -522,6 +632,7 @@ module Dropbox::Sign
|
|
522
632
|
# Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
|
523
633
|
# @param template_id [String] The id of the template files to retrieve.
|
524
634
|
# @param [Hash] opts the optional parameters
|
635
|
+
# @option opts [Integer] :force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.
|
525
636
|
# @return [Array<(FileResponse, Integer, Hash)>] FileResponse data, response status code and response headers
|
526
637
|
def template_files_as_file_url_with_http_info(template_id, opts = {})
|
527
638
|
if @api_client.config.debugging
|
@@ -536,6 +647,7 @@ module Dropbox::Sign
|
|
536
647
|
|
537
648
|
# query parameters
|
538
649
|
query_params = opts[:query_params] || {}
|
650
|
+
query_params[:'force_download'] = opts[:'force_download'] if !opts[:'force_download'].nil?
|
539
651
|
|
540
652
|
# header parameters
|
541
653
|
header_params = opts[:header_params] || {}
|
@@ -132,7 +132,7 @@ module Dropbox::Sign
|
|
132
132
|
end
|
133
133
|
|
134
134
|
# Create Embedded Unclaimed Draft
|
135
|
-
# Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE
|
135
|
+
# Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
136
136
|
# @param unclaimed_draft_create_embedded_request [UnclaimedDraftCreateEmbeddedRequest]
|
137
137
|
# @param [Hash] opts the optional parameters
|
138
138
|
# @return [UnclaimedDraftCreateResponse]
|
@@ -142,7 +142,7 @@ module Dropbox::Sign
|
|
142
142
|
end
|
143
143
|
|
144
144
|
# Create Embedded Unclaimed Draft
|
145
|
-
# Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE
|
145
|
+
# Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
146
146
|
# @param unclaimed_draft_create_embedded_request [UnclaimedDraftCreateEmbeddedRequest]
|
147
147
|
# @param [Hash] opts the optional parameters
|
148
148
|
# @return [Array<(UnclaimedDraftCreateResponse, Integer, Hash)>] UnclaimedDraftCreateResponse data, response status code and response headers
|
@@ -241,7 +241,7 @@ module Dropbox::Sign
|
|
241
241
|
end
|
242
242
|
|
243
243
|
# Create Embedded Unclaimed Draft with Template
|
244
|
-
# Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE
|
244
|
+
# Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
245
245
|
# @param unclaimed_draft_create_embedded_with_template_request [UnclaimedDraftCreateEmbeddedWithTemplateRequest]
|
246
246
|
# @param [Hash] opts the optional parameters
|
247
247
|
# @return [UnclaimedDraftCreateResponse]
|
@@ -251,7 +251,7 @@ module Dropbox::Sign
|
|
251
251
|
end
|
252
252
|
|
253
253
|
# Create Embedded Unclaimed Draft with Template
|
254
|
-
# Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE
|
254
|
+
# Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
255
255
|
# @param unclaimed_draft_create_embedded_with_template_request [UnclaimedDraftCreateEmbeddedWithTemplateRequest]
|
256
256
|
# @param [Hash] opts the optional parameters
|
257
257
|
# @return [Array<(UnclaimedDraftCreateResponse, Integer, Hash)>] UnclaimedDraftCreateResponse data, response status code and response headers
|
@@ -350,7 +350,7 @@ module Dropbox::Sign
|
|
350
350
|
end
|
351
351
|
|
352
352
|
# Edit and Resend Unclaimed Draft
|
353
|
-
# Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE
|
353
|
+
# Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
354
354
|
# @param signature_request_id [String] The ID of the signature request to edit and resend.
|
355
355
|
# @param unclaimed_draft_edit_and_resend_request [UnclaimedDraftEditAndResendRequest]
|
356
356
|
# @param [Hash] opts the optional parameters
|
@@ -361,7 +361,7 @@ module Dropbox::Sign
|
|
361
361
|
end
|
362
362
|
|
363
363
|
# Edit and Resend Unclaimed Draft
|
364
|
-
# Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE
|
364
|
+
# Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
365
365
|
# @param signature_request_id [String] The ID of the signature request to edit and resend.
|
366
366
|
# @param unclaimed_draft_edit_and_resend_request [UnclaimedDraftEditAndResendRequest]
|
367
367
|
# @param [Hash] opts the optional parameters
|
@@ -44,7 +44,7 @@ module Dropbox::Sign
|
|
44
44
|
def self.get_callback_type(event_callback)
|
45
45
|
metadata = event_callback.event.event_metadata || EventCallbackRequestEventMetadata.new
|
46
46
|
|
47
|
-
if metadata.reported_for_app_id.nil? || metadata.reported_for_app_id.empty?
|
47
|
+
if metadata.nil? || metadata.reported_for_app_id.nil? || metadata.reported_for_app_id.empty?
|
48
48
|
return EVENT_TYPE_ACCOUNT_CALLBACK
|
49
49
|
end
|
50
50
|
|
@@ -90,6 +90,10 @@ module Dropbox::Sign
|
|
90
90
|
# @return [String, nil]
|
91
91
|
attr_accessor :signing_redirect_url
|
92
92
|
|
93
|
+
# The path where the completed document can be downloaded
|
94
|
+
# @return [String, nil]
|
95
|
+
attr_accessor :final_copy_uri
|
96
|
+
|
93
97
|
# Templates IDs used in this SignatureRequest (if any).
|
94
98
|
# @return [Array<String>, nil]
|
95
99
|
attr_accessor :template_ids
|
@@ -135,6 +139,7 @@ module Dropbox::Sign
|
|
135
139
|
:'details_url' => :'details_url',
|
136
140
|
:'cc_email_addresses' => :'cc_email_addresses',
|
137
141
|
:'signing_redirect_url' => :'signing_redirect_url',
|
142
|
+
:'final_copy_uri' => :'final_copy_uri',
|
138
143
|
:'template_ids' => :'template_ids',
|
139
144
|
:'custom_fields' => :'custom_fields',
|
140
145
|
:'attachments' => :'attachments',
|
@@ -175,6 +180,7 @@ module Dropbox::Sign
|
|
175
180
|
:'details_url' => :'String',
|
176
181
|
:'cc_email_addresses' => :'Array<String>',
|
177
182
|
:'signing_redirect_url' => :'String',
|
183
|
+
:'final_copy_uri' => :'String',
|
178
184
|
:'template_ids' => :'Array<String>',
|
179
185
|
:'custom_fields' => :'Array<SignatureRequestResponseCustomFieldBase>',
|
180
186
|
:'attachments' => :'Array<SignatureRequestResponseAttachment>',
|
@@ -197,6 +203,7 @@ module Dropbox::Sign
|
|
197
203
|
:'message',
|
198
204
|
:'signing_url',
|
199
205
|
:'signing_redirect_url',
|
206
|
+
:'final_copy_uri',
|
200
207
|
:'template_ids',
|
201
208
|
:'custom_fields',
|
202
209
|
:'attachments',
|
@@ -310,6 +317,10 @@ module Dropbox::Sign
|
|
310
317
|
self.signing_redirect_url = attributes[:'signing_redirect_url']
|
311
318
|
end
|
312
319
|
|
320
|
+
if attributes.key?(:'final_copy_uri')
|
321
|
+
self.final_copy_uri = attributes[:'final_copy_uri']
|
322
|
+
end
|
323
|
+
|
313
324
|
if attributes.key?(:'template_ids')
|
314
325
|
if (value = attributes[:'template_ids']).is_a?(Array)
|
315
326
|
self.template_ids = value
|
@@ -381,6 +392,7 @@ module Dropbox::Sign
|
|
381
392
|
details_url == o.details_url &&
|
382
393
|
cc_email_addresses == o.cc_email_addresses &&
|
383
394
|
signing_redirect_url == o.signing_redirect_url &&
|
395
|
+
final_copy_uri == o.final_copy_uri &&
|
384
396
|
template_ids == o.template_ids &&
|
385
397
|
custom_fields == o.custom_fields &&
|
386
398
|
attachments == o.attachments &&
|
@@ -398,7 +410,7 @@ module Dropbox::Sign
|
|
398
410
|
# Calculates hash code according to all attributes.
|
399
411
|
# @return [Integer] Hash code
|
400
412
|
def hash
|
401
|
-
[test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id].hash
|
413
|
+
[test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, final_copy_uri, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id].hash
|
402
414
|
end
|
403
415
|
|
404
416
|
# Builds the object from hash
|
@@ -41,7 +41,7 @@ module Dropbox::Sign
|
|
41
41
|
# @return [Array<SubMergeField>]
|
42
42
|
attr_accessor :merge_fields
|
43
43
|
|
44
|
-
# This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). **
|
44
|
+
# This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). **NOTE:** This parameter overwrites `show_preview=true` (if set).
|
45
45
|
# @return [Boolean]
|
46
46
|
attr_accessor :preview_only
|
47
47
|
|
@@ -160,10 +160,6 @@ module Dropbox::Sign
|
|
160
160
|
invalid_properties.push('invalid value for "event_hash", event_hash cannot be nil.')
|
161
161
|
end
|
162
162
|
|
163
|
-
if @event_metadata.nil?
|
164
|
-
invalid_properties.push('invalid value for "event_metadata", event_metadata cannot be nil.')
|
165
|
-
end
|
166
|
-
|
167
163
|
invalid_properties
|
168
164
|
end
|
169
165
|
|
@@ -172,17 +168,16 @@ module Dropbox::Sign
|
|
172
168
|
def valid?
|
173
169
|
return false if @event_time.nil?
|
174
170
|
return false if @event_type.nil?
|
175
|
-
event_type_validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test"])
|
171
|
+
event_type_validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test", "signature_request_signer_removed"])
|
176
172
|
return false unless event_type_validator.valid?(@event_type)
|
177
173
|
return false if @event_hash.nil?
|
178
|
-
return false if @event_metadata.nil?
|
179
174
|
true
|
180
175
|
end
|
181
176
|
|
182
177
|
# Custom attribute writer method checking allowed values (enum).
|
183
178
|
# @param [Object] event_type Object to be assigned
|
184
179
|
def event_type=(event_type)
|
185
|
-
validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test"])
|
180
|
+
validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test", "signature_request_signer_removed"])
|
186
181
|
unless validator.valid?(event_type)
|
187
182
|
fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}."
|
188
183
|
end
|
data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb
CHANGED
@@ -26,7 +26,7 @@ module Dropbox::Sign
|
|
26
26
|
# @return [String]
|
27
27
|
attr_accessor :client_id
|
28
28
|
|
29
|
-
# `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) **
|
29
|
+
# `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```
|
30
30
|
# @return [File]
|
31
31
|
attr_accessor :signer_file
|
32
32
|
|
@@ -22,7 +22,7 @@ module Dropbox::Sign
|
|
22
22
|
# @return [Array<String>]
|
23
23
|
attr_accessor :template_ids
|
24
24
|
|
25
|
-
# `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) **
|
25
|
+
# `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```
|
26
26
|
# @return [File]
|
27
27
|
attr_accessor :signer_file
|
28
28
|
|
@@ -42,7 +42,7 @@ module Dropbox::Sign
|
|
42
42
|
# @return [Boolean]
|
43
43
|
attr_accessor :allow_decline
|
44
44
|
|
45
|
-
# Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **
|
45
|
+
# Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan.
|
46
46
|
# @return [Boolean]
|
47
47
|
attr_accessor :allow_reassign
|
48
48
|
|
@@ -69,11 +69,11 @@ module Dropbox::Sign
|
|
69
69
|
# @return [Array<SubFormFieldRule>]
|
70
70
|
attr_accessor :form_field_rules
|
71
71
|
|
72
|
-
# The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE
|
72
|
+
# The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
|
73
73
|
# @return [Array<SubFormFieldsPerDocumentBase>]
|
74
74
|
attr_accessor :form_fields_per_document
|
75
75
|
|
76
|
-
# Enables automatic Text Tag removal when set to true. **NOTE
|
76
|
+
# Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
|
77
77
|
# @return [Boolean]
|
78
78
|
attr_accessor :hide_text_tags
|
79
79
|
|
@@ -104,7 +104,7 @@ module Dropbox::Sign
|
|
104
104
|
# @return [Boolean]
|
105
105
|
attr_accessor :use_text_tags
|
106
106
|
|
107
|
-
# Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
|
107
|
+
# Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
|
108
108
|
# @return [Boolean]
|
109
109
|
attr_accessor :populate_auto_fill_fields
|
110
110
|
|
@@ -73,7 +73,7 @@ module Dropbox::Sign
|
|
73
73
|
# @return [String]
|
74
74
|
attr_accessor :title
|
75
75
|
|
76
|
-
# Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
|
76
|
+
# Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
|
77
77
|
# @return [Boolean]
|
78
78
|
attr_accessor :populate_auto_fill_fields
|
79
79
|
|