dropbox-sign 1.0.0.pre.beta2301

data/docs/ApiAppApi.md

@@ -0,0 +1,402 @@
+# Dropbox::Sign::ApiAppApi
+
+All URIs are relative to *https://api.hellosign.com/v3*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [`api_app_create`](ApiAppApi.md#api_app_create) | **POST** `/api_app` | Create API App |
+| [`api_app_delete`](ApiAppApi.md#api_app_delete) | **DELETE** `/api_app/{client_id}` | Delete API App |
+| [`api_app_get`](ApiAppApi.md#api_app_get) | **GET** `/api_app/{client_id}` | Get API App |
+| [`api_app_list`](ApiAppApi.md#api_app_list) | **GET** `/api_app/list` | List API Apps |
+| [`api_app_update`](ApiAppApi.md#api_app_update) | **PUT** `/api_app/{client_id}` | Update API App |
+
+
+## `api_app_create`
+
+> `<ApiAppGetResponse> api_app_create(api_app_create_request)`
+
+Create API App
+
+Creates a new API App.
+
+### Examples
+
+```ruby
+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
+
+```
+
+#### Using the `api_app_create_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<ApiAppGetResponse>, Integer, Hash)> api_app_create_with_http_info(api_app_create_request)`
+
+```ruby
+begin
+  # Create API App
+  data, status_code, headers = api_instance.api_app_create_with_http_info(api_app_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiAppGetResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling ApiAppApi->api_app_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `api_app_create_request` | [**ApiAppCreateRequest**](ApiAppCreateRequest.md) |  |  |
+
+### Return type
+
+[**ApiAppGetResponse**](ApiAppGetResponse.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
+
+
+## `api_app_delete`
+
+> `api_app_delete(client_id)`
+
+Delete API App
+
+Deletes an API App. Can only be invoked for apps you own.
+
+### Examples
+
+```ruby
+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
+
+```
+
+#### Using the `api_app_delete_with_http_info` variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> `<Array(nil, Integer, Hash)> api_app_delete_with_http_info(client_id)`
+
+```ruby
+begin
+  # Delete API App
+  data, status_code, headers = api_instance.api_app_delete_with_http_info(client_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling ApiAppApi->api_app_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `client_id` | **String** | The client id of the API App to delete. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## `api_app_get`
+
+> `<ApiAppGetResponse> api_app_get(client_id)`
+
+Get API App
+
+Returns an object with information about an API App.
+
+### Examples
+
+```ruby
+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
+
+```
+
+#### Using the `api_app_get_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<ApiAppGetResponse>, Integer, Hash)> api_app_get_with_http_info(client_id)`
+
+```ruby
+begin
+  # Get API App
+  data, status_code, headers = api_instance.api_app_get_with_http_info(client_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiAppGetResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling ApiAppApi->api_app_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `client_id` | **String** | The client id of the API App to retrieve. |  |
+
+### Return type
+
+[**ApiAppGetResponse**](ApiAppGetResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## `api_app_list`
+
+> `<ApiAppListResponse> api_app_list(opts)`
+
+List API Apps
+
+Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.
+
+### Examples
+
+```ruby
+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
+
+```
+
+#### Using the `api_app_list_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<ApiAppListResponse>, Integer, Hash)> api_app_list_with_http_info(opts)`
+
+```ruby
+begin
+  # List API Apps
+  data, status_code, headers = api_instance.api_app_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiAppListResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling ApiAppApi->api_app_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `page` | **Integer** | Which page number of the API App 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
+
+[**ApiAppListResponse**](ApiAppListResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## `api_app_update`
+
+> `<ApiAppGetResponse> api_app_update(client_id, api_app_update_request)`
+
+Update API App
+
+Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.
+
+### Examples
+
+```ruby
+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
+
+```
+
+#### Using the `api_app_update_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<ApiAppGetResponse>, Integer, Hash)> api_app_update_with_http_info(client_id, api_app_update_request)`
+
+```ruby
+begin
+  # Update API App
+  data, status_code, headers = api_instance.api_app_update_with_http_info(client_id, api_app_update_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiAppGetResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling ApiAppApi->api_app_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `client_id` | **String** | The client id of the API App to update. |  |
+| `api_app_update_request` | [**ApiAppUpdateRequest**](ApiAppUpdateRequest.md) |  |  |
+
+### Return type
+
+[**ApiAppGetResponse**](ApiAppGetResponse.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
+

data/docs/ApiAppCreateRequest.md

@@ -0,0 +1,16 @@
+# Dropbox::Sign::ApiAppCreateRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `domains`<sup>*_required_</sup> | ```Array<String>``` |  The domain names the ApiApp will be associated with.  |  |
+| `name`<sup>*_required_</sup> | ```String``` |  The name you want to assign to the ApiApp.  |  |
+| `callback_url` | ```String``` |  The URL at which the ApiApp should receive event callbacks.  |  |
+| `custom_logo_file` | ```File``` |  An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)  |  |
+| `oauth` | [```SubOAuth```](SubOAuth.md) |    |  |
+| `options` | [```SubOptions```](SubOptions.md) |    |  |
+| `white_labeling_options` | [```SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) |    |  |
+

data/docs/ApiAppGetResponse.md

@@ -0,0 +1,11 @@
+# Dropbox::Sign::ApiAppGetResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `api_app` | [```ApiAppResponse```](ApiAppResponse.md) |    |  |
+| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) |  A list of warnings.  |  |
+

data/docs/ApiAppListResponse.md

@@ -0,0 +1,12 @@
+# Dropbox::Sign::ApiAppListResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `api_apps` | [```Array<ApiAppResponse>```](ApiAppResponse.md) |  Contains information about API Apps.  |  |
+| `list_info` | [```ListInfoResponse```](ListInfoResponse.md) |    |  |
+| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) |  A list of warnings.  |  |
+

data/docs/ApiAppResponse.md

@@ -0,0 +1,19 @@
+# Dropbox::Sign::ApiAppResponse
+
+Contains information about an API App.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `callback_url` | ```String``` |  The app's callback URL (for events)  |  |
+| `client_id` | ```String``` |  The app's client id  |  |
+| `created_at` | ```Integer``` |  The time that the app was created  |  |
+| `domains` | ```Array<String>``` |  The domain name(s) associated with the app  |  |
+| `name` | ```String``` |  The name of the app  |  |
+| `is_approved` | ```Boolean``` |  Boolean to indicate if the app has been approved  |  |
+| `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) |    |  |
+| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) |    |  |
+| `owner_account` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) |    |  |
+| `white_labeling_options` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) |    |  |
+

data/docs/ApiAppResponseOAuth.md

@@ -0,0 +1,13 @@
+# Dropbox::Sign::ApiAppResponseOAuth
+
+An object describing the app's OAuth properties, or null if OAuth is not configured for the app.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `callback_url` | ```String``` |  The app's OAuth callback URL.  |  |
+| `secret` | ```String``` |  The app's OAuth secret, or null if the app does not belong to user.  |  |
+| `scopes` | ```Array<String>``` |  Array of OAuth scopes used by the app.  |  |
+| `charges_users` | ```Boolean``` |  Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.  |  |
+

data/docs/ApiAppResponseOptions.md

@@ -0,0 +1,10 @@
+# Dropbox::Sign::ApiAppResponseOptions
+
+An object with options that override account settings.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `can_insert_everywhere` | ```Boolean``` |  Boolean denoting if signers can "Insert Everywhere" in one click while signing a document  |  |
+

data/docs/ApiAppResponseOwnerAccount.md

@@ -0,0 +1,11 @@
+# Dropbox::Sign::ApiAppResponseOwnerAccount
+
+An object describing the app's owner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `account_id` | ```String``` |  The owner account's ID  |  |
+| `email_address` | ```String``` |  The owner account's email address  |  |
+

data/docs/ApiAppResponseWhiteLabelingOptions.md

@@ -0,0 +1,23 @@
+# Dropbox::Sign::ApiAppResponseWhiteLabelingOptions
+
+An object with options to customize the app's signer page
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `header_background_color` | ```String``` |    |  |
+| `legal_version` | ```String``` |    |  |
+| `link_color` | ```String``` |    |  |
+| `page_background_color` | ```String``` |    |  |
+| `primary_button_color` | ```String``` |    |  |
+| `primary_button_color_hover` | ```String``` |    |  |
+| `primary_button_text_color` | ```String``` |    |  |
+| `primary_button_text_color_hover` | ```String``` |    |  |
+| `secondary_button_color` | ```String``` |    |  |
+| `secondary_button_color_hover` | ```String``` |    |  |
+| `secondary_button_text_color` | ```String``` |    |  |
+| `secondary_button_text_color_hover` | ```String``` |    |  |
+| `text_color1` | ```String``` |    |  |
+| `text_color2` | ```String``` |    |  |
+

data/docs/ApiAppUpdateRequest.md

@@ -0,0 +1,16 @@
+# Dropbox::Sign::ApiAppUpdateRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `callback_url` | ```String``` |  The URL at which the API App should receive event callbacks.  |  |
+| `custom_logo_file` | ```File``` |  An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)  |  |
+| `domains` | ```Array<String>``` |  The domain names the ApiApp will be associated with.  |  |
+| `name` | ```String``` |  The name you want to assign to the ApiApp.  |  |
+| `oauth` | [```SubOAuth```](SubOAuth.md) |    |  |
+| `options` | [```SubOptions```](SubOptions.md) |    |  |
+| `white_labeling_options` | [```SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) |    |  |
+

data/docs/BulkSendJobApi.md

@@ -0,0 +1,155 @@
+# Dropbox::Sign::BulkSendJobApi
+
+All URIs are relative to *https://api.hellosign.com/v3*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [`bulk_send_job_get`](BulkSendJobApi.md#bulk_send_job_get) | **GET** `/bulk_send_job/{bulk_send_job_id}` | Get Bulk Send Job |
+| [`bulk_send_job_list`](BulkSendJobApi.md#bulk_send_job_list) | **GET** `/bulk_send_job/list` | List Bulk Send Jobs |
+
+
+## `bulk_send_job_get`
+
+> `<BulkSendJobGetResponse> bulk_send_job_get(bulk_send_job_id)`
+
+Get Bulk Send Job
+
+Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
+
+### Examples
+
+```ruby
+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
+
+```
+
+#### Using the `bulk_send_job_get_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<BulkSendJobGetResponse>, Integer, Hash)> bulk_send_job_get_with_http_info(bulk_send_job_id)`
+
+```ruby
+begin
+  # Get Bulk Send Job
+  data, status_code, headers = api_instance.bulk_send_job_get_with_http_info(bulk_send_job_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkSendJobGetResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling BulkSendJobApi->bulk_send_job_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `bulk_send_job_id` | **String** | The id of the BulkSendJob to retrieve. |  |
+
+### Return type
+
+[**BulkSendJobGetResponse**](BulkSendJobGetResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## `bulk_send_job_list`
+
+> `<BulkSendJobListResponse> bulk_send_job_list(opts)`
+
+List Bulk Send Jobs
+
+Returns a list of BulkSendJob that you can access.
+
+### Examples
+
+```ruby
+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
+
+```
+
+#### Using the `bulk_send_job_list_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<BulkSendJobListResponse>, Integer, Hash)> bulk_send_job_list_with_http_info(opts)`
+
+```ruby
+begin
+  # List Bulk Send Jobs
+  data, status_code, headers = api_instance.bulk_send_job_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkSendJobListResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling BulkSendJobApi->bulk_send_job_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `page` | **Integer** | Which page number of the BulkSendJob 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
+
+[**BulkSendJobListResponse**](BulkSendJobListResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+