dropbox-sign 1.0.0.pre.beta2301

data/examples/SignatureRequestGet.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+signature_request_api = Dropbox::Sign::SignatureRequestApi.new
+
+signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
+
+begin
+  result = signature_request_api.signature_request_get(signature_request_id)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/SignatureRequestList.rb

@@ -0,0 +1,21 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+signature_request_api = Dropbox::Sign::SignatureRequestApi.new
+
+account_id = null
+page = 1
+
+begin
+  result = signature_request_api.signature_request_list({account_id: account_id, page: page})
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/SignatureRequestReleaseHold.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+signature_request_api = Dropbox::Sign::SignatureRequestApi.new
+
+signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
+
+begin
+  result = signature_request_api.signature_request_release_hold(signature_request_id)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/SignatureRequestRemind.rb

@@ -0,0 +1,23 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+signature_request_api = Dropbox::Sign::SignatureRequestApi.new
+
+data = Dropbox::Sign::SignatureRequestRemindRequest.new
+data.email_address = "john@example.com"
+
+signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
+
+begin
+  result = signature_request_api.signature_request_remind(signature_request_id, data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/SignatureRequestRemove.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+signature_request_api = Dropbox::Sign::SignatureRequestApi.new
+
+signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
+
+begin
+  result = signature_request_api.signature_request_remove(signature_request_id)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/SignatureRequestSend.rb

@@ -0,0 +1,56 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+signature_request_api = Dropbox::Sign::SignatureRequestApi.new
+
+signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new
+signer_1.email_address = "jack@example.com"
+signer_1.name = "Jack"
+signer_1.order = 0
+
+signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new
+signer_2.email_address = "jill@example.com"
+signer_2.name = "Jill"
+signer_2.order = 1
+
+signing_options = Dropbox::Sign::SubSigningOptions.new
+signing_options.draw = true
+signing_options.type = true
+signing_options.upload = true
+signing_options.phone = true
+signing_options.default_type = "draw"
+
+field_options = Dropbox::Sign::SubFieldOptions.new
+field_options.date_format = "DD - MM - YYYY"
+
+data = Dropbox::Sign::SignatureRequestSendRequest.new
+data.title = "NDA with Acme Co."
+data.subject = "The NDA we talked about"
+data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
+data.signers = [signer_1, signer_2]
+data.cc_email_addresses = [
+  "lawyer@dropboxsign.com",
+  "lawyer@dropboxsign.com",
+]
+data.files = [File.new("example_signature_request.pdf", "r")]
+data.metadata = {
+  custom_id: 1234,
+  custom_text: "NDA #9",
+}
+data.signing_options = signing_options
+data.field_options = field_options
+data.test_mode = true
+
+begin
+  result = signature_request_api.signature_request_send(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/SignatureRequestSendWithTemplate.rb

@@ -0,0 +1,50 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+signature_request_api = Dropbox::Sign::SignatureRequestApi.new
+
+signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
+signer_1.role = "Client"
+signer_1.email_address = "george@example.com"
+signer_1.name = "George"
+
+cc_1 = Dropbox::Sign::SubCC.new
+cc_1.role = "Accounting"
+cc_1.email_address = "accounting@example.com"
+
+custom_field_1 = Dropbox::Sign::SubCustomField.new
+custom_field_1.name = "Cost"
+custom_field_1.value = "$20,000"
+custom_field_1.editor = "Client"
+custom_field_1.required = true
+
+signing_options = Dropbox::Sign::SubSigningOptions.new
+signing_options.draw = true
+signing_options.type = true
+signing_options.upload = true
+signing_options.phone = false
+signing_options.default_type = "draw"
+
+data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new
+data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]
+data.subject = "Purchase Order"
+data.message = "Glad we could come to an agreement."
+data.signers = [signer_1]
+data.ccs = [cc_1]
+data.custom_fields = [custom_field_1]
+data.signing_options = signing_options
+data.test_mode = true
+
+begin
+  result = signature_request_api.signature_request_send_with_template(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/SignatureRequestUpdate.rb

@@ -0,0 +1,24 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+signature_request_api = Dropbox::Sign::SignatureRequestApi.new
+
+data = Dropbox::Sign::SignatureRequestUpdateRequest.new
+data.email_address = "john@example.com"
+data.signature_id = "78caf2a1d01cd39cea2bc1cbb340dac3"
+
+signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
+
+begin
+  result = signature_request_api.signature_request_update(signature_request_id, data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TeamAddMember.rb

@@ -0,0 +1,21 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_api = Dropbox::Sign::TeamApi.new
+
+data = Dropbox::Sign::TeamAddMemberRequest.new
+data.email_address = "george@example.com"
+
+begin
+  result = team_api.team_add_member(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TeamCreate.rb

@@ -0,0 +1,21 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_api = Dropbox::Sign::TeamApi.new
+
+data = Dropbox::Sign::TeamCreateRequest.new
+data.name = "New Team Name"
+
+begin
+  result = team_api.team_create(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TeamDelete.rb

@@ -0,0 +1,18 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_api = Dropbox::Sign::TeamApi.new
+
+begin
+  result = team_api.team_delete
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TeamGet.rb

@@ -0,0 +1,18 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_api = Dropbox::Sign::TeamApi.new
+
+begin
+  result = team_api.team_get
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TeamInfo.rb

@@ -0,0 +1,18 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_api = Dropbox::Sign::TeamApi.new
+
+begin
+  result = team_api.team_info
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TeamInvites.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_api = Dropbox::Sign::TeamApi.new
+
+email_address = "user@dropboxsign.com"
+
+begin
+  result = team_api.team_invites({email_address: email_address})
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TeamMembers.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_api = Dropbox::Sign::TeamApi.new
+
+team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"
+
+begin
+  result = team_api.team_members(team_id)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TeamRemoveMember.rb

@@ -0,0 +1,22 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_api = Dropbox::Sign::TeamApi.new
+
+data = Dropbox::Sign::TeamRemoveMemberRequest.new
+data.email_address = "teammate@dropboxsign.com"
+data.new_owner_email_address = "new_teammate@dropboxsign.com"
+
+begin
+  result = team_api.team_remove_member(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TeamSubTeams.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_api = Dropbox::Sign::TeamApi.new
+
+team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"
+
+begin
+  result = team_api.team_sub_teams(team_id)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TeamUpdate.rb

@@ -0,0 +1,21 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_api = Dropbox::Sign::TeamApi.new
+
+data = Dropbox::Sign::TeamUpdateRequest.new
+data.name = "New Team Name"
+
+begin
+  result = team_api.team_update(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TemplateAddUser.rb

@@ -0,0 +1,23 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+data = Dropbox::Sign::TemplateAddUserRequest.new
+data.email_address = "george@dropboxsign.com"
+
+template_id = "f57db65d3f933b5316d398057a36176831451a35"
+
+begin
+  result = template_api.template_add_user(template_id, data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TemplateCreateEmbeddedDraft.rb

@@ -0,0 +1,49 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+role_1 = Dropbox::Sign::SubTemplateRole.new
+role_1.name = "Client"
+role_1.order = 0
+
+role_2 = Dropbox::Sign::SubTemplateRole.new
+role_2.name = "Witness"
+role_2.order = 1
+
+merge_field_1 = Dropbox::Sign::SubMergeField.new
+merge_field_1.name = "Full Name"
+merge_field_1.type = "text"
+
+merge_field_2 = Dropbox::Sign::SubMergeField.new
+merge_field_2.name = "Is Registered?"
+merge_field_2.type = "checkbox"
+
+field_options = Dropbox::Sign::SubFieldOptions.new
+field_options.date_format = "DD - MM - YYYY"
+
+data = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new
+data.client_id = "37dee8d8440c66d54cfa05d92c160882"
+data.files = [File.new("example_signature_request.pdf", "r")]
+data.title = "Test Template"
+data.subject = "Please sign this document"
+data.message = "For your approval"
+data.signer_roles = [role_1, role_2]
+data.cc_roles = ["Manager"]
+data.merge_fields = [merge_field_1, merge_field_2]
+data.field_options = field_options
+data.test_mode = true
+
+begin
+  result = template_api.template_create_embedded_draft(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TemplateDelete.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+template_id = "5de8179668f2033afac48da1868d0093bf133266"
+
+begin
+  result = template_api.template_delete(template_id)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TemplateFiles.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+template_id = "5de8179668f2033afac48da1868d0093bf133266"
+
+begin
+  file_bin = template_api.template_files(template_id)
+  FileUtils.cp(file_bin.path, "path/to/file.pdf")
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TemplateFilesAsDataUri.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+template_id = "5de8179668f2033afac48da1868d0093bf133266"
+
+begin
+  result = template_api.template_files_as_data_uri(template_id)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TemplateFilesAsFileUrl.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+template_id = "5de8179668f2033afac48da1868d0093bf133266"
+
+begin
+  result = template_api.template_files_as_file_url(template_id)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TemplateGet.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+template_id = "f57db65d3f933b5316d398057a36176831451a35"
+
+begin
+  result = template_api.template_get(template_id)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/TemplateList.rb

@@ -0,0 +1,20 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+account_id = "f57db65d3f933b5316d398057a36176831451a35"
+
+begin
+  result = template_api.template_list({account_id: account_id})
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end