diff --git a/.travis.yml b/.travis.yml index 6e95dec..5731dc5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,4 +8,4 @@ script: - bundle install --path vendor/bundle - bundle exec rspec - gem build dropbox-sign.gemspec - - gem install ./dropbox-sign-1.8.0.gem + - gem install ./dropbox-sign-1.9.0.gem diff --git a/Gemfile.lock b/Gemfile.lock index 633c21b..f1b43bb 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - dropbox-sign (1.8.0) + dropbox-sign (1.9.0) typhoeus (~> 1.0, >= 1.0.1) GEM @@ -13,10 +13,10 @@ GEM diff-lcs (1.5.1) ethon (0.16.0) ffi (>= 1.15.0) - ffi (1.17.0-aarch64-linux-gnu) - ffi (1.17.0-arm64-darwin) - ffi (1.17.0-x86_64-darwin) - ffi (1.17.0-x86_64-linux-gnu) + ffi (1.17.2-aarch64-linux-gnu) + ffi (1.17.2-arm64-darwin) + ffi (1.17.2-x86_64-darwin) + ffi (1.17.2-x86_64-linux-gnu) json (2.7.2) json_spec (1.1.5) multi_json (~> 1.0) diff --git a/README.md b/README.md index d0c05fc..1a7027f 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,8 @@ directory that corresponds to the file you want updated. This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 3.0.0 -- Package version: 1.8.0 -- Generator version: 7.8.0 +- Package version: 1.9.0 +- Generator version: 7.12.0 - Build package: org.openapitools.codegen.languages.RubyClientCodegen ## Installation @@ -47,15 +47,15 @@ gem build dropbox-sign.gemspec Then install the gem locally: ```shell -gem install ./dropbox-sign-1.8.0.gem +gem install ./dropbox-sign-1.9.0.gem ``` -(for development, run `gem install --dev ./dropbox-sign-1.8.0.gem` to install the development dependencies) +(for development, run `gem install --dev ./dropbox-sign-1.9.0.gem` to install the development dependencies) Finally add this to the Gemfile: - gem 'dropbox-sign', '~> 1.8.0' + gem 'dropbox-sign', '~> 1.9.0' ### Install from Git @@ -77,26 +77,25 @@ Please follow the [installation](#installation) procedure and then run the follo ```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 -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountCreateRequest.new -data.email_address = "newuser@dropboxsign.com" +account_create_request = Dropbox::Sign::AccountCreateRequest.new +account_create_request.email_address = "newuser@dropboxsign.com" begin - result = account_api.account_create(data) - p result + response = Dropbox::Sign::AccountApi.new.account_create( + account_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling AccountApi#account_create: #{e}" end ``` @@ -122,7 +121,7 @@ All URIs are relative to *https://api.hellosign.com/v3* |*Dropbox::Sign::EmbeddedApi* | [**embedded_edit_url**](docs/EmbeddedApi.md#embedded_edit_url) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | |*Dropbox::Sign::EmbeddedApi* | [**embedded_sign_url**](docs/EmbeddedApi.md#embedded_sign_url) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | |*Dropbox::Sign::FaxApi* | [**fax_delete**](docs/FaxApi.md#fax_delete) | **DELETE** /fax/{fax_id} | Delete Fax | -|*Dropbox::Sign::FaxApi* | [**fax_files**](docs/FaxApi.md#fax_files) | **GET** /fax/files/{fax_id} | List Fax Files | +|*Dropbox::Sign::FaxApi* | [**fax_files**](docs/FaxApi.md#fax_files) | **GET** /fax/files/{fax_id} | Download Fax Files | |*Dropbox::Sign::FaxApi* | [**fax_get**](docs/FaxApi.md#fax_get) | **GET** /fax/{fax_id} | Get Fax | |*Dropbox::Sign::FaxApi* | [**fax_list**](docs/FaxApi.md#fax_list) | **GET** /fax/list | Lists Faxes | |*Dropbox::Sign::FaxApi* | [**fax_send**](docs/FaxApi.md#fax_send) | **POST** /fax/send | Send Fax | @@ -141,6 +140,10 @@ All URIs are relative to *https://api.hellosign.com/v3* |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_cancel**](docs/SignatureRequestApi.md#signature_request_cancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request | |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_create_embedded**](docs/SignatureRequestApi.md#signature_request_create_embedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request | |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_create_embedded_with_template**](docs/SignatureRequestApi.md#signature_request_create_embedded_with_template) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template | +|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit**](docs/SignatureRequestApi.md#signature_request_edit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request | +|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_embedded**](docs/SignatureRequestApi.md#signature_request_edit_embedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request | +|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_embedded_with_template**](docs/SignatureRequestApi.md#signature_request_edit_embedded_with_template) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template | +|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_with_template**](docs/SignatureRequestApi.md#signature_request_edit_with_template) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template | |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files**](docs/SignatureRequestApi.md#signature_request_files) | **GET** /signature_request/files/{signature_request_id} | Download Files | |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files_as_data_uri**](docs/SignatureRequestApi.md#signature_request_files_as_data_uri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri | |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files_as_file_url**](docs/SignatureRequestApi.md#signature_request_files_as_file_url) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url | @@ -244,6 +247,10 @@ All URIs are relative to *https://api.hellosign.com/v3* - [Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md) - [Dropbox::Sign::SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md) - [Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md) + - [Dropbox::Sign::SignatureRequestEditEmbeddedRequest](docs/SignatureRequestEditEmbeddedRequest.md) + - [Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest](docs/SignatureRequestEditEmbeddedWithTemplateRequest.md) + - [Dropbox::Sign::SignatureRequestEditRequest](docs/SignatureRequestEditRequest.md) + - [Dropbox::Sign::SignatureRequestEditWithTemplateRequest](docs/SignatureRequestEditWithTemplateRequest.md) - [Dropbox::Sign::SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md) - [Dropbox::Sign::SignatureRequestListResponse](docs/SignatureRequestListResponse.md) - [Dropbox::Sign::SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md) diff --git a/VERSION b/VERSION index 27f9cd3..f8e233b 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.8.0 +1.9.0 diff --git a/docs/AccountApi.md b/docs/AccountApi.md index d2c439d..ebae714 100644 --- a/docs/AccountApi.md +++ b/docs/AccountApi.md @@ -21,26 +21,25 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ ### 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 -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountCreateRequest.new -data.email_address = "newuser@dropboxsign.com" +account_create_request = Dropbox::Sign::AccountCreateRequest.new +account_create_request.email_address = "newuser@dropboxsign.com" begin - result = account_api.account_create(data) - p result + response = Dropbox::Sign::AccountApi.new.account_create( + account_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling AccountApi#account_create: #{e}" end ``` @@ -94,23 +93,20 @@ Returns the properties and settings of your Account. ### 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 -account_api = Dropbox::Sign::AccountApi.new - begin - result = account_api.account_get({ email_address: "jack@example.com" }) - p result + response = Dropbox::Sign::AccountApi.new.account_get + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling AccountApi#account_get: #{e}" end ``` @@ -165,26 +161,26 @@ Updates the properties and settings of your Account. Currently only allows for u ### 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 -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountUpdateRequest.new -data.callback_url = "https://www.example.com/callback" +account_update_request = Dropbox::Sign::AccountUpdateRequest.new +account_update_request.callback_url = "https://www.example.com/callback" +account_update_request.locale = "en-US" begin - result = account_api.account_update(data) - p result + response = Dropbox::Sign::AccountApi.new.account_update( + account_update_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling AccountApi#account_update: #{e}" end ``` @@ -238,26 +234,25 @@ Verifies whether an Dropbox Sign Account exists for the given email address. ### 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 -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountVerifyRequest.new -data.email_address = "some_user@dropboxsign.com" +account_verify_request = Dropbox::Sign::AccountVerifyRequest.new +account_verify_request.email_address = "some_user@dropboxsign.com" begin - result = account_api.account_verify(data) - p result + response = Dropbox::Sign::AccountApi.new.account_verify( + account_verify_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling AccountApi#account_verify: #{e}" end ``` diff --git a/docs/ApiAppApi.md b/docs/ApiAppApi.md index 4a32626..10b5fac 100644 --- a/docs/ApiAppApi.md +++ b/docs/ApiAppApi.md @@ -22,40 +22,42 @@ Creates a new API App. ### 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 -api_app_api = Dropbox::Sign::ApiAppApi.new - oauth = Dropbox::Sign::SubOAuth.new oauth.callback_url = "https://example.com/oauth" -oauth.scopes = %w[basic_account_info request_signature] +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" -custom_logo_file = File.new('./CustomLogoFile.png') - -data = Dropbox::Sign::ApiAppCreateRequest.new -data.name = "My Production App" -data.domains = ["example.com"] -data.oauth = oauth -data.white_labeling_options = white_labeling_options -data.custom_logo_file = custom_logo_file +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 - result = api_app_api.api_app_create(data) - p result + response = Dropbox::Sign::ApiAppApi.new.api_app_create( + api_app_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling ApiAppApi#api_app_create: #{e}" end ``` @@ -109,25 +111,20 @@ Deletes an API App. Can only be invoked for apps you own. ### 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 -api_app_api = Dropbox::Sign::ApiAppApi.new - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - begin - result = api_app_api.api_app_delete(client_id) - p result + Dropbox::Sign::ApiAppApi.new.api_app_delete( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling ApiAppApi#api_app_delete: #{e}" end ``` @@ -181,25 +178,22 @@ Returns an object with information about an API App. ### 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 -api_app_api = Dropbox::Sign::ApiAppApi.new - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - begin - result = api_app_api.api_app_get(client_id) - p result + response = Dropbox::Sign::ApiAppApi.new.api_app_get( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling ApiAppApi#api_app_get: #{e}" end ``` @@ -253,26 +247,25 @@ Returns a list of API Apps that are accessible by you. If you are on a team with ### 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 -api_app_api = Dropbox::Sign::ApiAppApi.new - -page = 1 -page_size = 2 - begin - result = api_app_api.api_app_list({ page: page, page_size: page_size }) - p result + response = Dropbox::Sign::ApiAppApi.new.api_app_list( + { + page: 1, + page_size: 20, + }, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling ApiAppApi#api_app_list: #{e}" end ``` @@ -327,37 +320,44 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel ### 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 -api_app_api = Dropbox::Sign::ApiAppApi.new +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" -custom_logo_file = File.new('./CustomLogoFile.png') - -data = Dropbox::Sign::ApiAppUpdateRequest.new -data.name = "New Name" -data.callback_url = "http://example.com/dropboxsign" -data.white_labeling_options = white_labeling_options -data.custom_logo_file = custom_logo_file - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" +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 - result = api_app_api.api_app_update(client_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling ApiAppApi#api_app_update: #{e}" end ``` diff --git a/docs/BulkSendJobApi.md b/docs/BulkSendJobApi.md index bb42dd6..0771fbc 100644 --- a/docs/BulkSendJobApi.md +++ b/docs/BulkSendJobApi.md @@ -19,25 +19,26 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the ### 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 -bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new - -bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174" - begin - result = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling BulkSendJobApi#bulk_send_job_get: #{e}" end ``` @@ -93,26 +94,25 @@ Returns a list of BulkSendJob that you can access. ### 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 -bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new - -page = 1 -page_size = 20 - begin - result = bulk_send_job_api.bulk_send_job_list({ page: page, page_size: page_size }) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling BulkSendJobApi#bulk_send_job_list: #{e}" end ``` diff --git a/docs/EmbeddedApi.md b/docs/EmbeddedApi.md index af26da6..998c914 100644 --- a/docs/EmbeddedApi.md +++ b/docs/EmbeddedApi.md @@ -19,29 +19,32 @@ Retrieves an embedded object containing a template url that can be opened in an ### 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 -api = Dropbox::Sign::EmbeddedApi.new - -data = Dropbox::Sign::EmbeddedEditUrlRequest.new -data.cc_roles = [""] -data.merge_fields = [] +merge_fields = [ +] -template_id = "5de8179668f2033afac48da1868d0093bf133266" +embedded_edit_url_request = Dropbox::Sign::EmbeddedEditUrlRequest.new +embedded_edit_url_request.cc_roles = [ + "", +] +embedded_edit_url_request.merge_fields = merge_fields begin - result = embedded_api.embedded_edit_url(template_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling EmbeddedApi#embedded_edit_url: #{e}" end ``` @@ -96,25 +99,22 @@ Retrieves an embedded object containing a signature url that can be opened in an ### 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 -api = Dropbox::Sign::EmbeddedApi.new - -signature_id = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" - begin - result = embedded_api.embedded_sign_url(signature_id) - p result + response = Dropbox::Sign::EmbeddedApi.new.embedded_sign_url( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", # signature_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling EmbeddedApi#embedded_sign_url: #{e}" end ``` diff --git a/docs/FaxApi.md b/docs/FaxApi.md index 23129b6..310c9a3 100644 --- a/docs/FaxApi.md +++ b/docs/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [`fax_delete`](FaxApi.md#fax_delete) | **DELETE** `/fax/{fax_id}` | Delete Fax | -| [`fax_files`](FaxApi.md#fax_files) | **GET** `/fax/files/{fax_id}` | List Fax Files | +| [`fax_files`](FaxApi.md#fax_files) | **GET** `/fax/files/{fax_id}` | Download Fax Files | | [`fax_get`](FaxApi.md#fax_get) | **GET** `/fax/{fax_id}` | Get Fax | | [`fax_list`](FaxApi.md#fax_list) | **GET** `/fax/list` | Lists Faxes | | [`fax_send`](FaxApi.md#fax_send) | **POST** `/fax/send` | Send Fax | @@ -17,24 +17,24 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_api = Dropbox::Sign::FaxApi.new - begin - fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") + Dropbox::Sign::FaxApi.new.fax_delete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxApi#fax_delete: #{e}" end ``` @@ -81,29 +81,28 @@ nil (empty response body) > `File fax_files(fax_id)` -List Fax Files +Download Fax Files -Returns list of fax files +Downloads files associated with a Fax ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_api = Dropbox::Sign::FaxApi.new - -faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - file_bin = fax_api.fax_files(data) - FileUtils.cp(file_bin.path, "path/to/file.pdf") + 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 Dropbox Sign API: #{e}" + puts "Exception when calling FaxApi#fax_files: #{e}" end ``` @@ -116,7 +115,7 @@ This returns an Array which contains the response data, status code and headers. ```ruby begin - # List Fax Files + # Download Fax Files data, status_code, headers = api_instance.fax_files_with_http_info(fax_id) p status_code # => 2xx p headers # => { ... } @@ -152,27 +151,26 @@ end Get Fax -Returns information about fax +Returns information about a Fax ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_api = Dropbox::Sign::FaxApi.new - -fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - result = fax_api.fax_get(fax_id) - p result + response = Dropbox::Sign::FaxApi.new.fax_get( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxApi#fax_get: #{e}" end ``` @@ -221,28 +219,29 @@ end Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_api = Dropbox::Sign::FaxApi.new - -page = 1 -page_size = 2 - begin - result = fax_api.fax_list({ page: page, page_size: page_size }) - p result + response = Dropbox::Sign::FaxApi.new.fax_list( + { + page: 1, + page_size: 20, + }, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxApi#fax_list: #{e}" end ``` @@ -269,8 +268,8 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `page` | **Integer** | Page | [optional][default to 1] | -| `page_size` | **Integer** | Page size | [optional][default to 20] | +| `page` | **Integer** | Which page number of the Fax List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | ### Return type @@ -292,35 +291,38 @@ end Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_api = Dropbox::Sign::FaxApi.new - -data = Dropbox::Sign::FaxSendRequest.new -data.files = [File.new("example_signature_request.pdf", "r")] -data.test_mode = true -data.recipient = "16690000001" -data.sender = "16690000000" -data.cover_page_to = "Jill Fax" -data.cover_page_message = "I'm sending you a fax!" -data.cover_page_from = "Faxer Faxerson" -data.title = "This is what the fax is about!" +fax_send_request = Dropbox::Sign::FaxSendRequest.new +fax_send_request.recipient = "16690000001" +fax_send_request.sender = "16690000000" +fax_send_request.test_mode = true +fax_send_request.cover_page_to = "Jill Fax" +fax_send_request.cover_page_from = "Faxer Faxerson" +fax_send_request.cover_page_message = "I'm sending you a fax!" +fax_send_request.title = "This is what the fax is about!" +fax_send_request.files = [ + File.new("./example_fax.pdf", "r"), +] begin - result = fax_api.fax_send(data) - p result + response = Dropbox::Sign::FaxApi.new.fax_send( + fax_send_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxApi#fax_send: #{e}" end ``` diff --git a/docs/FaxLineAddUserRequest.md b/docs/FaxLineAddUserRequest.md index 272d383..f5339ae 100644 --- a/docs/FaxLineAddUserRequest.md +++ b/docs/FaxLineAddUserRequest.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | | `account_id` | ```String``` | Account ID | | | `email_address` | ```String``` | Email address | | diff --git a/docs/FaxLineApi.md b/docs/FaxLineApi.md index f5b1d3b..a52f30c 100644 --- a/docs/FaxLineApi.md +++ b/docs/FaxLineApi.md @@ -24,24 +24,25 @@ Grants a user access to the specified Fax Line. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineAddUserRequest.new -data.number = "[FAX_NUMBER]" -data.email_address = "member@dropboxsign.com" +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 - result = fax_line_api.fax_line_add_user(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_add_user: #{e}" end ``` @@ -90,25 +91,26 @@ end Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a list of available area codes for a given state/province and city ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - begin - result = fax_line_api.fax_line_area_code_get("US", "CA") - p result + response = Dropbox::Sign::FaxLineApi.new.fax_line_area_code_get( + "US", # country + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_area_code_get: #{e}" end ``` @@ -135,10 +137,10 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `country` | **String** | Filter area codes by country. | | -| `state` | **String** | Filter area codes by state. | [optional] | -| `province` | **String** | Filter area codes by province. | [optional] | -| `city` | **String** | Filter area codes by city. | [optional] | +| `country` | **String** | Filter area codes by country | | +| `state` | **String** | Filter area codes by state | [optional] | +| `province` | **String** | Filter area codes by province | [optional] | +| `city` | **String** | Filter area codes by city | [optional] | ### Return type @@ -160,29 +162,30 @@ end Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineCreateRequest.new -data.area_code = 209 -data.country = "US" +fax_line_create_request = Dropbox::Sign::FaxLineCreateRequest.new +fax_line_create_request.area_code = 209 +fax_line_create_request.country = "US" begin - result = fax_line_api.fax_line_create(data) - p result + response = Dropbox::Sign::FaxLineApi.new.fax_line_create( + fax_line_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_create: #{e}" end ``` @@ -236,22 +239,22 @@ Deletes the specified Fax Line from the subscription. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineDeleteRequest.new -data.number = "[FAX_NUMBER]" +fax_line_delete_request = Dropbox::Sign::FaxLineDeleteRequest.new +fax_line_delete_request.number = "[FAX_NUMBER]" begin - fax_line_api.fax_line_delete(data) + Dropbox::Sign::FaxLineApi.new.fax_line_delete( + fax_line_delete_request, + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_delete: #{e}" end ``` @@ -305,20 +308,21 @@ Returns the properties and settings of a Fax Line. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - begin - result = fax_line_api.fax_line_get("[NUMBER]") - p result + response = Dropbox::Sign::FaxLineApi.new.fax_line_get( + "123-123-1234", # number + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_get: #{e}" end ``` @@ -345,7 +349,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number` | **String** | The Fax Line number. | | +| `number` | **String** | The Fax Line number | | ### Return type @@ -372,20 +376,26 @@ Returns the properties and settings of multiple Fax Lines. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - begin - result = fax_line_api.fax_line_list() - p result + response = Dropbox::Sign::FaxLineApi.new.fax_line_list( + { + account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + page_size: 20, + show_team_lines: nil, + }, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_list: #{e}" end ``` @@ -413,9 +423,9 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **String** | Account ID | [optional] | -| `page` | **Integer** | Page | [optional][default to 1] | -| `page_size` | **Integer** | Page size | [optional][default to 20] | -| `show_team_lines` | **Boolean** | Show team lines | [optional] | +| `page` | **Integer** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | +| `show_team_lines` | **Boolean** | Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -437,29 +447,30 @@ end Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineRemoveUserRequest.new -data.number = "[FAX_NUMBER]" -data.email_address = "member@dropboxsign.com" +fax_line_remove_user_request = Dropbox::Sign::FaxLineRemoveUserRequest.new +fax_line_remove_user_request.number = "[FAX_NUMBER]" +fax_line_remove_user_request.email_address = "member@dropboxsign.com" begin - result = fax_line_api.fax_line_remove_user(data) - p result + response = Dropbox::Sign::FaxLineApi.new.fax_line_remove_user( + fax_line_remove_user_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_remove_user: #{e}" end ``` diff --git a/docs/FaxLineCreateRequest.md b/docs/FaxLineCreateRequest.md index bbe5312..5359e40 100644 --- a/docs/FaxLineCreateRequest.md +++ b/docs/FaxLineCreateRequest.md @@ -6,8 +6,8 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `area_code`*_required_ | ```Integer``` | Area code | | -| `country`*_required_ | ```String``` | Country | | -| `city` | ```String``` | City | | -| `account_id` | ```String``` | Account ID | | +| `area_code`*_required_ | ```Integer``` | Area code of the new Fax Line | | +| `country`*_required_ | ```String``` | Country of the area code | | +| `city` | ```String``` | City of the area code | | +| `account_id` | ```String``` | Account ID of the account that will be assigned this new Fax Line | | diff --git a/docs/FaxLineDeleteRequest.md b/docs/FaxLineDeleteRequest.md index 5c781f3..fc910e5 100644 --- a/docs/FaxLineDeleteRequest.md +++ b/docs/FaxLineDeleteRequest.md @@ -6,5 +6,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | diff --git a/docs/FaxLineRemoveUserRequest.md b/docs/FaxLineRemoveUserRequest.md index 98388f6..4156b61 100644 --- a/docs/FaxLineRemoveUserRequest.md +++ b/docs/FaxLineRemoveUserRequest.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | -| `account_id` | ```String``` | Account ID | | -| `email_address` | ```String``` | Email address | | +| `number`*_required_ | ```String``` | The Fax Line number | | +| `account_id` | ```String``` | Account ID of the user to remove access | | +| `email_address` | ```String``` | Email address of the user to remove access | | diff --git a/docs/FaxSendRequest.md b/docs/FaxSendRequest.md index 6217af9..af96a23 100644 --- a/docs/FaxSendRequest.md +++ b/docs/FaxSendRequest.md @@ -6,13 +6,13 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```Array``` | Fax File to Send | | -| `file_urls` | ```Array``` | Fax File URL to Send | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `test_mode` | ```Boolean``` | API Test Mode Setting | [default to false] | -| `cover_page_to` | ```String``` | Fax Cover Page for Recipient | | -| `cover_page_from` | ```String``` | Fax Cover Page for Sender | | +| `cover_page_to` | ```String``` | Fax cover page recipient information | | +| `cover_page_from` | ```String``` | Fax cover page sender information | | | `cover_page_message` | ```String``` | Fax Cover Page Message | | | `title` | ```String``` | Fax Title | | diff --git a/docs/OAuthApi.md b/docs/OAuthApi.md index b9ff029..579602d 100644 --- a/docs/OAuthApi.md +++ b/docs/OAuthApi.md @@ -19,21 +19,27 @@ Once you have retrieved the code from the user callback, you will need to exchan ### Examples ```ruby +require "json" require "dropbox-sign" -oauth_api = Dropbox::Sign::OAuthApi.new +Dropbox::Sign.configure do |config| +end -data = Dropbox::Sign::OAuthTokenGenerateRequest.new -data.state = "900e06e2" -data.code = "1b0d28d90c86c141" -data.client_id = "cc91c61d00f8bb2ece1428035716b" -data.client_secret = "1d14434088507ffa390e6f5528465" +o_auth_token_generate_request = Dropbox::Sign::OAuthTokenGenerateRequest.new +o_auth_token_generate_request.client_id = "cc91c61d00f8bb2ece1428035716b" +o_auth_token_generate_request.client_secret = "1d14434088507ffa390e6f5528465" +o_auth_token_generate_request.code = "1b0d28d90c86c141" +o_auth_token_generate_request.state = "900e06e2" +o_auth_token_generate_request.grant_type = "authorization_code" begin - result = oauth_api.oauth_token_generate(data) - p result + response = Dropbox::Sign::OAuthApi.new.oauth_token_generate( + o_auth_token_generate_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling OAuthApi#oauth_token_generate: #{e}" end ``` @@ -87,18 +93,24 @@ Access tokens are only valid for a given period of time (typically one hour) for ### Examples ```ruby +require "json" require "dropbox-sign" -oauth_api = Dropbox::Sign::OAuthApi.new +Dropbox::Sign.configure do |config| +end -data = Dropbox::Sign::OAuthTokenRefreshRequest.new -data.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" +o_auth_token_refresh_request = Dropbox::Sign::OAuthTokenRefreshRequest.new +o_auth_token_refresh_request.grant_type = "refresh_token" +o_auth_token_refresh_request.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" begin - result = oauth_api.oauth_token_refresh(data) - p result + response = Dropbox::Sign::OAuthApi.new.oauth_token_refresh( + o_auth_token_refresh_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling OAuthApi#oauth_token_refresh: #{e}" end ``` diff --git a/docs/ReportApi.md b/docs/ReportApi.md index d612c7e..9b0b903 100644 --- a/docs/ReportApi.md +++ b/docs/ReportApi.md @@ -18,28 +18,29 @@ Request the creation of one or more report(s). When the report(s) have been gen ### 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 -report_api = Dropbox::Sign::ReportApi.new - -data = Dropbox::Sign::ReportCreateRequest.new -data.start_date = "09/01/2020" -data.end_date = "09/01/2020" -data.report_type = %w[user_activity document_status] +report_create_request = Dropbox::Sign::ReportCreateRequest.new +report_create_request.start_date = "09/01/2020" +report_create_request.end_date = "09/01/2020" +report_create_request.report_type = [ + "user_activity", + "document_status", +] begin - result = report_api.report_create(data) - p result + response = Dropbox::Sign::ReportApi.new.report_create( + report_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling ReportApi#report_create: #{e}" end ``` diff --git a/docs/SignatureRequestApi.md b/docs/SignatureRequestApi.md index 0261ffa..964273c 100644 --- a/docs/SignatureRequestApi.md +++ b/docs/SignatureRequestApi.md @@ -9,6 +9,10 @@ All URIs are relative to *https://api.hellosign.com/v3* | [`signature_request_cancel`](SignatureRequestApi.md#signature_request_cancel) | **POST** `/signature_request/cancel/{signature_request_id}` | Cancel Incomplete Signature Request | | [`signature_request_create_embedded`](SignatureRequestApi.md#signature_request_create_embedded) | **POST** `/signature_request/create_embedded` | Create Embedded Signature Request | | [`signature_request_create_embedded_with_template`](SignatureRequestApi.md#signature_request_create_embedded_with_template) | **POST** `/signature_request/create_embedded_with_template` | Create Embedded Signature Request with Template | +| [`signature_request_edit`](SignatureRequestApi.md#signature_request_edit) | **PUT** `/signature_request/edit/{signature_request_id}` | Edit Signature Request | +| [`signature_request_edit_embedded`](SignatureRequestApi.md#signature_request_edit_embedded) | **PUT** `/signature_request/edit_embedded/{signature_request_id}` | Edit Embedded Signature Request | +| [`signature_request_edit_embedded_with_template`](SignatureRequestApi.md#signature_request_edit_embedded_with_template) | **PUT** `/signature_request/edit_embedded_with_template/{signature_request_id}` | Edit Embedded Signature Request with Template | +| [`signature_request_edit_with_template`](SignatureRequestApi.md#signature_request_edit_with_template) | **PUT** `/signature_request/edit_with_template/{signature_request_id}` | Edit Signature Request With Template | | [`signature_request_files`](SignatureRequestApi.md#signature_request_files) | **GET** `/signature_request/files/{signature_request_id}` | Download Files | | [`signature_request_files_as_data_uri`](SignatureRequestApi.md#signature_request_files_as_data_uri) | **GET** `/signature_request/files_as_data_uri/{signature_request_id}` | Download Files as Data Uri | | [`signature_request_files_as_file_url`](SignatureRequestApi.md#signature_request_files_as_file_url) | **GET** `/signature_request/files_as_file_url/{signature_request_id}` | Download Files as File Url | @@ -33,64 +37,89 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### 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 -signature_request_api = Dropbox::Sign::SignatureRequestApi.new +signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_2_custom_fields_1.name = "company" +signer_list_2_custom_fields_1.value = "123 LLC" -signer_list_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_1_signer.role = "Client" -signer_list_1_signer.name = "George" -signer_list_1_signer.email_address = "george@example.com" -signer_list_1_signer.pin = "d79a3td" +signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, +] -signer_list_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_1_custom_fields.name = "company" -signer_list_1_custom_fields.value = "ABC Corp" +signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_2_signers_1.role = "Client" +signer_list_2_signers_1.name = "Mary" +signer_list_2_signers_1.email_address = "mary@example.com" +signer_list_2_signers_1.pin = "gd9as5b" -signer_list_1 = Dropbox::Sign::SubBulkSignerList.new -signer_list_1.signers = [signer_list_1_signer] -signer_list_1.custom_fields = [signer_list_1_custom_fields] +signer_list_2_signers = [ + signer_list_2_signers_1, +] + +signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_1_custom_fields_1.name = "company" +signer_list_1_custom_fields_1.value = "ABC Corp" -signer_list_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_2_signer.role = "Client" -signer_list_2_signer.name = "Mary" -signer_list_2_signer.email_address = "mary@example.com" -signer_list_2_signer.pin = "gd9as5b" +signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, +] -signer_list_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_2_custom_fields.name = "company" -signer_list_2_custom_fields.value = "123 LLC" +signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_1_signers_1.role = "Client" +signer_list_1_signers_1.name = "George" +signer_list_1_signers_1.email_address = "george@example.com" +signer_list_1_signers_1.pin = "d79a3td" + +signer_list_1_signers = [ + signer_list_1_signers_1, +] + +signer_list_1 = Dropbox::Sign::SubBulkSignerList.new +signer_list_1.custom_fields = signer_list_1_custom_fields +signer_list_1.signers = signer_list_1_signers signer_list_2 = Dropbox::Sign::SubBulkSignerList.new -signer_list_2.signers = [signer_list_2_signer] -signer_list_2.custom_fields = [signer_list_2_custom_fields] - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -data = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new -data.client_id = "1a659d9ad95bccd307ecad78d72192f8" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signer_list = [signer_list_1, signer_list_2] -data.ccs = [cc_1] -data.test_mode = true +signer_list_2.custom_fields = signer_list_2_custom_fields +signer_list_2.signers = signer_list_2_signers + +signer_list = [ + signer_list_1, + signer_list_2, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +signature_request_bulk_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new +signature_request_bulk_create_embedded_with_template_request.client_id = "1a659d9ad95bccd307ecad78d72192f8" +signature_request_bulk_create_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_bulk_create_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_bulk_create_embedded_with_template_request.subject = "Purchase Order" +signature_request_bulk_create_embedded_with_template_request.test_mode = true +signature_request_bulk_create_embedded_with_template_request.signer_list = signer_list +signature_request_bulk_create_embedded_with_template_request.ccs = ccs begin - result = signature_request_api.signature_request_bulk_create_embedded_with_template(data) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_create_embedded_with_template( + signature_request_bulk_create_embedded_with_template_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: #{e}" end ``` @@ -144,63 +173,89 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### 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 -signature_request_api = Dropbox::Sign::SignatureRequestApi.new +signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_2_custom_fields_1.name = "company" +signer_list_2_custom_fields_1.value = "123 LLC" -signer_list_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_1_signer.role = "Client" -signer_list_1_signer.name = "George" -signer_list_1_signer.email_address = "george@example.com" -signer_list_1_signer.pin = "d79a3td" +signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, +] -signer_list_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_1_custom_fields.name = "company" -signer_list_1_custom_fields.value = "ABC Corp" +signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_2_signers_1.role = "Client" +signer_list_2_signers_1.name = "Mary" +signer_list_2_signers_1.email_address = "mary@example.com" +signer_list_2_signers_1.pin = "gd9as5b" -signer_list_1 = Dropbox::Sign::SubBulkSignerList.new -signer_list_1.signers = [signer_list_1_signer] -signer_list_1.custom_fields = [signer_list_1_custom_fields] +signer_list_2_signers = [ + signer_list_2_signers_1, +] -signer_list_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_2_signer.role = "Client" -signer_list_2_signer.name = "Mary" -signer_list_2_signer.email_address = "mary@example.com" -signer_list_2_signer.pin = "gd9as5b" +signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_1_custom_fields_1.name = "company" +signer_list_1_custom_fields_1.value = "ABC Corp" -signer_list_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_2_custom_fields.name = "company" -signer_list_2_custom_fields.value = "123 LLC" +signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, +] + +signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_1_signers_1.role = "Client" +signer_list_1_signers_1.name = "George" +signer_list_1_signers_1.email_address = "george@example.com" +signer_list_1_signers_1.pin = "d79a3td" + +signer_list_1_signers = [ + signer_list_1_signers_1, +] + +signer_list_1 = Dropbox::Sign::SubBulkSignerList.new +signer_list_1.custom_fields = signer_list_1_custom_fields +signer_list_1.signers = signer_list_1_signers signer_list_2 = Dropbox::Sign::SubBulkSignerList.new -signer_list_2.signers = [signer_list_2_signer] -signer_list_2.custom_fields = [signer_list_2_custom_fields] +signer_list_2.custom_fields = signer_list_2_custom_fields +signer_list_2.signers = signer_list_2_signers -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" +signer_list = [ + signer_list_1, + signer_list_2, +] -data = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signer_list = [signer_list_1, signer_list_2] -data.ccs = [cc_1] -data.test_mode = true +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +signature_request_bulk_send_with_template_request = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new +signature_request_bulk_send_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_bulk_send_with_template_request.message = "Glad we could come to an agreement." +signature_request_bulk_send_with_template_request.subject = "Purchase Order" +signature_request_bulk_send_with_template_request.test_mode = true +signature_request_bulk_send_with_template_request.signer_list = signer_list +signature_request_bulk_send_with_template_request.ccs = ccs begin - result = signature_request_api.signature_request_bulk_send_with_template(data) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_send_with_template( + signature_request_bulk_send_with_template_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: #{e}" end ``` @@ -254,25 +309,20 @@ Cancels an incomplete signature request. This action is **not reversible**. The ### 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 -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - begin - result = signature_request_api.signature_request_cancel(signature_request_id) - p result + Dropbox::Sign::SignatureRequestApi.new.signature_request_cancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_cancel: #{e}" end ``` @@ -326,51 +376,60 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e ### 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 -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.default_type = "draw" signing_options.draw = true +signing_options.phone = false signing_options.type = true signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" -data = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -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 = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"] -data.files = [File.new("example_signature_request.pdf", "r")] -data.signing_options = signing_options -data.test_mode = true +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_create_embedded_request = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new +signature_request_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_create_embedded_request.subject = "The NDA we talked about" +signature_request_create_embedded_request.test_mode = true +signature_request_create_embedded_request.title = "NDA with Acme Co." +signature_request_create_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_create_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.signers = signers begin - result = signature_request_api.signature_request_create_embedded(data) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded( + signature_request_create_embedded_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded: #{e}" end ``` @@ -424,44 +483,49 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an ### 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 -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" - 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 -signing_options.phone = true -signing_options.default_type = "draw" -data = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.signing_options = signing_options -data.test_mode = 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, +] + +signature_request_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new +signature_request_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_create_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_create_embedded_with_template_request.subject = "Purchase Order" +signature_request_create_embedded_with_template_request.test_mode = true +signature_request_create_embedded_with_template_request.signing_options = signing_options +signature_request_create_embedded_with_template_request.signers = signers begin - result = signature_request_api.signature_request_create_embedded_with_template(data) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded_with_template( + signature_request_create_embedded_with_template_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: #{e}" end ``` @@ -504,6 +568,449 @@ end - **Accept**: application/json +## `signature_request_edit` + +> ` signature_request_edit(signature_request_id, signature_request_edit_request)` + +Edit Signature Request + +Edits and sends a SignatureRequest with the submitted documents. 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:** Edit and resend *will* deduct your signature request quota. + +### Examples + +```ruby +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" + +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::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_edit_request = Dropbox::Sign::SignatureRequestEditRequest.new +signature_request_edit_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_request.subject = "The NDA we talked about" +signature_request_edit_request.test_mode = true +signature_request_edit_request.title = "NDA with Acme Co." +signature_request_edit_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_edit_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_edit_request.field_options = field_options +signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit: #{e}" +end + +``` + +#### Using the `signature_request_edit_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> `, Integer, Hash)> signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request)` + +```ruby +begin + # Edit Signature Request + data, status_code, headers = api_instance.signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request) + p status_code # => 2xx + p headers # => { ... } + p data # => +rescue Dropbox::Sign::ApiError => e + puts "Error when calling SignatureRequestApi->signature_request_edit_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_request` | [**SignatureRequestEditRequest**](SignatureRequestEditRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: application/json, multipart/form-data +- **Accept**: application/json + + +## `signature_request_edit_embedded` + +> ` signature_request_edit_embedded(signature_request_id, signature_request_edit_embedded_request)` + +Edit Embedded Signature Request + +Edits a 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. **NOTE:** Edit and resend *will* deduct your signature request quota. + +### Examples + +```ruby +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::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_edit_embedded_request = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new +signature_request_edit_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_embedded_request.subject = "The NDA we talked about" +signature_request_edit_embedded_request.test_mode = true +signature_request_edit_embedded_request.title = "NDA with Acme Co." +signature_request_edit_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded: #{e}" +end + +``` + +#### Using the `signature_request_edit_embedded_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> `, Integer, Hash)> signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request)` + +```ruby +begin + # Edit Embedded Signature Request + data, status_code, headers = api_instance.signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request) + p status_code # => 2xx + p headers # => { ... } + p data # => +rescue Dropbox::Sign::ApiError => e + puts "Error when calling SignatureRequestApi->signature_request_edit_embedded_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_embedded_request` | [**SignatureRequestEditEmbeddedRequest**](SignatureRequestEditEmbeddedRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: application/json, multipart/form-data +- **Accept**: application/json + + +## `signature_request_edit_embedded_with_template` + +> ` signature_request_edit_embedded_with_template(signature_request_id, signature_request_edit_embedded_with_template_request)` + +Edit Embedded Signature Request with Template + +Edits a 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. **NOTE:** Edit and resend *will* deduct your signature request quota. + +### Examples + +```ruby +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, +] + +signature_request_edit_embedded_with_template_request = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new +signature_request_edit_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_edit_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_edit_embedded_with_template_request.subject = "Purchase Order" +signature_request_edit_embedded_with_template_request.test_mode = true +signature_request_edit_embedded_with_template_request.signing_options = signing_options +signature_request_edit_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded_with_template( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: #{e}" +end + +``` + +#### Using the `signature_request_edit_embedded_with_template_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> `, Integer, Hash)> signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request)` + +```ruby +begin + # Edit Embedded Signature Request with Template + data, status_code, headers = api_instance.signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request) + p status_code # => 2xx + p headers # => { ... } + p data # => +rescue Dropbox::Sign::ApiError => e + puts "Error when calling SignatureRequestApi->signature_request_edit_embedded_with_template_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_embedded_with_template_request` | [**SignatureRequestEditEmbeddedWithTemplateRequest**](SignatureRequestEditEmbeddedWithTemplateRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: application/json, multipart/form-data +- **Accept**: application/json + + +## `signature_request_edit_with_template` + +> ` signature_request_edit_with_template(signature_request_id, signature_request_edit_with_template_request)` + +Edit Signature Request With Template + +Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + +### Examples + +```ruby +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_edit_with_template_request = Dropbox::Sign::SignatureRequestEditWithTemplateRequest.new +signature_request_edit_with_template_request.template_ids = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +] +signature_request_edit_with_template_request.message = "Glad we could come to an agreement." +signature_request_edit_with_template_request.subject = "Purchase Order" +signature_request_edit_with_template_request.test_mode = true +signature_request_edit_with_template_request.signing_options = signing_options +signature_request_edit_with_template_request.signers = signers +signature_request_edit_with_template_request.ccs = ccs +signature_request_edit_with_template_request.custom_fields = custom_fields + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_with_template( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_with_template: #{e}" +end + +``` + +#### Using the `signature_request_edit_with_template_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> `, Integer, Hash)> signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request)` + +```ruby +begin + # Edit Signature Request With Template + data, status_code, headers = api_instance.signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request) + p status_code # => 2xx + p headers # => { ... } + p data # => +rescue Dropbox::Sign::ApiError => e + puts "Error when calling SignatureRequestApi->signature_request_edit_with_template_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | | +| `signature_request_edit_with_template_request` | [**SignatureRequestEditWithTemplateRequest**](SignatureRequestEditWithTemplateRequest.md) | | | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key), [oauth2](../README.md#oauth2) + +### HTTP request headers + +- **Content-Type**: application/json, multipart/form-data +- **Accept**: application/json + + ## `signature_request_files` > `File signature_request_files(signature_request_id, opts)` @@ -515,25 +1022,25 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### 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 -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - file_bin = signature_request_api.signature_request_files(signature_request_id) - FileUtils.cp(file_bin.path, "path/to/file.pdf") + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + { + file_type: "pdf", + }, + ) + + FileUtils.cp(response.path, "./file_response") rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_files: #{e}" end ``` @@ -588,25 +1095,22 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### 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 -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - result = signature_request_api.signature_request_files_as_data_uri(signature_request_id) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files_as_data_uri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: #{e}" end ``` @@ -660,25 +1164,25 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### 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 -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - result = signature_request_api.signature_request_files_as_file_url(signature_request_id) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files_as_file_url( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + { + force_download: 1, + }, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_files_as_file_url: #{e}" end ``` @@ -733,25 +1237,22 @@ Returns the status of the SignatureRequest specified by the `signature_request_i ### 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 -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - result = signature_request_api.signature_request_get(signature_request_id) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_get( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_get: #{e}" end ``` @@ -805,26 +1306,27 @@ Returns a list of SignatureRequests that you can access. This includes Signature ### 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 -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 + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_list( + { + account_id: nil, + page: 1, + page_size: 20, + query: nil, + }, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_list: #{e}" end ``` @@ -881,25 +1383,22 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime ### 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 -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 + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_release_hold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_release_hold: #{e}" end ``` @@ -953,28 +1452,26 @@ Sends an email to the signer reminding them to sign the signature request. You c ### 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 -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -data = Dropbox::Sign::SignatureRequestRemindRequest.new -data.email_address = "john@example.com" - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" +signature_request_remind_request = Dropbox::Sign::SignatureRequestRemindRequest.new +signature_request_remind_request.email_address = "john@example.com" begin - result = signature_request_api.signature_request_remind(signature_request_id, data) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_remind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_remind_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_remind: #{e}" end ``` @@ -1029,25 +1526,19 @@ Removes your access to a completed signature request. This action is **not rever ### 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 -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - begin - result = signature_request_api.signature_request_remove(signature_request_id) - p result + Dropbox::Sign::SignatureRequestApi.new.signature_request_remove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_remove: #{e}" end ``` @@ -1101,61 +1592,70 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ ### 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 -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 +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" 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 -signing_options.phone = true -signing_options.default_type = "draw" -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 -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 = [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", +signers = [ + signers_1, + signers_2, +] + +signature_request_send_request = Dropbox::Sign::SignatureRequestSendRequest.new +signature_request_send_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_send_request.subject = "The NDA we talked about" +signature_request_send_request.test_mode = true +signature_request_send_request.title = "NDA with Acme Co." +signature_request_send_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_send_request.files = [ + File.new("./example_signature_request.pdf", "r"), ] -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 +signature_request_send_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_send_request.field_options = field_options +signature_request_send_request.signing_options = signing_options +signature_request_send_request.signers = signers begin - result = signature_request_api.signature_request_send(data) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send( + signature_request_send_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_send: #{e}" end ``` @@ -1209,55 +1709,68 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified ### 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 -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.default_type = "draw" signing_options.draw = true +signing_options.phone = false 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 +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 - result = signature_request_api.signature_request_send_with_template(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_send_with_template: #{e}" end ``` @@ -1311,29 +1824,27 @@ Updates the email address and/or the name for a given signer on a signature requ ### 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 -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" +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 - result = signature_request_api.signature_request_update(signature_request_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_update: #{e}" end ``` diff --git a/docs/SignatureRequestEditEmbeddedRequest.md b/docs/SignatureRequestEditEmbeddedRequest.md new file mode 100644 index 0000000..383cd8e --- /dev/null +++ b/docs/SignatureRequestEditEmbeddedRequest.md @@ -0,0 +1,33 @@ +# Dropbox::Sign::SignatureRequestEditEmbeddedRequest + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `client_id`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | +| `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```Array```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```Array```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```Array```](SubFormFieldsPerDocumentBase.md) | 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` | | +| `hide_text_tags` | ```Boolean``` | 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. | [default to false] | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `populate_auto_fill_fields` | ```Boolean``` | 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. | [default to false] | +| `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + diff --git a/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md new file mode 100644 index 0000000..736cbf7 --- /dev/null +++ b/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -0,0 +1,24 @@ +# Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `template_ids`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `client_id`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `custom_fields` | [```Array```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `populate_auto_fill_fields` | ```Boolean``` | 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. | [default to false] | + diff --git a/docs/SignatureRequestEditRequest.md b/docs/SignatureRequestEditRequest.md new file mode 100644 index 0000000..39d575a --- /dev/null +++ b/docs/SignatureRequestEditRequest.md @@ -0,0 +1,34 @@ +# Dropbox::Sign::SignatureRequestEditRequest + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | +| `client_id` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `form_field_groups` | [```Array```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `form_field_rules` | [```Array```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `form_fields_per_document` | [```Array```](SubFormFieldsPerDocumentBase.md) | 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` | | +| `hide_text_tags` | ```Boolean``` | 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. | [default to false] | +| `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | + diff --git a/docs/SignatureRequestEditWithTemplateRequest.md b/docs/SignatureRequestEditWithTemplateRequest.md new file mode 100644 index 0000000..12b4bee --- /dev/null +++ b/docs/SignatureRequestEditWithTemplateRequest.md @@ -0,0 +1,25 @@ +# Dropbox::Sign::SignatureRequestEditWithTemplateRequest + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `template_ids`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `client_id` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | +| `custom_fields` | [```Array```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | +| `subject` | ```String``` | The subject in the email that will be sent to the signers. | | +| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | +| `title` | ```String``` | The title you want to assign to the SignatureRequest. | | + diff --git a/docs/TeamApi.md b/docs/TeamApi.md index 8464914..b8279a3 100644 --- a/docs/TeamApi.md +++ b/docs/TeamApi.md @@ -27,26 +27,28 @@ Invites a user (specified using the `email_address` parameter) to your Team. If ### 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 -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamAddMemberRequest.new -data.email_address = "george@example.com" +team_add_member_request = Dropbox::Sign::TeamAddMemberRequest.new +team_add_member_request.email_address = "george@example.com" begin - result = team_api.team_add_member(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_add_member: #{e}" end ``` @@ -101,26 +103,25 @@ Creates a new Team and makes you a member. You must not currently belong to a Te ### 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 -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamCreateRequest.new -data.name = "New Team Name" +team_create_request = Dropbox::Sign::TeamCreateRequest.new +team_create_request.name = "New Team Name" begin - result = team_api.team_create(data) - p result + response = Dropbox::Sign::TeamApi.new.team_create( + team_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_create: #{e}" end ``` @@ -174,23 +175,18 @@ Deletes your Team. Can only be invoked when you have a Team with only one member ### 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 -team_api = Dropbox::Sign::TeamApi.new - begin - result = team_api.team_delete - p result + Dropbox::Sign::TeamApi.new.team_delete rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_delete: #{e}" end ``` @@ -242,23 +238,20 @@ Returns information about your Team as well as a list of its members. If you do ### 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 -team_api = Dropbox::Sign::TeamApi.new - begin - result = team_api.team_get - p result + response = Dropbox::Sign::TeamApi.new.team_get + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_get: #{e}" end ``` @@ -310,23 +303,24 @@ Provides information about a team. ### 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 -team_api = Dropbox::Sign::TeamApi.new - begin - result = team_api.team_info - p result + response = Dropbox::Sign::TeamApi.new.team_info( + { + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + }, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_info: #{e}" end ``` @@ -380,25 +374,20 @@ Provides a list of team invites (and their roles). ### 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 -team_api = Dropbox::Sign::TeamApi.new - -email_address = "user@dropboxsign.com" - begin - result = team_api.team_invites({ email_address: email_address }) - p result + response = Dropbox::Sign::TeamApi.new.team_invites + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_invites: #{e}" end ``` @@ -452,25 +441,26 @@ Provides a paginated list of members (and their roles) that belong to a given te ### 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 -team_api = Dropbox::Sign::TeamApi.new - -team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - begin - result = team_api.team_members(team_id) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_members: #{e}" end ``` @@ -526,27 +516,26 @@ Removes the provided user Account from your Team. If the Account had an outstand ### 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 -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" +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 - result = team_api.team_remove_member(data) - p result + response = Dropbox::Sign::TeamApi.new.team_remove_member( + team_remove_member_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_remove_member: #{e}" end ``` @@ -600,25 +589,26 @@ Provides a paginated list of sub teams that belong to a given team. ### 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 -team_api = Dropbox::Sign::TeamApi.new - -team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - begin - result = team_api.team_sub_teams(team_id) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_sub_teams: #{e}" end ``` @@ -674,26 +664,25 @@ Updates the name of your Team. ### 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 -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamUpdateRequest.new -data.name = "New Team Name" +team_update_request = Dropbox::Sign::TeamUpdateRequest.new +team_update_request.name = "New Team Name" begin - result = team_api.team_update(data) - p result + response = Dropbox::Sign::TeamApi.new.team_update( + team_update_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_update: #{e}" end ``` diff --git a/docs/TemplateApi.md b/docs/TemplateApi.md index bcd27fa..315ced9 100644 --- a/docs/TemplateApi.md +++ b/docs/TemplateApi.md @@ -28,28 +28,26 @@ Gives the specified Account access to the specified Template. The specified Acco ### 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 -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateAddUserRequest.new -data.email_address = "george@dropboxsign.com" - -template_id = "f57db65d3f933b5316d398057a36176831451a35" +template_add_user_request = Dropbox::Sign::TemplateAddUserRequest.new +template_add_user_request.email_address = "george@dropboxsign.com" begin - result = template_api.template_add_user(template_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_add_user: #{e}" end ``` @@ -104,54 +102,101 @@ Creates a template that can then be used. ### 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 -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::TemplateCreateRequest.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 +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, +] + +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 = "1" +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.placeholder = "" +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, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.merge_fields = merge_fields begin - result = template_api.template_create(data) - p result + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_create: #{e}" end ``` @@ -205,54 +250,67 @@ The first step in an embedded template workflow. Creates a draft template that c ### 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 -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 +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 - result = template_api.template_create_embedded_draft(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" end ``` @@ -306,25 +364,20 @@ Completely deletes the template specified from the account. ### 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 -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - begin - result = template_api.template_delete(template_id) - p result + Dropbox::Sign::TemplateApi.new.template_delete( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_delete: #{e}" end ``` @@ -378,25 +431,22 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### 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 -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") + response = Dropbox::Sign::TemplateApi.new.template_files( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + FileUtils.cp(response.path, "./file_response") rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_files: #{e}" end ``` @@ -451,25 +501,22 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### 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 -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - begin - result = template_api.template_files_as_data_uri(template_id) - p result + response = Dropbox::Sign::TemplateApi.new.template_files_as_data_uri( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_files_as_data_uri: #{e}" end ``` @@ -523,25 +570,25 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### 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 -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - begin - result = template_api.template_files_as_file_url(template_id) - p result + response = Dropbox::Sign::TemplateApi.new.template_files_as_file_url( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + { + force_download: 1, + }, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_files_as_file_url: #{e}" end ``` @@ -596,25 +643,22 @@ Returns the Template specified by the `template_id` parameter. ### 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 -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "f57db65d3f933b5316d398057a36176831451a35" - begin - result = template_api.template_get(template_id) - p result + response = Dropbox::Sign::TemplateApi.new.template_get( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_get: #{e}" end ``` @@ -668,25 +712,27 @@ Returns a list of the Templates that are accessible by you. Take a look at our ### 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 -template_api = Dropbox::Sign::TemplateApi.new - -account_id = "f57db65d3f933b5316d398057a36176831451a35" - begin - result = template_api.template_list({ account_id: account_id }) - p result + response = Dropbox::Sign::TemplateApi.new.template_list( + { + account_id: nil, + page: 1, + page_size: 20, + query: nil, + }, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_list: #{e}" end ``` @@ -743,28 +789,26 @@ Removes the specified Account's access to the specified Template. ### 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 -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateRemoveUserRequest.new -data.email_address = "george@dropboxsign.com" - -template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536" +template_remove_user_request = Dropbox::Sign::TemplateRemoveUserRequest.new +template_remove_user_request.email_address = "george@dropboxsign.com" begin - result = template_api.template_remove_user(template_id, data) - p result + response = Dropbox::Sign::TemplateApi.new.template_remove_user( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_remove_user_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_remove_user: #{e}" end ``` @@ -819,28 +863,28 @@ Overlays a new file with the overlay of an existing template. The new file(s) mu ### 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 -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateUpdateFilesRequest.new -data.files = [File.new("example_signature_request.pdf", "r")] - -template_id = "5de8179668f2033afac48da1868d0093bf133266" +template_update_files_request = Dropbox::Sign::TemplateUpdateFilesRequest.new +template_update_files_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] begin - result = template_api.template_update_files(template_id, data) - p result + response = Dropbox::Sign::TemplateApi.new.template_update_files( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_update_files_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_update_files: #{e}" end ``` diff --git a/docs/UnclaimedDraftApi.md b/docs/UnclaimedDraftApi.md index 8858f00..2ce8202 100644 --- a/docs/UnclaimedDraftApi.md +++ b/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 ``` diff --git a/dropbox-sign.gemspec b/dropbox-sign.gemspec index b547a06..1c683c9 100755 --- a/dropbox-sign.gemspec +++ b/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 diff --git a/examples/AccountCreate.rb b/examples/AccountCreate.rb deleted file mode 100644 index b572ae1..0000000 --- a/examples/AccountCreate.rb +++ /dev/null @@ -1,21 +0,0 @@ -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 - -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountCreateRequest.new -data.email_address = "newuser@dropboxsign.com" - -begin - result = account_api.account_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountCreateExample.rb b/examples/AccountCreateExample.rb new file mode 100644 index 0000000..0eddffa --- /dev/null +++ b/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 diff --git a/examples/AccountCreateOauthExample.rb b/examples/AccountCreateOauthExample.rb new file mode 100644 index 0000000..21255a6 --- /dev/null +++ b/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 diff --git a/examples/AccountGet.rb b/examples/AccountGet.rb deleted file mode 100644 index 426fcb6..0000000 --- a/examples/AccountGet.rb +++ /dev/null @@ -1,18 +0,0 @@ -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 - -account_api = Dropbox::Sign::AccountApi.new - -begin - result = account_api.account_get({ email_address: "jack@example.com" }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountGetExample.rb b/examples/AccountGetExample.rb new file mode 100644 index 0000000..ee63869 --- /dev/null +++ b/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 diff --git a/examples/AccountUpdate.rb b/examples/AccountUpdate.rb deleted file mode 100644 index 55b127b..0000000 --- a/examples/AccountUpdate.rb +++ /dev/null @@ -1,21 +0,0 @@ -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 - -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountUpdateRequest.new -data.callback_url = "https://www.example.com/callback" - -begin - result = account_api.account_update(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountUpdateExample.rb b/examples/AccountUpdateExample.rb new file mode 100644 index 0000000..4a8d4de --- /dev/null +++ b/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 diff --git a/examples/AccountVerify.rb b/examples/AccountVerify.rb deleted file mode 100644 index 20295f3..0000000 --- a/examples/AccountVerify.rb +++ /dev/null @@ -1,21 +0,0 @@ -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 - -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountVerifyRequest.new -data.email_address = "some_user@dropboxsign.com" - -begin - result = account_api.account_verify(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountVerifyExample.rb b/examples/AccountVerifyExample.rb new file mode 100644 index 0000000..01ef2e9 --- /dev/null +++ b/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 diff --git a/examples/ApiAppCreate.rb b/examples/ApiAppCreate.rb deleted file mode 100644 index 6b1ca23..0000000 --- a/examples/ApiAppCreate.rb +++ /dev/null @@ -1,35 +0,0 @@ -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 - -api_app_api = Dropbox::Sign::ApiAppApi.new - -oauth = Dropbox::Sign::SubOAuth.new -oauth.callback_url = "https://example.com/oauth" -oauth.scopes = %w[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" - -custom_logo_file = File.new('./CustomLogoFile.png') - -data = Dropbox::Sign::ApiAppCreateRequest.new -data.name = "My Production App" -data.domains = ["example.com"] -data.oauth = oauth -data.white_labeling_options = white_labeling_options -data.custom_logo_file = custom_logo_file - -begin - result = api_app_api.api_app_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppCreateExample.rb b/examples/ApiAppCreateExample.rb new file mode 100644 index 0000000..479de3b --- /dev/null +++ b/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 diff --git a/examples/ApiAppDelete.rb b/examples/ApiAppDelete.rb deleted file mode 100644 index 6e69462..0000000 --- a/examples/ApiAppDelete.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 - -api_app_api = Dropbox::Sign::ApiAppApi.new - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - -begin - result = api_app_api.api_app_delete(client_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppDeleteExample.rb b/examples/ApiAppDeleteExample.rb new file mode 100644 index 0000000..e6f97a9 --- /dev/null +++ b/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 diff --git a/examples/ApiAppGet.rb b/examples/ApiAppGet.rb deleted file mode 100644 index 37011b3..0000000 --- a/examples/ApiAppGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 - -api_app_api = Dropbox::Sign::ApiAppApi.new - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - -begin - result = api_app_api.api_app_get(client_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppGetExample.rb b/examples/ApiAppGetExample.rb new file mode 100644 index 0000000..cc708c1 --- /dev/null +++ b/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 diff --git a/examples/ApiAppList.rb b/examples/ApiAppList.rb deleted file mode 100644 index fa0d767..0000000 --- a/examples/ApiAppList.rb +++ /dev/null @@ -1,21 +0,0 @@ -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 - -api_app_api = Dropbox::Sign::ApiAppApi.new - -page = 1 -page_size = 2 - -begin - result = api_app_api.api_app_list({ page: page, page_size: page_size }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppListExample.rb b/examples/ApiAppListExample.rb new file mode 100644 index 0000000..b70253e --- /dev/null +++ b/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 diff --git a/examples/ApiAppUpdate.rb b/examples/ApiAppUpdate.rb deleted file mode 100644 index 44572cf..0000000 --- a/examples/ApiAppUpdate.rb +++ /dev/null @@ -1,32 +0,0 @@ -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 - -api_app_api = Dropbox::Sign::ApiAppApi.new - -white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new -white_labeling_options.primary_button_color = "#00b3e6" -white_labeling_options.primary_button_text_color = "#ffffff" - -custom_logo_file = File.new('./CustomLogoFile.png') - -data = Dropbox::Sign::ApiAppUpdateRequest.new -data.name = "New Name" -data.callback_url = "http://example.com/dropboxsign" -data.white_labeling_options = white_labeling_options -data.custom_logo_file = custom_logo_file - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - -begin - result = api_app_api.api_app_update(client_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppUpdateExample.rb b/examples/ApiAppUpdateExample.rb new file mode 100644 index 0000000..3f4a947 --- /dev/null +++ b/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 diff --git a/examples/BulkSendJobGet.rb b/examples/BulkSendJobGet.rb deleted file mode 100644 index 8ef33b2..0000000 --- a/examples/BulkSendJobGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 - -bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new - -bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174" - -begin - result = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/BulkSendJobGetExample.rb b/examples/BulkSendJobGetExample.rb new file mode 100644 index 0000000..54f0d44 --- /dev/null +++ b/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 diff --git a/examples/BulkSendJobList.rb b/examples/BulkSendJobList.rb deleted file mode 100644 index cb64c5d..0000000 --- a/examples/BulkSendJobList.rb +++ /dev/null @@ -1,21 +0,0 @@ -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 - -bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new - -page = 1 -page_size = 20 - -begin - result = bulk_send_job_api.bulk_send_job_list({ page: page, page_size: page_size }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/BulkSendJobListExample.rb b/examples/BulkSendJobListExample.rb new file mode 100644 index 0000000..efbdc90 --- /dev/null +++ b/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 diff --git a/examples/EmbeddedEditUrl.rb b/examples/EmbeddedEditUrl.rb deleted file mode 100644 index 0eef4c2..0000000 --- a/examples/EmbeddedEditUrl.rb +++ /dev/null @@ -1,24 +0,0 @@ -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 - -api = Dropbox::Sign::EmbeddedApi.new - -data = Dropbox::Sign::EmbeddedEditUrlRequest.new -data.cc_roles = [""] -data.merge_fields = [] - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = embedded_api.embedded_edit_url(template_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/EmbeddedEditUrlExample.rb b/examples/EmbeddedEditUrlExample.rb new file mode 100644 index 0000000..90803f5 --- /dev/null +++ b/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 diff --git a/examples/EmbeddedSignUrl.rb b/examples/EmbeddedSignUrl.rb deleted file mode 100644 index e23571a..0000000 --- a/examples/EmbeddedSignUrl.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 - -api = Dropbox::Sign::EmbeddedApi.new - -signature_id = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" - -begin - result = embedded_api.embedded_sign_url(signature_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/EmbeddedSignUrlExample.rb b/examples/EmbeddedSignUrlExample.rb new file mode 100644 index 0000000..3d3967d --- /dev/null +++ b/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 diff --git a/examples/EventCallback.rb b/examples/EventCallbackExample.rb similarity index 100% rename from examples/EventCallback.rb rename to examples/EventCallbackExample.rb diff --git a/examples/FaxDelete.rb b/examples/FaxDelete.rb deleted file mode 100644 index f68be34..0000000 --- a/examples/FaxDelete.rb +++ /dev/null @@ -1,14 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -begin - fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxDeleteExample.rb b/examples/FaxDeleteExample.rb new file mode 100644 index 0000000..ba55cc3 --- /dev/null +++ b/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 diff --git a/examples/FaxFiles.rb b/examples/FaxFiles.rb deleted file mode 100644 index 8f4955d..0000000 --- a/examples/FaxFiles.rb +++ /dev/null @@ -1,17 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - file_bin = fax_api.fax_files(data) - FileUtils.cp(file_bin.path, "path/to/file.pdf") -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxFilesExample.rb b/examples/FaxFilesExample.rb new file mode 100644 index 0000000..c8364b9 --- /dev/null +++ b/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 diff --git a/examples/FaxGet.rb b/examples/FaxGet.rb deleted file mode 100644 index 64dc1c0..0000000 --- a/examples/FaxGet.rb +++ /dev/null @@ -1,17 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - result = fax_api.fax_get(fax_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxGetExample.rb b/examples/FaxGetExample.rb new file mode 100644 index 0000000..6f2a651 --- /dev/null +++ b/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 diff --git a/examples/FaxLineAddUser.rb b/examples/FaxLineAddUser.rb deleted file mode 100644 index 1ad8553..0000000 --- a/examples/FaxLineAddUser.rb +++ /dev/null @@ -1,19 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineAddUserRequest.new -data.number = "[FAX_NUMBER]" -data.email_address = "member@dropboxsign.com" - -begin - result = fax_line_api.fax_line_add_user(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineAddUserExample.rb b/examples/FaxLineAddUserExample.rb new file mode 100644 index 0000000..2d3f74b --- /dev/null +++ b/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 diff --git a/examples/FaxLineAreaCodeGet.rb b/examples/FaxLineAreaCodeGet.rb deleted file mode 100644 index 571fb4f..0000000 --- a/examples/FaxLineAreaCodeGet.rb +++ /dev/null @@ -1,15 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -begin - result = fax_line_api.fax_line_area_code_get("US", "CA") - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineAreaCodeGetExample.rb b/examples/FaxLineAreaCodeGetExample.rb new file mode 100644 index 0000000..50e6e95 --- /dev/null +++ b/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 diff --git a/examples/FaxLineCreate.rb b/examples/FaxLineCreate.rb deleted file mode 100644 index 2619678..0000000 --- a/examples/FaxLineCreate.rb +++ /dev/null @@ -1,19 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineCreateRequest.new -data.area_code = 209 -data.country = "US" - -begin - result = fax_line_api.fax_line_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineCreateExample.rb b/examples/FaxLineCreateExample.rb new file mode 100644 index 0000000..22b0b08 --- /dev/null +++ b/examples/FaxLineCreateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_create_request = Dropbox::Sign::FaxLineCreateRequest.new +fax_line_create_request.area_code = 209 +fax_line_create_request.country = "US" + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_create( + fax_line_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_create: #{e}" +end diff --git a/examples/FaxLineDelete.rb b/examples/FaxLineDelete.rb deleted file mode 100644 index 001cf62..0000000 --- a/examples/FaxLineDelete.rb +++ /dev/null @@ -1,17 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineDeleteRequest.new -data.number = "[FAX_NUMBER]" - -begin - fax_line_api.fax_line_delete(data) -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineDeleteExample.rb b/examples/FaxLineDeleteExample.rb new file mode 100644 index 0000000..c81fc27 --- /dev/null +++ b/examples/FaxLineDeleteExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_delete_request = Dropbox::Sign::FaxLineDeleteRequest.new +fax_line_delete_request.number = "[FAX_NUMBER]" + +begin + Dropbox::Sign::FaxLineApi.new.fax_line_delete( + fax_line_delete_request, + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_delete: #{e}" +end diff --git a/examples/FaxLineGet.rb b/examples/FaxLineGet.rb deleted file mode 100644 index 090c2bd..0000000 --- a/examples/FaxLineGet.rb +++ /dev/null @@ -1,15 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -begin - result = fax_line_api.fax_line_get("[NUMBER]") - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineGetExample.rb b/examples/FaxLineGetExample.rb new file mode 100644 index 0000000..2215bc6 --- /dev/null +++ b/examples/FaxLineGetExample.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_get( + "123-123-1234", # number + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_get: #{e}" +end diff --git a/examples/FaxLineList.rb b/examples/FaxLineList.rb deleted file mode 100644 index 23a0ec8..0000000 --- a/examples/FaxLineList.rb +++ /dev/null @@ -1,15 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -begin - result = fax_line_api.fax_line_list() - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineListExample.rb b/examples/FaxLineListExample.rb new file mode 100644 index 0000000..9bae085 --- /dev/null +++ b/examples/FaxLineListExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_list( + { + account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + page_size: 20, + show_team_lines: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_list: #{e}" +end diff --git a/examples/FaxLineRemoveUser.rb b/examples/FaxLineRemoveUser.rb deleted file mode 100644 index 98bb7a0..0000000 --- a/examples/FaxLineRemoveUser.rb +++ /dev/null @@ -1,19 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineRemoveUserRequest.new -data.number = "[FAX_NUMBER]" -data.email_address = "member@dropboxsign.com" - -begin - result = fax_line_api.fax_line_remove_user(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineRemoveUserExample.rb b/examples/FaxLineRemoveUserExample.rb new file mode 100644 index 0000000..a8b2816 --- /dev/null +++ b/examples/FaxLineRemoveUserExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_remove_user_request = Dropbox::Sign::FaxLineRemoveUserRequest.new +fax_line_remove_user_request.number = "[FAX_NUMBER]" +fax_line_remove_user_request.email_address = "member@dropboxsign.com" + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_remove_user( + fax_line_remove_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_remove_user: #{e}" +end diff --git a/examples/FaxList.rb b/examples/FaxList.rb deleted file mode 100644 index 3f37a71..0000000 --- a/examples/FaxList.rb +++ /dev/null @@ -1,18 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -page = 1 -page_size = 2 - -begin - result = fax_api.fax_list({ page: page, page_size: page_size }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxListExample.rb b/examples/FaxListExample.rb new file mode 100644 index 0000000..1155ce1 --- /dev/null +++ b/examples/FaxListExample.rb @@ -0,0 +1,19 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxApi.new.fax_list( + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_list: #{e}" +end diff --git a/examples/FaxSend.rb b/examples/FaxSend.rb deleted file mode 100644 index c37cbbd..0000000 --- a/examples/FaxSend.rb +++ /dev/null @@ -1,25 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -data = Dropbox::Sign::FaxSendRequest.new -data.files = [File.new("example_signature_request.pdf", "r")] -data.test_mode = true -data.recipient = "16690000001" -data.sender = "16690000000" -data.cover_page_to = "Jill Fax" -data.cover_page_message = "I'm sending you a fax!" -data.cover_page_from = "Faxer Faxerson" -data.title = "This is what the fax is about!" - -begin - result = fax_api.fax_send(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxSendExample.rb b/examples/FaxSendExample.rb new file mode 100644 index 0000000..b5de600 --- /dev/null +++ b/examples/FaxSendExample.rb @@ -0,0 +1,28 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_send_request = Dropbox::Sign::FaxSendRequest.new +fax_send_request.recipient = "16690000001" +fax_send_request.sender = "16690000000" +fax_send_request.test_mode = true +fax_send_request.cover_page_to = "Jill Fax" +fax_send_request.cover_page_from = "Faxer Faxerson" +fax_send_request.cover_page_message = "I'm sending you a fax!" +fax_send_request.title = "This is what the fax is about!" +fax_send_request.files = [ + File.new("./example_fax.pdf", "r"), +] + +begin + response = Dropbox::Sign::FaxApi.new.fax_send( + fax_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_send: #{e}" +end diff --git a/examples/OauthTokenGenerate.rb b/examples/OauthTokenGenerate.rb deleted file mode 100644 index b5b38c8..0000000 --- a/examples/OauthTokenGenerate.rb +++ /dev/null @@ -1,16 +0,0 @@ -require "dropbox-sign" - -oauth_api = Dropbox::Sign::OAuthApi.new - -data = Dropbox::Sign::OAuthTokenGenerateRequest.new -data.state = "900e06e2" -data.code = "1b0d28d90c86c141" -data.client_id = "cc91c61d00f8bb2ece1428035716b" -data.client_secret = "1d14434088507ffa390e6f5528465" - -begin - result = oauth_api.oauth_token_generate(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/OauthTokenGenerateExample.rb b/examples/OauthTokenGenerateExample.rb new file mode 100644 index 0000000..3f2e9a4 --- /dev/null +++ b/examples/OauthTokenGenerateExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| +end + +o_auth_token_generate_request = Dropbox::Sign::OAuthTokenGenerateRequest.new +o_auth_token_generate_request.client_id = "cc91c61d00f8bb2ece1428035716b" +o_auth_token_generate_request.client_secret = "1d14434088507ffa390e6f5528465" +o_auth_token_generate_request.code = "1b0d28d90c86c141" +o_auth_token_generate_request.state = "900e06e2" +o_auth_token_generate_request.grant_type = "authorization_code" + +begin + response = Dropbox::Sign::OAuthApi.new.oauth_token_generate( + o_auth_token_generate_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling OAuthApi#oauth_token_generate: #{e}" +end diff --git a/examples/OauthTokenRefresh.rb b/examples/OauthTokenRefresh.rb deleted file mode 100644 index bac7eb6..0000000 --- a/examples/OauthTokenRefresh.rb +++ /dev/null @@ -1,13 +0,0 @@ -require "dropbox-sign" - -oauth_api = Dropbox::Sign::OAuthApi.new - -data = Dropbox::Sign::OAuthTokenRefreshRequest.new -data.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" - -begin - result = oauth_api.oauth_token_refresh(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/OauthTokenRefreshExample.rb b/examples/OauthTokenRefreshExample.rb new file mode 100644 index 0000000..7862b67 --- /dev/null +++ b/examples/OauthTokenRefreshExample.rb @@ -0,0 +1,19 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| +end + +o_auth_token_refresh_request = Dropbox::Sign::OAuthTokenRefreshRequest.new +o_auth_token_refresh_request.grant_type = "refresh_token" +o_auth_token_refresh_request.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" + +begin + response = Dropbox::Sign::OAuthApi.new.oauth_token_refresh( + o_auth_token_refresh_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling OAuthApi#oauth_token_refresh: #{e}" +end diff --git a/examples/ReportCreate.rb b/examples/ReportCreate.rb deleted file mode 100644 index 71da9d1..0000000 --- a/examples/ReportCreate.rb +++ /dev/null @@ -1,23 +0,0 @@ -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 - -report_api = Dropbox::Sign::ReportApi.new - -data = Dropbox::Sign::ReportCreateRequest.new -data.start_date = "09/01/2020" -data.end_date = "09/01/2020" -data.report_type = %w[user_activity document_status] - -begin - result = report_api.report_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ReportCreateExample.rb b/examples/ReportCreateExample.rb new file mode 100644 index 0000000..2b5587d --- /dev/null +++ b/examples/ReportCreateExample.rb @@ -0,0 +1,24 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +report_create_request = Dropbox::Sign::ReportCreateRequest.new +report_create_request.start_date = "09/01/2020" +report_create_request.end_date = "09/01/2020" +report_create_request.report_type = [ + "user_activity", + "document_status", +] + +begin + response = Dropbox::Sign::ReportApi.new.report_create( + report_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ReportApi#report_create: #{e}" +end diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb deleted file mode 100644 index e20babf..0000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +++ /dev/null @@ -1,59 +0,0 @@ -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_list_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_1_signer.role = "Client" -signer_list_1_signer.name = "George" -signer_list_1_signer.email_address = "george@example.com" -signer_list_1_signer.pin = "d79a3td" - -signer_list_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_1_custom_fields.name = "company" -signer_list_1_custom_fields.value = "ABC Corp" - -signer_list_1 = Dropbox::Sign::SubBulkSignerList.new -signer_list_1.signers = [signer_list_1_signer] -signer_list_1.custom_fields = [signer_list_1_custom_fields] - -signer_list_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_2_signer.role = "Client" -signer_list_2_signer.name = "Mary" -signer_list_2_signer.email_address = "mary@example.com" -signer_list_2_signer.pin = "gd9as5b" - -signer_list_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_2_custom_fields.name = "company" -signer_list_2_custom_fields.value = "123 LLC" - -signer_list_2 = Dropbox::Sign::SubBulkSignerList.new -signer_list_2.signers = [signer_list_2_signer] -signer_list_2.custom_fields = [signer_list_2_custom_fields] - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -data = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new -data.client_id = "1a659d9ad95bccd307ecad78d72192f8" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signer_list = [signer_list_1, signer_list_2] -data.ccs = [cc_1] -data.test_mode = true - -begin - result = signature_request_api.signature_request_bulk_create_embedded_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 0000000..82d3d8a --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,84 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_2_custom_fields_1.name = "company" +signer_list_2_custom_fields_1.value = "123 LLC" + +signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, +] + +signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_2_signers_1.role = "Client" +signer_list_2_signers_1.name = "Mary" +signer_list_2_signers_1.email_address = "mary@example.com" +signer_list_2_signers_1.pin = "gd9as5b" + +signer_list_2_signers = [ + signer_list_2_signers_1, +] + +signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_1_custom_fields_1.name = "company" +signer_list_1_custom_fields_1.value = "ABC Corp" + +signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, +] + +signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_1_signers_1.role = "Client" +signer_list_1_signers_1.name = "George" +signer_list_1_signers_1.email_address = "george@example.com" +signer_list_1_signers_1.pin = "d79a3td" + +signer_list_1_signers = [ + signer_list_1_signers_1, +] + +signer_list_1 = Dropbox::Sign::SubBulkSignerList.new +signer_list_1.custom_fields = signer_list_1_custom_fields +signer_list_1.signers = signer_list_1_signers + +signer_list_2 = Dropbox::Sign::SubBulkSignerList.new +signer_list_2.custom_fields = signer_list_2_custom_fields +signer_list_2.signers = signer_list_2_signers + +signer_list = [ + signer_list_1, + signer_list_2, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +signature_request_bulk_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new +signature_request_bulk_create_embedded_with_template_request.client_id = "1a659d9ad95bccd307ecad78d72192f8" +signature_request_bulk_create_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_bulk_create_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_bulk_create_embedded_with_template_request.subject = "Purchase Order" +signature_request_bulk_create_embedded_with_template_request.test_mode = true +signature_request_bulk_create_embedded_with_template_request.signer_list = signer_list +signature_request_bulk_create_embedded_with_template_request.ccs = ccs + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_create_embedded_with_template( + signature_request_bulk_create_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: #{e}" +end diff --git a/examples/SignatureRequestBulkSendWithTemplate.rb b/examples/SignatureRequestBulkSendWithTemplate.rb deleted file mode 100644 index 125bc06..0000000 --- a/examples/SignatureRequestBulkSendWithTemplate.rb +++ /dev/null @@ -1,58 +0,0 @@ -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_list_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_1_signer.role = "Client" -signer_list_1_signer.name = "George" -signer_list_1_signer.email_address = "george@example.com" -signer_list_1_signer.pin = "d79a3td" - -signer_list_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_1_custom_fields.name = "company" -signer_list_1_custom_fields.value = "ABC Corp" - -signer_list_1 = Dropbox::Sign::SubBulkSignerList.new -signer_list_1.signers = [signer_list_1_signer] -signer_list_1.custom_fields = [signer_list_1_custom_fields] - -signer_list_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_2_signer.role = "Client" -signer_list_2_signer.name = "Mary" -signer_list_2_signer.email_address = "mary@example.com" -signer_list_2_signer.pin = "gd9as5b" - -signer_list_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_2_custom_fields.name = "company" -signer_list_2_custom_fields.value = "123 LLC" - -signer_list_2 = Dropbox::Sign::SubBulkSignerList.new -signer_list_2.signers = [signer_list_2_signer] -signer_list_2.custom_fields = [signer_list_2_custom_fields] - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -data = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signer_list = [signer_list_1, signer_list_2] -data.ccs = [cc_1] -data.test_mode = true - -begin - result = signature_request_api.signature_request_bulk_send_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.rb b/examples/SignatureRequestBulkSendWithTemplateExample.rb new file mode 100644 index 0000000..6254c03 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.rb @@ -0,0 +1,84 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_2_custom_fields_1.name = "company" +signer_list_2_custom_fields_1.value = "123 LLC" + +signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, +] + +signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_2_signers_1.role = "Client" +signer_list_2_signers_1.name = "Mary" +signer_list_2_signers_1.email_address = "mary@example.com" +signer_list_2_signers_1.pin = "gd9as5b" + +signer_list_2_signers = [ + signer_list_2_signers_1, +] + +signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_1_custom_fields_1.name = "company" +signer_list_1_custom_fields_1.value = "ABC Corp" + +signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, +] + +signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_1_signers_1.role = "Client" +signer_list_1_signers_1.name = "George" +signer_list_1_signers_1.email_address = "george@example.com" +signer_list_1_signers_1.pin = "d79a3td" + +signer_list_1_signers = [ + signer_list_1_signers_1, +] + +signer_list_1 = Dropbox::Sign::SubBulkSignerList.new +signer_list_1.custom_fields = signer_list_1_custom_fields +signer_list_1.signers = signer_list_1_signers + +signer_list_2 = Dropbox::Sign::SubBulkSignerList.new +signer_list_2.custom_fields = signer_list_2_custom_fields +signer_list_2.signers = signer_list_2_signers + +signer_list = [ + signer_list_1, + signer_list_2, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +signature_request_bulk_send_with_template_request = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new +signature_request_bulk_send_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_bulk_send_with_template_request.message = "Glad we could come to an agreement." +signature_request_bulk_send_with_template_request.subject = "Purchase Order" +signature_request_bulk_send_with_template_request.test_mode = true +signature_request_bulk_send_with_template_request.signer_list = signer_list +signature_request_bulk_send_with_template_request.ccs = ccs + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_send_with_template( + signature_request_bulk_send_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: #{e}" +end diff --git a/examples/SignatureRequestCancel.rb b/examples/SignatureRequestCancel.rb deleted file mode 100644 index aab1277..0000000 --- a/examples/SignatureRequestCancel.rb +++ /dev/null @@ -1,20 +0,0 @@ -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_cancel(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestCancelExample.rb b/examples/SignatureRequestCancelExample.rb new file mode 100644 index 0000000..f516882 --- /dev/null +++ b/examples/SignatureRequestCancelExample.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::SignatureRequestApi.new.signature_request_cancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_cancel: #{e}" +end diff --git a/examples/SignatureRequestCreateEmbedded.rb b/examples/SignatureRequestCreateEmbedded.rb deleted file mode 100644 index 4cec8fa..0000000 --- a/examples/SignatureRequestCreateEmbedded.rb +++ /dev/null @@ -1,46 +0,0 @@ -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" - -data = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -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 = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"] -data.files = [File.new("example_signature_request.pdf", "r")] -data.signing_options = signing_options -data.test_mode = true - -begin - result = signature_request_api.signature_request_create_embedded(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestCreateEmbeddedExample.rb b/examples/SignatureRequestCreateEmbeddedExample.rb new file mode 100644 index 0000000..9be4112 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.rb @@ -0,0 +1,55 @@ +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::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_create_embedded_request = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new +signature_request_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_create_embedded_request.subject = "The NDA we talked about" +signature_request_create_embedded_request.test_mode = true +signature_request_create_embedded_request.title = "NDA with Acme Co." +signature_request_create_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_create_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded( + signature_request_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded: #{e}" +end diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb new file mode 100644 index 0000000..c9545ba --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb @@ -0,0 +1,81 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +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 + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_create_embedded_request = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new +signature_request_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_create_embedded_request.subject = "The NDA we talked about" +signature_request_create_embedded_request.test_mode = true +signature_request_create_embedded_request.title = "NDA with Acme Co." +signature_request_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_create_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded( + signature_request_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded: #{e}" +end diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.rb b/examples/SignatureRequestCreateEmbeddedWithTemplate.rb deleted file mode 100644 index 6aba3fd..0000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +++ /dev/null @@ -1,39 +0,0 @@ -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 = "jack@example.com" -signer_1.name = "Jack" - -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" - -data = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.signing_options = signing_options -data.test_mode = true - -begin - result = signature_request_api.signature_request_create_embedded_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 0000000..dbcd4af --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,44 @@ +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, +] + +signature_request_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new +signature_request_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_create_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_create_embedded_with_template_request.subject = "Purchase Order" +signature_request_create_embedded_with_template_request.test_mode = true +signature_request_create_embedded_with_template_request.signing_options = signing_options +signature_request_create_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded_with_template( + signature_request_create_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: #{e}" +end diff --git a/examples/SignatureRequestEdit.rb b/examples/SignatureRequestEdit.rb deleted file mode 100644 index b8db7b6..0000000 --- a/examples/SignatureRequestEdit.rb +++ /dev/null @@ -1,58 +0,0 @@ -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::SignatureRequestEditRequest.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 = [ - "lawyer1@dropboxsign.com", - "lawyer2@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 - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEditEmbedded.rb b/examples/SignatureRequestEditEmbedded.rb deleted file mode 100644 index 6b5d379..0000000 --- a/examples/SignatureRequestEditEmbedded.rb +++ /dev/null @@ -1,48 +0,0 @@ -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" - -data = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -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 = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"] -data.files = [File.new("example_signature_request.pdf", "r")] -data.signing_options = signing_options -data.test_mode = true - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit_embedded(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEditEmbeddedExample.rb b/examples/SignatureRequestEditEmbeddedExample.rb new file mode 100644 index 0000000..6228002 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.rb @@ -0,0 +1,56 @@ +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::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_edit_embedded_request = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new +signature_request_edit_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_embedded_request.subject = "The NDA we talked about" +signature_request_edit_embedded_request.test_mode = true +signature_request_edit_embedded_request.title = "NDA with Acme Co." +signature_request_edit_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded: #{e}" +end diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb new file mode 100644 index 0000000..6a0f05c --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb @@ -0,0 +1,82 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +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 + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_edit_embedded_request = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new +signature_request_edit_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_embedded_request.subject = "The NDA we talked about" +signature_request_edit_embedded_request.test_mode = true +signature_request_edit_embedded_request.title = "NDA with Acme Co." +signature_request_edit_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_edit_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded: #{e}" +end diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.rb b/examples/SignatureRequestEditEmbeddedWithTemplate.rb deleted file mode 100644 index 4dc4c9e..0000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.rb +++ /dev/null @@ -1,41 +0,0 @@ -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 = "jack@example.com" -signer_1.name = "Jack" - -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" - -data = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.signing_options = signing_options -data.test_mode = true - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit_embedded_with_template(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb b/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb new file mode 100644 index 0000000..9813d7b --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb @@ -0,0 +1,45 @@ +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, +] + +signature_request_edit_embedded_with_template_request = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new +signature_request_edit_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_edit_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_edit_embedded_with_template_request.subject = "Purchase Order" +signature_request_edit_embedded_with_template_request.test_mode = true +signature_request_edit_embedded_with_template_request.signing_options = signing_options +signature_request_edit_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded_with_template( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: #{e}" +end diff --git a/examples/SignatureRequestEditExample.rb b/examples/SignatureRequestEditExample.rb new file mode 100644 index 0000000..9c1d94b --- /dev/null +++ b/examples/SignatureRequestEditExample.rb @@ -0,0 +1,66 @@ +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" + +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::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_edit_request = Dropbox::Sign::SignatureRequestEditRequest.new +signature_request_edit_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_request.subject = "The NDA we talked about" +signature_request_edit_request.test_mode = true +signature_request_edit_request.title = "NDA with Acme Co." +signature_request_edit_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_edit_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_edit_request.field_options = field_options +signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit: #{e}" +end diff --git a/examples/SignatureRequestEditGroupedSignersExample.rb b/examples/SignatureRequestEditGroupedSignersExample.rb new file mode 100644 index 0000000..3b6a910 --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.rb @@ -0,0 +1,92 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +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 + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_edit_request = Dropbox::Sign::SignatureRequestEditRequest.new +signature_request_edit_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_request.subject = "The NDA we talked about" +signature_request_edit_request.test_mode = true +signature_request_edit_request.title = "NDA with Acme Co." +signature_request_edit_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_edit_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_edit_request.field_options = field_options +signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit: #{e}" +end diff --git a/examples/SignatureRequestEditWithTemplate.rb b/examples/SignatureRequestEditWithTemplate.rb deleted file mode 100644 index dacbaba..0000000 --- a/examples/SignatureRequestEditWithTemplate.rb +++ /dev/null @@ -1,52 +0,0 @@ -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 - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit_with_template(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEditWithTemplateExample.rb b/examples/SignatureRequestEditWithTemplateExample.rb new file mode 100644 index 0000000..ad299e5 --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.rb @@ -0,0 +1,64 @@ +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_edit_with_template_request = Dropbox::Sign::SignatureRequestEditWithTemplateRequest.new +signature_request_edit_with_template_request.template_ids = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +] +signature_request_edit_with_template_request.message = "Glad we could come to an agreement." +signature_request_edit_with_template_request.subject = "Purchase Order" +signature_request_edit_with_template_request.test_mode = true +signature_request_edit_with_template_request.signing_options = signing_options +signature_request_edit_with_template_request.signers = signers +signature_request_edit_with_template_request.ccs = ccs +signature_request_edit_with_template_request.custom_fields = custom_fields + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_with_template( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_with_template: #{e}" +end diff --git a/examples/SignatureRequestFiles.rb b/examples/SignatureRequestFiles.rb deleted file mode 100644 index 1710826..0000000 --- a/examples/SignatureRequestFiles.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 - file_bin = signature_request_api.signature_request_files(signature_request_id) - FileUtils.cp(file_bin.path, "path/to/file.pdf") -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestFilesAsDataUri.rb b/examples/SignatureRequestFilesAsDataUri.rb deleted file mode 100644 index b95c374..0000000 --- a/examples/SignatureRequestFilesAsDataUri.rb +++ /dev/null @@ -1,20 +0,0 @@ -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_files_as_data_uri(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestFilesAsDataUriExample.rb b/examples/SignatureRequestFilesAsDataUriExample.rb new file mode 100644 index 0000000..05cca11 --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.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::SignatureRequestApi.new.signature_request_files_as_data_uri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: #{e}" +end diff --git a/examples/SignatureRequestFilesAsFileUrl.rb b/examples/SignatureRequestFilesAsFileUrl.rb deleted file mode 100644 index a4294a2..0000000 --- a/examples/SignatureRequestFilesAsFileUrl.rb +++ /dev/null @@ -1,20 +0,0 @@ -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_files_as_file_url(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestFilesAsFileUrlExample.rb b/examples/SignatureRequestFilesAsFileUrlExample.rb new file mode 100644 index 0000000..623d201 --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.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::SignatureRequestApi.new.signature_request_files_as_file_url( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + { + force_download: 1, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files_as_file_url: #{e}" +end diff --git a/examples/SignatureRequestFilesExample.rb b/examples/SignatureRequestFilesExample.rb new file mode 100644 index 0000000..1fb60c8 --- /dev/null +++ b/examples/SignatureRequestFilesExample.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::SignatureRequestApi.new.signature_request_files( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + { + file_type: "pdf", + }, + ) + + FileUtils.cp(response.path, "./file_response") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files: #{e}" +end diff --git a/examples/SignatureRequestGet.rb b/examples/SignatureRequestGet.rb deleted file mode 100644 index 35721b8..0000000 --- a/examples/SignatureRequestGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/SignatureRequestGetExample.rb b/examples/SignatureRequestGetExample.rb new file mode 100644 index 0000000..99e0161 --- /dev/null +++ b/examples/SignatureRequestGetExample.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::SignatureRequestApi.new.signature_request_get( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_get: #{e}" +end diff --git a/examples/SignatureRequestList.rb b/examples/SignatureRequestList.rb deleted file mode 100644 index 30a4c49..0000000 --- a/examples/SignatureRequestList.rb +++ /dev/null @@ -1,21 +0,0 @@ -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 diff --git a/examples/SignatureRequestListExample.rb b/examples/SignatureRequestListExample.rb new file mode 100644 index 0000000..ba84cb6 --- /dev/null +++ b/examples/SignatureRequestListExample.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 + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_list( + { + account_id: nil, + page: 1, + page_size: 20, + query: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_list: #{e}" +end diff --git a/examples/SignatureRequestReleaseHold.rb b/examples/SignatureRequestReleaseHold.rb deleted file mode 100644 index e31f863..0000000 --- a/examples/SignatureRequestReleaseHold.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/SignatureRequestReleaseHoldExample.rb b/examples/SignatureRequestReleaseHoldExample.rb new file mode 100644 index 0000000..d4e3533 --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.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::SignatureRequestApi.new.signature_request_release_hold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_release_hold: #{e}" +end diff --git a/examples/SignatureRequestRemind.rb b/examples/SignatureRequestRemind.rb deleted file mode 100644 index 10979a4..0000000 --- a/examples/SignatureRequestRemind.rb +++ /dev/null @@ -1,23 +0,0 @@ -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 diff --git a/examples/SignatureRequestRemindExample.rb b/examples/SignatureRequestRemindExample.rb new file mode 100644 index 0000000..41109aa --- /dev/null +++ b/examples/SignatureRequestRemindExample.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 + +signature_request_remind_request = Dropbox::Sign::SignatureRequestRemindRequest.new +signature_request_remind_request.email_address = "john@example.com" + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_remind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_remind_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_remind: #{e}" +end diff --git a/examples/SignatureRequestRemove.rb b/examples/SignatureRequestRemove.rb deleted file mode 100644 index 63937f5..0000000 --- a/examples/SignatureRequestRemove.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/SignatureRequestRemoveExample.rb b/examples/SignatureRequestRemoveExample.rb new file mode 100644 index 0000000..56249f7 --- /dev/null +++ b/examples/SignatureRequestRemoveExample.rb @@ -0,0 +1,14 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + Dropbox::Sign::SignatureRequestApi.new.signature_request_remove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_remove: #{e}" +end diff --git a/examples/SignatureRequestSend.rb b/examples/SignatureRequestSend.rb deleted file mode 100644 index d6981f2..0000000 --- a/examples/SignatureRequestSend.rb +++ /dev/null @@ -1,56 +0,0 @@ -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 = [ - "lawyer1@dropboxsign.com", - "lawyer2@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 diff --git a/examples/SignatureRequestSendExample.rb b/examples/SignatureRequestSendExample.rb new file mode 100644 index 0000000..270ebe0 --- /dev/null +++ b/examples/SignatureRequestSendExample.rb @@ -0,0 +1,65 @@ +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" + +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::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_send_request = Dropbox::Sign::SignatureRequestSendRequest.new +signature_request_send_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_send_request.subject = "The NDA we talked about" +signature_request_send_request.test_mode = true +signature_request_send_request.title = "NDA with Acme Co." +signature_request_send_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_send_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_send_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_send_request.field_options = field_options +signature_request_send_request.signing_options = signing_options +signature_request_send_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send( + signature_request_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_send: #{e}" +end diff --git a/examples/SignatureRequestSendGroupedSignersExample.rb b/examples/SignatureRequestSendGroupedSignersExample.rb new file mode 100644 index 0000000..5f3a376 --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.rb @@ -0,0 +1,91 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +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 + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_send_request = Dropbox::Sign::SignatureRequestSendRequest.new +signature_request_send_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_send_request.subject = "The NDA we talked about" +signature_request_send_request.test_mode = true +signature_request_send_request.title = "NDA with Acme Co." +signature_request_send_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_send_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_send_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_send_request.field_options = field_options +signature_request_send_request.signing_options = signing_options +signature_request_send_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send( + signature_request_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_send: #{e}" +end diff --git a/examples/SignatureRequestSendWithTemplate.rb b/examples/SignatureRequestSendWithTemplate.rb deleted file mode 100644 index a31f711..0000000 --- a/examples/SignatureRequestSendWithTemplate.rb +++ /dev/null @@ -1,50 +0,0 @@ -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 diff --git a/examples/SignatureRequestSendWithTemplateExample.rb b/examples/SignatureRequestSendWithTemplateExample.rb new file mode 100644 index 0000000..24fd0de --- /dev/null +++ b/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 diff --git a/examples/SignatureRequestUpdate.rb b/examples/SignatureRequestUpdate.rb deleted file mode 100644 index 8294a44..0000000 --- a/examples/SignatureRequestUpdate.rb +++ /dev/null @@ -1,24 +0,0 @@ -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 diff --git a/examples/SignatureRequestUpdateExample.rb b/examples/SignatureRequestUpdateExample.rb new file mode 100644 index 0000000..66ff44b --- /dev/null +++ b/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 diff --git a/examples/TeamAddMember.rb b/examples/TeamAddMember.rb deleted file mode 100644 index 34b41e3..0000000 --- a/examples/TeamAddMember.rb +++ /dev/null @@ -1,21 +0,0 @@ -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 diff --git a/examples/TeamAddMemberAccountIdExample.rb b/examples/TeamAddMemberAccountIdExample.rb new file mode 100644 index 0000000..d905e84 --- /dev/null +++ b/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 diff --git a/examples/TeamAddMemberExample.rb b/examples/TeamAddMemberExample.rb new file mode 100644 index 0000000..120af12 --- /dev/null +++ b/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 diff --git a/examples/TeamCreate.rb b/examples/TeamCreate.rb deleted file mode 100644 index b97bfa3..0000000 --- a/examples/TeamCreate.rb +++ /dev/null @@ -1,21 +0,0 @@ -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 diff --git a/examples/TeamCreateExample.rb b/examples/TeamCreateExample.rb new file mode 100644 index 0000000..fcae238 --- /dev/null +++ b/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 diff --git a/examples/TeamDelete.rb b/examples/TeamDelete.rb deleted file mode 100644 index 336f3ba..0000000 --- a/examples/TeamDelete.rb +++ /dev/null @@ -1,18 +0,0 @@ -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 diff --git a/examples/TeamDeleteExample.rb b/examples/TeamDeleteExample.rb new file mode 100644 index 0000000..1e7df40 --- /dev/null +++ b/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 diff --git a/examples/TeamGet.rb b/examples/TeamGet.rb deleted file mode 100644 index 7f30488..0000000 --- a/examples/TeamGet.rb +++ /dev/null @@ -1,18 +0,0 @@ -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 diff --git a/examples/TeamGetExample.rb b/examples/TeamGetExample.rb new file mode 100644 index 0000000..f47b86e --- /dev/null +++ b/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 diff --git a/examples/TeamInfo.rb b/examples/TeamInfo.rb deleted file mode 100644 index a7435f0..0000000 --- a/examples/TeamInfo.rb +++ /dev/null @@ -1,18 +0,0 @@ -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 diff --git a/examples/TeamInfoExample.rb b/examples/TeamInfoExample.rb new file mode 100644 index 0000000..a509938 --- /dev/null +++ b/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 diff --git a/examples/TeamInvites.rb b/examples/TeamInvites.rb deleted file mode 100644 index 7294ea4..0000000 --- a/examples/TeamInvites.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/TeamInvitesExample.rb b/examples/TeamInvitesExample.rb new file mode 100644 index 0000000..5cbb0de --- /dev/null +++ b/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 diff --git a/examples/TeamMembers.rb b/examples/TeamMembers.rb deleted file mode 100644 index ce05cb2..0000000 --- a/examples/TeamMembers.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/TeamMembersExample.rb b/examples/TeamMembersExample.rb new file mode 100644 index 0000000..6a01367 --- /dev/null +++ b/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 diff --git a/examples/TeamRemoveMember.rb b/examples/TeamRemoveMember.rb deleted file mode 100644 index b2255ef..0000000 --- a/examples/TeamRemoveMember.rb +++ /dev/null @@ -1,22 +0,0 @@ -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 diff --git a/examples/TeamRemoveMemberAccountIdExample.rb b/examples/TeamRemoveMemberAccountIdExample.rb new file mode 100644 index 0000000..586047c --- /dev/null +++ b/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 diff --git a/examples/TeamRemoveMemberExample.rb b/examples/TeamRemoveMemberExample.rb new file mode 100644 index 0000000..eb9f8cc --- /dev/null +++ b/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 diff --git a/examples/TeamSubTeams.rb b/examples/TeamSubTeams.rb deleted file mode 100644 index 94192cd..0000000 --- a/examples/TeamSubTeams.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/TeamSubTeamsExample.rb b/examples/TeamSubTeamsExample.rb new file mode 100644 index 0000000..335ba78 --- /dev/null +++ b/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 diff --git a/examples/TeamUpdate.rb b/examples/TeamUpdate.rb deleted file mode 100644 index 27edefa..0000000 --- a/examples/TeamUpdate.rb +++ /dev/null @@ -1,21 +0,0 @@ -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 diff --git a/examples/TeamUpdateExample.rb b/examples/TeamUpdateExample.rb new file mode 100644 index 0000000..5f0c023 --- /dev/null +++ b/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 diff --git a/examples/TemplateAddUser.rb b/examples/TemplateAddUser.rb deleted file mode 100644 index 89573c3..0000000 --- a/examples/TemplateAddUser.rb +++ /dev/null @@ -1,23 +0,0 @@ -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 diff --git a/examples/TemplateAddUserExample.rb b/examples/TemplateAddUserExample.rb new file mode 100644 index 0000000..b4807c7 --- /dev/null +++ b/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 diff --git a/examples/TemplateCreate.rb b/examples/TemplateCreate.rb deleted file mode 100644 index 09863a2..0000000 --- a/examples/TemplateCreate.rb +++ /dev/null @@ -1,49 +0,0 @@ -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::TemplateCreateRequest.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(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateCreateEmbeddedDraft.rb b/examples/TemplateCreateEmbeddedDraft.rb deleted file mode 100644 index 6eb0f27..0000000 --- a/examples/TemplateCreateEmbeddedDraft.rb +++ /dev/null @@ -1,49 +0,0 @@ -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 diff --git a/examples/TemplateCreateEmbeddedDraftExample.rb b/examples/TemplateCreateEmbeddedDraftExample.rb new file mode 100644 index 0000000..199ad10 --- /dev/null +++ b/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 diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb new file mode 100644 index 0000000..8bab29c --- /dev/null +++ b/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 diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb new file mode 100644 index 0000000..a50b396 --- /dev/null +++ b/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 diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb new file mode 100644 index 0000000..ac81990 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb @@ -0,0 +1,96 @@ +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_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 = "1" +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.placeholder = "" +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_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 diff --git a/examples/TemplateCreateExample.rb b/examples/TemplateCreateExample.rb new file mode 100644 index 0000000..3019fb4 --- /dev/null +++ b/examples/TemplateCreateExample.rb @@ -0,0 +1,96 @@ +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" + +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, +] + +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 = "1" +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.placeholder = "" +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, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateCreateFormFieldGroupsExample.rb b/examples/TemplateCreateFormFieldGroupsExample.rb new file mode 100644 index 0000000..1c90c2b --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.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" + +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, +] + +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, +] + +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, +] + +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, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.form_field_groups = form_field_groups +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateCreateFormFieldRulesExample.rb b/examples/TemplateCreateFormFieldRulesExample.rb new file mode 100644 index 0000000..1934c3f --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.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" + +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, +] + +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, +] + +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, +] + +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, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.form_field_rules = form_field_rules +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.rb b/examples/TemplateCreateFormFieldsPerDocumentExample.rb new file mode 100644 index 0000000..65b97f8 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.rb @@ -0,0 +1,96 @@ +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" + +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, +] + +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 = "1" +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.placeholder = "" +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, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateDelete.rb b/examples/TemplateDelete.rb deleted file mode 100644 index cff67b4..0000000 --- a/examples/TemplateDelete.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/TemplateDeleteExample.rb b/examples/TemplateDeleteExample.rb new file mode 100644 index 0000000..e6afdd3 --- /dev/null +++ b/examples/TemplateDeleteExample.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::TemplateApi.new.template_delete( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_delete: #{e}" +end diff --git a/examples/TemplateFiles.rb b/examples/TemplateFiles.rb deleted file mode 100644 index 0ad5d60..0000000 --- a/examples/TemplateFiles.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/TemplateFilesAsDataUri.rb b/examples/TemplateFilesAsDataUri.rb deleted file mode 100644 index a668955..0000000 --- a/examples/TemplateFilesAsDataUri.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/TemplateFilesAsDataUriExample.rb b/examples/TemplateFilesAsDataUriExample.rb new file mode 100644 index 0000000..5e040d3 --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.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::TemplateApi.new.template_files_as_data_uri( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files_as_data_uri: #{e}" +end diff --git a/examples/TemplateFilesAsFileUrl.rb b/examples/TemplateFilesAsFileUrl.rb deleted file mode 100644 index b5502db..0000000 --- a/examples/TemplateFilesAsFileUrl.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/TemplateFilesAsFileUrlExample.rb b/examples/TemplateFilesAsFileUrlExample.rb new file mode 100644 index 0000000..0cce8ed --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.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::TemplateApi.new.template_files_as_file_url( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + { + force_download: 1, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files_as_file_url: #{e}" +end diff --git a/examples/TemplateFilesExample.rb b/examples/TemplateFilesExample.rb new file mode 100644 index 0000000..89d2949 --- /dev/null +++ b/examples/TemplateFilesExample.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::TemplateApi.new.template_files( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + FileUtils.cp(response.path, "./file_response") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files: #{e}" +end diff --git a/examples/TemplateGet.rb b/examples/TemplateGet.rb deleted file mode 100644 index f308d2b..0000000 --- a/examples/TemplateGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/TemplateGetExample.rb b/examples/TemplateGetExample.rb new file mode 100644 index 0000000..a1fd880 --- /dev/null +++ b/examples/TemplateGetExample.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::TemplateApi.new.template_get( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_get: #{e}" +end diff --git a/examples/TemplateList.rb b/examples/TemplateList.rb deleted file mode 100644 index e0006c7..0000000 --- a/examples/TemplateList.rb +++ /dev/null @@ -1,20 +0,0 @@ -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 diff --git a/examples/TemplateListExample.rb b/examples/TemplateListExample.rb new file mode 100644 index 0000000..4432973 --- /dev/null +++ b/examples/TemplateListExample.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 + +begin + response = Dropbox::Sign::TemplateApi.new.template_list( + { + account_id: nil, + page: 1, + page_size: 20, + query: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_list: #{e}" +end diff --git a/examples/TemplateRemoveUser.rb b/examples/TemplateRemoveUser.rb deleted file mode 100644 index b903529..0000000 --- a/examples/TemplateRemoveUser.rb +++ /dev/null @@ -1,23 +0,0 @@ -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::TemplateRemoveUserRequest.new -data.email_address = "george@dropboxsign.com" - -template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536" - -begin - result = template_api.template_remove_user(template_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateRemoveUserExample.rb b/examples/TemplateRemoveUserExample.rb new file mode 100644 index 0000000..a876f91 --- /dev/null +++ b/examples/TemplateRemoveUserExample.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_remove_user_request = Dropbox::Sign::TemplateRemoveUserRequest.new +template_remove_user_request.email_address = "george@dropboxsign.com" + +begin + response = Dropbox::Sign::TemplateApi.new.template_remove_user( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_remove_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_remove_user: #{e}" +end diff --git a/examples/TemplateUpdateFiles.rb b/examples/TemplateUpdateFiles.rb deleted file mode 100644 index f4c31e0..0000000 --- a/examples/TemplateUpdateFiles.rb +++ /dev/null @@ -1,23 +0,0 @@ -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::TemplateUpdateFilesRequest.new -data.files = [File.new("example_signature_request.pdf", "r")] - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = template_api.template_update_files(template_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateUpdateFilesExample.rb b/examples/TemplateUpdateFilesExample.rb new file mode 100644 index 0000000..0e95c9d --- /dev/null +++ b/examples/TemplateUpdateFilesExample.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 + +template_update_files_request = Dropbox::Sign::TemplateUpdateFilesRequest.new +template_update_files_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] + +begin + response = Dropbox::Sign::TemplateApi.new.template_update_files( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_update_files_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_update_files: #{e}" +end diff --git a/examples/UnclaimedDraftCreate.rb b/examples/UnclaimedDraftCreate.rb deleted file mode 100644 index 36d7ff7..0000000 --- a/examples/UnclaimedDraftCreate.rb +++ /dev/null @@ -1,56 +0,0 @@ -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", -] -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 = unclaimed_draft_api.unclaimed_draft_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftCreateEmbedded.rb b/examples/UnclaimedDraftCreateEmbedded.rb deleted file mode 100644 index ab80ad5..0000000 --- a/examples/UnclaimedDraftCreateEmbedded.rb +++ /dev/null @@ -1,24 +0,0 @@ -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 - -begin - result = unclaimed_draft_api.unclaimed_draft_create_embedded(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.rb b/examples/UnclaimedDraftCreateEmbeddedExample.rb new file mode 100644 index 0000000..dc954bc --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.rb @@ -0,0 +1,25 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +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 + 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 UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb new file mode 100644 index 0000000..a335227 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb @@ -0,0 +1,71 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +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, +] + +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 = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_field_groups = form_field_groups +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + 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 UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb new file mode 100644 index 0000000..c1aa490 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb @@ -0,0 +1,87 @@ +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, +] + +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, +] + +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 = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_field_rules = form_field_rules +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + 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 UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb new file mode 100644 index 0000000..efffe1f --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb @@ -0,0 +1,59 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +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 = "1" +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.placeholder = "" +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, +] + +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 = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + 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 UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb deleted file mode 100644 index abe1f5c..0000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +++ /dev/null @@ -1,35 +0,0 @@ -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::SubUnclaimedDraftTemplateSigner.new -signer_1.role = "Client" -signer_1.name = "George" -signer_1.email_address = "george@example.com" - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@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 - -begin - result = unclaimed_draft_api.unclaimed_draft_create_embedded_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 0000000..d5f7ee2 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,44 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@dropboxsign.com" + +ccs = [ + ccs_1, +] + +signers_1 = Dropbox::Sign::SubUnclaimedDraftTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +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 + 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 UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: #{e}" +end diff --git a/examples/UnclaimedDraftCreateExample.rb b/examples/UnclaimedDraftCreateExample.rb new file mode 100644 index 0000000..4375558 --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.rb @@ -0,0 +1,34 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signers_1 = Dropbox::Sign::SubUnclaimedDraftSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers = [ + signers_1, +] + +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 + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb b/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb new file mode 100644 index 0000000..9f1db82 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb @@ -0,0 +1,70 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +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, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_field_groups = form_field_groups +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.rb b/examples/UnclaimedDraftCreateFormFieldRulesExample.rb new file mode 100644 index 0000000..0ac3d95 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.rb @@ -0,0 +1,86 @@ +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, +] + +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, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_field_rules = form_field_rules +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb new file mode 100644 index 0000000..bb0434c --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb @@ -0,0 +1,58 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +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 = "1" +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.placeholder = "" +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, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftEditAndResend.rb b/examples/UnclaimedDraftEditAndResend.rb deleted file mode 100644 index 9b4b1c7..0000000 --- a/examples/UnclaimedDraftEditAndResend.rb +++ /dev/null @@ -1,24 +0,0 @@ -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" - -begin - result = unclaimed_draft_api.unclaimed_draft_edit_and_resend(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftEditAndResendExample.rb b/examples/UnclaimedDraftEditAndResendExample.rb new file mode 100644 index 0000000..34a23ea --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.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 + +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 + 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 UnclaimedDraftApi#unclaimed_draft_edit_and_resend: #{e}" +end diff --git a/lib/dropbox-sign.rb b/lib/dropbox-sign.rb index 0921573..413c293 100644 --- a/lib/dropbox-sign.rb +++ b/lib/dropbox-sign.rb @@ -6,7 +6,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 @@ -80,6 +80,10 @@ require 'dropbox-sign/models/signature_request_bulk_send_with_template_request' require 'dropbox-sign/models/signature_request_create_embedded_request' require 'dropbox-sign/models/signature_request_create_embedded_with_template_request' +require 'dropbox-sign/models/signature_request_edit_embedded_request' +require 'dropbox-sign/models/signature_request_edit_embedded_with_template_request' +require 'dropbox-sign/models/signature_request_edit_request' +require 'dropbox-sign/models/signature_request_edit_with_template_request' require 'dropbox-sign/models/signature_request_get_response' require 'dropbox-sign/models/signature_request_list_response' require 'dropbox-sign/models/signature_request_remind_request' diff --git a/lib/dropbox-sign/api/account_api.rb b/lib/dropbox-sign/api/account_api.rb index 35934cb..454dd21 100644 --- a/lib/dropbox-sign/api/account_api.rb +++ b/lib/dropbox-sign/api/account_api.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/api/api_app_api.rb b/lib/dropbox-sign/api/api_app_api.rb index 7b0c42e..a6fb785 100644 --- a/lib/dropbox-sign/api/api_app_api.rb +++ b/lib/dropbox-sign/api/api_app_api.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/api/bulk_send_job_api.rb b/lib/dropbox-sign/api/bulk_send_job_api.rb index 567b8c3..5f62840 100644 --- a/lib/dropbox-sign/api/bulk_send_job_api.rb +++ b/lib/dropbox-sign/api/bulk_send_job_api.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/api/embedded_api.rb b/lib/dropbox-sign/api/embedded_api.rb index 3b25c76..5724c49 100644 --- a/lib/dropbox-sign/api/embedded_api.rb +++ b/lib/dropbox-sign/api/embedded_api.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/api/fax_api.rb b/lib/dropbox-sign/api/fax_api.rb index 17fca79..aac2bc9 100644 --- a/lib/dropbox-sign/api/fax_api.rb +++ b/lib/dropbox-sign/api/fax_api.rb @@ -6,7 +6,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 @@ -23,7 +23,7 @@ def initialize(api_client = ApiClient.default) @api_client = api_client end # Delete Fax - # Deletes the specified Fax from the system. + # Deletes the specified Fax from the system # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [nil] @@ -33,7 +33,7 @@ def fax_delete(fax_id, opts = {}) end # Delete Fax - # Deletes the specified Fax from the system. + # Deletes the specified Fax from the system # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -89,8 +89,8 @@ def fax_delete_with_http_info(fax_id, opts = {}) return data, status_code, headers end - # List Fax Files - # Returns list of fax files + # Download Fax Files + # Downloads files associated with a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [File] @@ -99,8 +99,8 @@ def fax_files(fax_id, opts = {}) data end - # List Fax Files - # Returns list of fax files + # Download Fax Files + # Downloads files associated with a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers @@ -184,7 +184,7 @@ def fax_files_with_http_info(fax_id, opts = {}) end # Get Fax - # Returns information about fax + # Returns information about a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [FaxGetResponse] @@ -194,7 +194,7 @@ def fax_get(fax_id, opts = {}) end # Get Fax - # Returns information about fax + # Returns information about a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers @@ -278,10 +278,10 @@ def fax_get_with_http_info(fax_id, opts = {}) end # Lists Faxes - # Returns properties of multiple faxes + # Returns properties of multiple Faxes # @param [Hash] opts the optional parameters - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) + # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) # @return [FaxListResponse] def fax_list(opts = {}) data, _status_code, _headers = fax_list_with_http_info(opts) @@ -289,10 +289,10 @@ def fax_list(opts = {}) end # Lists Faxes - # Returns properties of multiple faxes + # Returns properties of multiple Faxes # @param [Hash] opts the optional parameters - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) + # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) # @return [Array<(FaxListResponse, Integer, Hash)>] FaxListResponse data, response status code and response headers def fax_list_with_http_info(opts = {}) if @api_client.config.debugging @@ -384,7 +384,7 @@ def fax_list_with_http_info(opts = {}) end # Send Fax - # Action to prepare and send a fax + # Creates and sends a new Fax with the submitted file(s) # @param fax_send_request [FaxSendRequest] # @param [Hash] opts the optional parameters # @return [FaxGetResponse] @@ -394,7 +394,7 @@ def fax_send(fax_send_request, opts = {}) end # Send Fax - # Action to prepare and send a fax + # Creates and sends a new Fax with the submitted file(s) # @param fax_send_request [FaxSendRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers diff --git a/lib/dropbox-sign/api/fax_line_api.rb b/lib/dropbox-sign/api/fax_line_api.rb index 7adb326..02d224c 100644 --- a/lib/dropbox-sign/api/fax_line_api.rb +++ b/lib/dropbox-sign/api/fax_line_api.rb @@ -6,7 +6,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 @@ -132,12 +132,12 @@ def fax_line_add_user_with_http_info(fax_line_add_user_request, opts = {}) end # Get Available Fax Line Area Codes - # Returns a response with the area codes available for a given state/provice and city. - # @param country [String] Filter area codes by country. + # Returns a list of available area codes for a given state/province and city + # @param country [String] Filter area codes by country # @param [Hash] opts the optional parameters - # @option opts [String] :state Filter area codes by state. - # @option opts [String] :province Filter area codes by province. - # @option opts [String] :city Filter area codes by city. + # @option opts [String] :state Filter area codes by state + # @option opts [String] :province Filter area codes by province + # @option opts [String] :city Filter area codes by city # @return [FaxLineAreaCodeGetResponse] def fax_line_area_code_get(country, opts = {}) data, _status_code, _headers = fax_line_area_code_get_with_http_info(country, opts) @@ -145,12 +145,12 @@ def fax_line_area_code_get(country, opts = {}) end # Get Available Fax Line Area Codes - # Returns a response with the area codes available for a given state/provice and city. - # @param country [String] Filter area codes by country. + # Returns a list of available area codes for a given state/province and city + # @param country [String] Filter area codes by country # @param [Hash] opts the optional parameters - # @option opts [String] :state Filter area codes by state. - # @option opts [String] :province Filter area codes by province. - # @option opts [String] :city Filter area codes by city. + # @option opts [String] :state Filter area codes by state + # @option opts [String] :province Filter area codes by province + # @option opts [String] :city Filter area codes by city # @return [Array<(FaxLineAreaCodeGetResponse, Integer, Hash)>] FaxLineAreaCodeGetResponse data, response status code and response headers def fax_line_area_code_get_with_http_info(country, opts = {}) if @api_client.config.debugging @@ -249,7 +249,7 @@ def fax_line_area_code_get_with_http_info(country, opts = {}) end # Purchase Fax Line - # Purchases a new Fax Line. + # Purchases a new Fax Line # @param fax_line_create_request [FaxLineCreateRequest] # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -259,7 +259,7 @@ def fax_line_create(fax_line_create_request, opts = {}) end # Purchase Fax Line - # Purchases a new Fax Line. + # Purchases a new Fax Line # @param fax_line_create_request [FaxLineCreateRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers @@ -441,7 +441,7 @@ def fax_line_delete_with_http_info(fax_line_delete_request, opts = {}) # Get Fax Line # Returns the properties and settings of a Fax Line. - # @param number [String] The Fax Line number. + # @param number [String] The Fax Line number # @param [Hash] opts the optional parameters # @return [FaxLineResponse] def fax_line_get(number, opts = {}) @@ -451,7 +451,7 @@ def fax_line_get(number, opts = {}) # Get Fax Line # Returns the properties and settings of a Fax Line. - # @param number [String] The Fax Line number. + # @param number [String] The Fax Line number # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers def fax_line_get_with_http_info(number, opts = {}) @@ -538,9 +538,9 @@ def fax_line_get_with_http_info(number, opts = {}) # Returns the properties and settings of multiple Fax Lines. # @param [Hash] opts the optional parameters # @option opts [String] :account_id Account ID - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) - # @option opts [Boolean] :show_team_lines Show team lines + # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) + # @option opts [Boolean] :show_team_lines Include Fax Lines belonging to team members in the list # @return [FaxLineListResponse] def fax_line_list(opts = {}) data, _status_code, _headers = fax_line_list_with_http_info(opts) @@ -551,9 +551,9 @@ def fax_line_list(opts = {}) # Returns the properties and settings of multiple Fax Lines. # @param [Hash] opts the optional parameters # @option opts [String] :account_id Account ID - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) - # @option opts [Boolean] :show_team_lines Show team lines + # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) + # @option opts [Boolean] :show_team_lines Include Fax Lines belonging to team members in the list # @return [Array<(FaxLineListResponse, Integer, Hash)>] FaxLineListResponse data, response status code and response headers def fax_line_list_with_http_info(opts = {}) if @api_client.config.debugging @@ -635,7 +635,7 @@ def fax_line_list_with_http_info(opts = {}) end # Remove Fax Line Access - # Removes a user's access to the specified Fax Line. + # Removes a user's access to the specified Fax Line # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -645,7 +645,7 @@ def fax_line_remove_user(fax_line_remove_user_request, opts = {}) end # Remove Fax Line Access - # Removes a user's access to the specified Fax Line. + # Removes a user's access to the specified Fax Line # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers diff --git a/lib/dropbox-sign/api/o_auth_api.rb b/lib/dropbox-sign/api/o_auth_api.rb index 6e9d748..ae9af5a 100644 --- a/lib/dropbox-sign/api/o_auth_api.rb +++ b/lib/dropbox-sign/api/o_auth_api.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/api/report_api.rb b/lib/dropbox-sign/api/report_api.rb index a48beb3..ee776ff 100644 --- a/lib/dropbox-sign/api/report_api.rb +++ b/lib/dropbox-sign/api/report_api.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/api/signature_request_api.rb b/lib/dropbox-sign/api/signature_request_api.rb index d61d27b..d2b9684 100644 --- a/lib/dropbox-sign/api/signature_request_api.rb +++ b/lib/dropbox-sign/api/signature_request_api.rb @@ -6,7 +6,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 @@ -525,6 +525,466 @@ def signature_request_create_embedded_with_template_with_http_info(signature_req return data, status_code, headers end + # Edit Signature Request + # Edits and sends a SignatureRequest with the submitted documents. 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:** Edit and resend *will* deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_request [SignatureRequestEditRequest] + # @param [Hash] opts the optional parameters + # @return [SignatureRequestGetResponse] + def signature_request_edit(signature_request_id, signature_request_edit_request, opts = {}) + data, _status_code, _headers = signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request, opts) + data + end + + # Edit Signature Request + # Edits and sends a SignatureRequest with the submitted documents. 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:** Edit and resend *will* deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_request [SignatureRequestEditRequest] + # @param [Hash] opts the optional parameters + # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers + def signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit ...' + end + # verify the required parameter 'signature_request_id' is set + if @api_client.config.client_side_validation && signature_request_id.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit" + end + # verify the required parameter 'signature_request_edit_request' is set + if @api_client.config.client_side_validation && signature_request_edit_request.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_edit_request' when calling SignatureRequestApi.signature_request_edit" + end + # resource path + local_var_path = '/signature_request/edit/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + post_body = {} + form_params = opts[:form_params] || {} + result = @api_client.generate_form_data( + signature_request_edit_request, + Dropbox::Sign::SignatureRequestEditRequest.openapi_types + ) + + # form parameters + if result[:has_file] + form_params = opts[:form_params] || result[:params] + header_params['Content-Type'] = 'multipart/form-data' + else + # http body (model) + post_body = opts[:debug_body] || result[:params] + end + + # return_type + return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2'] + + new_options = opts.merge( + :operation => :"SignatureRequestApi.signature_request_edit", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::SignatureRequestGetResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Edit Embedded Signature Request + # Edits a 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. **NOTE:** Edit and resend *will* deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_embedded_request [SignatureRequestEditEmbeddedRequest] + # @param [Hash] opts the optional parameters + # @return [SignatureRequestGetResponse] + def signature_request_edit_embedded(signature_request_id, signature_request_edit_embedded_request, opts = {}) + data, _status_code, _headers = signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request, opts) + data + end + + # Edit Embedded Signature Request + # Edits a 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. **NOTE:** Edit and resend *will* deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_embedded_request [SignatureRequestEditEmbeddedRequest] + # @param [Hash] opts the optional parameters + # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers + def signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit_embedded ...' + end + # verify the required parameter 'signature_request_id' is set + if @api_client.config.client_side_validation && signature_request_id.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit_embedded" + end + # verify the required parameter 'signature_request_edit_embedded_request' is set + if @api_client.config.client_side_validation && signature_request_edit_embedded_request.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_edit_embedded_request' when calling SignatureRequestApi.signature_request_edit_embedded" + end + # resource path + local_var_path = '/signature_request/edit_embedded/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + post_body = {} + form_params = opts[:form_params] || {} + result = @api_client.generate_form_data( + signature_request_edit_embedded_request, + Dropbox::Sign::SignatureRequestEditEmbeddedRequest.openapi_types + ) + + # form parameters + if result[:has_file] + form_params = opts[:form_params] || result[:params] + header_params['Content-Type'] = 'multipart/form-data' + else + # http body (model) + post_body = opts[:debug_body] || result[:params] + end + + # return_type + return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2'] + + new_options = opts.merge( + :operation => :"SignatureRequestApi.signature_request_edit_embedded", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::SignatureRequestGetResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit_embedded\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Edit Embedded Signature Request with Template + # Edits a 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. **NOTE:** Edit and resend *will* deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_embedded_with_template_request [SignatureRequestEditEmbeddedWithTemplateRequest] + # @param [Hash] opts the optional parameters + # @return [SignatureRequestGetResponse] + def signature_request_edit_embedded_with_template(signature_request_id, signature_request_edit_embedded_with_template_request, opts = {}) + data, _status_code, _headers = signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request, opts) + data + end + + # Edit Embedded Signature Request with Template + # Edits a 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. **NOTE:** Edit and resend *will* deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_embedded_with_template_request [SignatureRequestEditEmbeddedWithTemplateRequest] + # @param [Hash] opts the optional parameters + # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers + def signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit_embedded_with_template ...' + end + # verify the required parameter 'signature_request_id' is set + if @api_client.config.client_side_validation && signature_request_id.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit_embedded_with_template" + end + # verify the required parameter 'signature_request_edit_embedded_with_template_request' is set + if @api_client.config.client_side_validation && signature_request_edit_embedded_with_template_request.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_edit_embedded_with_template_request' when calling SignatureRequestApi.signature_request_edit_embedded_with_template" + end + # resource path + local_var_path = '/signature_request/edit_embedded_with_template/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + post_body = {} + form_params = opts[:form_params] || {} + result = @api_client.generate_form_data( + signature_request_edit_embedded_with_template_request, + Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.openapi_types + ) + + # form parameters + if result[:has_file] + form_params = opts[:form_params] || result[:params] + header_params['Content-Type'] = 'multipart/form-data' + else + # http body (model) + post_body = opts[:debug_body] || result[:params] + end + + # return_type + return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2'] + + new_options = opts.merge( + :operation => :"SignatureRequestApi.signature_request_edit_embedded_with_template", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::SignatureRequestGetResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit_embedded_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Edit Signature Request With Template + # Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_with_template_request [SignatureRequestEditWithTemplateRequest] + # @param [Hash] opts the optional parameters + # @return [SignatureRequestGetResponse] + def signature_request_edit_with_template(signature_request_id, signature_request_edit_with_template_request, opts = {}) + data, _status_code, _headers = signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request, opts) + data + end + + # Edit Signature Request With Template + # Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + # @param signature_request_id [String] The id of the SignatureRequest to edit. + # @param signature_request_edit_with_template_request [SignatureRequestEditWithTemplateRequest] + # @param [Hash] opts the optional parameters + # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers + def signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit_with_template ...' + end + # verify the required parameter 'signature_request_id' is set + if @api_client.config.client_side_validation && signature_request_id.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit_with_template" + end + # verify the required parameter 'signature_request_edit_with_template_request' is set + if @api_client.config.client_side_validation && signature_request_edit_with_template_request.nil? + fail ArgumentError, "Missing the required parameter 'signature_request_edit_with_template_request' when calling SignatureRequestApi.signature_request_edit_with_template" + end + # resource path + local_var_path = '/signature_request/edit_with_template/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + post_body = {} + form_params = opts[:form_params] || {} + result = @api_client.generate_form_data( + signature_request_edit_with_template_request, + Dropbox::Sign::SignatureRequestEditWithTemplateRequest.openapi_types + ) + + # form parameters + if result[:has_file] + form_params = opts[:form_params] || result[:params] + header_params['Content-Type'] = 'multipart/form-data' + else + # http body (model) + post_body = opts[:debug_body] || result[:params] + end + + # return_type + return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2'] + + new_options = opts.merge( + :operation => :"SignatureRequestApi.signature_request_edit_with_template", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::SignatureRequestGetResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Download Files # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. # @param signature_request_id [String] The id of the SignatureRequest to retrieve. diff --git a/lib/dropbox-sign/api/team_api.rb b/lib/dropbox-sign/api/team_api.rb index 010f36f..1002a2d 100644 --- a/lib/dropbox-sign/api/team_api.rb +++ b/lib/dropbox-sign/api/team_api.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/api/template_api.rb b/lib/dropbox-sign/api/template_api.rb index 7b6e4ac..4620ab3 100644 --- a/lib/dropbox-sign/api/template_api.rb +++ b/lib/dropbox-sign/api/template_api.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/api/unclaimed_draft_api.rb b/lib/dropbox-sign/api/unclaimed_draft_api.rb index cb497d5..53ede89 100644 --- a/lib/dropbox-sign/api/unclaimed_draft_api.rb +++ b/lib/dropbox-sign/api/unclaimed_draft_api.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/api_client.rb b/lib/dropbox-sign/api_client.rb index e8a3640..ad1d842 100644 --- a/lib/dropbox-sign/api_client.rb +++ b/lib/dropbox-sign/api_client.rb @@ -6,7 +6,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 @@ -51,7 +51,8 @@ def self.default # the data deserialized from response body (may be a Tempfile or nil), response status code and response headers. def call_api(http_method, path, opts = {}) request = build_request(http_method, path, opts) - tempfile = download_file(request) if opts[:return_type] == 'File' + tempfile = nil + (download_file(request) { tempfile = _1 }) if opts[:return_type] == 'File' response = request.run if @config.debugging @@ -190,19 +191,17 @@ def download_file(request) chunk.force_encoding(encoding) tempfile.write(chunk) end - # run the request to ensure the tempfile is created successfully before returning it - request.run - if tempfile + request.on_complete do + if !tempfile + fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") + end tempfile.close @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\ "will be deleted automatically with GC. It's also recommended to delete the temp file "\ "explicitly with `tempfile.delete`" - else - fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") + yield tempfile if block_given? end - - tempfile end # Check if the given MIME is a JSON MIME. diff --git a/lib/dropbox-sign/api_error.rb b/lib/dropbox-sign/api_error.rb index 59c00cc..6878150 100644 --- a/lib/dropbox-sign/api_error.rb +++ b/lib/dropbox-sign/api_error.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/configuration.rb b/lib/dropbox-sign/configuration.rb index 4e1c70b..4257530 100644 --- a/lib/dropbox-sign/configuration.rb +++ b/lib/dropbox-sign/configuration.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/event_callback_helper.rb b/lib/dropbox-sign/event_callback_helper.rb index 4da3093..d11354b 100644 --- a/lib/dropbox-sign/event_callback_helper.rb +++ b/lib/dropbox-sign/event_callback_helper.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/models/account_create_request.rb b/lib/dropbox-sign/models/account_create_request.rb index c1f094e..1553f08 100644 --- a/lib/dropbox-sign/models/account_create_request.rb +++ b/lib/dropbox-sign/models/account_create_request.rb @@ -6,7 +6,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 @@ -44,9 +44,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -98,9 +103,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -140,6 +146,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] email_address Value to be assigned + def email_address=(email_address) + if email_address.nil? + fail ArgumentError, 'email_address cannot be nil' + end + + @email_address = email_address + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/account_create_response.rb b/lib/dropbox-sign/models/account_create_response.rb index 65e9521..868cd74 100644 --- a/lib/dropbox-sign/models/account_create_response.rb +++ b/lib/dropbox-sign/models/account_create_response.rb @@ -6,7 +6,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 @@ -37,9 +37,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -90,9 +95,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountCreateResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountCreateResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -130,6 +136,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] account Value to be assigned + def account=(account) + if account.nil? + fail ArgumentError, 'account cannot be nil' + end + + @account = account + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/account_get_response.rb b/lib/dropbox-sign/models/account_get_response.rb index 855d8c6..cf00b1b 100644 --- a/lib/dropbox-sign/models/account_get_response.rb +++ b/lib/dropbox-sign/models/account_get_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountGetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountGetResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] account Value to be assigned + def account=(account) + if account.nil? + fail ArgumentError, 'account cannot be nil' + end + + @account = account + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/account_response.rb b/lib/dropbox-sign/models/account_response.rb index 1ab6a5d..4e96e47 100644 --- a/lib/dropbox-sign/models/account_response.rb +++ b/lib/dropbox-sign/models/account_response.rb @@ -6,7 +6,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 @@ -77,9 +77,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -142,9 +147,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/account_response_quotas.rb b/lib/dropbox-sign/models/account_response_quotas.rb index fd718d6..8fab66a 100644 --- a/lib/dropbox-sign/models/account_response_quotas.rb +++ b/lib/dropbox-sign/models/account_response_quotas.rb @@ -6,7 +6,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 @@ -55,9 +55,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -117,9 +122,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountResponseQuotas`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountResponseQuotas`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/account_response_usage.rb b/lib/dropbox-sign/models/account_response_usage.rb index 3eb5187..a888f45 100644 --- a/lib/dropbox-sign/models/account_response_usage.rb +++ b/lib/dropbox-sign/models/account_response_usage.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -82,9 +87,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountResponseUsage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountResponseUsage`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/account_update_request.rb b/lib/dropbox-sign/models/account_update_request.rb index a24f6a4..9da8f56 100644 --- a/lib/dropbox-sign/models/account_update_request.rb +++ b/lib/dropbox-sign/models/account_update_request.rb @@ -6,7 +6,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 @@ -39,9 +39,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -93,9 +98,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/account_verify_request.rb b/lib/dropbox-sign/models/account_verify_request.rb index 1b93ec7..5df8488 100644 --- a/lib/dropbox-sign/models/account_verify_request.rb +++ b/lib/dropbox-sign/models/account_verify_request.rb @@ -6,7 +6,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 @@ -29,9 +29,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -80,9 +85,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountVerifyRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountVerifyRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -110,6 +116,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] email_address Value to be assigned + def email_address=(email_address) + if email_address.nil? + fail ArgumentError, 'email_address cannot be nil' + end + + @email_address = email_address + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/account_verify_response.rb b/lib/dropbox-sign/models/account_verify_response.rb index 7f6b6e1..9cb98ee 100644 --- a/lib/dropbox-sign/models/account_verify_response.rb +++ b/lib/dropbox-sign/models/account_verify_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountVerifyResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountVerifyResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/account_verify_response_account.rb b/lib/dropbox-sign/models/account_verify_response_account.rb index 2ea7c80..a4f225e 100644 --- a/lib/dropbox-sign/models/account_verify_response_account.rb +++ b/lib/dropbox-sign/models/account_verify_response_account.rb @@ -6,7 +6,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 @@ -29,9 +29,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -80,9 +85,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountVerifyResponseAccount`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::AccountVerifyResponseAccount`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/api_app_create_request.rb b/lib/dropbox-sign/models/api_app_create_request.rb index 37e542e..f37d1a2 100644 --- a/lib/dropbox-sign/models/api_app_create_request.rb +++ b/lib/dropbox-sign/models/api_app_create_request.rb @@ -6,7 +6,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 @@ -56,9 +56,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -113,9 +118,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -201,6 +207,16 @@ def domains=(domains) @domains = domains end + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/api_app_get_response.rb b/lib/dropbox-sign/models/api_app_get_response.rb index 5befd74..2b22f7b 100644 --- a/lib/dropbox-sign/models/api_app_get_response.rb +++ b/lib/dropbox-sign/models/api_app_get_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppGetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppGetResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] api_app Value to be assigned + def api_app=(api_app) + if api_app.nil? + fail ArgumentError, 'api_app cannot be nil' + end + + @api_app = api_app + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/api_app_list_response.rb b/lib/dropbox-sign/models/api_app_list_response.rb index 7247d48..5d034c1 100644 --- a/lib/dropbox-sign/models/api_app_list_response.rb +++ b/lib/dropbox-sign/models/api_app_list_response.rb @@ -6,7 +6,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 @@ -38,9 +38,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -91,9 +96,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppListResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppListResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -138,6 +144,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] api_apps Value to be assigned + def api_apps=(api_apps) + if api_apps.nil? + fail ArgumentError, 'api_apps cannot be nil' + end + + @api_apps = api_apps + end + + # Custom attribute writer method with validation + # @param [Object] list_info Value to be assigned + def list_info=(list_info) + if list_info.nil? + fail ArgumentError, 'list_info cannot be nil' + end + + @list_info = list_info + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/api_app_response.rb b/lib/dropbox-sign/models/api_app_response.rb index 2f7923e..17c9da0 100644 --- a/lib/dropbox-sign/models/api_app_response.rb +++ b/lib/dropbox-sign/models/api_app_response.rb @@ -6,7 +6,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 @@ -71,9 +71,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -135,9 +140,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/api_app_response_o_auth.rb b/lib/dropbox-sign/models/api_app_response_o_auth.rb index c861200..d965681 100644 --- a/lib/dropbox-sign/models/api_app_response_o_auth.rb +++ b/lib/dropbox-sign/models/api_app_response_o_auth.rb @@ -6,7 +6,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 @@ -45,9 +45,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -100,9 +105,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppResponseOAuth`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppResponseOAuth`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/api_app_response_options.rb b/lib/dropbox-sign/models/api_app_response_options.rb index 8e7742a..ba98387 100644 --- a/lib/dropbox-sign/models/api_app_response_options.rb +++ b/lib/dropbox-sign/models/api_app_response_options.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppResponseOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppResponseOptions`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/api_app_response_owner_account.rb b/lib/dropbox-sign/models/api_app_response_owner_account.rb index 50abb33..495c770 100644 --- a/lib/dropbox-sign/models/api_app_response_owner_account.rb +++ b/lib/dropbox-sign/models/api_app_response_owner_account.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppResponseOwnerAccount`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppResponseOwnerAccount`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb b/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb index 99f0227..d1990e6 100644 --- a/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +++ b/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb @@ -6,7 +6,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 @@ -81,9 +81,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -145,9 +150,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppResponseWhiteLabelingOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppResponseWhiteLabelingOptions`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/api_app_update_request.rb b/lib/dropbox-sign/models/api_app_update_request.rb index 0c526d7..45b38ce 100644 --- a/lib/dropbox-sign/models/api_app_update_request.rb +++ b/lib/dropbox-sign/models/api_app_update_request.rb @@ -6,7 +6,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 @@ -56,9 +56,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -113,9 +118,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/bulk_send_job_get_response.rb b/lib/dropbox-sign/models/bulk_send_job_get_response.rb index bd14dd0..113311e 100644 --- a/lib/dropbox-sign/models/bulk_send_job_get_response.rb +++ b/lib/dropbox-sign/models/bulk_send_job_get_response.rb @@ -6,7 +6,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 @@ -42,9 +42,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -96,9 +101,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::BulkSendJobGetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::BulkSendJobGetResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -152,6 +158,36 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] bulk_send_job Value to be assigned + def bulk_send_job=(bulk_send_job) + if bulk_send_job.nil? + fail ArgumentError, 'bulk_send_job cannot be nil' + end + + @bulk_send_job = bulk_send_job + end + + # Custom attribute writer method with validation + # @param [Object] list_info Value to be assigned + def list_info=(list_info) + if list_info.nil? + fail ArgumentError, 'list_info cannot be nil' + end + + @list_info = list_info + end + + # Custom attribute writer method with validation + # @param [Object] signature_requests Value to be assigned + def signature_requests=(signature_requests) + if signature_requests.nil? + fail ArgumentError, 'signature_requests cannot be nil' + end + + @signature_requests = signature_requests + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb b/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb index 39e5e3c..603f9e5 100644 --- a/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +++ b/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb @@ -6,7 +6,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 @@ -149,9 +149,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -235,9 +240,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::BulkSendJobGetResponseSignatureRequests`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::BulkSendJobGetResponseSignatureRequests`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/bulk_send_job_list_response.rb b/lib/dropbox-sign/models/bulk_send_job_list_response.rb index 4c9b808..0f04a4e 100644 --- a/lib/dropbox-sign/models/bulk_send_job_list_response.rb +++ b/lib/dropbox-sign/models/bulk_send_job_list_response.rb @@ -6,7 +6,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 @@ -38,9 +38,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -91,9 +96,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::BulkSendJobListResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::BulkSendJobListResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -138,6 +144,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] bulk_send_jobs Value to be assigned + def bulk_send_jobs=(bulk_send_jobs) + if bulk_send_jobs.nil? + fail ArgumentError, 'bulk_send_jobs cannot be nil' + end + + @bulk_send_jobs = bulk_send_jobs + end + + # Custom attribute writer method with validation + # @param [Object] list_info Value to be assigned + def list_info=(list_info) + if list_info.nil? + fail ArgumentError, 'list_info cannot be nil' + end + + @list_info = list_info + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/bulk_send_job_response.rb b/lib/dropbox-sign/models/bulk_send_job_response.rb index b84d927..cba78bf 100644 --- a/lib/dropbox-sign/models/bulk_send_job_response.rb +++ b/lib/dropbox-sign/models/bulk_send_job_response.rb @@ -6,7 +6,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 @@ -45,9 +45,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -100,9 +105,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::BulkSendJobResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::BulkSendJobResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/bulk_send_job_send_response.rb b/lib/dropbox-sign/models/bulk_send_job_send_response.rb index f870982..27e6921 100644 --- a/lib/dropbox-sign/models/bulk_send_job_send_response.rb +++ b/lib/dropbox-sign/models/bulk_send_job_send_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::BulkSendJobSendResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::BulkSendJobSendResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] bulk_send_job Value to be assigned + def bulk_send_job=(bulk_send_job) + if bulk_send_job.nil? + fail ArgumentError, 'bulk_send_job cannot be nil' + end + + @bulk_send_job = bulk_send_job + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/embedded_edit_url_request.rb b/lib/dropbox-sign/models/embedded_edit_url_request.rb index 1f65e41..d192c0d 100644 --- a/lib/dropbox-sign/models/embedded_edit_url_request.rb +++ b/lib/dropbox-sign/models/embedded_edit_url_request.rb @@ -6,7 +6,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 @@ -73,9 +73,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -133,9 +138,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EmbeddedEditUrlRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EmbeddedEditUrlRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/embedded_edit_url_response.rb b/lib/dropbox-sign/models/embedded_edit_url_response.rb index 0ce2e61..34a94f0 100644 --- a/lib/dropbox-sign/models/embedded_edit_url_response.rb +++ b/lib/dropbox-sign/models/embedded_edit_url_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EmbeddedEditUrlResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EmbeddedEditUrlResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] embedded Value to be assigned + def embedded=(embedded) + if embedded.nil? + fail ArgumentError, 'embedded cannot be nil' + end + + @embedded = embedded + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb b/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb index 2c72d8b..552543b 100644 --- a/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +++ b/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EmbeddedEditUrlResponseEmbedded`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EmbeddedEditUrlResponseEmbedded`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/embedded_sign_url_response.rb b/lib/dropbox-sign/models/embedded_sign_url_response.rb index 7d91360..ac6fcd2 100644 --- a/lib/dropbox-sign/models/embedded_sign_url_response.rb +++ b/lib/dropbox-sign/models/embedded_sign_url_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EmbeddedSignUrlResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EmbeddedSignUrlResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] embedded Value to be assigned + def embedded=(embedded) + if embedded.nil? + fail ArgumentError, 'embedded cannot be nil' + end + + @embedded = embedded + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb b/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb index 15d0f13..a6770f3 100644 --- a/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +++ b/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EmbeddedSignUrlResponseEmbedded`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EmbeddedSignUrlResponseEmbedded`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/error_response.rb b/lib/dropbox-sign/models/error_response.rb index c2d3987..6bc8b72 100644 --- a/lib/dropbox-sign/models/error_response.rb +++ b/lib/dropbox-sign/models/error_response.rb @@ -6,7 +6,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 @@ -28,9 +28,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -79,9 +84,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ErrorResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ErrorResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -109,6 +115,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] error Value to be assigned + def error=(error) + if error.nil? + fail ArgumentError, 'error cannot be nil' + end + + @error = error + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/error_response_error.rb b/lib/dropbox-sign/models/error_response_error.rb index 21b2abf..b1b85ff 100644 --- a/lib/dropbox-sign/models/error_response_error.rb +++ b/lib/dropbox-sign/models/error_response_error.rb @@ -6,7 +6,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 @@ -40,9 +40,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -93,9 +98,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ErrorResponseError`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ErrorResponseError`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -136,6 +142,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] error_msg Value to be assigned + def error_msg=(error_msg) + if error_msg.nil? + fail ArgumentError, 'error_msg cannot be nil' + end + + @error_msg = error_msg + end + + # Custom attribute writer method with validation + # @param [Object] error_name Value to be assigned + def error_name=(error_name) + if error_name.nil? + fail ArgumentError, 'error_name cannot be nil' + end + + @error_name = error_name + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/event_callback_request.rb b/lib/dropbox-sign/models/event_callback_request.rb index b9e7182..cfd29da 100644 --- a/lib/dropbox-sign/models/event_callback_request.rb +++ b/lib/dropbox-sign/models/event_callback_request.rb @@ -6,7 +6,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 @@ -40,9 +40,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -94,9 +99,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EventCallbackRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EventCallbackRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -136,6 +142,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] event Value to be assigned + def event=(event) + if event.nil? + fail ArgumentError, 'event cannot be nil' + end + + @event = event + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/event_callback_request_event.rb b/lib/dropbox-sign/models/event_callback_request_event.rb index 5ce3dee..134ecee 100644 --- a/lib/dropbox-sign/models/event_callback_request_event.rb +++ b/lib/dropbox-sign/models/event_callback_request_event.rb @@ -6,7 +6,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 @@ -66,9 +66,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -120,9 +125,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EventCallbackRequestEvent`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EventCallbackRequestEvent`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -174,6 +180,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] event_time Value to be assigned + def event_time=(event_time) + if event_time.nil? + fail ArgumentError, 'event_time cannot be nil' + end + + @event_time = event_time + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] event_type Object to be assigned def event_type=(event_type) @@ -184,6 +200,16 @@ def event_type=(event_type) @event_type = event_type end + # Custom attribute writer method with validation + # @param [Object] event_hash Value to be assigned + def event_hash=(event_hash) + if event_hash.nil? + fail ArgumentError, 'event_hash cannot be nil' + end + + @event_hash = event_hash + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/event_callback_request_event_metadata.rb b/lib/dropbox-sign/models/event_callback_request_event_metadata.rb index 02c8d4c..a21984f 100644 --- a/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +++ b/lib/dropbox-sign/models/event_callback_request_event_metadata.rb @@ -6,7 +6,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 @@ -45,9 +45,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -103,9 +108,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EventCallbackRequestEventMetadata`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::EventCallbackRequestEventMetadata`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/fax_get_response.rb b/lib/dropbox-sign/models/fax_get_response.rb index a774af3..20ed384 100644 --- a/lib/dropbox-sign/models/fax_get_response.rb +++ b/lib/dropbox-sign/models/fax_get_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxGetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxGetResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] fax Value to be assigned + def fax=(fax) + if fax.nil? + fail ArgumentError, 'fax cannot be nil' + end + + @fax = fax + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/fax_line_add_user_request.rb b/lib/dropbox-sign/models/fax_line_add_user_request.rb index d2b04a3..a3d4369 100644 --- a/lib/dropbox-sign/models/fax_line_add_user_request.rb +++ b/lib/dropbox-sign/models/fax_line_add_user_request.rb @@ -6,7 +6,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 @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxLineAddUserRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number @@ -39,9 +39,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -92,9 +97,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineAddUserRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineAddUserRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -130,6 +136,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] number Value to be assigned + def number=(number) + if number.nil? + fail ArgumentError, 'number cannot be nil' + end + + @number = number + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/fax_line_area_code_get_country_enum.rb b/lib/dropbox-sign/models/fax_line_area_code_get_country_enum.rb index 837596e..bfe3e22 100644 --- a/lib/dropbox-sign/models/fax_line_area_code_get_country_enum.rb +++ b/lib/dropbox-sign/models/fax_line_area_code_get_country_enum.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/models/fax_line_area_code_get_province_enum.rb b/lib/dropbox-sign/models/fax_line_area_code_get_province_enum.rb index df6d0c2..c699981 100644 --- a/lib/dropbox-sign/models/fax_line_area_code_get_province_enum.rb +++ b/lib/dropbox-sign/models/fax_line_area_code_get_province_enum.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/models/fax_line_area_code_get_response.rb b/lib/dropbox-sign/models/fax_line_area_code_get_response.rb index a724596..695a0ef 100644 --- a/lib/dropbox-sign/models/fax_line_area_code_get_response.rb +++ b/lib/dropbox-sign/models/fax_line_area_code_get_response.rb @@ -6,7 +6,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 @@ -28,9 +28,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -79,9 +84,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineAreaCodeGetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineAreaCodeGetResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -111,6 +117,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] area_codes Value to be assigned + def area_codes=(area_codes) + if area_codes.nil? + fail ArgumentError, 'area_codes cannot be nil' + end + + @area_codes = area_codes + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/fax_line_area_code_get_state_enum.rb b/lib/dropbox-sign/models/fax_line_area_code_get_state_enum.rb index ceaa724..ddd707a 100644 --- a/lib/dropbox-sign/models/fax_line_area_code_get_state_enum.rb +++ b/lib/dropbox-sign/models/fax_line_area_code_get_state_enum.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/models/fax_line_create_request.rb b/lib/dropbox-sign/models/fax_line_create_request.rb index 16f9ebd..b014d92 100644 --- a/lib/dropbox-sign/models/fax_line_create_request.rb +++ b/lib/dropbox-sign/models/fax_line_create_request.rb @@ -6,7 +6,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 @@ -18,19 +18,19 @@ module Dropbox module Dropbox::Sign class FaxLineCreateRequest - # Area code + # Area code of the new Fax Line # @return [Integer] attr_accessor :area_code - # Country + # Country of the area code # @return [String] attr_accessor :country - # City + # City of the area code # @return [String] attr_accessor :city - # Account ID + # Account ID of the account that will be assigned this new Fax Line # @return [String] attr_accessor :account_id @@ -66,9 +66,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -120,9 +125,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -169,6 +175,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] area_code Value to be assigned + def area_code=(area_code) + if area_code.nil? + fail ArgumentError, 'area_code cannot be nil' + end + + @area_code = area_code + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] country Object to be assigned def country=(country) diff --git a/lib/dropbox-sign/models/fax_line_delete_request.rb b/lib/dropbox-sign/models/fax_line_delete_request.rb index cdb344e..e49240b 100644 --- a/lib/dropbox-sign/models/fax_line_delete_request.rb +++ b/lib/dropbox-sign/models/fax_line_delete_request.rb @@ -6,7 +6,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 @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxLineDeleteRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number @@ -29,9 +29,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -80,9 +85,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineDeleteRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineDeleteRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -110,6 +116,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] number Value to be assigned + def number=(number) + if number.nil? + fail ArgumentError, 'number cannot be nil' + end + + @number = number + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/fax_line_list_response.rb b/lib/dropbox-sign/models/fax_line_list_response.rb index 1aa8562..0fe478f 100644 --- a/lib/dropbox-sign/models/fax_line_list_response.rb +++ b/lib/dropbox-sign/models/fax_line_list_response.rb @@ -6,7 +6,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 @@ -36,9 +36,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -89,9 +94,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineListResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineListResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -134,6 +140,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] list_info Value to be assigned + def list_info=(list_info) + if list_info.nil? + fail ArgumentError, 'list_info cannot be nil' + end + + @list_info = list_info + end + + # Custom attribute writer method with validation + # @param [Object] fax_lines Value to be assigned + def fax_lines=(fax_lines) + if fax_lines.nil? + fail ArgumentError, 'fax_lines cannot be nil' + end + + @fax_lines = fax_lines + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/fax_line_remove_user_request.rb b/lib/dropbox-sign/models/fax_line_remove_user_request.rb index 3908c50..a907922 100644 --- a/lib/dropbox-sign/models/fax_line_remove_user_request.rb +++ b/lib/dropbox-sign/models/fax_line_remove_user_request.rb @@ -6,7 +6,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 @@ -18,15 +18,15 @@ module Dropbox module Dropbox::Sign class FaxLineRemoveUserRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number - # Account ID + # Account ID of the user to remove access # @return [String] attr_accessor :account_id - # Email address + # Email address of the user to remove access # @return [String] attr_accessor :email_address @@ -39,9 +39,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -92,9 +97,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineRemoveUserRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineRemoveUserRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -130,6 +136,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] number Value to be assigned + def number=(number) + if number.nil? + fail ArgumentError, 'number cannot be nil' + end + + @number = number + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/fax_line_response.rb b/lib/dropbox-sign/models/fax_line_response.rb index bf80e66..d495cac 100644 --- a/lib/dropbox-sign/models/fax_line_response.rb +++ b/lib/dropbox-sign/models/fax_line_response.rb @@ -6,7 +6,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 @@ -32,9 +32,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -84,9 +89,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -118,6 +124,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] fax_line Value to be assigned + def fax_line=(fax_line) + if fax_line.nil? + fail ArgumentError, 'fax_line cannot be nil' + end + + @fax_line = fax_line + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/fax_line_response_fax_line.rb b/lib/dropbox-sign/models/fax_line_response_fax_line.rb index 02d7797..6ca4395 100644 --- a/lib/dropbox-sign/models/fax_line_response_fax_line.rb +++ b/lib/dropbox-sign/models/fax_line_response_fax_line.rb @@ -6,7 +6,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 @@ -43,9 +43,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -97,9 +102,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineResponseFaxLine`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxLineResponseFaxLine`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/fax_list_response.rb b/lib/dropbox-sign/models/fax_list_response.rb index a06e7fe..22e8bef 100644 --- a/lib/dropbox-sign/models/fax_list_response.rb +++ b/lib/dropbox-sign/models/fax_list_response.rb @@ -6,7 +6,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 @@ -32,9 +32,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -84,9 +89,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxListResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxListResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -125,6 +131,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] faxes Value to be assigned + def faxes=(faxes) + if faxes.nil? + fail ArgumentError, 'faxes cannot be nil' + end + + @faxes = faxes + end + + # Custom attribute writer method with validation + # @param [Object] list_info Value to be assigned + def list_info=(list_info) + if list_info.nil? + fail ArgumentError, 'list_info cannot be nil' + end + + @list_info = list_info + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/fax_response.rb b/lib/dropbox-sign/models/fax_response.rb index b6b5350..b9f7ae1 100644 --- a/lib/dropbox-sign/models/fax_response.rb +++ b/lib/dropbox-sign/models/fax_response.rb @@ -6,7 +6,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 @@ -79,9 +79,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -143,9 +148,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -252,6 +258,86 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] fax_id Value to be assigned + def fax_id=(fax_id) + if fax_id.nil? + fail ArgumentError, 'fax_id cannot be nil' + end + + @fax_id = fax_id + end + + # Custom attribute writer method with validation + # @param [Object] title Value to be assigned + def title=(title) + if title.nil? + fail ArgumentError, 'title cannot be nil' + end + + @title = title + end + + # Custom attribute writer method with validation + # @param [Object] original_title Value to be assigned + def original_title=(original_title) + if original_title.nil? + fail ArgumentError, 'original_title cannot be nil' + end + + @original_title = original_title + end + + # Custom attribute writer method with validation + # @param [Object] metadata Value to be assigned + def metadata=(metadata) + if metadata.nil? + fail ArgumentError, 'metadata cannot be nil' + end + + @metadata = metadata + end + + # Custom attribute writer method with validation + # @param [Object] created_at Value to be assigned + def created_at=(created_at) + if created_at.nil? + fail ArgumentError, 'created_at cannot be nil' + end + + @created_at = created_at + end + + # Custom attribute writer method with validation + # @param [Object] sender Value to be assigned + def sender=(sender) + if sender.nil? + fail ArgumentError, 'sender cannot be nil' + end + + @sender = sender + end + + # Custom attribute writer method with validation + # @param [Object] files_url Value to be assigned + def files_url=(files_url) + if files_url.nil? + fail ArgumentError, 'files_url cannot be nil' + end + + @files_url = files_url + end + + # Custom attribute writer method with validation + # @param [Object] transmissions Value to be assigned + def transmissions=(transmissions) + if transmissions.nil? + fail ArgumentError, 'transmissions cannot be nil' + end + + @transmissions = transmissions + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/fax_response_transmission.rb b/lib/dropbox-sign/models/fax_response_transmission.rb index cd402cc..f10e053 100644 --- a/lib/dropbox-sign/models/fax_response_transmission.rb +++ b/lib/dropbox-sign/models/fax_response_transmission.rb @@ -6,7 +6,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 @@ -61,9 +61,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -114,9 +119,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxResponseTransmission`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxResponseTransmission`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -159,6 +165,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] recipient Value to be assigned + def recipient=(recipient) + if recipient.nil? + fail ArgumentError, 'recipient cannot be nil' + end + + @recipient = recipient + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] status_code Object to be assigned def status_code=(status_code) diff --git a/lib/dropbox-sign/models/fax_send_request.rb b/lib/dropbox-sign/models/fax_send_request.rb index 18616ce..e1fba41 100644 --- a/lib/dropbox-sign/models/fax_send_request.rb +++ b/lib/dropbox-sign/models/fax_send_request.rb @@ -6,7 +6,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 @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxSendRequest - # Fax Send To Recipient + # Recipient of the fax Can be a phone number in E.164 format or email address # @return [String] attr_accessor :recipient @@ -26,11 +26,11 @@ class FaxSendRequest # @return [String] attr_accessor :sender - # Fax File to Send + # Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. # @return [Array] attr_accessor :files - # Fax File URL to Send + # Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. # @return [Array] attr_accessor :file_urls @@ -38,11 +38,11 @@ class FaxSendRequest # @return [Boolean] attr_accessor :test_mode - # Fax Cover Page for Recipient + # Fax cover page recipient information # @return [String] attr_accessor :cover_page_to - # Fax Cover Page for Sender + # Fax cover page sender information # @return [String] attr_accessor :cover_page_from @@ -69,9 +69,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -128,9 +133,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxSendRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxSendRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -196,6 +202,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] recipient Value to be assigned + def recipient=(recipient) + if recipient.nil? + fail ArgumentError, 'recipient cannot be nil' + end + + @recipient = recipient + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/file_response.rb b/lib/dropbox-sign/models/file_response.rb index 7ec6b55..5d4ed8c 100644 --- a/lib/dropbox-sign/models/file_response.rb +++ b/lib/dropbox-sign/models/file_response.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FileResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FileResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -125,6 +131,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] file_url Value to be assigned + def file_url=(file_url) + if file_url.nil? + fail ArgumentError, 'file_url cannot be nil' + end + + @file_url = file_url + end + + # Custom attribute writer method with validation + # @param [Object] expires_at Value to be assigned + def expires_at=(expires_at) + if expires_at.nil? + fail ArgumentError, 'expires_at cannot be nil' + end + + @expires_at = expires_at + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/file_response_data_uri.rb b/lib/dropbox-sign/models/file_response_data_uri.rb index aa5b6cb..5db69e3 100644 --- a/lib/dropbox-sign/models/file_response_data_uri.rb +++ b/lib/dropbox-sign/models/file_response_data_uri.rb @@ -6,7 +6,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 @@ -29,9 +29,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -80,9 +85,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FileResponseDataUri`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FileResponseDataUri`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -110,6 +116,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] data_uri Value to be assigned + def data_uri=(data_uri) + if data_uri.nil? + fail ArgumentError, 'data_uri cannot be nil' + end + + @data_uri = data_uri + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/list_info_response.rb b/lib/dropbox-sign/models/list_info_response.rb index 6e39e1b..6063b26 100644 --- a/lib/dropbox-sign/models/list_info_response.rb +++ b/lib/dropbox-sign/models/list_info_response.rb @@ -6,7 +6,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 @@ -45,9 +45,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -100,9 +105,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ListInfoResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ListInfoResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/o_auth_token_generate_request.rb b/lib/dropbox-sign/models/o_auth_token_generate_request.rb index 81b9dd7..b7825d7 100644 --- a/lib/dropbox-sign/models/o_auth_token_generate_request.rb +++ b/lib/dropbox-sign/models/o_auth_token_generate_request.rb @@ -6,7 +6,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 @@ -49,9 +49,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -104,9 +109,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::OAuthTokenGenerateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::OAuthTokenGenerateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -172,6 +178,56 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] client_id Value to be assigned + def client_id=(client_id) + if client_id.nil? + fail ArgumentError, 'client_id cannot be nil' + end + + @client_id = client_id + end + + # Custom attribute writer method with validation + # @param [Object] client_secret Value to be assigned + def client_secret=(client_secret) + if client_secret.nil? + fail ArgumentError, 'client_secret cannot be nil' + end + + @client_secret = client_secret + end + + # Custom attribute writer method with validation + # @param [Object] code Value to be assigned + def code=(code) + if code.nil? + fail ArgumentError, 'code cannot be nil' + end + + @code = code + end + + # Custom attribute writer method with validation + # @param [Object] grant_type Value to be assigned + def grant_type=(grant_type) + if grant_type.nil? + fail ArgumentError, 'grant_type cannot be nil' + end + + @grant_type = grant_type + end + + # Custom attribute writer method with validation + # @param [Object] state Value to be assigned + def state=(state) + if state.nil? + fail ArgumentError, 'state cannot be nil' + end + + @state = state + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/o_auth_token_refresh_request.rb b/lib/dropbox-sign/models/o_auth_token_refresh_request.rb index 3ac7321..6715762 100644 --- a/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +++ b/lib/dropbox-sign/models/o_auth_token_refresh_request.rb @@ -6,7 +6,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 @@ -44,9 +44,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -98,9 +103,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::OAuthTokenRefreshRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::OAuthTokenRefreshRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -147,6 +153,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] grant_type Value to be assigned + def grant_type=(grant_type) + if grant_type.nil? + fail ArgumentError, 'grant_type cannot be nil' + end + + @grant_type = grant_type + end + + # Custom attribute writer method with validation + # @param [Object] refresh_token Value to be assigned + def refresh_token=(refresh_token) + if refresh_token.nil? + fail ArgumentError, 'refresh_token cannot be nil' + end + + @refresh_token = refresh_token + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/o_auth_token_response.rb b/lib/dropbox-sign/models/o_auth_token_response.rb index ffcad89..1e35f0c 100644 --- a/lib/dropbox-sign/models/o_auth_token_response.rb +++ b/lib/dropbox-sign/models/o_auth_token_response.rb @@ -6,7 +6,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 @@ -45,9 +45,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -101,9 +106,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::OAuthTokenResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::OAuthTokenResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/report_create_request.rb b/lib/dropbox-sign/models/report_create_request.rb index 1381314..9db74f5 100644 --- a/lib/dropbox-sign/models/report_create_request.rb +++ b/lib/dropbox-sign/models/report_create_request.rb @@ -6,7 +6,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 @@ -61,9 +61,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -114,9 +119,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ReportCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ReportCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -174,6 +180,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] end_date Value to be assigned + def end_date=(end_date) + if end_date.nil? + fail ArgumentError, 'end_date cannot be nil' + end + + @end_date = end_date + end + + # Custom attribute writer method with validation + # @param [Object] start_date Value to be assigned + def start_date=(start_date) + if start_date.nil? + fail ArgumentError, 'start_date cannot be nil' + end + + @start_date = start_date + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/report_create_response.rb b/lib/dropbox-sign/models/report_create_response.rb index b166b95..b65383f 100644 --- a/lib/dropbox-sign/models/report_create_response.rb +++ b/lib/dropbox-sign/models/report_create_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ReportCreateResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ReportCreateResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] report Value to be assigned + def report=(report) + if report.nil? + fail ArgumentError, 'report cannot be nil' + end + + @report = report + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/report_response.rb b/lib/dropbox-sign/models/report_response.rb index ba3ab99..0cf3b76 100644 --- a/lib/dropbox-sign/models/report_response.rb +++ b/lib/dropbox-sign/models/report_response.rb @@ -6,7 +6,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 @@ -67,9 +67,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -121,9 +126,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ReportResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ReportResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb b/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb index 6735166..1381757 100644 --- a/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +++ b/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb @@ -6,7 +6,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 @@ -89,9 +89,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -152,9 +157,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -264,6 +270,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] template_ids Value to be assigned + def template_ids=(template_ids) + if template_ids.nil? + fail ArgumentError, 'template_ids cannot be nil' + end + + @template_ids = template_ids + end + + # Custom attribute writer method with validation + # @param [Object] client_id Value to be assigned + def client_id=(client_id) + if client_id.nil? + fail ArgumentError, 'client_id cannot be nil' + end + + @client_id = client_id + end + # Custom attribute writer method with validation # @param [Object] message Value to be assigned def message=(message) diff --git a/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb b/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb index 9f6c449..1cc28d6 100644 --- a/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +++ b/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb @@ -6,7 +6,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 @@ -89,9 +89,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -152,9 +157,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -259,6 +265,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] template_ids Value to be assigned + def template_ids=(template_ids) + if template_ids.nil? + fail ArgumentError, 'template_ids cannot be nil' + end + + @template_ids = template_ids + end + # Custom attribute writer method with validation # @param [Object] message Value to be assigned def message=(message) diff --git a/lib/dropbox-sign/models/signature_request_create_embedded_request.rb b/lib/dropbox-sign/models/signature_request_create_embedded_request.rb index bdc9e94..9ea5387 100644 --- a/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +++ b/lib/dropbox-sign/models/signature_request_create_embedded_request.rb @@ -6,7 +6,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 @@ -142,9 +142,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -217,9 +222,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestCreateEmbeddedRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestCreateEmbeddedRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -388,6 +394,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] client_id Value to be assigned + def client_id=(client_id) + if client_id.nil? + fail ArgumentError, 'client_id cannot be nil' + end + + @client_id = client_id + end + # Custom attribute writer method with validation # @param [Object] message Value to be assigned def message=(message) diff --git a/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb b/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb index 4246670..8fdc7b2 100644 --- a/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +++ b/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb @@ -6,7 +6,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 @@ -98,9 +98,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -163,9 +168,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -294,6 +300,36 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] template_ids Value to be assigned + def template_ids=(template_ids) + if template_ids.nil? + fail ArgumentError, 'template_ids cannot be nil' + end + + @template_ids = template_ids + end + + # Custom attribute writer method with validation + # @param [Object] client_id Value to be assigned + def client_id=(client_id) + if client_id.nil? + fail ArgumentError, 'client_id cannot be nil' + end + + @client_id = client_id + end + + # Custom attribute writer method with validation + # @param [Object] signers Value to be assigned + def signers=(signers) + if signers.nil? + fail ArgumentError, 'signers cannot be nil' + end + + @signers = signers + end + # Custom attribute writer method with validation # @param [Object] message Value to be assigned def message=(message) diff --git a/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb b/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb new file mode 100644 index 0000000..eb9ece9 --- /dev/null +++ b/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb @@ -0,0 +1,604 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.12.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + class SignatureRequestEditEmbeddedRequest + # Client id of the app you're using to create this embedded signature request. Used for security purposes. + # @return [String] + attr_accessor :client_id + + # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :files + + # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :file_urls + + # Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # @return [Array] + attr_accessor :signers + + # Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # @return [Array] + attr_accessor :grouped_signers + + # Allows signers to decline to sign a document if `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_decline + + # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. + # @return [Boolean] + attr_accessor :allow_reassign + + # A list describing the attachments + # @return [Array] + attr_accessor :attachments + + # The email addresses that should be CCed. + # @return [Array] + attr_accessor :cc_email_addresses + + # When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + # @return [Array] + attr_accessor :custom_fields + + # @return [SubFieldOptions] + attr_accessor :field_options + + # Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + # @return [Array] + attr_accessor :form_field_groups + + # Conditional Logic rules for fields defined in `form_fields_per_document`. + # @return [Array] + attr_accessor :form_field_rules + + # 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` + # @return [Array] + attr_accessor :form_fields_per_document + + # 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. + # @return [Boolean] + attr_accessor :hide_text_tags + + # The custom message in the email that will be sent to the signers. + # @return [String] + attr_accessor :message + + # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # @return [Hash] + attr_accessor :metadata + + # @return [SubSigningOptions] + attr_accessor :signing_options + + # The subject in the email that will be sent to the signers. + # @return [String] + attr_accessor :subject + + # Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :test_mode + + # The title you want to assign to the SignatureRequest. + # @return [String] + attr_accessor :title + + # Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + # @return [Boolean] + attr_accessor :use_text_tags + + # 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. + # @return [Boolean] + attr_accessor :populate_auto_fill_fields + + # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + # @return [Integer, nil] + attr_accessor :expires_at + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'client_id' => :'client_id', + :'files' => :'files', + :'file_urls' => :'file_urls', + :'signers' => :'signers', + :'grouped_signers' => :'grouped_signers', + :'allow_decline' => :'allow_decline', + :'allow_reassign' => :'allow_reassign', + :'attachments' => :'attachments', + :'cc_email_addresses' => :'cc_email_addresses', + :'custom_fields' => :'custom_fields', + :'field_options' => :'field_options', + :'form_field_groups' => :'form_field_groups', + :'form_field_rules' => :'form_field_rules', + :'form_fields_per_document' => :'form_fields_per_document', + :'hide_text_tags' => :'hide_text_tags', + :'message' => :'message', + :'metadata' => :'metadata', + :'signing_options' => :'signing_options', + :'subject' => :'subject', + :'test_mode' => :'test_mode', + :'title' => :'title', + :'use_text_tags' => :'use_text_tags', + :'populate_auto_fill_fields' => :'populate_auto_fill_fields', + :'expires_at' => :'expires_at' + } + end + + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + acceptable_attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'client_id' => :'String', + :'files' => :'Array', + :'file_urls' => :'Array', + :'signers' => :'Array', + :'grouped_signers' => :'Array', + :'allow_decline' => :'Boolean', + :'allow_reassign' => :'Boolean', + :'attachments' => :'Array', + :'cc_email_addresses' => :'Array', + :'custom_fields' => :'Array', + :'field_options' => :'SubFieldOptions', + :'form_field_groups' => :'Array', + :'form_field_rules' => :'Array', + :'form_fields_per_document' => :'Array', + :'hide_text_tags' => :'Boolean', + :'message' => :'String', + :'metadata' => :'Hash', + :'signing_options' => :'SubSigningOptions', + :'subject' => :'String', + :'test_mode' => :'Boolean', + :'title' => :'String', + :'use_text_tags' => :'Boolean', + :'populate_auto_fill_fields' => :'Boolean', + :'expires_at' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + :'expires_at' + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [SignatureRequestEditEmbeddedRequest] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "SignatureRequestEditEmbeddedRequest" + ) || SignatureRequestEditEmbeddedRequest.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestEditEmbeddedRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestEditEmbeddedRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'client_id') + self.client_id = attributes[:'client_id'] + end + + if attributes.key?(:'files') + if (value = attributes[:'files']).is_a?(Array) + self.files = value + end + end + + if attributes.key?(:'file_urls') + if (value = attributes[:'file_urls']).is_a?(Array) + self.file_urls = value + end + end + + if attributes.key?(:'signers') + if (value = attributes[:'signers']).is_a?(Array) + self.signers = value + end + end + + if attributes.key?(:'grouped_signers') + if (value = attributes[:'grouped_signers']).is_a?(Array) + self.grouped_signers = value + end + end + + if attributes.key?(:'allow_decline') + self.allow_decline = attributes[:'allow_decline'] + else + self.allow_decline = false + end + + if attributes.key?(:'allow_reassign') + self.allow_reassign = attributes[:'allow_reassign'] + else + self.allow_reassign = false + end + + if attributes.key?(:'attachments') + if (value = attributes[:'attachments']).is_a?(Array) + self.attachments = value + end + end + + if attributes.key?(:'cc_email_addresses') + if (value = attributes[:'cc_email_addresses']).is_a?(Array) + self.cc_email_addresses = value + end + end + + if attributes.key?(:'custom_fields') + if (value = attributes[:'custom_fields']).is_a?(Array) + self.custom_fields = value + end + end + + if attributes.key?(:'field_options') + self.field_options = attributes[:'field_options'] + end + + if attributes.key?(:'form_field_groups') + if (value = attributes[:'form_field_groups']).is_a?(Array) + self.form_field_groups = value + end + end + + if attributes.key?(:'form_field_rules') + if (value = attributes[:'form_field_rules']).is_a?(Array) + self.form_field_rules = value + end + end + + if attributes.key?(:'form_fields_per_document') + if (value = attributes[:'form_fields_per_document']).is_a?(Array) + self.form_fields_per_document = value + end + end + + if attributes.key?(:'hide_text_tags') + self.hide_text_tags = attributes[:'hide_text_tags'] + else + self.hide_text_tags = false + end + + if attributes.key?(:'message') + self.message = attributes[:'message'] + end + + if attributes.key?(:'metadata') + if (value = attributes[:'metadata']).is_a?(Hash) + self.metadata = value + end + end + + if attributes.key?(:'signing_options') + self.signing_options = attributes[:'signing_options'] + end + + if attributes.key?(:'subject') + self.subject = attributes[:'subject'] + end + + if attributes.key?(:'test_mode') + self.test_mode = attributes[:'test_mode'] + else + self.test_mode = false + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'use_text_tags') + self.use_text_tags = attributes[:'use_text_tags'] + else + self.use_text_tags = false + end + + if attributes.key?(:'populate_auto_fill_fields') + self.populate_auto_fill_fields = attributes[:'populate_auto_fill_fields'] + else + self.populate_auto_fill_fields = false + end + + if attributes.key?(:'expires_at') + self.expires_at = attributes[:'expires_at'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @client_id.nil? + invalid_properties.push('invalid value for "client_id", client_id cannot be nil.') + end + + if !@message.nil? && @message.to_s.length > 5000 + invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.') + end + + if !@subject.nil? && @subject.to_s.length > 255 + invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.') + end + + if !@title.nil? && @title.to_s.length > 255 + invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @client_id.nil? + return false if !@message.nil? && @message.to_s.length > 5000 + return false if !@subject.nil? && @subject.to_s.length > 255 + return false if !@title.nil? && @title.to_s.length > 255 + true + end + + # Custom attribute writer method with validation + # @param [Object] client_id Value to be assigned + def client_id=(client_id) + if client_id.nil? + fail ArgumentError, 'client_id cannot be nil' + end + + @client_id = client_id + end + + # Custom attribute writer method with validation + # @param [Object] message Value to be assigned + def message=(message) + if message.to_s.length > 5000 + fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 5000.' + end + + @message = message + end + + # Custom attribute writer method with validation + # @param [Object] metadata Value to be assigned + def metadata=(metadata) + @metadata = metadata + end + + # Custom attribute writer method with validation + # @param [Object] subject Value to be assigned + def subject=(subject) + if subject.to_s.length > 255 + fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 255.' + end + + @subject = subject + end + + # Custom attribute writer method with validation + # @param [Object] title Value to be assigned + def title=(title) + if title.to_s.length > 255 + fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.' + end + + @title = title + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + client_id == o.client_id && + files == o.files && + file_urls == o.file_urls && + signers == o.signers && + grouped_signers == o.grouped_signers && + allow_decline == o.allow_decline && + allow_reassign == o.allow_reassign && + attachments == o.attachments && + cc_email_addresses == o.cc_email_addresses && + custom_fields == o.custom_fields && + field_options == o.field_options && + form_field_groups == o.form_field_groups && + form_field_rules == o.form_field_rules && + form_fields_per_document == o.form_fields_per_document && + hide_text_tags == o.hide_text_tags && + message == o.message && + metadata == o.metadata && + signing_options == o.signing_options && + subject == o.subject && + test_mode == o.test_mode && + title == o.title && + use_text_tags == o.use_text_tags && + populate_auto_fill_fields == o.populate_auto_fill_fields && + expires_at == o.expires_at + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, expires_at].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb b/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb new file mode 100644 index 0000000..8bc7d63 --- /dev/null +++ b/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb @@ -0,0 +1,521 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.12.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + class SignatureRequestEditEmbeddedWithTemplateRequest + # Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + # @return [Array] + attr_accessor :template_ids + + # Client id of the app you're using to create this embedded signature request. Used for security purposes. + # @return [String] + attr_accessor :client_id + + # Add Signers to your Templated-based Signature Request. + # @return [Array] + attr_accessor :signers + + # Allows signers to decline to sign a document if `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_decline + + # Add CC email recipients. Required when a CC role exists for the Template. + # @return [Array] + attr_accessor :ccs + + # An array defining values and options for custom fields. Required when a custom field exists in the Template. + # @return [Array] + attr_accessor :custom_fields + + # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :files + + # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :file_urls + + # The custom message in the email that will be sent to the signers. + # @return [String] + attr_accessor :message + + # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # @return [Hash] + attr_accessor :metadata + + # @return [SubSigningOptions] + attr_accessor :signing_options + + # The subject in the email that will be sent to the signers. + # @return [String] + attr_accessor :subject + + # Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :test_mode + + # The title you want to assign to the SignatureRequest. + # @return [String] + attr_accessor :title + + # 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. + # @return [Boolean] + attr_accessor :populate_auto_fill_fields + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'template_ids' => :'template_ids', + :'client_id' => :'client_id', + :'signers' => :'signers', + :'allow_decline' => :'allow_decline', + :'ccs' => :'ccs', + :'custom_fields' => :'custom_fields', + :'files' => :'files', + :'file_urls' => :'file_urls', + :'message' => :'message', + :'metadata' => :'metadata', + :'signing_options' => :'signing_options', + :'subject' => :'subject', + :'test_mode' => :'test_mode', + :'title' => :'title', + :'populate_auto_fill_fields' => :'populate_auto_fill_fields' + } + end + + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + acceptable_attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'template_ids' => :'Array', + :'client_id' => :'String', + :'signers' => :'Array', + :'allow_decline' => :'Boolean', + :'ccs' => :'Array', + :'custom_fields' => :'Array', + :'files' => :'Array', + :'file_urls' => :'Array', + :'message' => :'String', + :'metadata' => :'Hash', + :'signing_options' => :'SubSigningOptions', + :'subject' => :'String', + :'test_mode' => :'Boolean', + :'title' => :'String', + :'populate_auto_fill_fields' => :'Boolean' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [SignatureRequestEditEmbeddedWithTemplateRequest] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "SignatureRequestEditEmbeddedWithTemplateRequest" + ) || SignatureRequestEditEmbeddedWithTemplateRequest.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'template_ids') + if (value = attributes[:'template_ids']).is_a?(Array) + self.template_ids = value + end + end + + if attributes.key?(:'client_id') + self.client_id = attributes[:'client_id'] + end + + if attributes.key?(:'signers') + if (value = attributes[:'signers']).is_a?(Array) + self.signers = value + end + end + + if attributes.key?(:'allow_decline') + self.allow_decline = attributes[:'allow_decline'] + else + self.allow_decline = false + end + + if attributes.key?(:'ccs') + if (value = attributes[:'ccs']).is_a?(Array) + self.ccs = value + end + end + + if attributes.key?(:'custom_fields') + if (value = attributes[:'custom_fields']).is_a?(Array) + self.custom_fields = value + end + end + + if attributes.key?(:'files') + if (value = attributes[:'files']).is_a?(Array) + self.files = value + end + end + + if attributes.key?(:'file_urls') + if (value = attributes[:'file_urls']).is_a?(Array) + self.file_urls = value + end + end + + if attributes.key?(:'message') + self.message = attributes[:'message'] + end + + if attributes.key?(:'metadata') + if (value = attributes[:'metadata']).is_a?(Hash) + self.metadata = value + end + end + + if attributes.key?(:'signing_options') + self.signing_options = attributes[:'signing_options'] + end + + if attributes.key?(:'subject') + self.subject = attributes[:'subject'] + end + + if attributes.key?(:'test_mode') + self.test_mode = attributes[:'test_mode'] + else + self.test_mode = false + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'populate_auto_fill_fields') + self.populate_auto_fill_fields = attributes[:'populate_auto_fill_fields'] + else + self.populate_auto_fill_fields = false + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @template_ids.nil? + invalid_properties.push('invalid value for "template_ids", template_ids cannot be nil.') + end + + if @client_id.nil? + invalid_properties.push('invalid value for "client_id", client_id cannot be nil.') + end + + if @signers.nil? + invalid_properties.push('invalid value for "signers", signers cannot be nil.') + end + + if !@message.nil? && @message.to_s.length > 5000 + invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.') + end + + if !@subject.nil? && @subject.to_s.length > 255 + invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.') + end + + if !@title.nil? && @title.to_s.length > 255 + invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @template_ids.nil? + return false if @client_id.nil? + return false if @signers.nil? + return false if !@message.nil? && @message.to_s.length > 5000 + return false if !@subject.nil? && @subject.to_s.length > 255 + return false if !@title.nil? && @title.to_s.length > 255 + true + end + + # Custom attribute writer method with validation + # @param [Object] template_ids Value to be assigned + def template_ids=(template_ids) + if template_ids.nil? + fail ArgumentError, 'template_ids cannot be nil' + end + + @template_ids = template_ids + end + + # Custom attribute writer method with validation + # @param [Object] client_id Value to be assigned + def client_id=(client_id) + if client_id.nil? + fail ArgumentError, 'client_id cannot be nil' + end + + @client_id = client_id + end + + # Custom attribute writer method with validation + # @param [Object] signers Value to be assigned + def signers=(signers) + if signers.nil? + fail ArgumentError, 'signers cannot be nil' + end + + @signers = signers + end + + # Custom attribute writer method with validation + # @param [Object] message Value to be assigned + def message=(message) + if message.to_s.length > 5000 + fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 5000.' + end + + @message = message + end + + # Custom attribute writer method with validation + # @param [Object] metadata Value to be assigned + def metadata=(metadata) + @metadata = metadata + end + + # Custom attribute writer method with validation + # @param [Object] subject Value to be assigned + def subject=(subject) + if subject.to_s.length > 255 + fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 255.' + end + + @subject = subject + end + + # Custom attribute writer method with validation + # @param [Object] title Value to be assigned + def title=(title) + if title.to_s.length > 255 + fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.' + end + + @title = title + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + template_ids == o.template_ids && + client_id == o.client_id && + signers == o.signers && + allow_decline == o.allow_decline && + ccs == o.ccs && + custom_fields == o.custom_fields && + files == o.files && + file_urls == o.file_urls && + message == o.message && + metadata == o.metadata && + signing_options == o.signing_options && + subject == o.subject && + test_mode == o.test_mode && + title == o.title && + populate_auto_fill_fields == o.populate_auto_fill_fields + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [template_ids, client_id, signers, allow_decline, ccs, custom_fields, files, file_urls, message, metadata, signing_options, subject, test_mode, title, populate_auto_fill_fields].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/lib/dropbox-sign/models/signature_request_edit_request.rb b/lib/dropbox-sign/models/signature_request_edit_request.rb new file mode 100644 index 0000000..299dc70 --- /dev/null +++ b/lib/dropbox-sign/models/signature_request_edit_request.rb @@ -0,0 +1,600 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.12.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + class SignatureRequestEditRequest + # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :files + + # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :file_urls + + # Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # @return [Array] + attr_accessor :signers + + # Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # @return [Array] + attr_accessor :grouped_signers + + # Allows signers to decline to sign a document if `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_decline + + # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. + # @return [Boolean] + attr_accessor :allow_reassign + + # A list describing the attachments + # @return [Array] + attr_accessor :attachments + + # The email addresses that should be CCed. + # @return [Array] + attr_accessor :cc_email_addresses + + # The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. + # @return [String] + attr_accessor :client_id + + # When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + # @return [Array] + attr_accessor :custom_fields + + # @return [SubFieldOptions] + attr_accessor :field_options + + # Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. + # @return [Array] + attr_accessor :form_field_groups + + # Conditional Logic rules for fields defined in `form_fields_per_document`. + # @return [Array] + attr_accessor :form_field_rules + + # 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` + # @return [Array] + attr_accessor :form_fields_per_document + + # 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. + # @return [Boolean] + attr_accessor :hide_text_tags + + # Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + # @return [Boolean] + attr_accessor :is_eid + + # The custom message in the email that will be sent to the signers. + # @return [String] + attr_accessor :message + + # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # @return [Hash] + attr_accessor :metadata + + # @return [SubSigningOptions] + attr_accessor :signing_options + + # The URL you want signers redirected to after they successfully sign. + # @return [String] + attr_accessor :signing_redirect_url + + # The subject in the email that will be sent to the signers. + # @return [String] + attr_accessor :subject + + # Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :test_mode + + # The title you want to assign to the SignatureRequest. + # @return [String] + attr_accessor :title + + # Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + # @return [Boolean] + attr_accessor :use_text_tags + + # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + # @return [Integer, nil] + attr_accessor :expires_at + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'files' => :'files', + :'file_urls' => :'file_urls', + :'signers' => :'signers', + :'grouped_signers' => :'grouped_signers', + :'allow_decline' => :'allow_decline', + :'allow_reassign' => :'allow_reassign', + :'attachments' => :'attachments', + :'cc_email_addresses' => :'cc_email_addresses', + :'client_id' => :'client_id', + :'custom_fields' => :'custom_fields', + :'field_options' => :'field_options', + :'form_field_groups' => :'form_field_groups', + :'form_field_rules' => :'form_field_rules', + :'form_fields_per_document' => :'form_fields_per_document', + :'hide_text_tags' => :'hide_text_tags', + :'is_eid' => :'is_eid', + :'message' => :'message', + :'metadata' => :'metadata', + :'signing_options' => :'signing_options', + :'signing_redirect_url' => :'signing_redirect_url', + :'subject' => :'subject', + :'test_mode' => :'test_mode', + :'title' => :'title', + :'use_text_tags' => :'use_text_tags', + :'expires_at' => :'expires_at' + } + end + + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + acceptable_attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'files' => :'Array', + :'file_urls' => :'Array', + :'signers' => :'Array', + :'grouped_signers' => :'Array', + :'allow_decline' => :'Boolean', + :'allow_reassign' => :'Boolean', + :'attachments' => :'Array', + :'cc_email_addresses' => :'Array', + :'client_id' => :'String', + :'custom_fields' => :'Array', + :'field_options' => :'SubFieldOptions', + :'form_field_groups' => :'Array', + :'form_field_rules' => :'Array', + :'form_fields_per_document' => :'Array', + :'hide_text_tags' => :'Boolean', + :'is_eid' => :'Boolean', + :'message' => :'String', + :'metadata' => :'Hash', + :'signing_options' => :'SubSigningOptions', + :'signing_redirect_url' => :'String', + :'subject' => :'String', + :'test_mode' => :'Boolean', + :'title' => :'String', + :'use_text_tags' => :'Boolean', + :'expires_at' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + :'expires_at' + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [SignatureRequestEditRequest] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "SignatureRequestEditRequest" + ) || SignatureRequestEditRequest.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestEditRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestEditRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'files') + if (value = attributes[:'files']).is_a?(Array) + self.files = value + end + end + + if attributes.key?(:'file_urls') + if (value = attributes[:'file_urls']).is_a?(Array) + self.file_urls = value + end + end + + if attributes.key?(:'signers') + if (value = attributes[:'signers']).is_a?(Array) + self.signers = value + end + end + + if attributes.key?(:'grouped_signers') + if (value = attributes[:'grouped_signers']).is_a?(Array) + self.grouped_signers = value + end + end + + if attributes.key?(:'allow_decline') + self.allow_decline = attributes[:'allow_decline'] + else + self.allow_decline = false + end + + if attributes.key?(:'allow_reassign') + self.allow_reassign = attributes[:'allow_reassign'] + else + self.allow_reassign = false + end + + if attributes.key?(:'attachments') + if (value = attributes[:'attachments']).is_a?(Array) + self.attachments = value + end + end + + if attributes.key?(:'cc_email_addresses') + if (value = attributes[:'cc_email_addresses']).is_a?(Array) + self.cc_email_addresses = value + end + end + + if attributes.key?(:'client_id') + self.client_id = attributes[:'client_id'] + end + + if attributes.key?(:'custom_fields') + if (value = attributes[:'custom_fields']).is_a?(Array) + self.custom_fields = value + end + end + + if attributes.key?(:'field_options') + self.field_options = attributes[:'field_options'] + end + + if attributes.key?(:'form_field_groups') + if (value = attributes[:'form_field_groups']).is_a?(Array) + self.form_field_groups = value + end + end + + if attributes.key?(:'form_field_rules') + if (value = attributes[:'form_field_rules']).is_a?(Array) + self.form_field_rules = value + end + end + + if attributes.key?(:'form_fields_per_document') + if (value = attributes[:'form_fields_per_document']).is_a?(Array) + self.form_fields_per_document = value + end + end + + if attributes.key?(:'hide_text_tags') + self.hide_text_tags = attributes[:'hide_text_tags'] + else + self.hide_text_tags = false + end + + if attributes.key?(:'is_eid') + self.is_eid = attributes[:'is_eid'] + else + self.is_eid = false + end + + if attributes.key?(:'message') + self.message = attributes[:'message'] + end + + if attributes.key?(:'metadata') + if (value = attributes[:'metadata']).is_a?(Hash) + self.metadata = value + end + end + + if attributes.key?(:'signing_options') + self.signing_options = attributes[:'signing_options'] + end + + if attributes.key?(:'signing_redirect_url') + self.signing_redirect_url = attributes[:'signing_redirect_url'] + end + + if attributes.key?(:'subject') + self.subject = attributes[:'subject'] + end + + if attributes.key?(:'test_mode') + self.test_mode = attributes[:'test_mode'] + else + self.test_mode = false + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'use_text_tags') + self.use_text_tags = attributes[:'use_text_tags'] + else + self.use_text_tags = false + end + + if attributes.key?(:'expires_at') + self.expires_at = attributes[:'expires_at'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if !@message.nil? && @message.to_s.length > 5000 + invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.') + end + + if !@subject.nil? && @subject.to_s.length > 255 + invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.') + end + + if !@title.nil? && @title.to_s.length > 255 + invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if !@message.nil? && @message.to_s.length > 5000 + return false if !@subject.nil? && @subject.to_s.length > 255 + return false if !@title.nil? && @title.to_s.length > 255 + true + end + + # Custom attribute writer method with validation + # @param [Object] message Value to be assigned + def message=(message) + if message.to_s.length > 5000 + fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 5000.' + end + + @message = message + end + + # Custom attribute writer method with validation + # @param [Object] metadata Value to be assigned + def metadata=(metadata) + @metadata = metadata + end + + # Custom attribute writer method with validation + # @param [Object] subject Value to be assigned + def subject=(subject) + if subject.to_s.length > 255 + fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 255.' + end + + @subject = subject + end + + # Custom attribute writer method with validation + # @param [Object] title Value to be assigned + def title=(title) + if title.to_s.length > 255 + fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.' + end + + @title = title + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + files == o.files && + file_urls == o.file_urls && + signers == o.signers && + grouped_signers == o.grouped_signers && + allow_decline == o.allow_decline && + allow_reassign == o.allow_reassign && + attachments == o.attachments && + cc_email_addresses == o.cc_email_addresses && + client_id == o.client_id && + custom_fields == o.custom_fields && + field_options == o.field_options && + form_field_groups == o.form_field_groups && + form_field_rules == o.form_field_rules && + form_fields_per_document == o.form_fields_per_document && + hide_text_tags == o.hide_text_tags && + is_eid == o.is_eid && + message == o.message && + metadata == o.metadata && + signing_options == o.signing_options && + signing_redirect_url == o.signing_redirect_url && + subject == o.subject && + test_mode == o.test_mode && + title == o.title && + use_text_tags == o.use_text_tags && + expires_at == o.expires_at + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb b/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb new file mode 100644 index 0000000..ea8f2a9 --- /dev/null +++ b/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb @@ -0,0 +1,518 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.12.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + # + class SignatureRequestEditWithTemplateRequest + # Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + # @return [Array] + attr_accessor :template_ids + + # Add Signers to your Templated-based Signature Request. + # @return [Array] + attr_accessor :signers + + # Allows signers to decline to sign a document if `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_decline + + # Add CC email recipients. Required when a CC role exists for the Template. + # @return [Array] + attr_accessor :ccs + + # Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. + # @return [String] + attr_accessor :client_id + + # An array defining values and options for custom fields. Required when a custom field exists in the Template. + # @return [Array] + attr_accessor :custom_fields + + # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :files + + # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + # @return [Array] + attr_accessor :file_urls + + # Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + # @return [Boolean] + attr_accessor :is_eid + + # The custom message in the email that will be sent to the signers. + # @return [String] + attr_accessor :message + + # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # @return [Hash] + attr_accessor :metadata + + # @return [SubSigningOptions] + attr_accessor :signing_options + + # The URL you want signers redirected to after they successfully sign. + # @return [String] + attr_accessor :signing_redirect_url + + # The subject in the email that will be sent to the signers. + # @return [String] + attr_accessor :subject + + # Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :test_mode + + # The title you want to assign to the SignatureRequest. + # @return [String] + attr_accessor :title + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'template_ids' => :'template_ids', + :'signers' => :'signers', + :'allow_decline' => :'allow_decline', + :'ccs' => :'ccs', + :'client_id' => :'client_id', + :'custom_fields' => :'custom_fields', + :'files' => :'files', + :'file_urls' => :'file_urls', + :'is_eid' => :'is_eid', + :'message' => :'message', + :'metadata' => :'metadata', + :'signing_options' => :'signing_options', + :'signing_redirect_url' => :'signing_redirect_url', + :'subject' => :'subject', + :'test_mode' => :'test_mode', + :'title' => :'title' + } + end + + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + acceptable_attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'template_ids' => :'Array', + :'signers' => :'Array', + :'allow_decline' => :'Boolean', + :'ccs' => :'Array', + :'client_id' => :'String', + :'custom_fields' => :'Array', + :'files' => :'Array', + :'file_urls' => :'Array', + :'is_eid' => :'Boolean', + :'message' => :'String', + :'metadata' => :'Hash', + :'signing_options' => :'SubSigningOptions', + :'signing_redirect_url' => :'String', + :'subject' => :'String', + :'test_mode' => :'Boolean', + :'title' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [SignatureRequestEditWithTemplateRequest] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "SignatureRequestEditWithTemplateRequest" + ) || SignatureRequestEditWithTemplateRequest.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestEditWithTemplateRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestEditWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'template_ids') + if (value = attributes[:'template_ids']).is_a?(Array) + self.template_ids = value + end + end + + if attributes.key?(:'signers') + if (value = attributes[:'signers']).is_a?(Array) + self.signers = value + end + end + + if attributes.key?(:'allow_decline') + self.allow_decline = attributes[:'allow_decline'] + else + self.allow_decline = false + end + + if attributes.key?(:'ccs') + if (value = attributes[:'ccs']).is_a?(Array) + self.ccs = value + end + end + + if attributes.key?(:'client_id') + self.client_id = attributes[:'client_id'] + end + + if attributes.key?(:'custom_fields') + if (value = attributes[:'custom_fields']).is_a?(Array) + self.custom_fields = value + end + end + + if attributes.key?(:'files') + if (value = attributes[:'files']).is_a?(Array) + self.files = value + end + end + + if attributes.key?(:'file_urls') + if (value = attributes[:'file_urls']).is_a?(Array) + self.file_urls = value + end + end + + if attributes.key?(:'is_eid') + self.is_eid = attributes[:'is_eid'] + else + self.is_eid = false + end + + if attributes.key?(:'message') + self.message = attributes[:'message'] + end + + if attributes.key?(:'metadata') + if (value = attributes[:'metadata']).is_a?(Hash) + self.metadata = value + end + end + + if attributes.key?(:'signing_options') + self.signing_options = attributes[:'signing_options'] + end + + if attributes.key?(:'signing_redirect_url') + self.signing_redirect_url = attributes[:'signing_redirect_url'] + end + + if attributes.key?(:'subject') + self.subject = attributes[:'subject'] + end + + if attributes.key?(:'test_mode') + self.test_mode = attributes[:'test_mode'] + else + self.test_mode = false + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @template_ids.nil? + invalid_properties.push('invalid value for "template_ids", template_ids cannot be nil.') + end + + if @signers.nil? + invalid_properties.push('invalid value for "signers", signers cannot be nil.') + end + + if !@message.nil? && @message.to_s.length > 5000 + invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.') + end + + if !@subject.nil? && @subject.to_s.length > 255 + invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 255.') + end + + if !@title.nil? && @title.to_s.length > 255 + invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @template_ids.nil? + return false if @signers.nil? + return false if !@message.nil? && @message.to_s.length > 5000 + return false if !@subject.nil? && @subject.to_s.length > 255 + return false if !@title.nil? && @title.to_s.length > 255 + true + end + + # Custom attribute writer method with validation + # @param [Object] template_ids Value to be assigned + def template_ids=(template_ids) + if template_ids.nil? + fail ArgumentError, 'template_ids cannot be nil' + end + + @template_ids = template_ids + end + + # Custom attribute writer method with validation + # @param [Object] signers Value to be assigned + def signers=(signers) + if signers.nil? + fail ArgumentError, 'signers cannot be nil' + end + + @signers = signers + end + + # Custom attribute writer method with validation + # @param [Object] message Value to be assigned + def message=(message) + if message.to_s.length > 5000 + fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 5000.' + end + + @message = message + end + + # Custom attribute writer method with validation + # @param [Object] metadata Value to be assigned + def metadata=(metadata) + @metadata = metadata + end + + # Custom attribute writer method with validation + # @param [Object] subject Value to be assigned + def subject=(subject) + if subject.to_s.length > 255 + fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 255.' + end + + @subject = subject + end + + # Custom attribute writer method with validation + # @param [Object] title Value to be assigned + def title=(title) + if title.to_s.length > 255 + fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 255.' + end + + @title = title + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + template_ids == o.template_ids && + signers == o.signers && + allow_decline == o.allow_decline && + ccs == o.ccs && + client_id == o.client_id && + custom_fields == o.custom_fields && + files == o.files && + file_urls == o.file_urls && + is_eid == o.is_eid && + message == o.message && + metadata == o.metadata && + signing_options == o.signing_options && + signing_redirect_url == o.signing_redirect_url && + subject == o.subject && + test_mode == o.test_mode && + title == o.title + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/lib/dropbox-sign/models/signature_request_get_response.rb b/lib/dropbox-sign/models/signature_request_get_response.rb index 04ca8fe..f3195ac 100644 --- a/lib/dropbox-sign/models/signature_request_get_response.rb +++ b/lib/dropbox-sign/models/signature_request_get_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestGetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestGetResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] signature_request Value to be assigned + def signature_request=(signature_request) + if signature_request.nil? + fail ArgumentError, 'signature_request cannot be nil' + end + + @signature_request = signature_request + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/signature_request_list_response.rb b/lib/dropbox-sign/models/signature_request_list_response.rb index 187e12b..48897f6 100644 --- a/lib/dropbox-sign/models/signature_request_list_response.rb +++ b/lib/dropbox-sign/models/signature_request_list_response.rb @@ -6,7 +6,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 @@ -38,9 +38,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -91,9 +96,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestListResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestListResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -138,6 +144,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] signature_requests Value to be assigned + def signature_requests=(signature_requests) + if signature_requests.nil? + fail ArgumentError, 'signature_requests cannot be nil' + end + + @signature_requests = signature_requests + end + + # Custom attribute writer method with validation + # @param [Object] list_info Value to be assigned + def list_info=(list_info) + if list_info.nil? + fail ArgumentError, 'list_info cannot be nil' + end + + @list_info = list_info + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/signature_request_remind_request.rb b/lib/dropbox-sign/models/signature_request_remind_request.rb index 677d410..5ba02f4 100644 --- a/lib/dropbox-sign/models/signature_request_remind_request.rb +++ b/lib/dropbox-sign/models/signature_request_remind_request.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestRemindRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestRemindRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -120,6 +126,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] email_address Value to be assigned + def email_address=(email_address) + if email_address.nil? + fail ArgumentError, 'email_address cannot be nil' + end + + @email_address = email_address + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/signature_request_response.rb b/lib/dropbox-sign/models/signature_request_response.rb index 3981f79..e8bd418 100644 --- a/lib/dropbox-sign/models/signature_request_response.rb +++ b/lib/dropbox-sign/models/signature_request_response.rb @@ -6,7 +6,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 @@ -150,9 +150,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -237,9 +242,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_response_attachment.rb b/lib/dropbox-sign/models/signature_request_response_attachment.rb index 9629909..7fb408b 100644 --- a/lib/dropbox-sign/models/signature_request_response_attachment.rb +++ b/lib/dropbox-sign/models/signature_request_response_attachment.rb @@ -6,7 +6,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 @@ -55,9 +55,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -113,9 +118,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseAttachment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseAttachment`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -178,6 +184,46 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] id Value to be assigned + def id=(id) + if id.nil? + fail ArgumentError, 'id cannot be nil' + end + + @id = id + end + + # Custom attribute writer method with validation + # @param [Object] signer Value to be assigned + def signer=(signer) + if signer.nil? + fail ArgumentError, 'signer cannot be nil' + end + + @signer = signer + end + + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + + # Custom attribute writer method with validation + # @param [Object] required Value to be assigned + def required=(required) + if required.nil? + fail ArgumentError, 'required cannot be nil' + end + + @required = required + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb b/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb index 5840285..bbf68fb 100644 --- a/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +++ b/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb @@ -6,7 +6,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 @@ -50,9 +50,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -114,9 +119,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseCustomFieldBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseCustomFieldBase`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -165,6 +171,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb b/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb index 531891f..c29f4bb 100644 --- a/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +++ b/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseCustomFieldCheckbox`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseCustomFieldCheckbox`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -126,6 +132,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb b/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb index 9899bd0..5af5166 100644 --- a/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +++ b/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseCustomFieldText`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseCustomFieldText`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -126,6 +132,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb b/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb index 63f61f1..1175c8a 100644 --- a/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +++ b/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/models/signature_request_response_data_base.rb b/lib/dropbox-sign/models/signature_request_response_data_base.rb index 08d0a18..9290220 100644 --- a/lib/dropbox-sign/models/signature_request_response_data_base.rb +++ b/lib/dropbox-sign/models/signature_request_response_data_base.rb @@ -6,7 +6,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 @@ -49,9 +49,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -133,9 +138,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataBase`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb b/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb index 74f03f2..36f46f6 100644 --- a/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +++ b/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb b/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb index ccc30ca..620a25b 100644 --- a/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +++ b/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueCheckbox`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueCheckbox`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb b/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb index df3714a..8c51b79 100644 --- a/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +++ b/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueCheckboxMerge`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueCheckboxMerge`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb b/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb index 35b5722..27eb89d 100644 --- a/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +++ b/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueDateSigned`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueDateSigned`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb b/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb index 56d6149..a8c8890 100644 --- a/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +++ b/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueDropdown`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueDropdown`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb b/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb index e5c4df0..b3828e4 100644 --- a/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +++ b/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb @@ -6,7 +6,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 @@ -39,9 +39,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -93,9 +98,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueInitials`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueInitials`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb b/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb index 87aa469..da06fdd 100644 --- a/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +++ b/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueRadio`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueRadio`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb b/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb index ecbc9b5..1d24ea0 100644 --- a/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +++ b/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb @@ -6,7 +6,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 @@ -39,9 +39,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -93,9 +98,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueSignature`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueSignature`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_response_data_value_text.rb b/lib/dropbox-sign/models/signature_request_response_data_value_text.rb index 86fda70..60ea7d9 100644 --- a/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +++ b/lib/dropbox-sign/models/signature_request_response_data_value_text.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueText`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueText`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb b/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb index fe39d64..e78f7d2 100644 --- a/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +++ b/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueTextMerge`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseDataValueTextMerge`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_response_signatures.rb b/lib/dropbox-sign/models/signature_request_response_signatures.rb index 1e29927..99602a2 100644 --- a/lib/dropbox-sign/models/signature_request_response_signatures.rb +++ b/lib/dropbox-sign/models/signature_request_response_signatures.rb @@ -6,7 +6,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 @@ -120,9 +120,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -204,9 +209,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseSignatures`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestResponseSignatures`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_send_request.rb b/lib/dropbox-sign/models/signature_request_send_request.rb index c11fb51..1bfe729 100644 --- a/lib/dropbox-sign/models/signature_request_send_request.rb +++ b/lib/dropbox-sign/models/signature_request_send_request.rb @@ -6,7 +6,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 @@ -152,9 +152,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -229,9 +234,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestSendRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestSendRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/signature_request_send_with_template_request.rb b/lib/dropbox-sign/models/signature_request_send_with_template_request.rb index b626cee..ac26472 100644 --- a/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +++ b/lib/dropbox-sign/models/signature_request_send_with_template_request.rb @@ -6,7 +6,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 @@ -109,9 +109,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -176,9 +181,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestSendWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestSendWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -312,6 +318,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] template_ids Value to be assigned + def template_ids=(template_ids) + if template_ids.nil? + fail ArgumentError, 'template_ids cannot be nil' + end + + @template_ids = template_ids + end + + # Custom attribute writer method with validation + # @param [Object] signers Value to be assigned + def signers=(signers) + if signers.nil? + fail ArgumentError, 'signers cannot be nil' + end + + @signers = signers + end + # Custom attribute writer method with validation # @param [Object] message Value to be assigned def message=(message) diff --git a/lib/dropbox-sign/models/signature_request_update_request.rb b/lib/dropbox-sign/models/signature_request_update_request.rb index 1b65aa5..d43b675 100644 --- a/lib/dropbox-sign/models/signature_request_update_request.rb +++ b/lib/dropbox-sign/models/signature_request_update_request.rb @@ -6,7 +6,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 @@ -44,9 +44,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -99,9 +104,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -141,6 +147,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] signature_id Value to be assigned + def signature_id=(signature_id) + if signature_id.nil? + fail ArgumentError, 'signature_id cannot be nil' + end + + @signature_id = signature_id + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_attachment.rb b/lib/dropbox-sign/models/sub_attachment.rb index dfc7a33..cf6c3d5 100644 --- a/lib/dropbox-sign/models/sub_attachment.rb +++ b/lib/dropbox-sign/models/sub_attachment.rb @@ -6,7 +6,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 @@ -44,9 +44,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -98,9 +103,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubAttachment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubAttachment`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -147,6 +153,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + + # Custom attribute writer method with validation + # @param [Object] signer_index Value to be assigned + def signer_index=(signer_index) + if signer_index.nil? + fail ArgumentError, 'signer_index cannot be nil' + end + + @signer_index = signer_index + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_bulk_signer_list.rb b/lib/dropbox-sign/models/sub_bulk_signer_list.rb index ecc48bd..80085f3 100644 --- a/lib/dropbox-sign/models/sub_bulk_signer_list.rb +++ b/lib/dropbox-sign/models/sub_bulk_signer_list.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubBulkSignerList`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubBulkSignerList`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb b/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb index e9f81d3..627232b 100644 --- a/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +++ b/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubBulkSignerListCustomField`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubBulkSignerListCustomField`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -125,6 +131,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + + # Custom attribute writer method with validation + # @param [Object] value Value to be assigned + def value=(value) + if value.nil? + fail ArgumentError, 'value cannot be nil' + end + + @value = value + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_cc.rb b/lib/dropbox-sign/models/sub_cc.rb index 7136623..5d22227 100644 --- a/lib/dropbox-sign/models/sub_cc.rb +++ b/lib/dropbox-sign/models/sub_cc.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubCC`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubCC`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -125,6 +131,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] role Value to be assigned + def role=(role) + if role.nil? + fail ArgumentError, 'role cannot be nil' + end + + @role = role + end + + # Custom attribute writer method with validation + # @param [Object] email_address Value to be assigned + def email_address=(email_address) + if email_address.nil? + fail ArgumentError, 'email_address cannot be nil' + end + + @email_address = email_address + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_custom_field.rb b/lib/dropbox-sign/models/sub_custom_field.rb index f5ad1f6..81ef208 100644 --- a/lib/dropbox-sign/models/sub_custom_field.rb +++ b/lib/dropbox-sign/models/sub_custom_field.rb @@ -6,7 +6,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 @@ -45,9 +45,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -99,9 +104,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubCustomField`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubCustomField`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -143,6 +149,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_editor_options.rb b/lib/dropbox-sign/models/sub_editor_options.rb index 182a921..eb4d6b8 100644 --- a/lib/dropbox-sign/models/sub_editor_options.rb +++ b/lib/dropbox-sign/models/sub_editor_options.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubEditorOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubEditorOptions`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/sub_field_options.rb b/lib/dropbox-sign/models/sub_field_options.rb index 993ced3..a46e325 100644 --- a/lib/dropbox-sign/models/sub_field_options.rb +++ b/lib/dropbox-sign/models/sub_field_options.rb @@ -6,7 +6,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 @@ -52,9 +52,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -103,9 +108,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFieldOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFieldOptions`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/sub_form_field_group.rb b/lib/dropbox-sign/models/sub_form_field_group.rb index 0917901..f927fa0 100644 --- a/lib/dropbox-sign/models/sub_form_field_group.rb +++ b/lib/dropbox-sign/models/sub_form_field_group.rb @@ -6,7 +6,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 @@ -39,9 +39,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -92,9 +97,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldGroup`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldGroup`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -140,6 +146,36 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] group_id Value to be assigned + def group_id=(group_id) + if group_id.nil? + fail ArgumentError, 'group_id cannot be nil' + end + + @group_id = group_id + end + + # Custom attribute writer method with validation + # @param [Object] group_label Value to be assigned + def group_label=(group_label) + if group_label.nil? + fail ArgumentError, 'group_label cannot be nil' + end + + @group_label = group_label + end + + # Custom attribute writer method with validation + # @param [Object] requirement Value to be assigned + def requirement=(requirement) + if requirement.nil? + fail ArgumentError, 'requirement cannot be nil' + end + + @requirement = requirement + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_form_field_rule.rb b/lib/dropbox-sign/models/sub_form_field_rule.rb index 6eb04a2..3053735 100644 --- a/lib/dropbox-sign/models/sub_form_field_rule.rb +++ b/lib/dropbox-sign/models/sub_form_field_rule.rb @@ -6,7 +6,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 @@ -44,9 +44,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -98,9 +103,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldRule`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldRule`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -176,6 +182,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] id Value to be assigned + def id=(id) + if id.nil? + fail ArgumentError, 'id cannot be nil' + end + + @id = id + end + + # Custom attribute writer method with validation + # @param [Object] trigger_operator Value to be assigned + def trigger_operator=(trigger_operator) + if trigger_operator.nil? + fail ArgumentError, 'trigger_operator cannot be nil' + end + + @trigger_operator = trigger_operator + end + # Custom attribute writer method with validation # @param [Object] triggers Value to be assigned def triggers=(triggers) diff --git a/lib/dropbox-sign/models/sub_form_field_rule_action.rb b/lib/dropbox-sign/models/sub_form_field_rule_action.rb index 8b524a1..ba51d11 100644 --- a/lib/dropbox-sign/models/sub_form_field_rule_action.rb +++ b/lib/dropbox-sign/models/sub_form_field_rule_action.rb @@ -6,7 +6,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 @@ -65,9 +65,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -119,9 +124,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldRuleAction`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldRuleAction`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -168,6 +174,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] hidden Value to be assigned + def hidden=(hidden) + if hidden.nil? + fail ArgumentError, 'hidden cannot be nil' + end + + @hidden = hidden + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) diff --git a/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb b/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb index 9ef68ce..26180ca 100644 --- a/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +++ b/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb @@ -6,7 +6,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 @@ -66,9 +66,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -120,9 +125,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldRuleTrigger`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldRuleTrigger`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -171,6 +177,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] id Value to be assigned + def id=(id) + if id.nil? + fail ArgumentError, 'id cannot be nil' + end + + @id = id + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] operator Object to be assigned def operator=(operator) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb index e429727..ee41c08 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb @@ -6,7 +6,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 @@ -79,9 +79,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -173,9 +178,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentBase`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -283,6 +289,96 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] document_index Value to be assigned + def document_index=(document_index) + if document_index.nil? + fail ArgumentError, 'document_index cannot be nil' + end + + @document_index = document_index + end + + # Custom attribute writer method with validation + # @param [Object] api_id Value to be assigned + def api_id=(api_id) + if api_id.nil? + fail ArgumentError, 'api_id cannot be nil' + end + + @api_id = api_id + end + + # Custom attribute writer method with validation + # @param [Object] height Value to be assigned + def height=(height) + if height.nil? + fail ArgumentError, 'height cannot be nil' + end + + @height = height + end + + # Custom attribute writer method with validation + # @param [Object] required Value to be assigned + def required=(required) + if required.nil? + fail ArgumentError, 'required cannot be nil' + end + + @required = required + end + + # Custom attribute writer method with validation + # @param [Object] signer Value to be assigned + def signer=(signer) + if signer.nil? + fail ArgumentError, 'signer cannot be nil' + end + + @signer = signer + end + + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + + # Custom attribute writer method with validation + # @param [Object] width Value to be assigned + def width=(width) + if width.nil? + fail ArgumentError, 'width cannot be nil' + end + + @width = width + end + + # Custom attribute writer method with validation + # @param [Object] x Value to be assigned + def x=(x) + if x.nil? + fail ArgumentError, 'x cannot be nil' + end + + @x = x + end + + # Custom attribute writer method with validation + # @param [Object] y Value to be assigned + def y=(y) + if y.nil? + fail ArgumentError, 'y cannot be nil' + end + + @y = y + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb index 74968ed..d93171a 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb @@ -6,7 +6,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 @@ -40,9 +40,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -93,9 +98,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentCheckbox`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentCheckbox`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -141,6 +147,26 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + + # Custom attribute writer method with validation + # @param [Object] is_checked Value to be assigned + def is_checked=(is_checked) + if is_checked.nil? + fail ArgumentError, 'is_checked cannot be nil' + end + + @is_checked = is_checked + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb index 0c8dc92..53f934b 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentCheckboxMerge`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentCheckboxMerge`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb index 85e37c7..b6f9c3f 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb @@ -6,7 +6,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 @@ -62,9 +62,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -115,9 +120,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentDateSigned`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentDateSigned`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -162,6 +168,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] font_family Object to be assigned def font_family=(font_family) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb index 51d8244..159d431 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb @@ -6,7 +6,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 @@ -72,9 +72,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -127,9 +132,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentDropdown`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentDropdown`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -194,6 +200,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Custom attribute writer method with validation # @param [Object] options Value to be assigned def options=(options) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb index 77ba1dd..8e689b5 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb index 0cb2bf4..7a733da 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb @@ -6,7 +6,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 @@ -72,9 +72,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -127,9 +132,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentHyperlink`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentHyperlink`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -192,6 +198,36 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + + # Custom attribute writer method with validation + # @param [Object] content Value to be assigned + def content=(content) + if content.nil? + fail ArgumentError, 'content cannot be nil' + end + + @content = content + end + + # Custom attribute writer method with validation + # @param [Object] content_url Value to be assigned + def content_url=(content_url) + if content_url.nil? + fail ArgumentError, 'content_url cannot be nil' + end + + @content_url = content_url + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] font_family Object to be assigned def font_family=(font_family) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb index 0433390..fa5af10 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentInitials`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentInitials`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb index 5436051..4286467 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb @@ -6,7 +6,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 @@ -40,9 +40,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -93,9 +98,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentRadio`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentRadio`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -146,6 +152,36 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + + # Custom attribute writer method with validation + # @param [Object] group Value to be assigned + def group=(group) + if group.nil? + fail ArgumentError, 'group cannot be nil' + end + + @group = group + end + + # Custom attribute writer method with validation + # @param [Object] is_checked Value to be assigned + def is_checked=(is_checked) + if is_checked.nil? + fail ArgumentError, 'is_checked cannot be nil' + end + + @is_checked = is_checked + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb index a8a737b..1ac7c67 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentSignature`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentSignature`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb index 35fc716..167b7f0 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb @@ -6,7 +6,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 @@ -100,9 +100,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -161,9 +166,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentText`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentText`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -242,6 +248,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] validation_type Object to be assigned def validation_type=(validation_type) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb index 2f62a81..edab85f 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb @@ -6,7 +6,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 @@ -62,9 +62,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -115,9 +120,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentTextMerge`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubFormFieldsPerDocumentTextMerge`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -162,6 +168,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] font_family Object to be assigned def font_family=(font_family) diff --git a/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb b/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb index bc0fd00..b1a119f 100644 --- a/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +++ b/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb @@ -6,7 +6,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 diff --git a/lib/dropbox-sign/models/sub_merge_field.rb b/lib/dropbox-sign/models/sub_merge_field.rb index 08f4041..b894cf9 100644 --- a/lib/dropbox-sign/models/sub_merge_field.rb +++ b/lib/dropbox-sign/models/sub_merge_field.rb @@ -6,7 +6,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 @@ -56,9 +56,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -108,9 +113,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubMergeField`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubMergeField`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -149,6 +155,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] type Object to be assigned def type=(type) diff --git a/lib/dropbox-sign/models/sub_o_auth.rb b/lib/dropbox-sign/models/sub_o_auth.rb index 2297282..ca6b55b 100644 --- a/lib/dropbox-sign/models/sub_o_auth.rb +++ b/lib/dropbox-sign/models/sub_o_auth.rb @@ -6,7 +6,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 @@ -57,9 +57,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -109,9 +114,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubOAuth`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubOAuth`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/sub_options.rb b/lib/dropbox-sign/models/sub_options.rb index 6c4c07b..a2f2df2 100644 --- a/lib/dropbox-sign/models/sub_options.rb +++ b/lib/dropbox-sign/models/sub_options.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubOptions`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb b/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb index 70cf632..23615d5 100644 --- a/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +++ b/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb @@ -6,7 +6,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 @@ -39,9 +39,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -93,9 +98,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubSignatureRequestGroupedSigners`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubSignatureRequestGroupedSigners`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -138,6 +144,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] group Value to be assigned + def group=(group) + if group.nil? + fail ArgumentError, 'group cannot be nil' + end + + @group = group + end + + # Custom attribute writer method with validation + # @param [Object] signers Value to be assigned + def signers=(signers) + if signers.nil? + fail ArgumentError, 'signers cannot be nil' + end + + @signers = signers + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_signature_request_signer.rb b/lib/dropbox-sign/models/sub_signature_request_signer.rb index 8fe9ddb..2a4eaed 100644 --- a/lib/dropbox-sign/models/sub_signature_request_signer.rb +++ b/lib/dropbox-sign/models/sub_signature_request_signer.rb @@ -6,7 +6,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 @@ -76,9 +76,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -133,9 +138,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubSignatureRequestSigner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubSignatureRequestSigner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -200,6 +206,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + + # Custom attribute writer method with validation + # @param [Object] email_address Value to be assigned + def email_address=(email_address) + if email_address.nil? + fail ArgumentError, 'email_address cannot be nil' + end + + @email_address = email_address + end + # Custom attribute writer method with validation # @param [Object] pin Value to be assigned def pin=(pin) diff --git a/lib/dropbox-sign/models/sub_signature_request_template_signer.rb b/lib/dropbox-sign/models/sub_signature_request_template_signer.rb index f30ec34..eb52b71 100644 --- a/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +++ b/lib/dropbox-sign/models/sub_signature_request_template_signer.rb @@ -6,7 +6,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 @@ -76,9 +76,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -132,9 +137,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubSignatureRequestTemplateSigner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubSignatureRequestTemplateSigner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -204,6 +210,36 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] role Value to be assigned + def role=(role) + if role.nil? + fail ArgumentError, 'role cannot be nil' + end + + @role = role + end + + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + + # Custom attribute writer method with validation + # @param [Object] email_address Value to be assigned + def email_address=(email_address) + if email_address.nil? + fail ArgumentError, 'email_address cannot be nil' + end + + @email_address = email_address + end + # Custom attribute writer method with validation # @param [Object] pin Value to be assigned def pin=(pin) diff --git a/lib/dropbox-sign/models/sub_signing_options.rb b/lib/dropbox-sign/models/sub_signing_options.rb index 0ccca5b..26a6406 100644 --- a/lib/dropbox-sign/models/sub_signing_options.rb +++ b/lib/dropbox-sign/models/sub_signing_options.rb @@ -6,7 +6,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 @@ -72,9 +72,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -127,9 +132,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubSigningOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubSigningOptions`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/sub_team_response.rb b/lib/dropbox-sign/models/sub_team_response.rb index 9b4d9d1..7ee4be8 100644 --- a/lib/dropbox-sign/models/sub_team_response.rb +++ b/lib/dropbox-sign/models/sub_team_response.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubTeamResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubTeamResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/sub_template_role.rb b/lib/dropbox-sign/models/sub_template_role.rb index f0943c0..ff16168 100644 --- a/lib/dropbox-sign/models/sub_template_role.rb +++ b/lib/dropbox-sign/models/sub_template_role.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubTemplateRole`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubTemplateRole`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb b/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb index 653a0fd..f77ddb1 100644 --- a/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +++ b/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb @@ -6,7 +6,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 @@ -39,9 +39,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -93,9 +98,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubUnclaimedDraftSigner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubUnclaimedDraftSigner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -136,6 +142,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] email_address Value to be assigned + def email_address=(email_address) + if email_address.nil? + fail ArgumentError, 'email_address cannot be nil' + end + + @email_address = email_address + end + + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb b/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb index 449e2ec..61fe5d8 100644 --- a/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +++ b/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb @@ -6,7 +6,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 @@ -39,9 +39,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -92,9 +97,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubUnclaimedDraftTemplateSigner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubUnclaimedDraftTemplateSigner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -140,6 +146,36 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] role Value to be assigned + def role=(role) + if role.nil? + fail ArgumentError, 'role cannot be nil' + end + + @role = role + end + + # Custom attribute writer method with validation + # @param [Object] name Value to be assigned + def name=(name) + if name.nil? + fail ArgumentError, 'name cannot be nil' + end + + @name = name + end + + # Custom attribute writer method with validation + # @param [Object] email_address Value to be assigned + def email_address=(email_address) + if email_address.nil? + fail ArgumentError, 'email_address cannot be nil' + end + + @email_address = email_address + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/sub_white_labeling_options.rb b/lib/dropbox-sign/models/sub_white_labeling_options.rb index d6c25e2..0878b3d 100644 --- a/lib/dropbox-sign/models/sub_white_labeling_options.rb +++ b/lib/dropbox-sign/models/sub_white_labeling_options.rb @@ -6,7 +6,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 @@ -108,9 +108,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -173,9 +178,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubWhiteLabelingOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubWhiteLabelingOptions`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/team_add_member_request.rb b/lib/dropbox-sign/models/team_add_member_request.rb index 8758475..57dde8e 100644 --- a/lib/dropbox-sign/models/team_add_member_request.rb +++ b/lib/dropbox-sign/models/team_add_member_request.rb @@ -6,7 +6,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 @@ -61,9 +61,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -114,9 +119,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamAddMemberRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamAddMemberRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/team_create_request.rb b/lib/dropbox-sign/models/team_create_request.rb index 9d68d49..3c1e69f 100644 --- a/lib/dropbox-sign/models/team_create_request.rb +++ b/lib/dropbox-sign/models/team_create_request.rb @@ -6,7 +6,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 @@ -29,9 +29,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -80,9 +85,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/team_get_info_response.rb b/lib/dropbox-sign/models/team_get_info_response.rb index e7bc851..6dda33a 100644 --- a/lib/dropbox-sign/models/team_get_info_response.rb +++ b/lib/dropbox-sign/models/team_get_info_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamGetInfoResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamGetInfoResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] team Value to be assigned + def team=(team) + if team.nil? + fail ArgumentError, 'team cannot be nil' + end + + @team = team + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/team_get_response.rb b/lib/dropbox-sign/models/team_get_response.rb index ed276ee..50c0ac7 100644 --- a/lib/dropbox-sign/models/team_get_response.rb +++ b/lib/dropbox-sign/models/team_get_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamGetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamGetResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] team Value to be assigned + def team=(team) + if team.nil? + fail ArgumentError, 'team cannot be nil' + end + + @team = team + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/team_info_response.rb b/lib/dropbox-sign/models/team_info_response.rb index 9c7ca02..5231ddf 100644 --- a/lib/dropbox-sign/models/team_info_response.rb +++ b/lib/dropbox-sign/models/team_info_response.rb @@ -6,7 +6,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 @@ -48,9 +48,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -104,9 +109,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamInfoResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamInfoResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/team_invite_response.rb b/lib/dropbox-sign/models/team_invite_response.rb index 9da55fa..9cb01aa 100644 --- a/lib/dropbox-sign/models/team_invite_response.rb +++ b/lib/dropbox-sign/models/team_invite_response.rb @@ -6,7 +6,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 @@ -54,9 +54,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -110,9 +115,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamInviteResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamInviteResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/team_invites_response.rb b/lib/dropbox-sign/models/team_invites_response.rb index 7b061bb..44b5e95 100644 --- a/lib/dropbox-sign/models/team_invites_response.rb +++ b/lib/dropbox-sign/models/team_invites_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamInvitesResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamInvitesResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -123,6 +129,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] team_invites Value to be assigned + def team_invites=(team_invites) + if team_invites.nil? + fail ArgumentError, 'team_invites cannot be nil' + end + + @team_invites = team_invites + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/team_member_response.rb b/lib/dropbox-sign/models/team_member_response.rb index 8e58d7f..91e1c74 100644 --- a/lib/dropbox-sign/models/team_member_response.rb +++ b/lib/dropbox-sign/models/team_member_response.rb @@ -6,7 +6,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 @@ -39,9 +39,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -92,9 +97,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamMemberResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamMemberResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/team_members_response.rb b/lib/dropbox-sign/models/team_members_response.rb index 0fb211d..9247450 100644 --- a/lib/dropbox-sign/models/team_members_response.rb +++ b/lib/dropbox-sign/models/team_members_response.rb @@ -6,7 +6,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 @@ -37,9 +37,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -90,9 +95,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamMembersResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamMembersResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -137,6 +143,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] team_members Value to be assigned + def team_members=(team_members) + if team_members.nil? + fail ArgumentError, 'team_members cannot be nil' + end + + @team_members = team_members + end + + # Custom attribute writer method with validation + # @param [Object] list_info Value to be assigned + def list_info=(list_info) + if list_info.nil? + fail ArgumentError, 'list_info cannot be nil' + end + + @list_info = list_info + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/team_parent_response.rb b/lib/dropbox-sign/models/team_parent_response.rb index 7f0d8ae..48cf5f1 100644 --- a/lib/dropbox-sign/models/team_parent_response.rb +++ b/lib/dropbox-sign/models/team_parent_response.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamParentResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamParentResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/team_remove_member_request.rb b/lib/dropbox-sign/models/team_remove_member_request.rb index d910378..0b725e4 100644 --- a/lib/dropbox-sign/models/team_remove_member_request.rb +++ b/lib/dropbox-sign/models/team_remove_member_request.rb @@ -6,7 +6,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 @@ -71,9 +71,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -126,9 +131,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamRemoveMemberRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamRemoveMemberRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/team_response.rb b/lib/dropbox-sign/models/team_response.rb index b336247..c239735 100644 --- a/lib/dropbox-sign/models/team_response.rb +++ b/lib/dropbox-sign/models/team_response.rb @@ -6,7 +6,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 @@ -44,9 +44,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -98,9 +103,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/team_sub_teams_response.rb b/lib/dropbox-sign/models/team_sub_teams_response.rb index 904da23..5f5a612 100644 --- a/lib/dropbox-sign/models/team_sub_teams_response.rb +++ b/lib/dropbox-sign/models/team_sub_teams_response.rb @@ -6,7 +6,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 @@ -37,9 +37,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -90,9 +95,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamSubTeamsResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamSubTeamsResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -137,6 +143,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] sub_teams Value to be assigned + def sub_teams=(sub_teams) + if sub_teams.nil? + fail ArgumentError, 'sub_teams cannot be nil' + end + + @sub_teams = sub_teams + end + + # Custom attribute writer method with validation + # @param [Object] list_info Value to be assigned + def list_info=(list_info) + if list_info.nil? + fail ArgumentError, 'list_info cannot be nil' + end + + @list_info = list_info + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/team_update_request.rb b/lib/dropbox-sign/models/team_update_request.rb index 7b952aa..030ebd0 100644 --- a/lib/dropbox-sign/models/team_update_request.rb +++ b/lib/dropbox-sign/models/team_update_request.rb @@ -6,7 +6,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 @@ -29,9 +29,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -80,9 +85,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TeamUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_add_user_request.rb b/lib/dropbox-sign/models/template_add_user_request.rb index 23999d5..bb39218 100644 --- a/lib/dropbox-sign/models/template_add_user_request.rb +++ b/lib/dropbox-sign/models/template_add_user_request.rb @@ -6,7 +6,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 @@ -39,9 +39,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -92,9 +97,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateAddUserRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateAddUserRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_create_embedded_draft_request.rb b/lib/dropbox-sign/models/template_create_embedded_draft_request.rb index aa9e07e..4b006bd 100644 --- a/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +++ b/lib/dropbox-sign/models/template_create_embedded_draft_request.rb @@ -6,7 +6,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 @@ -147,9 +147,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -222,9 +227,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateEmbeddedDraftRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateEmbeddedDraftRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -396,6 +402,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] client_id Value to be assigned + def client_id=(client_id) + if client_id.nil? + fail ArgumentError, 'client_id cannot be nil' + end + + @client_id = client_id + end + # Custom attribute writer method with validation # @param [Object] message Value to be assigned def message=(message) diff --git a/lib/dropbox-sign/models/template_create_embedded_draft_response.rb b/lib/dropbox-sign/models/template_create_embedded_draft_response.rb index 7886993..540a700 100644 --- a/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +++ b/lib/dropbox-sign/models/template_create_embedded_draft_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateEmbeddedDraftResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateEmbeddedDraftResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] template Value to be assigned + def template=(template) + if template.nil? + fail ArgumentError, 'template cannot be nil' + end + + @template = template + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb b/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb index a8eeafb..354ad0d 100644 --- a/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +++ b/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb @@ -6,7 +6,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 @@ -45,9 +45,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -99,9 +104,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateEmbeddedDraftResponseTemplate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateEmbeddedDraftResponseTemplate`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_create_request.rb b/lib/dropbox-sign/models/template_create_request.rb index e94e608..2376b78 100644 --- a/lib/dropbox-sign/models/template_create_request.rb +++ b/lib/dropbox-sign/models/template_create_request.rb @@ -6,7 +6,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 @@ -113,9 +113,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -181,9 +186,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -320,6 +326,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] form_fields_per_document Value to be assigned + def form_fields_per_document=(form_fields_per_document) + if form_fields_per_document.nil? + fail ArgumentError, 'form_fields_per_document cannot be nil' + end + + @form_fields_per_document = form_fields_per_document + end + + # Custom attribute writer method with validation + # @param [Object] signer_roles Value to be assigned + def signer_roles=(signer_roles) + if signer_roles.nil? + fail ArgumentError, 'signer_roles cannot be nil' + end + + @signer_roles = signer_roles + end + # Custom attribute writer method with validation # @param [Object] message Value to be assigned def message=(message) diff --git a/lib/dropbox-sign/models/template_create_response.rb b/lib/dropbox-sign/models/template_create_response.rb index dd084e0..5ca1bcb 100644 --- a/lib/dropbox-sign/models/template_create_response.rb +++ b/lib/dropbox-sign/models/template_create_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] template Value to be assigned + def template=(template) + if template.nil? + fail ArgumentError, 'template cannot be nil' + end + + @template = template + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_create_response_template.rb b/lib/dropbox-sign/models/template_create_response_template.rb index 91e0dc5..1ffeb10 100644 --- a/lib/dropbox-sign/models/template_create_response_template.rb +++ b/lib/dropbox-sign/models/template_create_response_template.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateResponseTemplate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateResponseTemplate`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_edit_response.rb b/lib/dropbox-sign/models/template_edit_response.rb index b2f589e..9a49967 100644 --- a/lib/dropbox-sign/models/template_edit_response.rb +++ b/lib/dropbox-sign/models/template_edit_response.rb @@ -6,7 +6,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 @@ -29,9 +29,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -80,9 +85,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateEditResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateEditResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -110,6 +116,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] template_id Value to be assigned + def template_id=(template_id) + if template_id.nil? + fail ArgumentError, 'template_id cannot be nil' + end + + @template_id = template_id + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_get_response.rb b/lib/dropbox-sign/models/template_get_response.rb index 3ff1bcd..dcbc14b 100644 --- a/lib/dropbox-sign/models/template_get_response.rb +++ b/lib/dropbox-sign/models/template_get_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateGetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateGetResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] template Value to be assigned + def template=(template) + if template.nil? + fail ArgumentError, 'template cannot be nil' + end + + @template = template + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_list_response.rb b/lib/dropbox-sign/models/template_list_response.rb index 9b7025c..aea5a64 100644 --- a/lib/dropbox-sign/models/template_list_response.rb +++ b/lib/dropbox-sign/models/template_list_response.rb @@ -6,7 +6,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 @@ -38,9 +38,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -91,9 +96,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateListResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateListResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -138,6 +144,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] templates Value to be assigned + def templates=(templates) + if templates.nil? + fail ArgumentError, 'templates cannot be nil' + end + + @templates = templates + end + + # Custom attribute writer method with validation + # @param [Object] list_info Value to be assigned + def list_info=(list_info) + if list_info.nil? + fail ArgumentError, 'list_info cannot be nil' + end + + @list_info = list_info + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_remove_user_request.rb b/lib/dropbox-sign/models/template_remove_user_request.rb index 88a35a5..3a93e27 100644 --- a/lib/dropbox-sign/models/template_remove_user_request.rb +++ b/lib/dropbox-sign/models/template_remove_user_request.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateRemoveUserRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateRemoveUserRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_response.rb b/lib/dropbox-sign/models/template_response.rb index 1d59bdf..fdf9446 100644 --- a/lib/dropbox-sign/models/template_response.rb +++ b/lib/dropbox-sign/models/template_response.rb @@ -6,7 +6,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 @@ -105,9 +105,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -174,9 +179,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_response_account.rb b/lib/dropbox-sign/models/template_response_account.rb index c401203..9bdf49e 100644 --- a/lib/dropbox-sign/models/template_response_account.rb +++ b/lib/dropbox-sign/models/template_response_account.rb @@ -6,7 +6,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 @@ -53,9 +53,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -109,9 +114,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseAccount`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseAccount`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_response_account_quota.rb b/lib/dropbox-sign/models/template_response_account_quota.rb index 4e46afa..d8631da 100644 --- a/lib/dropbox-sign/models/template_response_account_quota.rb +++ b/lib/dropbox-sign/models/template_response_account_quota.rb @@ -6,7 +6,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 @@ -45,9 +45,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -99,9 +104,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseAccountQuota`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseAccountQuota`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_response_cc_role.rb b/lib/dropbox-sign/models/template_response_cc_role.rb index 7b73e8d..a5cf632 100644 --- a/lib/dropbox-sign/models/template_response_cc_role.rb +++ b/lib/dropbox-sign/models/template_response_cc_role.rb @@ -6,7 +6,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 @@ -29,9 +29,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -80,9 +85,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseCCRole`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseCCRole`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_response_document.rb b/lib/dropbox-sign/models/template_response_document.rb index 49eaf4f..2c0f02d 100644 --- a/lib/dropbox-sign/models/template_response_document.rb +++ b/lib/dropbox-sign/models/template_response_document.rb @@ -6,7 +6,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 @@ -54,9 +54,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -110,9 +115,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocument`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocument`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_response_document_custom_field_base.rb b/lib/dropbox-sign/models/template_response_document_custom_field_base.rb index a80739b..6ad8697 100644 --- a/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +++ b/lib/dropbox-sign/models/template_response_document_custom_field_base.rb @@ -6,7 +6,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 @@ -74,9 +74,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -144,9 +149,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentCustomFieldBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentCustomFieldBase`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -210,6 +216,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb b/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb index 7379fc4..0f4f340 100644 --- a/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +++ b/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentCustomFieldCheckbox`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentCustomFieldCheckbox`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_custom_field_text.rb b/lib/dropbox-sign/models/template_response_document_custom_field_text.rb index 653b131..7799d71 100644 --- a/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +++ b/lib/dropbox-sign/models/template_response_document_custom_field_text.rb @@ -6,7 +6,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 @@ -49,9 +49,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -104,9 +109,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentCustomFieldText`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentCustomFieldText`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -155,6 +161,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_field_group.rb b/lib/dropbox-sign/models/template_response_document_field_group.rb index ce2389e..c879c28 100644 --- a/lib/dropbox-sign/models/template_response_document_field_group.rb +++ b/lib/dropbox-sign/models/template_response_document_field_group.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFieldGroup`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFieldGroup`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_response_document_field_group_rule.rb b/lib/dropbox-sign/models/template_response_document_field_group_rule.rb index 5b0d3ec..e80370f 100644 --- a/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +++ b/lib/dropbox-sign/models/template_response_document_field_group_rule.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFieldGroupRule`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFieldGroupRule`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_response_document_form_field_base.rb b/lib/dropbox-sign/models/template_response_document_form_field_base.rb index bc91770..4676fd1 100644 --- a/lib/dropbox-sign/models/template_response_document_form_field_base.rb +++ b/lib/dropbox-sign/models/template_response_document_form_field_base.rb @@ -6,7 +6,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 @@ -69,9 +69,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -154,9 +159,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldBase`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -216,6 +222,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb b/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb index a4c759c..628758f 100644 --- a/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +++ b/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -88,9 +93,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldCheckbox`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldCheckbox`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -127,6 +133,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb b/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb index f20f04c..2687000 100644 --- a/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +++ b/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -88,9 +93,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldDateSigned`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldDateSigned`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -127,6 +133,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb b/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb index c6ad1b3..3d6e664 100644 --- a/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +++ b/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -88,9 +93,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldDropdown`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldDropdown`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -127,6 +133,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb b/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb index f2f8631..579494f 100644 --- a/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +++ b/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb @@ -6,7 +6,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 @@ -54,9 +54,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -111,9 +116,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldHyperlink`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldHyperlink`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -166,6 +172,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_form_field_initials.rb b/lib/dropbox-sign/models/template_response_document_form_field_initials.rb index 3ff48a7..9611552 100644 --- a/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +++ b/lib/dropbox-sign/models/template_response_document_form_field_initials.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -88,9 +93,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldInitials`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldInitials`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -127,6 +133,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_form_field_radio.rb b/lib/dropbox-sign/models/template_response_document_form_field_radio.rb index 6af0b07..6e99534 100644 --- a/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +++ b/lib/dropbox-sign/models/template_response_document_form_field_radio.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldRadio`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldRadio`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -131,6 +137,26 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + + # Custom attribute writer method with validation + # @param [Object] group Value to be assigned + def group=(group) + if group.nil? + fail ArgumentError, 'group cannot be nil' + end + + @group = group + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_form_field_signature.rb b/lib/dropbox-sign/models/template_response_document_form_field_signature.rb index c48d157..dcfed47 100644 --- a/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +++ b/lib/dropbox-sign/models/template_response_document_form_field_signature.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -88,9 +93,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldSignature`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldSignature`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -127,6 +133,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_form_field_text.rb b/lib/dropbox-sign/models/template_response_document_form_field_text.rb index 51ed8bc..7028169 100644 --- a/lib/dropbox-sign/models/template_response_document_form_field_text.rb +++ b/lib/dropbox-sign/models/template_response_document_form_field_text.rb @@ -6,7 +6,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 @@ -81,9 +81,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -140,9 +145,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldText`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldText`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -201,6 +207,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Custom attribute writer method checking allowed values (enum). # @param [Object] validation_type Object to be assigned def validation_type=(validation_type) diff --git a/lib/dropbox-sign/models/template_response_document_static_field_base.rb b/lib/dropbox-sign/models/template_response_document_static_field_base.rb index a2d9622..89606c7 100644 --- a/lib/dropbox-sign/models/template_response_document_static_field_base.rb +++ b/lib/dropbox-sign/models/template_response_document_static_field_base.rb @@ -6,7 +6,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 @@ -74,9 +74,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -161,9 +166,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldBase`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -229,6 +235,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb b/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb index 741e8b7..e27917f 100644 --- a/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +++ b/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldCheckbox`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldCheckbox`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb b/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb index 9c02d01..574e052 100644 --- a/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +++ b/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldDateSigned`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldDateSigned`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb b/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb index e1fb958..7c14f58 100644 --- a/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +++ b/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldDropdown`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldDropdown`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb b/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb index 9e82dc9..ccb1727 100644 --- a/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +++ b/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldHyperlink`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldHyperlink`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_static_field_initials.rb b/lib/dropbox-sign/models/template_response_document_static_field_initials.rb index 77be2c3..47d8b72 100644 --- a/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +++ b/lib/dropbox-sign/models/template_response_document_static_field_initials.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldInitials`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldInitials`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_static_field_radio.rb b/lib/dropbox-sign/models/template_response_document_static_field_radio.rb index 501ad89..b829905 100644 --- a/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +++ b/lib/dropbox-sign/models/template_response_document_static_field_radio.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldRadio`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldRadio`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_static_field_signature.rb b/lib/dropbox-sign/models/template_response_document_static_field_signature.rb index c3ff4ac..91c0192 100644 --- a/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +++ b/lib/dropbox-sign/models/template_response_document_static_field_signature.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldSignature`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldSignature`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_document_static_field_text.rb b/lib/dropbox-sign/models/template_response_document_static_field_text.rb index 0cf46c5..37612d6 100644 --- a/lib/dropbox-sign/models/template_response_document_static_field_text.rb +++ b/lib/dropbox-sign/models/template_response_document_static_field_text.rb @@ -6,7 +6,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 @@ -30,9 +30,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about, including the ones defined in its parent(s) + def self.acceptable_attribute_map + superclass.acceptable_attribute_map.merge(attribute_map) + end + # Returns all the JSON keys this model knows about, including the ones defined in its parent(s) def self.acceptable_attributes - attribute_map.values.concat(superclass.acceptable_attributes) + acceptable_attribute_map.values end # Attribute type mapping. @@ -81,9 +86,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldText`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldText`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -116,6 +122,16 @@ def valid? true && super end + # Custom attribute writer method with validation + # @param [Object] type Value to be assigned + def type=(type) + if type.nil? + fail ArgumentError, 'type cannot be nil' + end + + @type = type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_response_field_avg_text_length.rb b/lib/dropbox-sign/models/template_response_field_avg_text_length.rb index a85e2c3..aceaff4 100644 --- a/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +++ b/lib/dropbox-sign/models/template_response_field_avg_text_length.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseFieldAvgTextLength`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseFieldAvgTextLength`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_response_signer_role.rb b/lib/dropbox-sign/models/template_response_signer_role.rb index 2866072..a2263db 100644 --- a/lib/dropbox-sign/models/template_response_signer_role.rb +++ b/lib/dropbox-sign/models/template_response_signer_role.rb @@ -6,7 +6,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 @@ -34,9 +34,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -86,9 +91,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseSignerRole`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseSignerRole`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_update_files_request.rb b/lib/dropbox-sign/models/template_update_files_request.rb index 1e26f24..e9d5610 100644 --- a/lib/dropbox-sign/models/template_update_files_request.rb +++ b/lib/dropbox-sign/models/template_update_files_request.rb @@ -6,7 +6,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 @@ -54,9 +54,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -110,9 +115,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateUpdateFilesRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateUpdateFilesRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/template_update_files_response.rb b/lib/dropbox-sign/models/template_update_files_response.rb index 290c3ae..15c51df 100644 --- a/lib/dropbox-sign/models/template_update_files_response.rb +++ b/lib/dropbox-sign/models/template_update_files_response.rb @@ -6,7 +6,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 @@ -28,9 +28,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -79,9 +84,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateUpdateFilesResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateUpdateFilesResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -109,6 +115,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] template Value to be assigned + def template=(template) + if template.nil? + fail ArgumentError, 'template cannot be nil' + end + + @template = template + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/template_update_files_response_template.rb b/lib/dropbox-sign/models/template_update_files_response_template.rb index 97280f3..5d3ab09 100644 --- a/lib/dropbox-sign/models/template_update_files_response_template.rb +++ b/lib/dropbox-sign/models/template_update_files_response_template.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateUpdateFilesResponseTemplate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateUpdateFilesResponseTemplate`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb b/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb index 53ae4fb..210aae8 100644 --- a/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +++ b/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb @@ -6,7 +6,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 @@ -224,9 +224,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -311,9 +316,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -548,6 +554,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] client_id Value to be assigned + def client_id=(client_id) + if client_id.nil? + fail ArgumentError, 'client_id cannot be nil' + end + + @client_id = client_id + end + + # Custom attribute writer method with validation + # @param [Object] requester_email_address Value to be assigned + def requester_email_address=(requester_email_address) + if requester_email_address.nil? + fail ArgumentError, 'requester_email_address cannot be nil' + end + + @requester_email_address = requester_email_address + end + # Custom attribute writer method with validation # @param [Object] message Value to be assigned def message=(message) diff --git a/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb b/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb index 770b649..339107b 100644 --- a/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +++ b/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb @@ -6,7 +6,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 @@ -171,9 +171,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -251,9 +256,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -462,6 +468,36 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] client_id Value to be assigned + def client_id=(client_id) + if client_id.nil? + fail ArgumentError, 'client_id cannot be nil' + end + + @client_id = client_id + end + + # Custom attribute writer method with validation + # @param [Object] requester_email_address Value to be assigned + def requester_email_address=(requester_email_address) + if requester_email_address.nil? + fail ArgumentError, 'requester_email_address cannot be nil' + end + + @requester_email_address = requester_email_address + end + + # Custom attribute writer method with validation + # @param [Object] template_ids Value to be assigned + def template_ids=(template_ids) + if template_ids.nil? + fail ArgumentError, 'template_ids cannot be nil' + end + + @template_ids = template_ids + end + # Custom attribute writer method with validation # @param [Object] message Value to be assigned def message=(message) diff --git a/lib/dropbox-sign/models/unclaimed_draft_create_request.rb b/lib/dropbox-sign/models/unclaimed_draft_create_request.rb index b39bab7..3aa8412 100644 --- a/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +++ b/lib/dropbox-sign/models/unclaimed_draft_create_request.rb @@ -6,7 +6,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 @@ -165,9 +165,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -240,9 +245,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/unclaimed_draft_create_response.rb b/lib/dropbox-sign/models/unclaimed_draft_create_response.rb index 7b93bed..d72c78f 100644 --- a/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +++ b/lib/dropbox-sign/models/unclaimed_draft_create_response.rb @@ -6,7 +6,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 @@ -33,9 +33,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -85,9 +90,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftCreateResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftCreateResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -121,6 +127,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] unclaimed_draft Value to be assigned + def unclaimed_draft=(unclaimed_draft) + if unclaimed_draft.nil? + fail ArgumentError, 'unclaimed_draft cannot be nil' + end + + @unclaimed_draft = unclaimed_draft + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb b/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb index 30efe7d..1ed535c 100644 --- a/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +++ b/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb @@ -6,7 +6,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 @@ -63,9 +63,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -121,9 +126,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftEditAndResendRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftEditAndResendRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -183,6 +189,16 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] client_id Value to be assigned + def client_id=(client_id) + if client_id.nil? + fail ArgumentError, 'client_id cannot be nil' + end + + @client_id = client_id + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/models/unclaimed_draft_response.rb b/lib/dropbox-sign/models/unclaimed_draft_response.rb index b777dac..f393e20 100644 --- a/lib/dropbox-sign/models/unclaimed_draft_response.rb +++ b/lib/dropbox-sign/models/unclaimed_draft_response.rb @@ -6,7 +6,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 @@ -55,9 +55,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -115,9 +120,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } diff --git a/lib/dropbox-sign/models/warning_response.rb b/lib/dropbox-sign/models/warning_response.rb index efe4d77..32042a9 100644 --- a/lib/dropbox-sign/models/warning_response.rb +++ b/lib/dropbox-sign/models/warning_response.rb @@ -6,7 +6,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 @@ -35,9 +35,14 @@ def self.attribute_map } end + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + # Returns all the JSON keys this model knows about def self.acceptable_attributes - attribute_map.values + acceptable_attribute_map.values end # Attribute type mapping. @@ -87,9 +92,10 @@ def initialize(attributes = {}) end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.merged_attributes.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::WarningResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::WarningResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -126,6 +132,26 @@ def valid? true end + # Custom attribute writer method with validation + # @param [Object] warning_msg Value to be assigned + def warning_msg=(warning_msg) + if warning_msg.nil? + fail ArgumentError, 'warning_msg cannot be nil' + end + + @warning_msg = warning_msg + end + + # Custom attribute writer method with validation + # @param [Object] warning_name Value to be assigned + def warning_name=(warning_name) + if warning_name.nil? + fail ArgumentError, 'warning_name cannot be nil' + end + + @warning_name = warning_name + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/lib/dropbox-sign/version.rb b/lib/dropbox-sign/version.rb index c2465b4..bb40a10 100644 --- a/lib/dropbox-sign/version.rb +++ b/lib/dropbox-sign/version.rb @@ -6,7 +6,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 @@ -14,5 +14,5 @@ module Dropbox end module Dropbox::Sign - VERSION = '1.8.0' + VERSION = '1.9.0' end diff --git a/openapi-config.yaml b/openapi-config.yaml index 310aec9..84f8f50 100644 --- a/openapi-config.yaml +++ b/openapi-config.yaml @@ -9,13 +9,16 @@ additionalProperties: gemName: dropbox-sign gemRequiredRubyVersion: '>= 2.7' moduleName: "Dropbox::Sign" - gemVersion: 1.8.0 + gemVersion: 1.9.0 sortModelPropertiesByRequiredFlag: true legacyDiscriminatorBehavior: true gitUserId: hellosign gitRepoId: dropbox-sign-ruby useCustomTemplateCode: true licenseCopyrightYear: 2024 + oseg.printApiCallProperty: true + oseg.security.api_key.username: YOUR_API_KEY + oseg.security.oauth2.access_token: YOUR_ACCESS_TOKEN files: dropbox-event_callback_helper.mustache: templateType: SupportingFiles diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 608b57d..c832450 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -27,12 +27,12 @@ paths: schema: $ref: '#/components/schemas/AccountCreateRequest' examples: - default_example: - $ref: '#/components/examples/AccountCreateRequestDefaultExample' - oauth: - $ref: '#/components/examples/AccountCreateRequestOAuthExample' + example: + $ref: '#/components/examples/AccountCreateRequest' + oauth_example: + $ref: '#/components/examples/AccountCreateRequestOAuth' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -46,11 +46,11 @@ paths: schema: $ref: '#/components/schemas/AccountCreateResponse' examples: - default_example: - $ref: '#/components/examples/AccountCreateResponseExample' - oauth: - $ref: '#/components/examples/AccountCreateOAuthResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountCreateResponse' + oauth_example: + $ref: '#/components/examples/AccountCreateOAuthResponse' + '4XX': description: failed_operation content: application/json: @@ -58,15 +58,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -78,42 +78,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountCreate.php + $ref: examples/AccountCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountCreate.js + $ref: examples/AccountCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountCreate.ts + $ref: examples/AccountCreateExample.ts - lang: Java label: Java source: - $ref: examples/AccountCreate.java + $ref: examples/AccountCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountCreate.rb + $ref: examples/AccountCreateExample.rb - lang: Python label: Python source: - $ref: examples/AccountCreate.py + $ref: examples/AccountCreateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountCreate.sh + $ref: examples/AccountCreateExample.sh x-meta: seo: title: 'Create Account | API Documentation | Dropbox Sign for Developers' @@ -147,7 +142,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -161,9 +156,9 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountGetResponse' + '4XX': description: failed_operation content: application/json: @@ -171,15 +166,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -192,42 +187,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountGet.php + $ref: examples/AccountGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountGet.js + $ref: examples/AccountGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountGet.ts + $ref: examples/AccountGetExample.ts - lang: Java label: Java source: - $ref: examples/AccountGet.java + $ref: examples/AccountGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountGet.rb + $ref: examples/AccountGetExample.rb - lang: Python label: Python source: - $ref: examples/AccountGet.py + $ref: examples/AccountGetExample.py - lang: cURL label: cURL source: - $ref: examples/AccountGet.sh + $ref: examples/AccountGetExample.sh x-meta: seo: title: 'Get Account | API Documentation | Dropbox Sign for Developers' @@ -245,10 +235,10 @@ paths: schema: $ref: '#/components/schemas/AccountUpdateRequest' examples: - default_example: - $ref: '#/components/examples/AccountUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/AccountUpdateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -262,9 +252,9 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -272,17 +262,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -294,42 +284,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountUpdate.php + $ref: examples/AccountUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountUpdate.js + $ref: examples/AccountUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountUpdate.ts + $ref: examples/AccountUpdateExample.ts - lang: Java label: Java source: - $ref: examples/AccountUpdate.java + $ref: examples/AccountUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountUpdate.rb + $ref: examples/AccountUpdateExample.rb - lang: Python label: Python source: - $ref: examples/AccountUpdate.py + $ref: examples/AccountUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountUpdate.sh + $ref: examples/AccountUpdateExample.sh x-meta: seo: title: 'Update Account | API Documentation | Dropbox Sign for Developers' @@ -348,10 +333,10 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyRequest' examples: - default_example: - $ref: '#/components/examples/AccountVerifyRequestDefaultExample' + example: + $ref: '#/components/examples/AccountVerifyRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -365,11 +350,11 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyResponse' examples: - default_example: - $ref: '#/components/examples/AccountVerifyFoundResponseExample' - not_found: - $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountVerifyFoundResponse' + not_found_example: + $ref: '#/components/examples/AccountVerifyNotFoundResponse' + '4XX': description: failed_operation content: application/json: @@ -377,15 +362,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -397,42 +382,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountVerify.php + $ref: examples/AccountVerifyExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountVerify.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountVerify.js + $ref: examples/AccountVerifyExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountVerify.ts + $ref: examples/AccountVerifyExample.ts - lang: Java label: Java source: - $ref: examples/AccountVerify.java + $ref: examples/AccountVerifyExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountVerify.rb + $ref: examples/AccountVerifyExample.rb - lang: Python label: Python source: - $ref: examples/AccountVerify.py + $ref: examples/AccountVerifyExample.py - lang: cURL label: cURL source: - $ref: examples/AccountVerify.sh + $ref: examples/AccountVerifyExample.sh x-meta: seo: title: 'Verify Account | API Documentation | Dropbox Sign for Developers' @@ -451,13 +431,13 @@ paths: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppCreateRequest' responses: - 201: + '201': description: 'successful operation' headers: X-RateLimit-Limit: @@ -471,9 +451,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -481,17 +461,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -503,42 +483,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppCreate.php + $ref: examples/ApiAppCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppCreate.js + $ref: examples/ApiAppCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppCreate.ts + $ref: examples/ApiAppCreateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppCreate.java + $ref: examples/ApiAppCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppCreate.rb + $ref: examples/ApiAppCreateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppCreate.py + $ref: examples/ApiAppCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppCreate.sh + $ref: examples/ApiAppCreateExample.sh x-meta: seo: title: 'Create API App | API Documentation | Dropbox Sign for Developers' @@ -560,7 +535,7 @@ paths: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -574,9 +549,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppGetResponse' + '4XX': description: failed_operation content: application/json: @@ -584,19 +559,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -608,42 +583,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppGet.php + $ref: examples/ApiAppGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppGet.js + $ref: examples/ApiAppGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppGet.ts + $ref: examples/ApiAppGetExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppGet.java + $ref: examples/ApiAppGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppGet.rb + $ref: examples/ApiAppGetExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppGet.py + $ref: examples/ApiAppGetExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppGet.sh + $ref: examples/ApiAppGetExample.sh x-meta: seo: title: 'Get API App | API Documentation | Dropbox Sign for Developers' @@ -670,13 +640,13 @@ paths: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -690,9 +660,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -700,19 +670,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -724,42 +694,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppUpdate.php + $ref: examples/ApiAppUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppUpdate.js + $ref: examples/ApiAppUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppUpdate.ts + $ref: examples/ApiAppUpdateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppUpdate.java + $ref: examples/ApiAppUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppUpdate.rb + $ref: examples/ApiAppUpdateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppUpdate.py + $ref: examples/ApiAppUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppUpdate.sh + $ref: examples/ApiAppUpdateExample.sh x-meta: seo: title: 'Update API App | API Documentation | Dropbox Sign for Developers' @@ -780,7 +745,7 @@ paths: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: - 204: + '204': description: 'successful operation' headers: X-RateLimit-Limit: @@ -789,7 +754,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -797,17 +762,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -819,42 +784,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppDelete.php + $ref: examples/ApiAppDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppDelete.js + $ref: examples/ApiAppDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppDelete.ts + $ref: examples/ApiAppDeleteExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppDelete.java + $ref: examples/ApiAppDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppDelete.rb + $ref: examples/ApiAppDeleteExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppDelete.py + $ref: examples/ApiAppDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppDelete.sh + $ref: examples/ApiAppDeleteExample.sh x-meta: seo: title: 'Delete API App | API Documentation | Dropbox Sign for Developers' @@ -882,7 +842,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -896,9 +856,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppListResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppListResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppListResponse' + '4XX': description: failed_operation content: application/json: @@ -906,15 +866,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -926,42 +886,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppList.php + $ref: examples/ApiAppListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppList.js + $ref: examples/ApiAppListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppList.ts + $ref: examples/ApiAppListExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppList.java + $ref: examples/ApiAppListExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppList.rb + $ref: examples/ApiAppListExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppList.py + $ref: examples/ApiAppListExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppList.sh + $ref: examples/ApiAppListExample.sh x-meta: seo: title: 'List API Apps | API Documentation | Dropbox Sign for Developers' @@ -997,7 +952,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1011,9 +966,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobGetResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/BulkSendJobGetResponse' + '4XX': description: failed_operation content: application/json: @@ -1021,15 +976,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1042,42 +997,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobGet.php + $ref: examples/BulkSendJobGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobGet.js + $ref: examples/BulkSendJobGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobGet.ts + $ref: examples/BulkSendJobGetExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobGet.java + $ref: examples/BulkSendJobGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobGet.rb + $ref: examples/BulkSendJobGetExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobGet.py + $ref: examples/BulkSendJobGetExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobGet.sh + $ref: examples/BulkSendJobGetExample.sh x-meta: seo: title: 'Get Bulk Send Job | API Documentation | Dropbox Sign for Developers' @@ -1105,7 +1055,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1119,9 +1069,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobListResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobListResponseExample' - 4XX: + example: + $ref: '#/components/examples/BulkSendJobListResponse' + '4XX': description: failed_operation content: application/json: @@ -1129,15 +1079,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1150,42 +1100,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobList.php + $ref: examples/BulkSendJobListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobList.js + $ref: examples/BulkSendJobListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobList.ts + $ref: examples/BulkSendJobListExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobList.java + $ref: examples/BulkSendJobListExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobList.rb + $ref: examples/BulkSendJobListExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobList.py + $ref: examples/BulkSendJobListExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobList.sh + $ref: examples/BulkSendJobListExample.sh x-meta: seo: title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' @@ -1213,10 +1158,10 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlRequest' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1230,9 +1175,9 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlResponseExample' - 4XX: + example: + $ref: '#/components/examples/EmbeddedEditUrlResponse' + '4XX': description: failed_operation content: application/json: @@ -1240,17 +1185,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1262,42 +1207,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedEditUrl.php + $ref: examples/EmbeddedEditUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedEditUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedEditUrl.js + $ref: examples/EmbeddedEditUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedEditUrl.ts + $ref: examples/EmbeddedEditUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedEditUrl.java + $ref: examples/EmbeddedEditUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedEditUrl.rb + $ref: examples/EmbeddedEditUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedEditUrl.py + $ref: examples/EmbeddedEditUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedEditUrl.sh + $ref: examples/EmbeddedEditUrlExample.sh x-meta: seo: title: 'Get Embedded Template URL | iFrame | Dropbox Sign for Developers' @@ -1319,7 +1259,7 @@ paths: type: string example: 50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1333,9 +1273,9 @@ paths: schema: $ref: '#/components/schemas/EmbeddedSignUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedSignUrlResponseExample' - 4XX: + example: + $ref: '#/components/examples/EmbeddedSignUrlResponse' + '4XX': description: failed_operation content: application/json: @@ -1343,21 +1283,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1369,42 +1309,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedSignUrl.php + $ref: examples/EmbeddedSignUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedSignUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedSignUrl.js + $ref: examples/EmbeddedSignUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedSignUrl.ts + $ref: examples/EmbeddedSignUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedSignUrl.java + $ref: examples/EmbeddedSignUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedSignUrl.rb + $ref: examples/EmbeddedSignUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedSignUrl.py + $ref: examples/EmbeddedSignUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedSignUrl.sh + $ref: examples/EmbeddedSignUrlExample.sh x-meta: seo: title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' @@ -1414,7 +1349,7 @@ paths: tags: - Fax summary: 'Get Fax' - description: 'Returns information about fax' + description: 'Returns information about a Fax' operationId: faxGet parameters: - @@ -1426,7 +1361,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1440,9 +1375,9 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxGetResponse' + '4XX': description: failed_operation content: application/json: @@ -1450,19 +1385,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1471,51 +1406,46 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxGet.php + $ref: examples/FaxGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxGet.js + $ref: examples/FaxGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxGet.ts + $ref: examples/FaxGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxGet.java + $ref: examples/FaxGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxGet.rb + $ref: examples/FaxGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxGet.py + $ref: examples/FaxGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxGet.sh + $ref: examples/FaxGetExample.sh x-meta: seo: title: 'Get Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here.' delete: tags: - Fax summary: 'Delete Fax' - description: 'Deletes the specified Fax from the system.' + description: 'Deletes the specified Fax from the system' operationId: faxDelete parameters: - @@ -1527,7 +1457,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 204: + '204': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1536,7 +1466,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1544,19 +1474,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1565,42 +1495,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxDelete.php + $ref: examples/FaxDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxDelete.js + $ref: examples/FaxDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxDelete.ts + $ref: examples/FaxDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxDelete.java + $ref: examples/FaxDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxDelete.rb + $ref: examples/FaxDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxDelete.py + $ref: examples/FaxDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxDelete.sh + $ref: examples/FaxDeleteExample.sh x-meta: seo: title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' @@ -1609,8 +1534,8 @@ paths: get: tags: - Fax - summary: 'List Fax Files' - description: 'Returns list of fax files' + summary: 'Download Fax Files' + description: 'Downloads files associated with a Fax' operationId: faxFiles parameters: - @@ -1622,7 +1547,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1636,7 +1561,7 @@ paths: schema: type: string format: binary - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1644,21 +1569,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1667,46 +1592,41 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxFiles.php + $ref: examples/FaxFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxFiles.js + $ref: examples/FaxFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxFiles.ts + $ref: examples/FaxFilesExample.ts - lang: Java label: Java source: - $ref: examples/FaxFiles.java + $ref: examples/FaxFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxFiles.rb + $ref: examples/FaxFilesExample.rb - lang: Python label: Python source: - $ref: examples/FaxFiles.py + $ref: examples/FaxFilesExample.py - lang: cURL label: cURL source: - $ref: examples/FaxFiles.sh + $ref: examples/FaxFilesExample.sh x-meta: seo: title: 'Fax Files | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here.' /fax_line/add_user: put: tags: @@ -1721,10 +1641,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineAddUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineAddUserRequestExample' + example: + $ref: '#/components/examples/FaxLineAddUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1738,9 +1658,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -1748,17 +1668,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1767,42 +1687,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAddUser.php + $ref: examples/FaxLineAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAddUser.js + $ref: examples/FaxLineAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAddUser.ts + $ref: examples/FaxLineAddUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAddUser.java + $ref: examples/FaxLineAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAddUser.rb + $ref: examples/FaxLineAddUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAddUser.py + $ref: examples/FaxLineAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAddUser.sh + $ref: examples/FaxLineAddUserExample.sh x-meta: seo: title: 'Fax Line Add User | API Documentation | Dropbox Fax for Developers' @@ -1812,13 +1727,13 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/provice and city.' + description: 'Returns a list of available area codes for a given state/province and city' operationId: faxLineAreaCodeGet parameters: - name: country in: query - description: 'Filter area codes by country.' + description: 'Filter area codes by country' required: true schema: type: string @@ -1826,10 +1741,11 @@ paths: - CA - US - UK + example: US - name: state in: query - description: 'Filter area codes by state.' + description: 'Filter area codes by state' schema: type: string enum: @@ -1887,7 +1803,7 @@ paths: - name: province in: query - description: 'Filter area codes by province.' + description: 'Filter area codes by province' schema: type: string enum: @@ -1907,11 +1823,11 @@ paths: - name: city in: query - description: 'Filter area codes by city.' + description: 'Filter area codes by city' schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1925,9 +1841,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineAreaCodeGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineAreaCodeGetResponse' + '4XX': description: failed_operation content: application/json: @@ -1935,15 +1851,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1952,52 +1868,47 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAreaCodeGet.php + $ref: examples/FaxLineAreaCodeGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAreaCodeGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAreaCodeGet.js + $ref: examples/FaxLineAreaCodeGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAreaCodeGet.ts + $ref: examples/FaxLineAreaCodeGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAreaCodeGet.java + $ref: examples/FaxLineAreaCodeGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAreaCodeGet.rb + $ref: examples/FaxLineAreaCodeGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAreaCodeGet.py + $ref: examples/FaxLineAreaCodeGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAreaCodeGet.sh + $ref: examples/FaxLineAreaCodeGetExample.sh x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.' /fax_line/create: post: tags: - 'Fax Line' summary: 'Purchase Fax Line' - description: 'Purchases a new Fax Line.' + description: 'Purchases a new Fax Line' operationId: faxLineCreate requestBody: required: true @@ -2006,10 +1917,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineCreateRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineCreateRequestExample' + example: + $ref: '#/components/examples/FaxLineCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2023,9 +1934,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -2033,17 +1944,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2052,42 +1963,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineCreate.php + $ref: examples/FaxLineCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineCreate.js + $ref: examples/FaxLineCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineCreate.ts + $ref: examples/FaxLineCreateExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineCreate.java + $ref: examples/FaxLineCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineCreate.rb + $ref: examples/FaxLineCreateExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineCreate.py + $ref: examples/FaxLineCreateExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineCreate.sh + $ref: examples/FaxLineCreateExample.sh x-meta: seo: title: 'Purchase Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2103,12 +2009,13 @@ paths: - name: number in: query - description: 'The Fax Line number.' + description: 'The Fax Line number' required: true schema: type: string + example: 123-123-1234 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2122,9 +2029,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -2132,17 +2039,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2151,46 +2058,41 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineGet.php + $ref: examples/FaxLineGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineGet.js + $ref: examples/FaxLineGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineGet.ts + $ref: examples/FaxLineGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineGet.java + $ref: examples/FaxLineGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineGet.rb + $ref: examples/FaxLineGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineGet.py + $ref: examples/FaxLineGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineGet.sh + $ref: examples/FaxLineGetExample.sh x-meta: seo: title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.' delete: tags: - 'Fax Line' @@ -2204,10 +2106,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineDeleteRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineDeleteRequestExample' + example: + $ref: '#/components/examples/FaxLineDeleteRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2218,7 +2120,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2226,17 +2128,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2245,42 +2147,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineDelete.php + $ref: examples/FaxLineDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineDelete.js + $ref: examples/FaxLineDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineDelete.ts + $ref: examples/FaxLineDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineDelete.java + $ref: examples/FaxLineDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineDelete.rb + $ref: examples/FaxLineDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineDelete.py + $ref: examples/FaxLineDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineDelete.sh + $ref: examples/FaxLineDeleteExample.sh x-meta: seo: title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2299,31 +2196,31 @@ paths: description: 'Account ID' schema: type: string - example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 - name: page in: query - description: Page + description: 'Which page number of the Fax Line List to return. Defaults to `1`.' schema: type: integer default: 1 - example: 1 + example: 1 - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 - example: 20 + example: 20 - name: show_team_lines in: query - description: 'Show team lines' + description: 'Include Fax Lines belonging to team members in the list' schema: type: boolean responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2337,9 +2234,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineListResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineListResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineListResponse' + '4XX': description: failed_operation content: application/json: @@ -2347,15 +2244,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2364,42 +2261,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineList.php + $ref: examples/FaxLineListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineList.js + $ref: examples/FaxLineListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineList.ts + $ref: examples/FaxLineListExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineList.java + $ref: examples/FaxLineListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineList.rb + $ref: examples/FaxLineListExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineList.py + $ref: examples/FaxLineListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineList.sh + $ref: examples/FaxLineListExample.sh x-meta: seo: title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers' @@ -2409,7 +2301,7 @@ paths: tags: - 'Fax Line' summary: 'Remove Fax Line Access' - description: 'Removes a user''s access to the specified Fax Line.' + description: 'Removes a user''s access to the specified Fax Line' operationId: faxLineRemoveUser requestBody: required: true @@ -2418,10 +2310,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineRemoveUserRequestExample' + example: + $ref: '#/components/examples/FaxLineRemoveUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2435,9 +2327,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -2445,17 +2337,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2464,42 +2356,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineRemoveUser.php + $ref: examples/FaxLineRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineRemoveUser.js + $ref: examples/FaxLineRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineRemoveUser.ts + $ref: examples/FaxLineRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineRemoveUser.java + $ref: examples/FaxLineRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineRemoveUser.rb + $ref: examples/FaxLineRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineRemoveUser.py + $ref: examples/FaxLineRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineRemoveUser.sh + $ref: examples/FaxLineRemoveUserExample.sh x-meta: seo: title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' @@ -2509,13 +2396,13 @@ paths: tags: - Fax summary: 'Lists Faxes' - description: 'Returns properties of multiple faxes' + description: 'Returns properties of multiple Faxes' operationId: faxList parameters: - name: page in: query - description: Page + description: 'Which page number of the Fax List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2524,7 +2411,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2532,7 +2419,7 @@ paths: minimum: 1 example: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2546,9 +2433,9 @@ paths: schema: $ref: '#/components/schemas/FaxListResponse' examples: - default_example: - $ref: '#/components/examples/FaxListResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxListResponse' + '4XX': description: failed_operation content: application/json: @@ -2556,15 +2443,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2573,42 +2460,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxList.php + $ref: examples/FaxListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxList.js + $ref: examples/FaxListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxList.ts + $ref: examples/FaxListExample.ts - lang: Java label: Java source: - $ref: examples/FaxList.java + $ref: examples/FaxListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxList.rb + $ref: examples/FaxListExample.rb - lang: Python label: Python source: - $ref: examples/FaxList.py + $ref: examples/FaxListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxList.sh + $ref: examples/FaxListExample.sh x-meta: seo: title: 'List Faxes | API Documentation | Dropbox Fax for Developers' @@ -2618,7 +2500,7 @@ paths: tags: - Fax summary: 'Send Fax' - description: 'Action to prepare and send a fax' + description: 'Creates and sends a new Fax with the submitted file(s)' operationId: faxSend requestBody: required: true @@ -2627,13 +2509,13 @@ paths: schema: $ref: '#/components/schemas/FaxSendRequest' examples: - default_example: - $ref: '#/components/examples/FaxSendRequestExample' + example: + $ref: '#/components/examples/FaxSendRequest' multipart/form-data: schema: $ref: '#/components/schemas/FaxSendRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2647,9 +2529,9 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxGetResponse' + '4XX': description: failed_operation content: application/json: @@ -2657,19 +2539,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2678,45 +2560,40 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxSend.php + $ref: examples/FaxSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxSend.js + $ref: examples/FaxSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxSend.ts + $ref: examples/FaxSendExample.ts - lang: Java label: Java source: - $ref: examples/FaxSend.java + $ref: examples/FaxSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxSend.rb + $ref: examples/FaxSendExample.rb - lang: Python label: Python source: - $ref: examples/FaxSend.py + $ref: examples/FaxSendExample.py - lang: cURL label: cURL source: - $ref: examples/FaxSend.sh + $ref: examples/FaxSendExample.sh x-meta: seo: - title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + title: 'Send Fax | API Documentation | Dropbox Fax for Developers' description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' /oauth/token: post: @@ -2732,10 +2609,10 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenGenerateRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateRequestExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2749,9 +2626,9 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateResponseExample' - 4XX: + example: + $ref: '#/components/examples/OAuthTokenGenerateResponse' + '4XX': description: failed_operation content: application/json: @@ -2759,15 +2636,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2777,42 +2654,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenGenerate.php + $ref: examples/OauthTokenGenerateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenGenerate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenGenerate.js + $ref: examples/OauthTokenGenerateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenGenerate.ts + $ref: examples/OauthTokenGenerateExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenGenerate.java + $ref: examples/OauthTokenGenerateExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenGenerate.rb + $ref: examples/OauthTokenGenerateExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenGenerate.py + $ref: examples/OauthTokenGenerateExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenGenerate.sh + $ref: examples/OauthTokenGenerateExample.sh x-meta: seo: title: 'Generate OAuth Token | Documentation | Dropbox Sign for Developers' @@ -2832,10 +2704,10 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenRefreshRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshRequestExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2849,9 +2721,9 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshResponseExample' - 4XX: + example: + $ref: '#/components/examples/OAuthTokenRefreshResponse' + '4XX': description: failed_operation content: application/json: @@ -2859,15 +2731,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2877,42 +2749,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenRefresh.php + $ref: examples/OauthTokenRefreshExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenRefresh.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenRefresh.js + $ref: examples/OauthTokenRefreshExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenRefresh.ts + $ref: examples/OauthTokenRefreshExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenRefresh.java + $ref: examples/OauthTokenRefreshExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenRefresh.rb + $ref: examples/OauthTokenRefreshExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenRefresh.py + $ref: examples/OauthTokenRefreshExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenRefresh.sh + $ref: examples/OauthTokenRefreshExample.sh x-meta: seo: title: 'OAuth Token Refresh | Documentation | Dropbox Sign for Developers' @@ -2935,10 +2802,10 @@ paths: schema: $ref: '#/components/schemas/ReportCreateRequest' examples: - default_example: - $ref: '#/components/examples/ReportCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ReportCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2952,9 +2819,9 @@ paths: schema: $ref: '#/components/schemas/ReportCreateResponse' examples: - default_example: - $ref: '#/components/examples/ReportCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/ReportCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -2962,15 +2829,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2979,42 +2846,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ReportCreate.php + $ref: examples/ReportCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ReportCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ReportCreate.js + $ref: examples/ReportCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ReportCreate.ts + $ref: examples/ReportCreateExample.ts - lang: Java label: Java source: - $ref: examples/ReportCreate.java + $ref: examples/ReportCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ReportCreate.rb + $ref: examples/ReportCreateExample.rb - lang: Python label: Python source: - $ref: examples/ReportCreate.py + $ref: examples/ReportCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ReportCreate.sh + $ref: examples/ReportCreateExample.sh x-meta: seo: title: 'Create Report | API Documentation | Dropbox Sign for Developers' @@ -3036,13 +2898,13 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3056,9 +2918,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3066,21 +2928,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3089,42 +2951,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Embedded Bulk Send with Template | Dropbox Sign for Developers' @@ -3146,13 +3003,13 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3166,9 +3023,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3176,17 +3033,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3199,42 +3056,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkSendWithTemplate.php + $ref: examples/SignatureRequestBulkSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkSendWithTemplate.js + $ref: examples/SignatureRequestBulkSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkSendWithTemplate.ts + $ref: examples/SignatureRequestBulkSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkSendWithTemplate.java + $ref: examples/SignatureRequestBulkSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkSendWithTemplate.rb + $ref: examples/SignatureRequestBulkSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkSendWithTemplate.py + $ref: examples/SignatureRequestBulkSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkSendWithTemplate.sh + $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh x-meta: seo: title: 'Bulk Send with Template | REST API | Dropbox Sign for Developers' @@ -3265,7 +3117,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3276,7 +3128,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3284,21 +3136,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3311,42 +3163,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCancel.php + $ref: examples/SignatureRequestCancelExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCancel.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCancel.js + $ref: examples/SignatureRequestCancelExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCancel.ts + $ref: examples/SignatureRequestCancelExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCancel.java + $ref: examples/SignatureRequestCancelExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCancel.rb + $ref: examples/SignatureRequestCancelExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCancel.py + $ref: examples/SignatureRequestCancelExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCancel.sh + $ref: examples/SignatureRequestCancelExample.sh x-meta: seo: title: 'Cancel Incomplete Signature Request | Dropbox Sign for Developers' @@ -3365,15 +3212,15 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3387,9 +3234,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' + '4XX': description: failed_operation content: application/json: @@ -3397,19 +3244,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3421,42 +3268,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbedded.php + $ref: examples/SignatureRequestCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbedded.js + $ref: examples/SignatureRequestCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbedded.ts + $ref: examples/SignatureRequestCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbedded.java + $ref: examples/SignatureRequestCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbedded.rb + $ref: examples/SignatureRequestCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbedded.py + $ref: examples/SignatureRequestCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbedded.sh + $ref: examples/SignatureRequestCreateEmbeddedExample.sh x-meta: seo: title: 'Create Embedded Signature Request | Dropbox Sign for Developers' @@ -3475,13 +3317,13 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3495,9 +3337,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3505,19 +3347,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3529,77 +3371,76 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Signature Request with Template | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here.' - '/signature_request/files/{signature_request_id}': - get: + '/signature_request/edit/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files' + summary: 'Edit Signature Request' description: |- - Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. + Edits and sends a SignatureRequest with the submitted documents. 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. - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFiles + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEdit parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - - name: file_type - in: query - description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' - schema: - type: string - default: pdf - enum: - - pdf - - zip + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditRequestGroupedSigners' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3609,15 +3450,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/pdf: - schema: - type: string - format: binary - application/zip: + application/json: schema: - type: string - format: binary - 4XX: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestSendResponse' + '4XX': description: failed_operation content: application/json: @@ -3625,23 +3464,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3654,67 +3491,76 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFiles.php + $ref: examples/SignatureRequestEditExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFiles.js + $ref: examples/SignatureRequestEditExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFiles.ts + $ref: examples/SignatureRequestEditExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFiles.java + $ref: examples/SignatureRequestEditExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFiles.rb + $ref: examples/SignatureRequestEditExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFiles.py + $ref: examples/SignatureRequestEditExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFiles.sh + $ref: examples/SignatureRequestEditExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/files_as_data_uri/{signature_request_id}': - get: + title: 'Edit Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.' + '/signature_request/edit_embedded/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files as Data Uri' + summary: 'Edit Embedded Signature Request' description: |- - Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). + Edits a 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. - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFilesAsDataUri + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEditEmbedded parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSigners' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3726,11 +3572,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponseDataUri' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' + '4XX': description: failed_operation content: application/json: @@ -3738,103 +3584,100 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsDataUri.php + $ref: examples/SignatureRequestEditEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsDataUri.js + $ref: examples/SignatureRequestEditEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsDataUri.ts + $ref: examples/SignatureRequestEditEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsDataUri.java + $ref: examples/SignatureRequestEditEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsDataUri.rb + $ref: examples/SignatureRequestEditEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsDataUri.py + $ref: examples/SignatureRequestEditEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsDataUri.sh + $ref: examples/SignatureRequestEditEmbeddedExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/files_as_file_url/{signature_request_id}': - get: + title: 'Edit Embedded Signature Request | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here.' + '/signature_request/edit_embedded_with_template/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files as File Url' + summary: 'Edit Embedded Signature Request with Template' description: |- - 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). + Edits a 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. - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFilesAsFileUrl + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEditEmbeddedWithTemplate parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - - name: force_download - in: query - description: '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.' - schema: - type: integer - default: 1 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3846,11 +3689,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3858,93 +3701,100 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsFileUrl.php + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsFileUrl.js + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsFileUrl.ts + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsFileUrl.java + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsFileUrl.rb + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsFileUrl.py + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsFileUrl.sh + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/{signature_request_id}': - get: + title: 'Signature Request with Template | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based on the given Template, click here.' + '/signature_request/edit_with_template/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Get Signature Request' - description: 'Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.' - operationId: signatureRequestGet + summary: 'Edit Signature Request With Template' + description: |- + Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. + + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEditWithTemplate parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3958,9 +3808,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3968,19 +3818,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3993,86 +3845,72 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestGet.php + $ref: examples/SignatureRequestEditWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestGet.js + $ref: examples/SignatureRequestEditWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestGet.ts + $ref: examples/SignatureRequestEditWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestGet.java + $ref: examples/SignatureRequestEditWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestGet.rb + $ref: examples/SignatureRequestEditWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestGet.py + $ref: examples/SignatureRequestEditWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestGet.sh + $ref: examples/SignatureRequestEditWithTemplateExample.sh x-meta: seo: - title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.' - /signature_request/list: + title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based off of the Template, click here.' + '/signature_request/files/{signature_request_id}': get: tags: - 'Signature Request' - summary: 'List Signature Requests' + summary: 'Download Files' description: |- - Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. + Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. - Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. - operationId: signatureRequestList + If the files are currently being prepared, a status code of `409` will be returned instead. + operationId: signatureRequestFiles parameters: - - name: account_id - in: query - description: 'Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to retrieve.' + required: true schema: type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - name: page + name: file_type in: query - description: 'Which page number of the SignatureRequest List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - example: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - - - name: query - in: query - description: 'String that includes search terms and/or fields to be used to filter the SignatureRequest objects.' + description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' schema: type: string + default: pdf + enum: + - pdf + - zip responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4082,13 +3920,15 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/SignatureRequestListResponse' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestListResponseExample' - 4XX: + type: string + format: binary + application/zip: + schema: + type: string + format: binary + '4XX': description: failed_operation content: application/json: @@ -4096,17 +3936,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4119,64 +3965,62 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestList.php + $ref: examples/SignatureRequestFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestList.js + $ref: examples/SignatureRequestFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestList.ts + $ref: examples/SignatureRequestFilesExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestList.java + $ref: examples/SignatureRequestFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestList.rb + $ref: examples/SignatureRequestFilesExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestList.py + $ref: examples/SignatureRequestFilesExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestList.sh + $ref: examples/SignatureRequestFilesExample.sh x-meta: seo: - title: 'List Signature Requests | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.' - '/signature_request/release_hold/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/files_as_data_uri/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Release On-Hold Signature Request' - description: 'Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.' - operationId: signatureRequestReleaseHold + summary: 'Download Files as Data Uri' + description: |- + Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). + + If the files are currently being prepared, a status code of `409` will be returned instead. + operationId: signatureRequestFilesAsDataUri parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to release.' + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4188,11 +4032,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -4200,98 +4044,98 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: + - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestReleaseHold.php + $ref: examples/SignatureRequestFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestReleaseHold.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestReleaseHold.js + $ref: examples/SignatureRequestFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestReleaseHold.ts + $ref: examples/SignatureRequestFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestReleaseHold.java + $ref: examples/SignatureRequestFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestReleaseHold.rb + $ref: examples/SignatureRequestFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestReleaseHold.py + $ref: examples/SignatureRequestFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestReleaseHold.sh + $ref: examples/SignatureRequestFilesAsDataUriExample.sh x-meta: seo: - title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.' - '/signature_request/remind/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/files_as_file_url/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Send Request Reminder' + summary: 'Download Files as File Url' description: |- - 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. + 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). - **NOTE:** This action can **not** be used with embedded signature requests. - operationId: signatureRequestRemind + If the files are currently being prepared, a status code of `409` will be returned instead. + operationId: signatureRequestFilesAsFileUrl parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to send a reminder for.' + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestRemindRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' + - + name: force_download + in: query + description: '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.' + schema: + type: integer + default: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4303,11 +4147,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -4315,23 +4159,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4344,69 +4188,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemind.php + $ref: examples/SignatureRequestFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemind.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemind.js + $ref: examples/SignatureRequestFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemind.ts + $ref: examples/SignatureRequestFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemind.java + $ref: examples/SignatureRequestFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemind.rb + $ref: examples/SignatureRequestFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemind.py + $ref: examples/SignatureRequestFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemind.sh + $ref: examples/SignatureRequestFilesAsFileUrlExample.sh x-meta: seo: - title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.' - '/signature_request/remove/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Remove Signature Request Access' - description: |- - Removes your access to a completed signature request. This action is **not reversible**. - - The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). - - Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. - operationId: signatureRequestRemove + summary: 'Get Signature Request' + description: 'Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.' + operationId: signatureRequestGet parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to remove.' + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4416,8 +4250,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: {} - 4XX: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestGetResponse' + '4XX': description: failed_operation content: application/json: @@ -4425,92 +4264,106 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] + - + oauth2: + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemove.php + $ref: examples/SignatureRequestGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemove.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemove.js + $ref: examples/SignatureRequestGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemove.ts + $ref: examples/SignatureRequestGetExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemove.java + $ref: examples/SignatureRequestGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemove.rb + $ref: examples/SignatureRequestGetExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemove.py + $ref: examples/SignatureRequestGetExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemove.sh + $ref: examples/SignatureRequestGetExample.sh x-meta: seo: - title: 'Remove Signature Request Access | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.' - /signature_request/send: - post: + title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.' + /signature_request/list: + get: tags: - 'Signature Request' - summary: 'Send Signature Request' - description: 'Creates and sends a new SignatureRequest with the submitted documents. 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.' - operationId: signatureRequestSend - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestSendRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' - grouped_signers_example: - $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/SignatureRequestSendRequest' + summary: 'List Signature Requests' + description: |- + Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. + + Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + operationId: signatureRequestList + parameters: + - + name: account_id + in: query + description: 'Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + schema: + type: string + - + name: page + in: query + description: 'Which page number of the SignatureRequest List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + example: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + - + name: query + in: query + description: 'String that includes search terms and/or fields to be used to filter the SignatureRequest objects.' + schema: + type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4522,11 +4375,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/SignatureRequestListResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestListResponse' + '4XX': description: failed_operation content: application/json: @@ -4534,19 +4387,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4559,67 +4410,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSend.php + $ref: examples/SignatureRequestListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSend.js + $ref: examples/SignatureRequestListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSend.ts + $ref: examples/SignatureRequestListExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSend.java + $ref: examples/SignatureRequestListExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSend.rb + $ref: examples/SignatureRequestListExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSend.py + $ref: examples/SignatureRequestListExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSend.sh + $ref: examples/SignatureRequestListExample.sh x-meta: seo: - title: 'Send Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.' - /signature_request/send_with_template: + title: 'List Signature Requests | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.' + '/signature_request/release_hold/{signature_request_id}': post: tags: - 'Signature Request' - summary: 'Send with Template' - description: 'Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.' - operationId: signatureRequestSendWithTemplate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' + summary: 'Release On-Hold Signature Request' + description: 'Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.' + operationId: signatureRequestReleaseHold + parameters: + - + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to release.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4633,9 +4476,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestReleaseHoldResponse' + '4XX': description: failed_operation content: application/json: @@ -4643,86 +4486,78 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestSendWithTemplate.php + $ref: examples/SignatureRequestReleaseHoldExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSendWithTemplate.js + $ref: examples/SignatureRequestReleaseHoldExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSendWithTemplate.ts + $ref: examples/SignatureRequestReleaseHoldExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSendWithTemplate.java + $ref: examples/SignatureRequestReleaseHoldExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSendWithTemplate.rb + $ref: examples/SignatureRequestReleaseHoldExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSendWithTemplate.py + $ref: examples/SignatureRequestReleaseHoldExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSendWithTemplate.sh + $ref: examples/SignatureRequestReleaseHoldExample.sh x-meta: seo: - title: 'Send with Template | API Documentation | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.' - '/signature_request/update/{signature_request_id}': + title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.' + '/signature_request/remind/{signature_request_id}': post: tags: - 'Signature Request' - summary: 'Update Signature Request' + summary: 'Send Request Reminder' description: |- - 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. + 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 cannot be performed on a signature request with an appended signature page. - operationId: signatureRequestUpdate + **NOTE:** This action can **not** be used with embedded signature requests. + operationId: signatureRequestRemind parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to update.' + description: 'The id of the SignatureRequest to send a reminder for.' required: true schema: type: string @@ -4732,12 +4567,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestUpdateRequest' + $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestRemindRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4751,9 +4586,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestRemindResponse' + '4XX': description: failed_operation content: application/json: @@ -4761,97 +4596,93 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: + - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestUpdate.php + $ref: examples/SignatureRequestRemindExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestUpdate.js + $ref: examples/SignatureRequestRemindExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestUpdate.ts + $ref: examples/SignatureRequestRemindExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestUpdate.java + $ref: examples/SignatureRequestRemindExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestUpdate.rb + $ref: examples/SignatureRequestRemindExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestUpdate.py + $ref: examples/SignatureRequestRemindExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestUpdate.sh + $ref: examples/SignatureRequestRemindExample.sh x-meta: seo: - title: 'Update Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.' - /team/add_member: - put: + title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.' + '/signature_request/remove/{signature_request_id}': + post: tags: - - Team - summary: 'Add User to Team' - description: 'Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.' - operationId: teamAddMember + - 'Signature Request' + summary: 'Remove Signature Request Access' + description: |- + Removes your access to a completed signature request. This action is **not reversible**. + + The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). + + Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + operationId: signatureRequestRemove parameters: - - name: team_id - in: query - description: 'The id of the team.' - required: false + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to remove.' + required: true schema: type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TeamAddMemberRequest' - examples: - email_address: - $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4861,13 +4692,8 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: - schema: - $ref: '#/components/schemas/TeamGetResponse' - examples: - default_example: - $ref: '#/components/examples/TeamAddMemberResponseExample' - 4XX: + application/json: {} + '4XX': description: failed_operation content: application/json: @@ -4875,86 +4701,87 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - - - oauth2: - - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamAddMember.php + $ref: examples/SignatureRequestRemoveExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamAddMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamAddMember.js + $ref: examples/SignatureRequestRemoveExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamAddMember.ts + $ref: examples/SignatureRequestRemoveExample.ts - lang: Java label: Java source: - $ref: examples/TeamAddMember.java + $ref: examples/SignatureRequestRemoveExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamAddMember.rb + $ref: examples/SignatureRequestRemoveExample.rb - lang: Python label: Python source: - $ref: examples/TeamAddMember.py + $ref: examples/SignatureRequestRemoveExample.py - lang: cURL label: cURL source: - $ref: examples/TeamAddMember.sh + $ref: examples/SignatureRequestRemoveExample.sh x-meta: seo: - title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.' - /team/create: + title: 'Remove Signature Request Access | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.' + /signature_request/send: post: tags: - - Team - summary: 'Create Team' - description: 'Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.' - operationId: teamCreate + - 'Signature Request' + summary: 'Send Signature Request' + description: 'Creates and sends a new SignatureRequest with the submitted documents. 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.' + operationId: signatureRequestSend requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamCreateRequest' + $ref: '#/components/schemas/SignatureRequestSendRequest' examples: - default_example: - $ref: '#/components/examples/TeamCreateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestSendRequestGroupedSigners' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestSendRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4966,11 +4793,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestSendResponse' + '4XX': description: failed_operation content: application/json: @@ -4978,75 +4805,87 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - team_access + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamCreate.php + $ref: examples/SignatureRequestSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamCreate.js + $ref: examples/SignatureRequestSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamCreate.ts + $ref: examples/SignatureRequestSendExample.ts - lang: Java label: Java source: - $ref: examples/TeamCreate.java + $ref: examples/SignatureRequestSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamCreate.rb + $ref: examples/SignatureRequestSendExample.rb - lang: Python label: Python source: - $ref: examples/TeamCreate.py + $ref: examples/SignatureRequestSendExample.py - lang: cURL label: cURL source: - $ref: examples/TeamCreate.sh + $ref: examples/SignatureRequestSendExample.sh x-meta: seo: - title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.' - /team/destroy: - delete: + title: 'Send Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.' + /signature_request/send_with_template: + post: tags: - - Team - summary: 'Delete Team' - description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).' - operationId: teamDelete + - 'Signature Request' + summary: 'Send with Template' + description: 'Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.' + operationId: signatureRequestSendWithTemplate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5055,7 +4894,14 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -5063,75 +4909,96 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - team_access + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamDelete.php + $ref: examples/SignatureRequestSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamDelete.js + $ref: examples/SignatureRequestSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamDelete.ts + $ref: examples/SignatureRequestSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/TeamDelete.java + $ref: examples/SignatureRequestSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamDelete.rb + $ref: examples/SignatureRequestSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/TeamDelete.py + $ref: examples/SignatureRequestSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamDelete.sh + $ref: examples/SignatureRequestSendWithTemplateExample.sh x-meta: seo: - title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.' - /team: - get: + title: 'Send with Template | API Documentation | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.' + '/signature_request/update/{signature_request_id}': + post: tags: - - Team - summary: 'Get Team' - description: 'Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.' - operationId: teamGet + - 'Signature Request' + summary: 'Update Signature Request' + description: |- + 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. + operationId: signatureRequestUpdate + parameters: + - + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to update.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestUpdateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestUpdateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5143,11 +5010,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -5155,85 +5022,92 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - team_access + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamGet.php + $ref: examples/SignatureRequestUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamGet.js + $ref: examples/SignatureRequestUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamGet.ts + $ref: examples/SignatureRequestUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamGet.java + $ref: examples/SignatureRequestUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamGet.rb + $ref: examples/SignatureRequestUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamGet.py + $ref: examples/SignatureRequestUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamGet.sh + $ref: examples/SignatureRequestUpdateExample.sh x-meta: seo: - title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.' + title: 'Update Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.' + /team/add_member: put: tags: - Team - summary: 'Update Team' - description: 'Updates the name of your Team.' - operationId: teamUpdate + summary: 'Add User to Team' + description: 'Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.' + operationId: teamAddMember + parameters: + - + name: team_id + in: query + description: 'The id of the team.' + required: false + schema: + type: string + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamUpdateRequest' + $ref: '#/components/schemas/TeamAddMemberRequest' examples: - default_example: - $ref: '#/components/examples/TeamUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamAddMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamAddMemberRequestAccountId' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5247,9 +5121,9 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamAddMemberResponse' + '4XX': description: failed_operation content: application/json: @@ -5257,15 +5131,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5277,64 +5153,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamUpdate.php + $ref: examples/TeamAddMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamUpdate.js + $ref: examples/TeamAddMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamUpdate.ts + $ref: examples/TeamAddMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamUpdate.java + $ref: examples/TeamAddMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamUpdate.rb + $ref: examples/TeamAddMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamUpdate.py + $ref: examples/TeamAddMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamUpdate.sh + $ref: examples/TeamAddMemberExample.sh x-meta: seo: - title: 'Update Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.' - /team/info: - get: + title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.' + /team/create: + post: tags: - Team - summary: 'Get Team Info' - description: 'Provides information about a team.' - operationId: teamInfo - parameters: - - - name: team_id - in: query - description: 'The id of the team.' - required: false - schema: - type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + summary: 'Create Team' + description: 'Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.' + operationId: teamCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TeamCreateRequest' + examples: + example: + $ref: '#/components/examples/TeamCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5346,11 +5217,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetInfoResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetInfoResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -5358,19 +5229,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5382,63 +5249,50 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInfo.php + $ref: examples/TeamCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInfo.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInfo.js + $ref: examples/TeamCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInfo.ts + $ref: examples/TeamCreateExample.ts - lang: Java label: Java source: - $ref: examples/TeamInfo.java + $ref: examples/TeamCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInfo.rb + $ref: examples/TeamCreateExample.rb - lang: Python label: Python source: - $ref: examples/TeamInfo.py + $ref: examples/TeamCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInfo.sh + $ref: examples/TeamCreateExample.sh x-meta: seo: - title: 'Get Team Info | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.' - /team/invites: - get: + title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.' + /team/destroy: + delete: tags: - Team - summary: 'List Team Invites' - description: 'Provides a list of team invites (and their roles).' - operationId: teamInvites - parameters: - - - name: email_address - in: query - description: 'The email address for which to display the team invites.' - required: false - schema: - type: string + summary: 'Delete Team' + description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).' + operationId: teamDelete responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5447,14 +5301,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - content: - application/json: - schema: - $ref: '#/components/schemas/TeamInvitesResponse' - examples: - default_example: - $ref: '#/components/examples/TeamInvitesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5462,101 +5309,70 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - account_access - - basic_account_info + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamInvites.php + $ref: examples/TeamDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInvites.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInvites.js + $ref: examples/TeamDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInvites.ts + $ref: examples/TeamDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TeamInvites.java + $ref: examples/TeamDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInvites.rb + $ref: examples/TeamDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TeamInvites.py + $ref: examples/TeamDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInvites.sh + $ref: examples/TeamDeleteExample.sh x-meta: seo: - title: 'List Team Invites | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.' - '/team/members/{team_id}': + title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.' + /team: get: tags: - Team - summary: 'List Team Members' - description: 'Provides a paginated list of members (and their roles) that belong to a given team.' - operationId: teamMembers - parameters: - - - name: team_id - in: path - description: 'The id of the team that a member list is being requested from.' - required: true - schema: - type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - - - name: page - in: query - description: 'Which page number of the team member list to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 + summary: 'Get Team' + description: 'Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.' + operationId: teamGet responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5568,11 +5384,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamMembersResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamMembersResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamGetResponse' + '4XX': description: failed_operation content: application/json: @@ -5580,19 +5396,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5604,66 +5418,58 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamMembers.php + $ref: examples/TeamGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamMembers.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamMembers.js + $ref: examples/TeamGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamMembers.ts + $ref: examples/TeamGetExample.ts - lang: Java label: Java source: - $ref: examples/TeamMembers.java + $ref: examples/TeamGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamMembers.rb + $ref: examples/TeamGetExample.rb - lang: Python label: Python source: - $ref: examples/TeamMembers.py + $ref: examples/TeamGetExample.py - lang: cURL label: cURL source: - $ref: examples/TeamMembers.sh + $ref: examples/TeamGetExample.sh x-meta: seo: - title: 'List Team Members | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.' - /team/remove_member: - post: + title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.' + put: tags: - Team - summary: 'Remove User from Team' - description: 'Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.' - operationId: teamRemoveMember + summary: 'Update Team' + description: 'Updates the name of your Team.' + operationId: teamUpdate requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamRemoveMemberRequest' + $ref: '#/components/schemas/TeamUpdateRequest' examples: - email_address: - $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamUpdateRequest' responses: - 201: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5677,9 +5483,9 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamRemoveMemberResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -5687,17 +5493,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5709,80 +5513,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamRemoveMember.php + $ref: examples/TeamUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamRemoveMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamRemoveMember.js + $ref: examples/TeamUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamRemoveMember.ts + $ref: examples/TeamUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamRemoveMember.java + $ref: examples/TeamUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamRemoveMember.rb + $ref: examples/TeamUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamRemoveMember.py + $ref: examples/TeamUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamRemoveMember.sh + $ref: examples/TeamUpdateExample.sh x-meta: seo: - title: 'Remove User from Team | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.' - '/team/sub_teams/{team_id}': + title: 'Update Team | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.' + /team/info: get: tags: - Team - summary: 'List Sub Teams' - description: 'Provides a paginated list of sub teams that belong to a given team.' - operationId: teamSubTeams + summary: 'Get Team Info' + description: 'Provides information about a team.' + operationId: teamInfo parameters: - name: team_id - in: path - description: 'The id of the parent Team.' - required: true + in: query + description: 'The id of the team.' + required: false schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - - - name: page - in: query - description: 'Which page number of the SubTeam List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5794,11 +5577,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamSubTeamsResponse' + $ref: '#/components/schemas/TeamGetInfoResponse' examples: - default_example: - $ref: '#/components/examples/TeamSubTeamsResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamGetInfoResponse' + '4XX': description: failed_operation content: application/json: @@ -5806,19 +5589,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5830,73 +5613,58 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamSubTeams.php + $ref: examples/TeamInfoExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamSubTeams.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamSubTeams.js + $ref: examples/TeamInfoExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamSubTeams.ts + $ref: examples/TeamInfoExample.ts - lang: Java label: Java source: - $ref: examples/TeamSubTeams.java + $ref: examples/TeamInfoExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamSubTeams.rb + $ref: examples/TeamInfoExample.rb - lang: Python label: Python source: - $ref: examples/TeamSubTeams.py + $ref: examples/TeamInfoExample.py - lang: cURL label: cURL source: - $ref: examples/TeamSubTeams.sh + $ref: examples/TeamInfoExample.sh x-meta: seo: - title: 'List Sub Teams | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.' - '/template/add_user/{template_id}': - post: + title: 'Get Team Info | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.' + /team/invites: + get: tags: - - Template - summary: 'Add User to Template' - description: 'Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.' - operationId: templateAddUser + - Team + summary: 'List Team Invites' + description: 'Provides a list of team invites (and their roles).' + operationId: teamInvites parameters: - - name: template_id - in: path - description: 'The id of the Template to give the Account access to.' - required: true + name: email_address + in: query + description: 'The email address for which to display the team invites.' + required: false schema: type: string - example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateAddUserRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5908,11 +5676,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateGetResponse' + $ref: '#/components/schemas/TeamInvitesResponse' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamInvitesResponse' + '4XX': description: failed_operation content: application/json: @@ -5920,95 +5688,96 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - account_access + - basic_account_info x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateAddUser.php + $ref: examples/TeamInvitesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateAddUser.js + $ref: examples/TeamInvitesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateAddUser.ts + $ref: examples/TeamInvitesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateAddUser.java + $ref: examples/TeamInvitesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateAddUser.rb + $ref: examples/TeamInvitesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateAddUser.py + $ref: examples/TeamInvitesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateAddUser.sh + $ref: examples/TeamInvitesExample.sh x-meta: seo: - title: 'Add User to Template | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.' - /template/create: - post: + title: 'List Team Invites | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.' + '/team/members/{team_id}': + get: tags: - - Template - summary: 'Create Template' - description: 'Creates a template that can then be used.' - operationId: templateCreate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateCreateRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateCreateRequest' + - Team + summary: 'List Team Members' + description: 'Provides a paginated list of members (and their roles) that belong to a given team.' + operationId: teamMembers + parameters: + - + name: team_id + in: path + description: 'The id of the team that a member list is being requested from.' + required: true + schema: + type: string + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + - + name: page + in: query + description: 'Which page number of the team member list to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6020,11 +5789,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateResponse' + $ref: '#/components/schemas/TeamMembersResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamMembersResponse' + '4XX': description: failed_operation content: application/json: @@ -6032,97 +5801,85 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateCreate.php + $ref: examples/TeamMembersExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreate.js + $ref: examples/TeamMembersExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreate.ts + $ref: examples/TeamMembersExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreate.java + $ref: examples/TeamMembersExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreate.rb + $ref: examples/TeamMembersExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreate.py + $ref: examples/TeamMembersExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreate.sh + $ref: examples/TeamMembersExample.sh x-meta: seo: - title: 'Create Template | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.' - /template/create_embedded_draft: + title: 'List Team Members | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.' + /team/remove_member: post: tags: - - Template - summary: 'Create Embedded Template Draft' - description: 'The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ''edit'' stage.' - operationId: templateCreateEmbeddedDraft + - Team + summary: 'Remove User from Team' + description: 'Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.' + operationId: teamRemoveMember requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + example: + $ref: '#/components/examples/TeamRemoveMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamRemoveMemberRequestAccountId' responses: - 200: + '201': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6134,11 +5891,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamRemoveMemberResponse' + '4XX': description: failed_operation content: application/json: @@ -6146,88 +5903,97 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateCreateEmbeddedDraft.php + $ref: examples/TeamRemoveMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreateEmbeddedDraft.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreateEmbeddedDraft.js + $ref: examples/TeamRemoveMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreateEmbeddedDraft.ts + $ref: examples/TeamRemoveMemberExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreateEmbeddedDraft.java + $ref: examples/TeamRemoveMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreateEmbeddedDraft.rb + $ref: examples/TeamRemoveMemberExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreateEmbeddedDraft.py + $ref: examples/TeamRemoveMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreateEmbeddedDraft.sh + $ref: examples/TeamRemoveMemberExample.sh x-meta: seo: - title: 'Create Embedded Template Draft | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.' - '/template/delete/{template_id}': - post: + title: 'Remove User from Team | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.' + '/team/sub_teams/{team_id}': + get: tags: - - Template - summary: 'Delete Template' - description: 'Completely deletes the template specified from the account.' - operationId: templateDelete + - Team + summary: 'List Sub Teams' + description: 'Provides a paginated list of sub teams that belong to a given team.' + operationId: teamSubTeams parameters: - - name: template_id + name: team_id in: path - description: 'The id of the Template to delete.' + description: 'The id of the parent Team.' required: true schema: type: string - example: f57db65d3f933b5316d398057a36176831451a35 - responses: - 200: + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + - + name: page + in: query + description: 'Which page number of the SubTeam List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 + responses: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6237,8 +6003,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: {} - 4XX: + application/json: + schema: + $ref: '#/components/schemas/TeamSubTeamsResponse' + examples: + example: + $ref: '#/components/examples/TeamSubTeamsResponse' + '4XX': description: failed_operation content: application/json: @@ -6246,100 +6017,92 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateDelete.php + $ref: examples/TeamSubTeamsExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateDelete.js + $ref: examples/TeamSubTeamsExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateDelete.ts + $ref: examples/TeamSubTeamsExample.ts - lang: Java label: Java source: - $ref: examples/TemplateDelete.java + $ref: examples/TeamSubTeamsExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateDelete.rb + $ref: examples/TeamSubTeamsExample.rb - lang: Python label: Python source: - $ref: examples/TemplateDelete.py + $ref: examples/TeamSubTeamsExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateDelete.sh + $ref: examples/TeamSubTeamsExample.sh x-meta: seo: - title: 'Delete Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.' - '/template/files/{template_id}': - get: + title: 'List Sub Teams | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.' + '/template/add_user/{template_id}': + post: tags: - Template - summary: 'Get Template Files' - description: |- - Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. - - 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. - operationId: templateFiles + summary: 'Add User to Template' + description: 'Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.' + operationId: templateAddUser parameters: - name: template_id in: path - description: 'The id of the template files to retrieve.' + description: 'The id of the Template to give the Account access to.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - - - name: file_type - in: query - description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' - schema: - type: string - enum: - - pdf - - zip + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateAddUserRequest' + examples: + example: + $ref: '#/components/examples/TemplateAddUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6349,15 +6112,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/pdf: - schema: - type: string - format: binary - application/zip: + application/json: schema: - type: string - format: binary - 4XX: + $ref: '#/components/schemas/TemplateGetResponse' + examples: + example: + $ref: '#/components/examples/TemplateAddUserResponse' + '4XX': description: failed_operation content: application/json: @@ -6365,23 +6126,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6393,67 +6148,68 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFiles.php + $ref: examples/TemplateAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFiles.js + $ref: examples/TemplateAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFiles.ts + $ref: examples/TemplateAddUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFiles.java + $ref: examples/TemplateAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFiles.rb + $ref: examples/TemplateAddUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFiles.py + $ref: examples/TemplateAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFiles.sh + $ref: examples/TemplateAddUserExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/files_as_data_uri/{template_id}': - get: + title: 'Add User to Template | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.' + /template/create: + post: tags: - Template - summary: 'Get Template Files as Data Uri' - description: |- - Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded 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. - operationId: templateFilesAsDataUri - parameters: - - - name: template_id - in: path - description: 'The id of the template files to retrieve.' - required: true - schema: - type: string - example: f57db65d3f933b5316d398057a36176831451a35 + summary: 'Create Template' + description: 'Creates a template that can then be used.' + operationId: templateCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateCreateRequest' + examples: + example: + $ref: '#/components/examples/TemplateCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6465,11 +6221,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponseDataUri' + $ref: '#/components/schemas/TemplateCreateResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -6477,23 +6233,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6505,74 +6257,68 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsDataUri.php + $ref: examples/TemplateCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsDataUri.js + $ref: examples/TemplateCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsDataUri.ts + $ref: examples/TemplateCreateExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsDataUri.java + $ref: examples/TemplateCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsDataUri.rb + $ref: examples/TemplateCreateExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsDataUri.py + $ref: examples/TemplateCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsDataUri.sh + $ref: examples/TemplateCreateExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/files_as_file_url/{template_id}': - get: + title: 'Create Template | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.' + /template/create_embedded_draft: + post: tags: - Template - summary: 'Get Template Files as File Url' - description: |- - 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. - operationId: templateFilesAsFileUrl - parameters: - - - name: template_id - in: path - description: 'The id of the template files to retrieve.' - required: true - schema: - type: string - example: f57db65d3f933b5316d398057a36176831451a35 - - - name: force_download - in: query - description: '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.' - schema: - type: integer - default: 1 + summary: 'Create Embedded Template Draft' + description: 'The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ''edit'' stage.' + operationId: templateCreateEmbeddedDraft + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + examples: + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6584,11 +6330,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponse' + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponse' + '4XX': description: failed_operation content: application/json: @@ -6596,23 +6342,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6624,64 +6366,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsFileUrl.php + $ref: examples/TemplateCreateEmbeddedDraftExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsFileUrl.js + $ref: examples/TemplateCreateEmbeddedDraftExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsFileUrl.ts + $ref: examples/TemplateCreateEmbeddedDraftExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsFileUrl.java + $ref: examples/TemplateCreateEmbeddedDraftExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsFileUrl.rb + $ref: examples/TemplateCreateEmbeddedDraftExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsFileUrl.py + $ref: examples/TemplateCreateEmbeddedDraftExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsFileUrl.sh + $ref: examples/TemplateCreateEmbeddedDraftExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/{template_id}': - get: + title: 'Create Embedded Template Draft | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.' + '/template/delete/{template_id}': + post: tags: - Template - summary: 'Get Template' - description: 'Returns the Template specified by the `template_id` parameter.' - operationId: templateGet + summary: 'Delete Template' + description: 'Completely deletes the template specified from the account.' + operationId: templateDelete parameters: - name: template_id in: path - description: 'The id of the Template to retrieve.' + description: 'The id of the Template to delete.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6691,13 +6428,8 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: - schema: - $ref: '#/components/schemas/TemplateGetResponse' - examples: - default_example: - $ref: '#/components/examples/TemplateGetResponseExample' - 4XX: + application/json: {} + '4XX': description: failed_operation content: application/json: @@ -6705,19 +6437,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6729,87 +6461,71 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateGet.php + $ref: examples/TemplateDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateGet.js + $ref: examples/TemplateDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateGet.ts + $ref: examples/TemplateDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TemplateGet.java + $ref: examples/TemplateDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateGet.rb + $ref: examples/TemplateDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TemplateGet.py + $ref: examples/TemplateDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateGet.sh + $ref: examples/TemplateDeleteExample.sh x-meta: seo: - title: 'Get Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.' - /template/list: + title: 'Delete Template | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.' + '/template/files/{template_id}': get: tags: - Template - summary: 'List Templates' + summary: 'Get Template Files' description: |- - Returns a list of the Templates that are accessible by you. + Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. - Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. - operationId: templateList + 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. + operationId: templateFiles parameters: - - name: account_id - in: query - description: 'Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + name: template_id + in: path + description: 'The id of the template files to retrieve.' + required: true schema: type: string + example: f57db65d3f933b5316d398057a36176831451a35 - - name: page - in: query - description: 'Which page number of the Template List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 - - - name: query + name: file_type in: query - description: 'String that includes search terms and/or fields to be used to filter the Template objects.' + description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' schema: type: string + enum: + - pdf + - zip responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6819,13 +6535,15 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/TemplateListResponse' - examples: - default_example: - $ref: '#/components/examples/TemplateListResponseExample' - 4XX: + type: string + format: binary + application/zip: + schema: + type: string + format: binary + '4XX': description: failed_operation content: application/json: @@ -6833,19 +6551,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6857,73 +6579,62 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateList.php + $ref: examples/TemplateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateList.js + $ref: examples/TemplateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateList.ts + $ref: examples/TemplateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateList.java + $ref: examples/TemplateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateList.rb + $ref: examples/TemplateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateList.py + $ref: examples/TemplateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateList.sh + $ref: examples/TemplateFilesExample.sh x-meta: seo: - title: 'List Templates | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.' - '/template/remove_user/{template_id}': - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/files_as_data_uri/{template_id}': + get: tags: - Template - summary: 'Remove User from Template' - description: 'Removes the specified Account''s access to the specified Template.' - operationId: templateRemoveUser + summary: 'Get Template Files as Data Uri' + description: |- + Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded 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. + operationId: templateFilesAsDataUri parameters: - name: template_id in: path - description: 'The id of the Template to remove the Account''s access to.' + description: 'The id of the template files to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateRemoveUserRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6935,11 +6646,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateGetResponse' + $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -6947,17 +6658,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6969,88 +6686,69 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateRemoveUser.php + $ref: examples/TemplateFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateRemoveUser.js + $ref: examples/TemplateFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateRemoveUser.ts + $ref: examples/TemplateFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/TemplateRemoveUser.java + $ref: examples/TemplateFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateRemoveUser.rb + $ref: examples/TemplateFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/TemplateRemoveUser.py + $ref: examples/TemplateFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateRemoveUser.sh + $ref: examples/TemplateFilesAsDataUriExample.sh x-meta: seo: - title: 'Remove User from Template | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.' - '/template/update_files/{template_id}': - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/files_as_file_url/{template_id}': + get: tags: - Template - summary: 'Update Template Files' + summary: 'Get Template Files as File Url' description: |- - Overlays a new file with the overlay of an existing template. The new file(s) must: - - 1. have the same or higher page count - 2. the same orientation as the file(s) being replaced. - - This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. - - Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. - - It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. 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 and retry the request if necessary. + 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 page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). - operationId: templateUpdateFiles + 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. + operationId: templateFilesAsFileUrl parameters: - name: template_id in: path - description: 'The ID of the template whose files to update.' + description: 'The id of the template files to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateUpdateFilesRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateUpdateFilesRequest' + - + name: force_download + in: query + description: '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.' + schema: + type: integer + default: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7062,11 +6760,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateUpdateFilesResponse' + $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -7074,21 +6772,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7100,73 +6800,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateUpdateFiles.php + $ref: examples/TemplateFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateUpdateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateUpdateFiles.js + $ref: examples/TemplateFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateUpdateFiles.ts + $ref: examples/TemplateFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/TemplateUpdateFiles.java + $ref: examples/TemplateFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateUpdateFiles.rb + $ref: examples/TemplateFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/TemplateUpdateFiles.py + $ref: examples/TemplateFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateUpdateFiles.sh + $ref: examples/TemplateFilesAsFileUrlExample.sh x-meta: seo: - title: 'Update Template Files | REST API | Dropbox Sign for Developers' - description: 'Overlays a new file with the overlay of an existing template' - /unclaimed_draft/create: - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/{template_id}': + get: tags: - - 'Unclaimed Draft' - summary: 'Create Unclaimed Draft' - description: 'Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.' - operationId: unclaimedDraftCreate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateRequest' - examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + - Template + summary: 'Get Template' + description: 'Returns the Template specified by the `template_id` parameter.' + operationId: templateGet + parameters: + - + name: template_id + in: path + description: 'The id of the Template to retrieve.' + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7178,11 +6864,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateGetResponse' + '4XX': description: failed_operation content: application/json: @@ -7190,96 +6876,106 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreate.php + $ref: examples/TemplateGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreate.js + $ref: examples/TemplateGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreate.ts + $ref: examples/TemplateGetExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreate.java + $ref: examples/TemplateGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreate.rb + $ref: examples/TemplateGetExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreate.py + $ref: examples/TemplateGetExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreate.sh + $ref: examples/TemplateGetExample.sh x-meta: seo: - title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.' - /unclaimed_draft/create_embedded: - post: + title: 'Get Template | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.' + /template/list: + get: tags: - - 'Unclaimed Draft' - summary: 'Create Embedded Unclaimed Draft' + - Template + summary: 'List Templates' description: |- - 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. + Returns a list of the Templates that are accessible by you. - **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. - operationId: unclaimedDraftCreateEmbedded - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' - examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + operationId: templateList + parameters: + - + name: account_id + in: query + description: 'Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + schema: + type: string + - + name: page + in: query + description: 'Which page number of the Template List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 + - + name: query + in: query + description: 'String that includes search terms and/or fields to be used to filter the Template objects.' + schema: + type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7291,11 +6987,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateListResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateListResponse' + '4XX': description: failed_operation content: application/json: @@ -7303,95 +6999,92 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbedded.php + $ref: examples/TemplateListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbedded.js + $ref: examples/TemplateListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbedded.ts + $ref: examples/TemplateListExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbedded.java + $ref: examples/TemplateListExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbedded.rb + $ref: examples/TemplateListExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbedded.py + $ref: examples/TemplateListExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbedded.sh + $ref: examples/TemplateListExample.sh x-meta: seo: - title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.' - /unclaimed_draft/create_embedded_with_template: + title: 'List Templates | API Documentation | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.' + '/template/remove_user/{template_id}': post: tags: - - 'Unclaimed Draft' - summary: 'Create Embedded Unclaimed Draft with Template' - description: |- - 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. - operationId: unclaimedDraftCreateEmbeddedWithTemplate + - Template + summary: 'Remove User from Template' + description: 'Removes the specified Account''s access to the specified Template.' + operationId: templateRemoveUser + parameters: + - + name: template_id + in: path + description: 'The id of the Template to remove the Account''s access to.' + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + example: + $ref: '#/components/examples/TemplateRemoveUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7403,11 +7096,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateRemoveUserResponse' + '4XX': description: failed_operation content: application/json: @@ -7415,102 +7108,105 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php + $ref: examples/TemplateRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js + $ref: examples/TemplateRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts + $ref: examples/TemplateRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java + $ref: examples/TemplateRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb + $ref: examples/TemplateRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py + $ref: examples/TemplateRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh + $ref: examples/TemplateRemoveUserExample.sh x-meta: seo: - title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.' - '/unclaimed_draft/edit_and_resend/{signature_request_id}': + title: 'Remove User from Template | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.' + '/template/update_files/{template_id}': post: tags: - - 'Unclaimed Draft' - summary: 'Edit and Resend Unclaimed Draft' + - Template + summary: 'Update Template Files' description: |- - 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. + Overlays a new file with the overlay of an existing template. The new file(s) must: - **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. - operationId: unclaimedDraftEditAndResend - parameters: - - - name: signature_request_id - in: path - description: 'The ID of the signature request to edit and resend.' + 1. have the same or higher page count + 2. the same orientation as the file(s) being replaced. + + This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. + + Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. + + It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. 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 and retry the request if necessary. + + If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + operationId: templateUpdateFiles + parameters: + - + name: template_id + in: path + description: 'The ID of the template whose files to update.' required: true schema: type: string - example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' + $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateUpdateFilesRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7522,11 +7218,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' - 4XX: + example: + $ref: '#/components/examples/TemplateUpdateFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -7534,123 +7230,558 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftEditAndResend.php + $ref: examples/TemplateUpdateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.cs + $ref: examples/TemplateUpdateFilesExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/TemplateUpdateFilesExample.ts + - + lang: Java + label: Java + source: + $ref: examples/TemplateUpdateFilesExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/TemplateUpdateFilesExample.rb + - + lang: Python + label: Python + source: + $ref: examples/TemplateUpdateFilesExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/TemplateUpdateFilesExample.sh + x-meta: + seo: + title: 'Update Template Files | REST API | Dropbox Sign for Developers' + description: 'Overlays a new file with the overlay of an existing template' + /unclaimed_draft/create: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Unclaimed Draft' + description: 'Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.' + operationId: unclaimedDraftCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateResponse' + '4XX': + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftCreateExample.php - - lang: JavaScript - label: JavaScript + lang: 'C#' + label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.js + $ref: examples/UnclaimedDraftCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftEditAndResend.ts + $ref: examples/UnclaimedDraftCreateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftEditAndResend.java + $ref: examples/UnclaimedDraftCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftEditAndResend.rb + $ref: examples/UnclaimedDraftCreateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftEditAndResend.py + $ref: examples/UnclaimedDraftCreateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftEditAndResend.sh + $ref: examples/UnclaimedDraftCreateExample.sh x-meta: seo: - title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.' -components: - schemas: - AccountCreateRequest: - required: - - email_address - properties: - client_id: - description: |- - Used when creating a new account with OAuth authorization. + title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.' + /unclaimed_draft/create_embedded: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Embedded Unclaimed Draft' + description: |- + 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. - See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) - type: string - client_secret: - description: |- - Used when creating a new account with OAuth authorization. + **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + operationId: unclaimedDraftCreateEmbedded + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponse' + '4XX': + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.sh + x-meta: + seo: + title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.' + /unclaimed_draft/create_embedded_with_template: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Embedded Unclaimed Draft with Template' + description: |- + 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. - See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) - type: string - email_address: - description: 'The email address which will be associated with the new Account.' - type: string - format: email - locale: - description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' - type: string - type: object - AccountUpdateRequest: - properties: - account_id: - description: 'The ID of the Account' - type: string - nullable: true - callback_url: - description: 'The URL that Dropbox Sign should POST events to.' - type: string - locale: - description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' - type: string - type: object - AccountVerifyRequest: - required: - - email_address - properties: - email_address: - description: 'Email address to run the verification for.' - type: string - format: email - type: object - ApiAppCreateRequest: - required: + **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + operationId: unclaimedDraftCreateEmbeddedWithTemplate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponse' + '4XX': + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh + x-meta: + seo: + title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.' + '/unclaimed_draft/edit_and_resend/{signature_request_id}': + post: + tags: + - 'Unclaimed Draft' + summary: 'Edit and Resend Unclaimed Draft' + description: |- + 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. + operationId: unclaimedDraftEditAndResend + parameters: + - + name: signature_request_id + in: path + description: 'The ID of the signature request to edit and resend.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendRequest' + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResend' + '4XX': + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftEditAndResendExample.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftEditAndResendExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftEditAndResendExample.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftEditAndResendExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftEditAndResendExample.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftEditAndResendExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftEditAndResendExample.sh + x-meta: + seo: + title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.' +components: + schemas: + AccountCreateRequest: + required: + - email_address + properties: + client_id: + description: |- + Used when creating a new account with OAuth authorization. + + See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) + type: string + client_secret: + description: |- + Used when creating a new account with OAuth authorization. + + See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) + type: string + email_address: + description: 'The email address which will be associated with the new Account.' + type: string + format: email + locale: + description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' + type: string + type: object + AccountUpdateRequest: + properties: + account_id: + description: 'The ID of the Account' + type: string + nullable: true + callback_url: + description: 'The URL that Dropbox Sign should POST events to.' + type: string + locale: + description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' + type: string + type: object + AccountVerifyRequest: + required: + - email_address + properties: + email_address: + description: 'Email address to run the verification for.' + type: string + format: email + type: object + ApiAppCreateRequest: + required: - name - domains properties: @@ -7757,7 +7888,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: description: 'Account ID' @@ -7850,20 +7981,20 @@ components: - country properties: area_code: - description: 'Area code' + description: 'Area code of the new Fax Line' type: integer country: - description: Country + description: 'Country of the area code' type: string enum: - CA - US - UK city: - description: City + description: 'City of the area code' type: string account_id: - description: 'Account ID' + description: 'Account ID of the account that will be assigned this new Fax Line' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 type: object @@ -7872,7 +8003,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string type: object FaxLineRemoveUserRequest: @@ -7880,14 +8011,14 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: - description: 'Account ID' + description: 'Account ID of the user to remove access' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 email_address: - description: 'Email address' + description: 'Email address of the user to remove access' type: string format: email type: object @@ -7896,7 +8027,9 @@ components: - recipient properties: recipient: - description: 'Fax Send To Recipient' + description: |- + Recipient of the fax + Can be a phone number in E.164 format or email address type: string example: recipient@example.com sender: @@ -7904,13 +8037,19 @@ components: type: string example: sender@example.com files: - description: 'Fax File to Send' + description: |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: - description: 'Fax File URL to Send' + description: |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string @@ -7919,11 +8058,11 @@ components: type: boolean default: false cover_page_to: - description: 'Fax Cover Page for Recipient' + description: 'Fax cover page recipient information' type: string example: 'Recipient Name' cover_page_from: - description: 'Fax Cover Page for Sender' + description: 'Fax cover page sender information' type: string example: 'Sender Name' cover_page_message: @@ -8119,27 +8258,361 @@ components: Example CSV: - ``` - name, email_address, pin, company_field - George, george@example.com, d79a3td, ABC Corp - Mary, mary@example.com, gd9as5b, 123 LLC - ``` - type: string - format: binary - signer_list: - description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.' + ``` + name, email_address, pin, company_field + George, george@example.com, d79a3td, ABC Corp + Mary, mary@example.com, gd9as5b, 123 LLC + ``` + type: string + format: binary + signer_list: + description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.' + type: array + items: + $ref: '#/components/schemas/SubBulkSignerList' + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.' + type: string + custom_fields: + description: |- + When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + + Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + + For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + type: array + items: + $ref: '#/components/schemas/SubCustomField' + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signing_redirect_url: + description: 'The URL you want signers redirected to after they successfully sign.' + type: string + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + type: object + SignatureRequestCreateEmbeddedRequest: + required: + - client_id + properties: + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + signers: + description: |- + Add Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: |- + Add Grouped Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + allow_reassign: + description: |- + Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + + **NOTE:** Only available for Premium plan. + type: boolean + default: false + attachments: + description: 'A list describing the attachments' + type: array + items: + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: 'The email addresses that should be CCed.' + type: array + items: + type: string + format: email + client_id: + description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' + type: string + custom_fields: + description: |- + When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + + Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + + For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + type: array + items: + $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + form_field_groups: + description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + form_field_rules: + description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + form_fields_per_document: + description: |- + 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` + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + hide_text_tags: + description: |- + 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. + type: boolean + default: false + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + use_text_tags: + description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' + type: boolean + default: false + populate_auto_fill_fields: + description: |- + 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. + type: boolean + default: false + expires_at: + description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' + type: integer + nullable: true + type: object + SignatureRequestCreateEmbeddedWithTemplateRequest: + required: + - client_id + - template_ids + - signers + properties: + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + type: array + items: + type: string + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' + type: string + custom_fields: + description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signers: + description: 'Add Signers to your Templated-based Signature Request.' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + populate_auto_fill_fields: + description: |- + 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. + type: boolean + default: false + type: object + SignatureRequestEditRequest: + properties: + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + signers: + description: |- + Add Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: |- + Add Grouped Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. type: array items: - $ref: '#/components/schemas/SubBulkSignerList' + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - ccs: - description: 'Add CC email recipients. Required when a CC role exists for the Template.' + allow_reassign: + description: |- + Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + + **NOTE:** Only available for Premium plan and higher. + type: boolean + default: false + attachments: + description: 'A list describing the attachments' type: array items: - $ref: '#/components/schemas/SubCC' + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: 'The email addresses that should be CCed.' + type: array + items: + type: string + format: email client_id: description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.' type: string @@ -8153,6 +8626,52 @@ components: type: array items: $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + form_field_groups: + description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + form_field_rules: + description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + form_fields_per_document: + description: |- + 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` + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + hide_text_tags: + description: |- + 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. + type: boolean + default: false + is_eid: + description: |- + Send with a value of `true` if you wish to enable + [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + type: boolean + default: false message: description: 'The custom message in the email that will be sent to the signers.' type: string @@ -8165,6 +8684,8 @@ components: type: object maxItems: 10 additionalProperties: {} + signing_options: + $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string @@ -8180,8 +8701,16 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + use_text_tags: + description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' + type: boolean + default: false + expires_at: + description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' + type: integer + nullable: true type: object - SignatureRequestCreateEmbeddedRequest: + SignatureRequestEditEmbeddedRequest: required: - client_id properties: @@ -8333,7 +8862,7 @@ components: type: integer nullable: true type: object - SignatureRequestCreateEmbeddedWithTemplateRequest: + SignatureRequestEditEmbeddedWithTemplateRequest: required: - client_id - template_ids @@ -8417,6 +8946,94 @@ components: type: boolean default: false type: object + SignatureRequestEditWithTemplateRequest: + description: '' + required: + - signers + - template_ids + properties: + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + type: array + items: + type: string + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.' + type: string + custom_fields: + description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + is_eid: + description: |- + Send with a value of `true` if you wish to enable + [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + type: boolean + default: false + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signers: + description: 'Add Signers to your Templated-based Signature Request.' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + signing_redirect_url: + description: 'The URL you want signers redirected to after they successfully sign.' + type: string + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + type: object SignatureRequestRemindRequest: required: - email_address @@ -13085,498 +13702,522 @@ components: type: string default: 'Hello API Event Received' examples: - AccountCreateRequestDefaultExample: + AccountCreateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountCreateRequestDefaultExample.json - AccountCreateRequestOAuthExample: + $ref: examples/json/AccountCreateRequest.json + AccountCreateRequestOAuth: summary: 'OAuth Example' value: - $ref: examples/json/AccountCreateRequestOAuthExample.json - AccountUpdateRequestDefaultExample: + $ref: examples/json/AccountCreateRequestOAuth.json + AccountUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountUpdateRequestDefaultExample.json - AccountVerifyRequestDefaultExample: + $ref: examples/json/AccountUpdateRequest.json + AccountVerifyRequest: summary: 'Default Example' value: - $ref: examples/json/AccountVerifyRequestDefaultExample.json - ApiAppCreateRequestDefaultExample: + $ref: examples/json/AccountVerifyRequest.json + ApiAppCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppCreateRequestDefaultExample.json - ApiAppUpdateRequestDefaultExample: + $ref: examples/json/ApiAppCreateRequest.json + ApiAppUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppUpdateRequestDefaultExample.json - EmbeddedEditUrlRequestDefaultExample: + $ref: examples/json/ApiAppUpdateRequest.json + EmbeddedEditUrlRequest: summary: 'Default Example' value: - $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json - FaxLineAddUserRequestExample: + $ref: examples/json/EmbeddedEditUrlRequest.json + FaxLineAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineAddUserRequestExample.json - FaxLineCreateRequestExample: + $ref: examples/json/FaxLineAddUserRequest.json + FaxLineCreateRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineCreateRequestExample.json - FaxLineDeleteRequestExample: + $ref: examples/json/FaxLineCreateRequest.json + FaxLineDeleteRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineDeleteRequestExample.json - FaxLineRemoveUserRequestExample: + $ref: examples/json/FaxLineDeleteRequest.json + FaxLineRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineRemoveUserRequestExample.json - FaxSendRequestExample: + $ref: examples/json/FaxLineRemoveUserRequest.json + FaxSendRequest: summary: 'Default Example' value: - $ref: examples/json/FaxSendRequestExample.json - OAuthTokenGenerateRequestExample: + $ref: examples/json/FaxSendRequest.json + OAuthTokenGenerateRequest: summary: 'OAuth Token Generate Example' value: - $ref: examples/json/OAuthTokenGenerateRequestExample.json - OAuthTokenRefreshRequestExample: + $ref: examples/json/OAuthTokenGenerateRequest.json + OAuthTokenRefreshRequest: summary: 'OAuth Token Refresh Example' value: - $ref: examples/json/OAuthTokenRefreshRequestExample.json - ReportCreateRequestDefaultExample: + $ref: examples/json/OAuthTokenRefreshRequest.json + ReportCreateRequest: + summary: 'Default Example' + value: + $ref: examples/json/ReportCreateRequest.json + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json + SignatureRequestBulkSendWithTemplateRequest: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestBulkSendWithTemplateRequest.json + SignatureRequestCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/ReportCreateRequestDefaultExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequest.json + SignatureRequestCreateEmbeddedRequestGroupedSigners: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json + SignatureRequestCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestBulkSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json + SignatureRequestEditRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestEditRequest.json + SignatureRequestEditRequestGroupedSigners: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestEditRequestGroupedSigners.json + SignatureRequestEditEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequest.json + SignatureRequestEditEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json - SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json + SignatureRequestEditEmbeddedWithTemplateRequest: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json + SignatureRequestEditWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestRemindRequestDefaultExample: + $ref: examples/json/SignatureRequestEditWithTemplateRequest.json + SignatureRequestRemindRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestRemindRequestDefaultExample.json - SignatureRequestSendRequestDefaultExample: + $ref: examples/json/SignatureRequestRemindRequest.json + SignatureRequestSendRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendRequestDefaultExample.json - SignatureRequestSendRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestSendRequest.json + SignatureRequestSendRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestSendRequestGroupedSignersExample.json - SignatureRequestSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendRequestGroupedSigners.json + SignatureRequestSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json - SignatureRequestUpdateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendWithTemplateRequest.json + SignatureRequestUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestUpdateRequestDefaultExample.json - TeamAddMemberRequestEmailAddressExample: + $ref: examples/json/SignatureRequestUpdateRequest.json + TeamAddMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamAddMemberRequestEmailAddressExample.json - TeamAddMemberRequestAccountIdExample: + $ref: examples/json/TeamAddMemberRequest.json + TeamAddMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamAddMemberRequestAccountIdExample.json - TeamCreateRequestDefaultExample: + $ref: examples/json/TeamAddMemberRequestAccountId.json + TeamCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamCreateRequestDefaultExample.json - TeamRemoveMemberRequestEmailAddressExample: + $ref: examples/json/TeamCreateRequest.json + TeamRemoveMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamRemoveMemberRequestEmailAddressExample.json - TeamRemoveMemberRequestAccountIdExample: + $ref: examples/json/TeamRemoveMemberRequest.json + TeamRemoveMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamRemoveMemberRequestAccountIdExample.json - TeamUpdateRequestDefaultExample: + $ref: examples/json/TeamRemoveMemberRequestAccountId.json + TeamUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamUpdateRequestDefaultExample.json - TemplateAddUserRequestDefaultExample: + $ref: examples/json/TeamUpdateRequest.json + TemplateAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateAddUserRequestDefaultExample.json - TemplateCreateRequestDefaultExample: + $ref: examples/json/TemplateAddUserRequest.json + TemplateCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateRequestDefaultExample.json - TemplateCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateRequest.json + TemplateCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json - TemplateCreateRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateRequestFormFieldsPerDocument.json + TemplateCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json - TemplateCreateRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateRequestFormFieldGroups.json + TemplateCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json - TemplateCreateEmbeddedDraftRequestDefaultExample: + $ref: examples/json/TemplateCreateRequestFormFieldRules.json + TemplateCreateEmbeddedDraftRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json - TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequest.json + TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json - TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json + TemplateCreateEmbeddedDraftRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json - TemplateCreateEmbeddedDraftRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json + TemplateCreateEmbeddedDraftRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json - TemplateRemoveUserRequestDefaultExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json + TemplateRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateRemoveUserRequestDefaultExample.json - TemplateUpdateFilesRequestDefaultExample: + $ref: examples/json/TemplateRemoveUserRequest.json + TemplateUpdateFilesRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateUpdateFilesRequestDefaultExample.json - UnclaimedDraftCreateRequestDefaultExample: + $ref: examples/json/TemplateUpdateFilesRequest.json + UnclaimedDraftCreateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestDefaultExample.json - UnclaimedDraftCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateRequest.json + UnclaimedDraftCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json + UnclaimedDraftCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json - UnclaimedDraftCreateRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json + UnclaimedDraftCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequest.json + UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json + UnclaimedDraftCreateEmbeddedRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json + UnclaimedDraftCreateEmbeddedRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json - UnclaimedDraftEditAndResendRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json + UnclaimedDraftEditAndResendRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json - AccountCreateResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResendRequest.json + AccountCreateResponse: summary: 'Account Create' value: - $ref: examples/json/AccountCreateResponseExample.json - AccountCreateOAuthResponseExample: + $ref: examples/json/AccountCreateResponse.json + AccountCreateOAuthResponse: summary: 'Account Create with OAuth Authorization' value: - $ref: examples/json/AccountCreateOAuthResponseExample.json - AccountGetResponseExample: + $ref: examples/json/AccountCreateOAuthResponse.json + AccountGetResponse: summary: 'Account Get' value: - $ref: examples/json/AccountGetResponseExample.json - AccountVerifyFoundResponseExample: + $ref: examples/json/AccountGetResponse.json + AccountVerifyFoundResponse: summary: 'Account Found' value: - $ref: examples/json/AccountVerifyFoundResponseExample.json - AccountVerifyNotFoundResponseExample: + $ref: examples/json/AccountVerifyFoundResponse.json + AccountVerifyNotFoundResponse: summary: 'Account Not Found' value: - $ref: examples/json/AccountVerifyNotFoundResponseExample.json - ApiAppGetResponseExample: + $ref: examples/json/AccountVerifyNotFoundResponse.json + ApiAppGetResponse: summary: 'API App' value: - $ref: examples/json/ApiAppGetResponseExample.json - ApiAppListResponseExample: + $ref: examples/json/ApiAppGetResponse.json + ApiAppListResponse: summary: 'API App List' value: - $ref: examples/json/ApiAppListResponseExample.json - BulkSendJobGetResponseExample: + $ref: examples/json/ApiAppListResponse.json + BulkSendJobGetResponse: summary: 'Bulk Send Job' value: - $ref: examples/json/BulkSendJobGetResponseExample.json - BulkSendJobListResponseExample: + $ref: examples/json/BulkSendJobGetResponse.json + BulkSendJobListResponse: summary: 'Bulk Send Job List' value: - $ref: examples/json/BulkSendJobListResponseExample.json - EmbeddedEditUrlResponseExample: + $ref: examples/json/BulkSendJobListResponse.json + EmbeddedEditUrlResponse: summary: 'Embedded Edit URL' value: - $ref: examples/json/EmbeddedEditUrlResponseExample.json - EmbeddedSignUrlResponseExample: + $ref: examples/json/EmbeddedEditUrlResponse.json + EmbeddedSignUrlResponse: summary: 'Embedded Sign URL' value: - $ref: examples/json/EmbeddedSignUrlResponseExample.json - Error400ResponseExample: + $ref: examples/json/EmbeddedSignUrlResponse.json + Error400Response: summary: 'Error 400 bad_request' value: - $ref: examples/json/Error400ResponseExample.json - Error401ResponseExample: + $ref: examples/json/Error400Response.json + Error401Response: summary: 'Error 401 unauthorized' value: - $ref: examples/json/Error401ResponseExample.json - Error402ResponseExample: + $ref: examples/json/Error401Response.json + Error402Response: summary: 'Error 402 payment_required' value: - $ref: examples/json/Error402ResponseExample.json - Error403ResponseExample: + $ref: examples/json/Error402Response.json + Error403Response: summary: 'Error 403 forbidden' value: - $ref: examples/json/Error403ResponseExample.json - Error404ResponseExample: + $ref: examples/json/Error403Response.json + Error404Response: summary: 'Error 404 not_found' value: - $ref: examples/json/Error404ResponseExample.json - Error409ResponseExample: + $ref: examples/json/Error404Response.json + Error409Response: summary: 'Error 409 conflict' value: - $ref: examples/json/Error409ResponseExample.json - Error410ResponseExample: + $ref: examples/json/Error409Response.json + Error410Response: summary: 'Error 410 deleted' value: - $ref: examples/json/Error410ResponseExample.json - Error422ResponseExample: + $ref: examples/json/Error410Response.json + Error422Response: summary: 'Error 422 unprocessable_entity' value: - $ref: examples/json/Error422ResponseExample.json - Error429ResponseExample: + $ref: examples/json/Error422Response.json + Error429Response: summary: 'Error 429 exceeded_rate' value: - $ref: examples/json/Error429ResponseExample.json - Error4XXResponseExample: + $ref: examples/json/Error429Response.json + Error4XXResponse: summary: 'Error 4XX failed_operation' value: - $ref: examples/json/Error4XXResponseExample.json - FaxGetResponseExample: + $ref: examples/json/Error4XXResponse.json + FaxGetResponse: summary: 'Fax Response' value: - $ref: examples/json/FaxGetResponseExample.json - FaxLineResponseExample: + $ref: examples/json/FaxGetResponse.json + FaxLineResponse: summary: 'Sample Fax Line Response' value: - $ref: examples/json/FaxLineResponseExample.json - FaxLineAreaCodeGetResponseExample: + $ref: examples/json/FaxLineResponse.json + FaxLineAreaCodeGetResponse: summary: 'Sample Area Code Response' value: - $ref: examples/json/FaxLineAreaCodeGetResponseExample.json - FaxLineListResponseExample: + $ref: examples/json/FaxLineAreaCodeGetResponse.json + FaxLineListResponse: summary: 'Sample Fax Line List Response' value: - $ref: examples/json/FaxLineListResponseExample.json - FaxListResponseExample: - summary: 'Returns the properties and settings of multiple Faxes.' + $ref: examples/json/FaxLineListResponse.json + FaxListResponse: + summary: 'Returns the properties and settings of multiple Faxes' value: - $ref: examples/json/FaxListResponseExample.json - ReportCreateResponseExample: + $ref: examples/json/FaxListResponse.json + ReportCreateResponse: summary: Report value: - $ref: examples/json/ReportCreateResponseExample.json - SignatureRequestGetResponseExample: + $ref: examples/json/ReportCreateResponse.json + SignatureRequestGetResponse: summary: 'Get Signature Request' value: - $ref: examples/json/SignatureRequestGetResponseExample.json - SignatureRequestListResponseExample: + $ref: examples/json/SignatureRequestGetResponse.json + SignatureRequestListResponse: summary: 'List Signature Requests' value: - $ref: examples/json/SignatureRequestListResponseExample.json - AccountUpdateResponseExample: + $ref: examples/json/SignatureRequestListResponse.json + AccountUpdateResponse: summary: 'Account Update' value: - $ref: examples/json/AccountUpdateResponseExample.json - OAuthTokenGenerateResponseExample: + $ref: examples/json/AccountUpdateResponse.json + OAuthTokenGenerateResponse: summary: 'Retrieving the OAuth token' value: - $ref: examples/json/OAuthTokenGenerateResponseExample.json - OAuthTokenRefreshResponseExample: + $ref: examples/json/OAuthTokenGenerateResponse.json + OAuthTokenRefreshResponse: summary: 'Refresh an existing OAuth token' value: - $ref: examples/json/OAuthTokenRefreshResponseExample.json - ApiAppCreateResponseExample: + $ref: examples/json/OAuthTokenRefreshResponse.json + ApiAppCreateResponse: summary: 'API App' value: - $ref: examples/json/ApiAppCreateResponseExample.json - ApiAppUpdateResponseExample: + $ref: examples/json/ApiAppCreateResponse.json + ApiAppUpdateResponse: summary: 'API App Update' value: - $ref: examples/json/ApiAppUpdateResponseExample.json - SignatureRequestCreateEmbeddedResponseExample: + $ref: examples/json/ApiAppUpdateResponse.json + SignatureRequestCreateEmbeddedResponse: summary: 'Create Embedded Signature Request' value: - $ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json - SignatureRequestCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json + SignatureRequestCreateEmbeddedWithTemplateResponse: summary: 'Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json - SignatureRequestFilesResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json + SignatureRequestFilesResponse: summary: 'Signature Requests Files' value: - $ref: examples/json/SignatureRequestFilesResponseExample.json - SignatureRequestReleaseHoldResponseExample: + $ref: examples/json/SignatureRequestFilesResponse.json + SignatureRequestReleaseHoldResponse: summary: 'Send Signature Release Hold' value: - $ref: examples/json/SignatureRequestReleaseHoldResponseExample.json - SignatureRequestRemindResponseExample: + $ref: examples/json/SignatureRequestReleaseHoldResponse.json + SignatureRequestRemindResponse: summary: 'Send Signature Request Reminder' value: - $ref: examples/json/SignatureRequestRemindResponseExample.json - SignatureRequestSendResponseExample: + $ref: examples/json/SignatureRequestRemindResponse.json + SignatureRequestSendResponse: summary: 'Send Signature Request' value: - $ref: examples/json/SignatureRequestSendResponseExample.json - SignatureRequestSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestSendResponse.json + SignatureRequestSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json - SignatureRequestUpdateResponseExample: + $ref: examples/json/SignatureRequestSendWithTemplateResponse.json + SignatureRequestUpdateResponse: summary: 'Signature Request Update' value: - $ref: examples/json/SignatureRequestUpdateResponseExample.json - SignatureRequestBulkSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestUpdateResponse.json + SignatureRequestBulkSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json + SignatureRequestBulkCreateEmbeddedWithTemplateResponse: summary: 'Bulk Send Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json - TeamCreateResponseExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json + TeamCreateResponse: summary: 'Team Create' value: - $ref: examples/json/TeamCreateResponseExample.json - TeamMembersResponseExample: + $ref: examples/json/TeamCreateResponse.json + TeamMembersResponse: summary: 'Team Members List' value: - $ref: examples/json/TeamMembersResponseExample.json - TeamRemoveMemberResponseExample: + $ref: examples/json/TeamMembersResponse.json + TeamRemoveMemberResponse: summary: 'Team Remove Member' value: - $ref: examples/json/TeamRemoveMemberResponseExample.json - TeamUpdateResponseExample: + $ref: examples/json/TeamRemoveMemberResponse.json + TeamUpdateResponse: summary: 'Team Update' value: - $ref: examples/json/TeamUpdateResponseExample.json - TeamDoesNotExistResponseExample: + $ref: examples/json/TeamUpdateResponse.json + TeamDoesNotExistResponse: summary: 'Team Does Not Exist' value: - $ref: examples/json/TeamDoesNotExistResponseExample.json - TemplateAddUserResponseExample: + $ref: examples/json/TeamDoesNotExistResponse.json + TemplateAddUserResponse: summary: 'Add User to Template' value: - $ref: examples/json/TemplateAddUserResponseExample.json - TemplateFilesResponseExample: + $ref: examples/json/TemplateAddUserResponse.json + TemplateFilesResponse: summary: 'Template Files' value: - $ref: examples/json/TemplateFilesResponseExample.json - TemplateRemoveUserResponseExample: + $ref: examples/json/TemplateFilesResponse.json + TemplateRemoveUserResponse: summary: 'Remove User from Template' value: - $ref: examples/json/TemplateRemoveUserResponseExample.json - UnclaimedDraftCreateEmbeddedResponseExample: + $ref: examples/json/TemplateRemoveUserResponse.json + UnclaimedDraftCreateEmbeddedResponse: summary: 'Unclaimed Draft Create Embedded' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json - UnclaimedDraftCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json + UnclaimedDraftCreateEmbeddedWithTemplateResponse: summary: 'Unclaimed Draft Create Embedded With Template' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json - UnclaimedDraftEditAndResendExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json + UnclaimedDraftEditAndResend: summary: 'Unclaimed Draft Edit and Resend' value: - $ref: examples/json/UnclaimedDraftEditAndResendExample.json - TeamGetResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResend.json + TeamGetResponse: summary: 'Team Get' value: - $ref: examples/json/TeamGetResponseExample.json - TeamGetInfoResponseExample: + $ref: examples/json/TeamGetResponse.json + TeamGetInfoResponse: summary: 'Team Get Info' value: - $ref: examples/json/TeamGetInfoResponseExample.json - TeamInvitesResponseExample: + $ref: examples/json/TeamGetInfoResponse.json + TeamInvitesResponse: summary: 'Team Invites' value: - $ref: examples/json/TeamInvitesResponseExample.json - TeamAddMemberResponseExample: + $ref: examples/json/TeamInvitesResponse.json + TeamAddMemberResponse: summary: 'Team Add Member' value: - $ref: examples/json/TeamAddMemberResponseExample.json - TeamSubTeamsResponseExample: + $ref: examples/json/TeamAddMemberResponse.json + TeamSubTeamsResponse: summary: 'Team Sub Teams List' value: - $ref: examples/json/TeamSubTeamsResponseExample.json - TemplateCreateResponseExample: + $ref: examples/json/TeamSubTeamsResponse.json + TemplateCreateResponse: summary: 'Create Template' value: - $ref: examples/json/TemplateCreateResponseExample.json - TemplateCreateEmbeddedDraftResponseExample: + $ref: examples/json/TemplateCreateResponse.json + TemplateCreateEmbeddedDraftResponse: summary: 'Create Embedded Draft Template' value: - $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json - TemplateGetResponseExample: + $ref: examples/json/TemplateCreateEmbeddedDraftResponse.json + TemplateGetResponse: summary: 'Get Template' value: - $ref: examples/json/TemplateGetResponseExample.json - TemplateListResponseExample: + $ref: examples/json/TemplateGetResponse.json + TemplateListResponse: summary: 'List Templates' value: - $ref: examples/json/TemplateListResponseExample.json - TemplateUpdateFilesResponseExample: + $ref: examples/json/TemplateListResponse.json + TemplateUpdateFilesResponse: summary: 'Update Template Files' value: - $ref: examples/json/TemplateUpdateFilesResponseExample.json - UnclaimedDraftCreateResponseExample: + $ref: examples/json/TemplateUpdateFilesResponse.json + UnclaimedDraftCreateResponse: summary: 'Unclaimed Draft Create' value: - $ref: examples/json/UnclaimedDraftCreateResponseExample.json - EventCallbackAccountSignatureRequestSentExample: + $ref: examples/json/UnclaimedDraftCreateResponse.json + EventCallbackAccountSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json - EventCallbackAccountTemplateCreatedExample: + $ref: examples/json/EventCallbackAccountSignatureRequestSent.json + EventCallbackAccountTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json - EventCallbackAppAccountConfirmedExample: + $ref: examples/json/EventCallbackAccountTemplateCreated.json + EventCallbackAppAccountConfirmed: summary: 'Example: account_confirmed' value: - $ref: examples/json/EventCallbackAppAccountConfirmedExample.json - EventCallbackAppSignatureRequestSentExample: + $ref: examples/json/EventCallbackAppAccountConfirmed.json + EventCallbackAppSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json - EventCallbackAppTemplateCreatedExample: + $ref: examples/json/EventCallbackAppSignatureRequestSent.json + EventCallbackAppTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAppTemplateCreatedExample.json + $ref: examples/json/EventCallbackAppTemplateCreated.json requestBodies: EventCallbackAccountRequest: description: |- @@ -13588,9 +14229,9 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAccountSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAccountTemplateCreated' EventCallbackAppRequest: description: |- **API App Callback Payloads --** @@ -13601,11 +14242,11 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: account_confirmed_example: - $ref: '#/components/examples/EventCallbackAppAccountConfirmedExample' + $ref: '#/components/examples/EventCallbackAppAccountConfirmed' signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAppSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAppSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAppTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAppTemplateCreated' headers: X-RateLimit-Limit: description: 'The maximum number of requests per hour that you can make.' @@ -13642,6 +14283,7 @@ components: security: - api_key: [] + - oauth2: - account_access - signature_request_access @@ -13669,37 +14311,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: @@ -13722,37 +14359,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: diff --git a/run-build b/run-build index 7127d64..dc37a2c 100755 --- a/run-build +++ b/run-build @@ -18,7 +18,7 @@ rm -f "${DIR}/lib/dropbox-sign/models/"*.rb docker run --rm \ -v "${DIR}/:/local" \ - openapitools/openapi-generator-cli:v7.8.0 generate \ + openapitools/openapi-generator-cli:v7.12.0 generate \ -i "/local/openapi-sdk.yaml" \ -c "/local/openapi-config.yaml" \ -t "/local/templates" \ diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index a365de3..bf9c234 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -6,7 +6,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 diff --git a/templates/README.mustache b/templates/README.mustache index a8e4a9c..0fe015e 100644 --- a/templates/README.mustache +++ b/templates/README.mustache @@ -110,9 +110,9 @@ require '{{{gemName}}}' # Configure a proc to get access tokens in lieu of the static access_token configuration config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isBasicBearer}}{{/isBasic}}{{#isApiKey}} # Configure API key authorization: {{{name}}} - config.api_key['{{{name}}}'] = 'YOUR API KEY' + config.api_key['{{{keyParamName}}}'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['{{{name}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}} + # config.api_key_prefix['{{{keyParamName}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}} # Configure OAuth2 access token for authorization: {{{name}}} config.access_token = 'YOUR ACCESS TOKEN' # Configure a proc to get access tokens in lieu of the static access_token configuration diff --git a/templates/api_client_typhoeus_partial.mustache b/templates/api_client_typhoeus_partial.mustache index 39792eb..f55f980 100644 --- a/templates/api_client_typhoeus_partial.mustache +++ b/templates/api_client_typhoeus_partial.mustache @@ -4,7 +4,8 @@ # the data deserialized from response body (may be a Tempfile or nil), response status code and response headers. def call_api(http_method, path, opts = {}) request = build_request(http_method, path, opts) - tempfile = download_file(request) if opts[:return_type] == 'File' + tempfile = nil + (download_file(request) { tempfile = _1 }) if opts[:return_type] == 'File' response = request.run if @config.debugging @@ -145,17 +146,15 @@ chunk.force_encoding(encoding) tempfile.write(chunk) end - # run the request to ensure the tempfile is created successfully before returning it - request.run - if tempfile + request.on_complete do + if !tempfile + fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") + end tempfile.close @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\ "will be deleted automatically with GC. It's also recommended to delete the temp file "\ "explicitly with `tempfile.delete`" - else - fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") + yield tempfile if block_given? end - - tempfile end diff --git a/templates/api_doc.mustache b/templates/api_doc.mustache index 818343d..f58a833 100644 --- a/templates/api_doc.mustache +++ b/templates/api_doc.mustache @@ -50,9 +50,9 @@ require '{{{gemName}}}' # Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}} config.access_token = 'YOUR_BEARER_TOKEN'{{/isBasicBearer}}{{/isBasic}}{{#isApiKey}} # Configure API key authorization: {{{name}}} - config.api_key['{{{name}}}'] = 'YOUR API KEY' + config.api_key['{{{keyParamName}}}'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - # config.api_key_prefix['{{{name}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}} + # config.api_key_prefix['{{{keyParamName}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}} # Configure OAuth2 access token for authorization: {{{name}}} config.access_token = 'YOUR ACCESS TOKEN'{{/isOAuth}} {{/authMethods}}end diff --git a/templates/configuration.mustache b/templates/configuration.mustache index 3127903..ef53ee3 100644 --- a/templates/configuration.mustache +++ b/templates/configuration.mustache @@ -237,7 +237,7 @@ module {{moduleName}} type: 'api_key', in: {{#isKeyInHeader}}'header'{{/isKeyInHeader}}{{#isKeyInQuery}}'query'{{/isKeyInQuery}}, key: '{{keyParamName}}', - value: api_key_with_prefix('{{name}}'{{#vendorExtensions.x-auth-id-alias}}, '{{.}}'{{/vendorExtensions.x-auth-id-alias}}) + value: api_key_with_prefix('{{keyParamName}}'{{#vendorExtensions.x-auth-id-alias}}, '{{.}}'{{/vendorExtensions.x-auth-id-alias}}) }, {{/isApiKey}} {{#isBasic}} diff --git a/templates/partial_model_generic.mustache b/templates/partial_model_generic.mustache index 4d9c5a8..62bfd78 100644 --- a/templates/partial_model_generic.mustache +++ b/templates/partial_model_generic.mustache @@ -45,16 +45,21 @@ } end - # Returns all the JSON keys this model knows about{{#parent}}, including the ones defined in its parent(s){{/parent}} - def self.acceptable_attributes + # Returns attribute mapping this model knows about{{#parent}}, including the ones defined in its parent(s){{/parent}} + def self.acceptable_attribute_map {{^parent}} - attribute_map.values + attribute_map {{/parent}} {{#parent}} - attribute_map.values.concat(superclass.acceptable_attributes) + superclass.acceptable_attribute_map.merge(attribute_map) {{/parent}} end + # Returns all the JSON keys this model knows about{{#parent}}, including the ones defined in its parent(s){{/parent}} + def self.acceptable_attributes + acceptable_attribute_map.values + end + # Attribute type mapping. def self.openapi_types { @@ -182,14 +187,15 @@ end # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map attributes = attributes.each_with_object({}) { |(k, v), h| {{^useCustomTemplateCode}} - if (!self.class.attribute_map.key?(k.to_sym)) + if (!acceptable_attribute_map.key?(k.to_sym)) {{/useCustomTemplateCode}} {{#useCustomTemplateCode}} if (!self.class.merged_attributes.key?(k.to_sym)) {{/useCustomTemplateCode}} - fail ArgumentError, "`#{k}` is not a valid attribute in `{{{moduleName}}}::{{{classname}}}`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `{{{moduleName}}}::{{{classname}}}`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect end h[k.to_sym] = v } @@ -437,6 +443,22 @@ @{{{name}}} = {{{name}}} end + {{/hasValidation}} + {{^hasValidation}} + {{^isNullable}} + {{#required}} + # Custom attribute writer method with validation + # @param [Object] {{{name}}} Value to be assigned + def {{{name}}}=({{{name}}}) + if {{{name}}}.nil? + fail ArgumentError, '{{{name}}} cannot be nil' + end + + @{{{name}}} = {{{name}}} + end + + {{/required}} + {{/isNullable}} {{/hasValidation}} {{/isEnum}} {{/vars}}