dropbox-sign 1.7.0 → 1.9.0

data/docs/UnclaimedDraftApi.md

@@ -21,61 +21,39 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic
 ### Examples
 
 ```ruby
+require "json"
 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
 
-unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new
-
-signer_1 = Dropbox::Sign::SubUnclaimedDraftSigner.new
-signer_1.email_address = "jack@example.com"
-signer_1.name = "Jack"
-signer_1.order = 0
-
-signer_2 = Dropbox::Sign::SubUnclaimedDraftSigner.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 = false
-signing_options.default_type = "draw"
-
-field_options = Dropbox::Sign::SubFieldOptions.new
-field_options.date_format = "DD - MM - YYYY"
-
-data = Dropbox::Sign::UnclaimedDraftCreateRequest.new
-data.subject = "The NDA we talked about"
-data.type = "request_signature"
-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 = [
-  "lawyer1@dropboxsign.com",
-  "lawyer2@dropboxsign.com",
+signers_1 = Dropbox::Sign::SubUnclaimedDraftSigner.new
+signers_1.name = "Jack"
+signers_1.email_address = "jack@example.com"
+signers_1.order = 0
+
+signers = [
+    signers_1,
 ]
-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
+
+unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new
+unclaimed_draft_create_request.type = "request_signature"
+unclaimed_draft_create_request.test_mode = true
+unclaimed_draft_create_request.files = [
+    File.new("./example_signature_request.pdf", "r"),
+]
+unclaimed_draft_create_request.signers = signers
 
 begin
-  result = unclaimed_draft_api.unclaimed_draft_create(data)
-  p result
+  response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create(
+    unclaimed_draft_create_request,
+  )
+
+  p response
 rescue Dropbox::Sign::ApiError => e
-  puts "Exception when calling Dropbox Sign API: #{e}"
+  puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}"
 end
 
 ```
@@ -129,29 +107,30 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs
 ### Examples
 
 ```ruby
+require "json"
 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
 
-unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new
-
-data = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new
-data.client_id = "ec64a202072370a737edf4a0eb7f4437"
-data.files = [File.new("example_signature_request.pdf", "r")]
-data.requester_email_address = "jack@dropboxsign.com"
-data.test_mode = true
+unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new
+unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"
+unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com"
+unclaimed_draft_create_embedded_request.test_mode = true
+unclaimed_draft_create_embedded_request.files = [
+    File.new("./example_signature_request.pdf", "r"),
+]
 
 begin
-  result = unclaimed_draft_api.unclaimed_draft_create_embedded(data)
-  p result
+  response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded(
+    unclaimed_draft_create_embedded_request,
+  )
+
+  p response
 rescue Dropbox::Sign::ApiError => e
-  puts "Exception when calling Dropbox Sign API: #{e}"
+  puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}"
 end
 
 ```
@@ -205,40 +184,49 @@ Creates a new Draft with a previously saved template(s) that can be claimed and
 ### Examples
 
 ```ruby
+require "json"
 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
 
-unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new
+ccs_1 = Dropbox::Sign::SubCC.new
+ccs_1.role = "Accounting"
+ccs_1.email_address = "accounting@dropboxsign.com"
 
-signer_1 = Dropbox::Sign::SubUnclaimedDraftTemplateSigner.new
-signer_1.role = "Client"
-signer_1.name = "George"
-signer_1.email_address = "george@example.com"
+ccs = [
+    ccs_1,
+]
 
-cc_1 = Dropbox::Sign::SubCC.new
-cc_1.role = "Accounting"
-cc_1.email_address = "accounting@example.com"
+signers_1 = Dropbox::Sign::SubUnclaimedDraftTemplateSigner.new
+signers_1.role = "Client"
+signers_1.name = "George"
+signers_1.email_address = "george@example.com"
 
-data = Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest.new
-data.client_id = "ec64a202072370a737edf4a0eb7f4437"
-data.template_ids = ["61a832ff0d8423f91d503e76bfbcc750f7417c78"]
-data.requester_email_address = "jack@dropboxsign.com"
-data.signers = [signer_1]
-data.ccs = [cc_1]
-data.test_mode = true
+signers = [
+    signers_1,
+]
+
+unclaimed_draft_create_embedded_with_template_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest.new
+unclaimed_draft_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"
+unclaimed_draft_create_embedded_with_template_request.requester_email_address = "jack@dropboxsign.com"
+unclaimed_draft_create_embedded_with_template_request.template_ids = [
+    "61a832ff0d8423f91d503e76bfbcc750f7417c78",
+]
+unclaimed_draft_create_embedded_with_template_request.test_mode = false
+unclaimed_draft_create_embedded_with_template_request.ccs = ccs
+unclaimed_draft_create_embedded_with_template_request.signers = signers
 
 begin
-  result = unclaimed_draft_api.unclaimed_draft_create_embedded_with_template(data)
-  p result
+  response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded_with_template(
+    unclaimed_draft_create_embedded_with_template_request,
+  )
+
+  p response
 rescue Dropbox::Sign::ApiError => e
-  puts "Exception when calling Dropbox Sign API: #{e}"
+  puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: #{e}"
 end
 
 ```
@@ -292,29 +280,27 @@ Creates a new signature request from an embedded request that can be edited prio
 ### Examples
 
 ```ruby
+require "json"
 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
 
-unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new
-
-data = Dropbox::Sign::UnclaimedDraftEditAndResendRequest.new
-data.client_id = "ec64a202072370a737edf4a0eb7f4437"
-data.test_mode = true
-
-signature_request_id = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"
+unclaimed_draft_edit_and_resend_request = Dropbox::Sign::UnclaimedDraftEditAndResendRequest.new
+unclaimed_draft_edit_and_resend_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"
+unclaimed_draft_edit_and_resend_request.test_mode = false
 
 begin
-  result = unclaimed_draft_api.unclaimed_draft_edit_and_resend(signature_request_id, data)
-  p result
+  response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_edit_and_resend(
+    "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
+      unclaimed_draft_edit_and_resend_request,
+  )
+
+  p response
 rescue Dropbox::Sign::ApiError => e
-  puts "Exception when calling Dropbox Sign API: #{e}"
+  puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_edit_and_resend: #{e}"
 end
 
 ```

data/dropbox-sign.gemspec

@@ -8,7 +8,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.8.0
+Generator version: 7.12.0
 
 =end
 

data/examples/AccountCreateExample.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
+
+account_create_request = Dropbox::Sign::AccountCreateRequest.new
+account_create_request.email_address = "newuser@dropboxsign.com"
+
+begin
+  response = Dropbox::Sign::AccountApi.new.account_create(
+    account_create_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling AccountApi#account_create: #{e}"
+end

data/examples/AccountCreateOauthExample.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
+
+account_create_request = Dropbox::Sign::AccountCreateRequest.new
+account_create_request.email_address = "newuser@dropboxsign.com"
+account_create_request.client_id = "cc91c61d00f8bb2ece1428035716b"
+account_create_request.client_secret = "1d14434088507ffa390e6f5528465"
+
+begin
+  response = Dropbox::Sign::AccountApi.new.account_create(
+    account_create_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling AccountApi#account_create: #{e}"
+end

data/examples/AccountGetExample.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::AccountApi.new.account_get
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling AccountApi#account_get: #{e}"
+end

data/examples/AccountUpdateExample.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
+
+account_update_request = Dropbox::Sign::AccountUpdateRequest.new
+account_update_request.callback_url = "https://www.example.com/callback"
+account_update_request.locale = "en-US"
+
+begin
+  response = Dropbox::Sign::AccountApi.new.account_update(
+    account_update_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling AccountApi#account_update: #{e}"
+end

data/examples/AccountVerifyExample.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
+
+account_verify_request = Dropbox::Sign::AccountVerifyRequest.new
+account_verify_request.email_address = "some_user@dropboxsign.com"
+
+begin
+  response = Dropbox::Sign::AccountApi.new.account_verify(
+    account_verify_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling AccountApi#account_verify: #{e}"
+end

data/examples/ApiAppCreateExample.rb

@@ -0,0 +1,37 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+oauth = Dropbox::Sign::SubOAuth.new
+oauth.callback_url = "https://example.com/oauth"
+oauth.scopes = [
+    "basic_account_info",
+    "request_signature",
+]
+
+white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new
+white_labeling_options.primary_button_color = "#00b3e6"
+white_labeling_options.primary_button_text_color = "#ffffff"
+
+api_app_create_request = Dropbox::Sign::ApiAppCreateRequest.new
+api_app_create_request.name = "My Production App"
+api_app_create_request.domains = [
+    "example.com",
+]
+api_app_create_request.custom_logo_file = File.new("CustomLogoFile.png", "r")
+api_app_create_request.oauth = oauth
+api_app_create_request.white_labeling_options = white_labeling_options
+
+begin
+  response = Dropbox::Sign::ApiAppApi.new.api_app_create(
+    api_app_create_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling ApiAppApi#api_app_create: #{e}"
+end

data/examples/ApiAppDeleteExample.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
+  Dropbox::Sign::ApiAppApi.new.api_app_delete(
+    "0dd3b823a682527788c4e40cb7b6f7e9", # client_id
+  )
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling ApiAppApi#api_app_delete: #{e}"
+end

data/examples/ApiAppGetExample.rb

@@ -0,0 +1,17 @@
+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::ApiAppApi.new.api_app_get(
+    "0dd3b823a682527788c4e40cb7b6f7e9", # client_id
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling ApiAppApi#api_app_get: #{e}"
+end

data/examples/ApiAppListExample.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
+
+begin
+  response = Dropbox::Sign::ApiAppApi.new.api_app_list(
+    {
+          page: 1,
+          page_size: 20,
+      },
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling ApiAppApi#api_app_list: #{e}"
+end

data/examples/ApiAppUpdateExample.rb

@@ -0,0 +1,39 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+oauth = Dropbox::Sign::SubOAuth.new
+oauth.callback_url = "https://example.com/oauth"
+oauth.scopes = [
+    "basic_account_info",
+    "request_signature",
+]
+
+white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new
+white_labeling_options.primary_button_color = "#00b3e6"
+white_labeling_options.primary_button_text_color = "#ffffff"
+
+api_app_update_request = Dropbox::Sign::ApiAppUpdateRequest.new
+api_app_update_request.callback_url = "https://example.com/dropboxsign"
+api_app_update_request.name = "New Name"
+api_app_update_request.domains = [
+    "example.com",
+]
+api_app_update_request.custom_logo_file = File.new("CustomLogoFile.png", "r")
+api_app_update_request.oauth = oauth
+api_app_update_request.white_labeling_options = white_labeling_options
+
+begin
+  response = Dropbox::Sign::ApiAppApi.new.api_app_update(
+    "0dd3b823a682527788c4e40cb7b6f7e9", # client_id
+      api_app_update_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling ApiAppApi#api_app_update: #{e}"
+end

data/examples/BulkSendJobGetExample.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::BulkSendJobApi.new.bulk_send_job_get(
+    "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", # bulk_send_job_id
+      {
+          page: 1,
+          page_size: 20,
+      },
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling BulkSendJobApi#bulk_send_job_get: #{e}"
+end

data/examples/BulkSendJobListExample.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
+
+begin
+  response = Dropbox::Sign::BulkSendJobApi.new.bulk_send_job_list(
+    {
+          page: 1,
+          page_size: 20,
+      },
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling BulkSendJobApi#bulk_send_job_list: #{e}"
+end

data/examples/EmbeddedEditUrlExample.rb

@@ -0,0 +1,27 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+merge_fields = [
+]
+
+embedded_edit_url_request = Dropbox::Sign::EmbeddedEditUrlRequest.new
+embedded_edit_url_request.cc_roles = [
+    "",
+]
+embedded_edit_url_request.merge_fields = merge_fields
+
+begin
+  response = Dropbox::Sign::EmbeddedApi.new.embedded_edit_url(
+    "f57db65d3f933b5316d398057a36176831451a35", # template_id
+      embedded_edit_url_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling EmbeddedApi#embedded_edit_url: #{e}"
+end

data/examples/EmbeddedSignUrlExample.rb

@@ -0,0 +1,17 @@
+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::EmbeddedApi.new.embedded_sign_url(
+    "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", # signature_id
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling EmbeddedApi#embedded_sign_url: #{e}"
+end

data/examples/FaxDeleteExample.rb

@@ -0,0 +1,14 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+end
+
+begin
+  Dropbox::Sign::FaxApi.new.fax_delete(
+    "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id
+  )
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling FaxApi#fax_delete: #{e}"
+end

data/examples/FaxFilesExample.rb

@@ -0,0 +1,16 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+end
+
+begin
+  response = Dropbox::Sign::FaxApi.new.fax_files(
+    "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id
+  )
+
+  FileUtils.cp(response.path, "./file_response")
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling FaxApi#fax_files: #{e}"
+end

data/examples/FaxGetExample.rb

@@ -0,0 +1,16 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+end
+
+begin
+  response = Dropbox::Sign::FaxApi.new.fax_get(
+    "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling FaxApi#fax_get: #{e}"
+end

data/examples/FaxLineAddUserExample.rb

@@ -0,0 +1,20 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+end
+
+fax_line_add_user_request = Dropbox::Sign::FaxLineAddUserRequest.new
+fax_line_add_user_request.number = "[FAX_NUMBER]"
+fax_line_add_user_request.email_address = "member@dropboxsign.com"
+
+begin
+  response = Dropbox::Sign::FaxLineApi.new.fax_line_add_user(
+    fax_line_add_user_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling FaxLineApi#fax_line_add_user: #{e}"
+end

data/examples/FaxLineAreaCodeGetExample.rb

@@ -0,0 +1,16 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+end
+
+begin
+  response = Dropbox::Sign::FaxLineApi.new.fax_line_area_code_get(
+    "US", # country
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling FaxLineApi#fax_line_area_code_get: #{e}"
+end