dropbox-sign 1.7.0 → 1.9.0

data/examples/SignatureRequestSendWithTemplateExample.rb

@@ -0,0 +1,63 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+signing_options = Dropbox::Sign::SubSigningOptions.new
+signing_options.default_type = "draw"
+signing_options.draw = true
+signing_options.phone = false
+signing_options.type = true
+signing_options.upload = true
+
+signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
+signers_1.role = "Client"
+signers_1.name = "George"
+signers_1.email_address = "george@example.com"
+
+signers = [
+    signers_1,
+]
+
+ccs_1 = Dropbox::Sign::SubCC.new
+ccs_1.role = "Accounting"
+ccs_1.email_address = "accounting@example.com"
+
+ccs = [
+    ccs_1,
+]
+
+custom_fields_1 = Dropbox::Sign::SubCustomField.new
+custom_fields_1.name = "Cost"
+custom_fields_1.editor = "Client"
+custom_fields_1.required = true
+custom_fields_1.value = "$20,000"
+
+custom_fields = [
+    custom_fields_1,
+]
+
+signature_request_send_with_template_request = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new
+signature_request_send_with_template_request.template_ids = [
+    "61a832ff0d8423f91d503e76bfbcc750f7417c78",
+]
+signature_request_send_with_template_request.message = "Glad we could come to an agreement."
+signature_request_send_with_template_request.subject = "Purchase Order"
+signature_request_send_with_template_request.test_mode = true
+signature_request_send_with_template_request.signing_options = signing_options
+signature_request_send_with_template_request.signers = signers
+signature_request_send_with_template_request.ccs = ccs
+signature_request_send_with_template_request.custom_fields = custom_fields
+
+begin
+  response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send_with_template(
+    signature_request_send_with_template_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling SignatureRequestApi#signature_request_send_with_template: #{e}"
+end

data/examples/SignatureRequestUpdateExample.rb

@@ -0,0 +1,22 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+signature_request_update_request = Dropbox::Sign::SignatureRequestUpdateRequest.new
+signature_request_update_request.signature_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
+signature_request_update_request.email_address = "john@example.com"
+
+begin
+  response = Dropbox::Sign::SignatureRequestApi.new.signature_request_update(
+    "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
+      signature_request_update_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling SignatureRequestApi#signature_request_update: #{e}"
+end

data/examples/TeamAddMemberAccountIdExample.rb

@@ -0,0 +1,23 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_add_member_request = Dropbox::Sign::TeamAddMemberRequest.new
+team_add_member_request.account_id = "f57db65d3f933b5316d398057a36176831451a35"
+
+begin
+  response = Dropbox::Sign::TeamApi.new.team_add_member(
+    team_add_member_request,
+      {
+          team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c",
+      },
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_add_member: #{e}"
+end

data/examples/TeamAddMemberExample.rb

@@ -0,0 +1,23 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_add_member_request = Dropbox::Sign::TeamAddMemberRequest.new
+team_add_member_request.email_address = "george@example.com"
+
+begin
+  response = Dropbox::Sign::TeamApi.new.team_add_member(
+    team_add_member_request,
+      {
+          team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c",
+      },
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_add_member: #{e}"
+end

data/examples/TeamCreateExample.rb

@@ -0,0 +1,20 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_create_request = Dropbox::Sign::TeamCreateRequest.new
+team_create_request.name = "New Team Name"
+
+begin
+  response = Dropbox::Sign::TeamApi.new.team_create(
+    team_create_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_create: #{e}"
+end

data/examples/TeamDeleteExample.rb

@@ -0,0 +1,13 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+begin
+  Dropbox::Sign::TeamApi.new.team_delete
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_delete: #{e}"
+end

data/examples/TeamGetExample.rb

@@ -0,0 +1,15 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+begin
+  response = Dropbox::Sign::TeamApi.new.team_get
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_get: #{e}"
+end

data/examples/TeamInfoExample.rb

@@ -0,0 +1,19 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+begin
+  response = Dropbox::Sign::TeamApi.new.team_info(
+    {
+          team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c",
+      },
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_info: #{e}"
+end

data/examples/TeamInvitesExample.rb

@@ -0,0 +1,15 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+begin
+  response = Dropbox::Sign::TeamApi.new.team_invites
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_invites: #{e}"
+end

data/examples/TeamMembersExample.rb

@@ -0,0 +1,21 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+begin
+  response = Dropbox::Sign::TeamApi.new.team_members(
+    "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", # team_id
+      {
+          page: 1,
+          page_size: 20,
+      },
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_members: #{e}"
+end

data/examples/TeamRemoveMemberAccountIdExample.rb

@@ -0,0 +1,20 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_remove_member_request = Dropbox::Sign::TeamRemoveMemberRequest.new
+team_remove_member_request.account_id = "f57db65d3f933b5316d398057a36176831451a35"
+
+begin
+  response = Dropbox::Sign::TeamApi.new.team_remove_member(
+    team_remove_member_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_remove_member: #{e}"
+end

data/examples/TeamRemoveMemberExample.rb

@@ -0,0 +1,21 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_remove_member_request = Dropbox::Sign::TeamRemoveMemberRequest.new
+team_remove_member_request.email_address = "teammate@dropboxsign.com"
+team_remove_member_request.new_owner_email_address = "new_teammate@dropboxsign.com"
+
+begin
+  response = Dropbox::Sign::TeamApi.new.team_remove_member(
+    team_remove_member_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_remove_member: #{e}"
+end

data/examples/TeamSubTeamsExample.rb

@@ -0,0 +1,21 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+begin
+  response = Dropbox::Sign::TeamApi.new.team_sub_teams(
+    "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", # team_id
+      {
+          page: 1,
+          page_size: 20,
+      },
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_sub_teams: #{e}"
+end

data/examples/TeamUpdateExample.rb

@@ -0,0 +1,20 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+team_update_request = Dropbox::Sign::TeamUpdateRequest.new
+team_update_request.name = "New Team Name"
+
+begin
+  response = Dropbox::Sign::TeamApi.new.team_update(
+    team_update_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TeamApi#team_update: #{e}"
+end

data/examples/TemplateAddUserExample.rb

@@ -0,0 +1,21 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_add_user_request = Dropbox::Sign::TemplateAddUserRequest.new
+template_add_user_request.email_address = "george@dropboxsign.com"
+
+begin
+  response = Dropbox::Sign::TemplateApi.new.template_add_user(
+    "f57db65d3f933b5316d398057a36176831451a35", # template_id
+      template_add_user_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TemplateApi#template_add_user: #{e}"
+end

data/examples/TemplateCreateEmbeddedDraftExample.rb

@@ -0,0 +1,62 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+field_options = Dropbox::Sign::SubFieldOptions.new
+field_options.date_format = "DD - MM - YYYY"
+
+merge_fields_1 = Dropbox::Sign::SubMergeField.new
+merge_fields_1.name = "Full Name"
+merge_fields_1.type = "text"
+
+merge_fields_2 = Dropbox::Sign::SubMergeField.new
+merge_fields_2.name = "Is Registered?"
+merge_fields_2.type = "checkbox"
+
+merge_fields = [
+    merge_fields_1,
+    merge_fields_2,
+]
+
+signer_roles_1 = Dropbox::Sign::SubTemplateRole.new
+signer_roles_1.name = "Client"
+signer_roles_1.order = 0
+
+signer_roles_2 = Dropbox::Sign::SubTemplateRole.new
+signer_roles_2.name = "Witness"
+signer_roles_2.order = 1
+
+signer_roles = [
+    signer_roles_1,
+    signer_roles_2,
+]
+
+template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new
+template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882"
+template_create_embedded_draft_request.message = "For your approval"
+template_create_embedded_draft_request.subject = "Please sign this document"
+template_create_embedded_draft_request.test_mode = true
+template_create_embedded_draft_request.title = "Test Template"
+template_create_embedded_draft_request.cc_roles = [
+    "Manager",
+]
+template_create_embedded_draft_request.files = [
+    File.new("./example_signature_request.pdf", "r"),
+]
+template_create_embedded_draft_request.field_options = field_options
+template_create_embedded_draft_request.merge_fields = merge_fields
+template_create_embedded_draft_request.signer_roles = signer_roles
+
+begin
+  response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft(
+    template_create_embedded_draft_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}"
+end

data/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb

@@ -0,0 +1,108 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+field_options = Dropbox::Sign::SubFieldOptions.new
+field_options.date_format = "DD - MM - YYYY"
+
+form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new
+form_field_groups_1.group_id = "RadioItemGroup1"
+form_field_groups_1.group_label = "Radio Item Group 1"
+form_field_groups_1.requirement = "require_0-1"
+
+form_field_groups = [
+    form_field_groups_1,
+]
+
+form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new
+form_fields_per_document_1.document_index = 0
+form_fields_per_document_1.api_id = "uniqueIdHere_1"
+form_fields_per_document_1.type = "radio"
+form_fields_per_document_1.required = false
+form_fields_per_document_1.signer = "0"
+form_fields_per_document_1.width = 18
+form_fields_per_document_1.height = 18
+form_fields_per_document_1.x = 112
+form_fields_per_document_1.y = 328
+form_fields_per_document_1.group = "RadioItemGroup1"
+form_fields_per_document_1.is_checked = true
+form_fields_per_document_1.name = ""
+form_fields_per_document_1.page = 1
+
+form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new
+form_fields_per_document_2.document_index = 0
+form_fields_per_document_2.api_id = "uniqueIdHere_2"
+form_fields_per_document_2.type = "radio"
+form_fields_per_document_2.required = false
+form_fields_per_document_2.signer = "0"
+form_fields_per_document_2.width = 18
+form_fields_per_document_2.height = 18
+form_fields_per_document_2.x = 112
+form_fields_per_document_2.y = 370
+form_fields_per_document_2.group = "RadioItemGroup1"
+form_fields_per_document_2.is_checked = false
+form_fields_per_document_2.name = ""
+form_fields_per_document_2.page = 1
+
+form_fields_per_document = [
+    form_fields_per_document_1,
+    form_fields_per_document_2,
+]
+
+merge_fields_1 = Dropbox::Sign::SubMergeField.new
+merge_fields_1.name = "Full Name"
+merge_fields_1.type = "text"
+
+merge_fields_2 = Dropbox::Sign::SubMergeField.new
+merge_fields_2.name = "Is Registered?"
+merge_fields_2.type = "checkbox"
+
+merge_fields = [
+    merge_fields_1,
+    merge_fields_2,
+]
+
+signer_roles_1 = Dropbox::Sign::SubTemplateRole.new
+signer_roles_1.name = "Client"
+signer_roles_1.order = 0
+
+signer_roles_2 = Dropbox::Sign::SubTemplateRole.new
+signer_roles_2.name = "Witness"
+signer_roles_2.order = 1
+
+signer_roles = [
+    signer_roles_1,
+    signer_roles_2,
+]
+
+template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new
+template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882"
+template_create_embedded_draft_request.message = "For your approval"
+template_create_embedded_draft_request.subject = "Please sign this document"
+template_create_embedded_draft_request.test_mode = true
+template_create_embedded_draft_request.title = "Test Template"
+template_create_embedded_draft_request.file_urls = [
+    "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1",
+]
+template_create_embedded_draft_request.cc_roles = [
+    "Manager",
+]
+template_create_embedded_draft_request.field_options = field_options
+template_create_embedded_draft_request.form_field_groups = form_field_groups
+template_create_embedded_draft_request.form_fields_per_document = form_fields_per_document
+template_create_embedded_draft_request.merge_fields = merge_fields
+template_create_embedded_draft_request.signer_roles = signer_roles
+
+begin
+  response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft(
+    template_create_embedded_draft_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}"
+end

data/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb

@@ -0,0 +1,124 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new
+form_field_rules_1_triggers_1.id = "uniqueIdHere_1"
+form_field_rules_1_triggers_1.operator = "is"
+form_field_rules_1_triggers_1.value = "foo"
+
+form_field_rules_1_triggers = [
+    form_field_rules_1_triggers_1,
+]
+
+form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new
+form_field_rules_1_actions_1.hidden = true
+form_field_rules_1_actions_1.type = "change-field-visibility"
+form_field_rules_1_actions_1.field_id = "uniqueIdHere_2"
+
+form_field_rules_1_actions = [
+    form_field_rules_1_actions_1,
+]
+
+field_options = Dropbox::Sign::SubFieldOptions.new
+field_options.date_format = "DD - MM - YYYY"
+
+form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new
+form_field_rules_1.id = "rule_1"
+form_field_rules_1.trigger_operator = "AND"
+form_field_rules_1.triggers = form_field_rules_1_triggers
+form_field_rules_1.actions = form_field_rules_1_actions
+
+form_field_rules = [
+    form_field_rules_1,
+]
+
+form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new
+form_fields_per_document_1.document_index = 0
+form_fields_per_document_1.api_id = "uniqueIdHere_1"
+form_fields_per_document_1.type = "text"
+form_fields_per_document_1.required = true
+form_fields_per_document_1.signer = "0"
+form_fields_per_document_1.width = 100
+form_fields_per_document_1.height = 16
+form_fields_per_document_1.x = 112
+form_fields_per_document_1.y = 328
+form_fields_per_document_1.name = ""
+form_fields_per_document_1.page = 1
+form_fields_per_document_1.validation_type = "numbers_only"
+
+form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new
+form_fields_per_document_2.document_index = 0
+form_fields_per_document_2.api_id = "uniqueIdHere_2"
+form_fields_per_document_2.type = "signature"
+form_fields_per_document_2.required = true
+form_fields_per_document_2.signer = "0"
+form_fields_per_document_2.width = 120
+form_fields_per_document_2.height = 30
+form_fields_per_document_2.x = 530
+form_fields_per_document_2.y = 415
+form_fields_per_document_2.name = ""
+form_fields_per_document_2.page = 1
+
+form_fields_per_document = [
+    form_fields_per_document_1,
+    form_fields_per_document_2,
+]
+
+merge_fields_1 = Dropbox::Sign::SubMergeField.new
+merge_fields_1.name = "Full Name"
+merge_fields_1.type = "text"
+
+merge_fields_2 = Dropbox::Sign::SubMergeField.new
+merge_fields_2.name = "Is Registered?"
+merge_fields_2.type = "checkbox"
+
+merge_fields = [
+    merge_fields_1,
+    merge_fields_2,
+]
+
+signer_roles_1 = Dropbox::Sign::SubTemplateRole.new
+signer_roles_1.name = "Client"
+signer_roles_1.order = 0
+
+signer_roles_2 = Dropbox::Sign::SubTemplateRole.new
+signer_roles_2.name = "Witness"
+signer_roles_2.order = 1
+
+signer_roles = [
+    signer_roles_1,
+    signer_roles_2,
+]
+
+template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new
+template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882"
+template_create_embedded_draft_request.message = "For your approval"
+template_create_embedded_draft_request.subject = "Please sign this document"
+template_create_embedded_draft_request.test_mode = true
+template_create_embedded_draft_request.title = "Test Template"
+template_create_embedded_draft_request.file_urls = [
+    "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1",
+]
+template_create_embedded_draft_request.cc_roles = [
+    "Manager",
+]
+template_create_embedded_draft_request.field_options = field_options
+template_create_embedded_draft_request.form_field_rules = form_field_rules
+template_create_embedded_draft_request.form_fields_per_document = form_fields_per_document
+template_create_embedded_draft_request.merge_fields = merge_fields
+template_create_embedded_draft_request.signer_roles = signer_roles
+
+begin
+  response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft(
+    template_create_embedded_draft_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}"
+end