dropbox-sign 1.0.0.pre.beta2301

data/docs/BulkSendJobGetResponse.md

@@ -0,0 +1,13 @@
+# Dropbox::Sign::BulkSendJobGetResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `bulk_send_job` | [```BulkSendJobResponse```](BulkSendJobResponse.md) |    |  |
+| `list_info` | [```ListInfoResponse```](ListInfoResponse.md) |    |  |
+| `signature_requests` | [```Array<BulkSendJobGetResponseSignatureRequests>```](BulkSendJobGetResponseSignatureRequests.md) |  Contains information about the Signature Requests sent in bulk.  |  |
+| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) |  A list of warnings.  |  |
+

data/docs/BulkSendJobGetResponseSignatureRequests.md

@@ -0,0 +1,33 @@
+# Dropbox::Sign::BulkSendJobGetResponseSignatureRequests
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `test_mode` | ```Boolean``` |  Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.  |  [default to false] |
+| `signature_request_id` | ```String``` |  The id of the SignatureRequest.  |  |
+| `requester_email_address` | ```String``` |  The email address of the initiator of the SignatureRequest.  |  |
+| `title` | ```String``` |  The title the specified Account uses for the SignatureRequest.  |  |
+| `original_title` | ```String``` |  Default Label for account.  |  |
+| `subject` | ```String``` |  The subject in the email that was initially sent to the signers.  |  |
+| `message` | ```String``` |  The custom message in the email that was initially sent to the signers.  |  |
+| `metadata` | ```Object``` |  The metadata attached to the signature request.  |  |
+| `created_at` | ```Integer``` |  Time the signature request was created.  |  |
+| `expires_at` | ```Integer``` |  The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.  |  |
+| `is_complete` | ```Boolean``` |  Whether or not the SignatureRequest has been fully executed by all signers.  |  |
+| `is_declined` | ```Boolean``` |  Whether or not the SignatureRequest has been declined by a signer.  |  |
+| `has_error` | ```Boolean``` |  Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).  |  |
+| `files_url` | ```String``` |  The URL where a copy of the request's documents can be downloaded.  |  |
+| `signing_url` | ```String``` |  The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.  |  |
+| `details_url` | ```String``` |  The URL where the requester and the signers can view the current status of the SignatureRequest.  |  |
+| `cc_email_addresses` | ```Array<String>``` |  A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.  |  |
+| `signing_redirect_url` | ```String``` |  The URL you want the signer redirected to after they successfully sign.  |  |
+| `template_ids` | ```Array<String>``` |  Templates IDs used in this SignatureRequest (if any).  |  |
+| `custom_fields` | [```Array<SignatureRequestResponseCustomFieldBase>```](SignatureRequestResponseCustomFieldBase.md) |  An array of Custom Field objects containing the name and type of each custom field.<br><br>* Text Field uses `SignatureRequestResponseCustomFieldText`<br>* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`  |  |
+| `attachments` | [```Array<SignatureRequestResponseAttachment>```](SignatureRequestResponseAttachment.md) |  Signer attachments.  |  |
+| `response_data` | [```Array<SignatureRequestResponseDataBase>```](SignatureRequestResponseDataBase.md) |  An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.  |  |
+| `signatures` | [```Array<SignatureRequestResponseSignatures>```](SignatureRequestResponseSignatures.md) |  An array of signature objects, 1 for each signer.  |  |
+| `bulk_send_job_id` | ```String``` |  The id of the BulkSendJob.  |  |
+

data/docs/BulkSendJobListResponse.md

@@ -0,0 +1,12 @@
+# Dropbox::Sign::BulkSendJobListResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `bulk_send_jobs` | [```Array<BulkSendJobResponse>```](BulkSendJobResponse.md) |  Contains a list of BulkSendJobs that the API caller has access to.  |  |
+| `list_info` | [```ListInfoResponse```](ListInfoResponse.md) |    |  |
+| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) |  A list of warnings.  |  |
+

data/docs/BulkSendJobResponse.md

@@ -0,0 +1,13 @@
+# Dropbox::Sign::BulkSendJobResponse
+
+Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `bulk_send_job_id` | ```String``` |  The id of the BulkSendJob.  |  |
+| `total` | ```Integer``` |  The total amount of Signature Requests queued for sending.  |  |
+| `is_creator` | ```Boolean``` |  True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.  |  |
+| `created_at` | ```Integer``` |  Time that the BulkSendJob was created.  |  |
+

data/docs/BulkSendJobSendResponse.md

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

data/docs/EmbeddedApi.md

@@ -0,0 +1,158 @@
+# Dropbox::Sign::EmbeddedApi
+
+All URIs are relative to *https://api.hellosign.com/v3*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [`embedded_edit_url`](EmbeddedApi.md#embedded_edit_url) | **POST** `/embedded/edit_url/{template_id}` | Get Embedded Template Edit URL |
+| [`embedded_sign_url`](EmbeddedApi.md#embedded_sign_url) | **GET** `/embedded/sign_url/{signature_id}` | Get Embedded Sign URL |
+
+
+## `embedded_edit_url`
+
+> `<EmbeddedEditUrlResponse> embedded_edit_url(template_id, embedded_edit_url_request)`
+
+Get Embedded Template Edit URL
+
+Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.
+
+### 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 = 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
+
+```
+
+#### Using the `embedded_edit_url_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<EmbeddedEditUrlResponse>, Integer, Hash)> embedded_edit_url_with_http_info(template_id, embedded_edit_url_request)`
+
+```ruby
+begin
+  # Get Embedded Template Edit URL
+  data, status_code, headers = api_instance.embedded_edit_url_with_http_info(template_id, embedded_edit_url_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmbeddedEditUrlResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling EmbeddedApi->embedded_edit_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template_id` | **String** | The id of the template to edit. |  |
+| `embedded_edit_url_request` | [**EmbeddedEditUrlRequest**](EmbeddedEditUrlRequest.md) |  |  |
+
+### Return type
+
+[**EmbeddedEditUrlResponse**](EmbeddedEditUrlResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## `embedded_sign_url`
+
+> `<EmbeddedSignUrlResponse> embedded_sign_url(signature_id)`
+
+Get Embedded Sign URL
+
+Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.
+
+### 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 = 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
+
+```
+
+#### Using the `embedded_sign_url_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<EmbeddedSignUrlResponse>, Integer, Hash)> embedded_sign_url_with_http_info(signature_id)`
+
+```ruby
+begin
+  # Get Embedded Sign URL
+  data, status_code, headers = api_instance.embedded_sign_url_with_http_info(signature_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmbeddedSignUrlResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling EmbeddedApi->embedded_sign_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `signature_id` | **String** | The id of the signature to get a signature url for. |  |
+
+### Return type
+
+[**EmbeddedSignUrlResponse**](EmbeddedSignUrlResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/EmbeddedEditUrlRequest.md

@@ -0,0 +1,19 @@
+# Dropbox::Sign::EmbeddedEditUrlRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `allow_edit_ccs` | ```Boolean``` |  This allows the requester to enable/disable to add or change CC roles when editing the template.  |  [default to false] |
+| `cc_roles` | ```Array<String>``` |  The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.  |  |
+| `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) |    |  |
+| `force_signer_roles` | ```Boolean``` |  Provide users the ability to review/edit the template signer roles.  |  [default to false] |
+| `force_subject_message` | ```Boolean``` |  Provide users the ability to review/edit the template subject and message.  |  [default to false] |
+| `merge_fields` | [```Array<SubMergeField>```](SubMergeField.md) |  Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.<br><br>Remove all merge fields on the template by passing an empty array `[]`.  |  |
+| `preview_only` | ```Boolean``` |  This allows the requester to enable the preview experience (i.e. does not allow the requester&#39;s end user to add any additional fields via the editor).<br><br>**Note**: This parameter overwrites `show_preview&#x3D;true` (if set).  |  [default to false] |
+| `show_preview` | ```Boolean``` |  This allows the requester to enable the editor/preview experience.  |  [default to false] |
+| `show_progress_stepper` | ```Boolean``` |  When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.  |  [default to true] |
+| `test_mode` | ```Boolean``` |  Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.  |  [default to false] |
+

data/docs/EmbeddedEditUrlResponse.md

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

data/docs/EmbeddedEditUrlResponseEmbedded.md

@@ -0,0 +1,11 @@
+# Dropbox::Sign::EmbeddedEditUrlResponseEmbedded
+
+An embedded template object.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `edit_url` | ```String``` |  A template url that can be opened in an iFrame.  |  |
+| `expires_at` | ```Integer``` |  The specific time that the the `edit_url` link expires, in epoch.  |  |
+

data/docs/EmbeddedSignUrlResponse.md

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

data/docs/EmbeddedSignUrlResponseEmbedded.md

@@ -0,0 +1,11 @@
+# Dropbox::Sign::EmbeddedSignUrlResponseEmbedded
+
+An object that contains necessary information to set up embedded signing.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `sign_url` | ```String``` |  A signature url that can be opened in an iFrame.  |  |
+| `expires_at` | ```Integer``` |  The specific time that the the `sign_url` link expires, in epoch.  |  |
+

data/docs/ErrorResponse.md

@@ -0,0 +1,10 @@
+# Dropbox::Sign::ErrorResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `error`<sup>*_required_</sup> | [```ErrorResponseError```](ErrorResponseError.md) |    |  |
+

data/docs/ErrorResponseError.md

@@ -0,0 +1,12 @@
+# Dropbox::Sign::ErrorResponseError
+
+Contains information about an error that occurred.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `error_msg`<sup>*_required_</sup> | ```String``` |  Message describing an error.  |  |
+| `error_name`<sup>*_required_</sup> | ```String``` |  Name of the error.  |  |
+| `error_path` | ```String``` |  Path at which an error occurred.  |  |
+

data/docs/EventCallbackRequest.md

@@ -0,0 +1,13 @@
+# Dropbox::Sign::EventCallbackRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `event`<sup>*_required_</sup> | [```EventCallbackRequestEvent```](EventCallbackRequestEvent.md) |    |  |
+| `account` | [```AccountResponse```](AccountResponse.md) |    |  |
+| `signature_request` | [```SignatureRequestResponse```](SignatureRequestResponse.md) |    |  |
+| `template` | [```TemplateResponse```](TemplateResponse.md) |    |  |
+

data/docs/EventCallbackRequestEvent.md

@@ -0,0 +1,13 @@
+# Dropbox::Sign::EventCallbackRequestEvent
+
+Basic information about the event that occurred.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `event_time`<sup>*_required_</sup> | ```String``` |  Time the event was created (using Unix time).  |  |
+| `event_type`<sup>*_required_</sup> | ```String``` |  Type of callback event that was triggered.  |  |
+| `event_hash`<sup>*_required_</sup> | ```String``` |  Generated hash used to verify source of event data.  |  |
+| `event_metadata`<sup>*_required_</sup> | [```EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) |    |  |
+

data/docs/EventCallbackRequestEventMetadata.md

@@ -0,0 +1,13 @@
+# Dropbox::Sign::EventCallbackRequestEventMetadata
+
+Specific metadata about the event.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `related_signature_id` | ```String``` |  Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.  |  |
+| `reported_for_account_id` | ```String``` |  Account ID the event was reported for.  |  |
+| `reported_for_app_id` | ```String``` |  App ID the event was reported for.  |  |
+| `event_message` | ```String``` |  Message about a declined or failed (due to error) signature flow.  |  |
+

data/docs/FileResponse.md

@@ -0,0 +1,11 @@
+# Dropbox::Sign::FileResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `file_url` | ```String``` |  URL to the file.  |  |
+| `expires_at` | ```Integer``` |  When the link expires.  |  |
+

data/docs/FileResponseDataUri.md

@@ -0,0 +1,10 @@
+# Dropbox::Sign::FileResponseDataUri
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `data_uri` | ```String``` |  File as base64 encoded string.  |  |
+

data/docs/ListInfoResponse.md

@@ -0,0 +1,13 @@
+# Dropbox::Sign::ListInfoResponse
+
+Contains pagination information about the data returned.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `num_pages` | ```Integer``` |  Total number of pages available.  |  |
+| `num_results` | ```Integer``` |  Total number of objects available.  |  |
+| `page` | ```Integer``` |  Number of the page being returned.  |  |
+| `page_size` | ```Integer``` |  Objects returned per page.  |  |
+

data/docs/OAuthApi.md

@@ -0,0 +1,158 @@
+# Dropbox::Sign::OAuthApi
+
+All URIs are relative to *https://api.hellosign.com/v3*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [`oauth_token_generate`](OAuthApi.md#oauth_token_generate) | **POST** `/oauth/token` | OAuth Token Generate |
+| [`oauth_token_refresh`](OAuthApi.md#oauth_token_refresh) | **POST** `/oauth/token?refresh` | OAuth Token Refresh |
+
+
+## `oauth_token_generate`
+
+> `<OAuthTokenResponse> oauth_token_generate(o_auth_token_generate_request)`
+
+OAuth Token Generate
+
+Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.
+
+### 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
+
+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
+
+```
+
+#### Using the `oauth_token_generate_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<OAuthTokenResponse>, Integer, Hash)> oauth_token_generate_with_http_info(o_auth_token_generate_request)`
+
+```ruby
+begin
+  # OAuth Token Generate
+  data, status_code, headers = api_instance.oauth_token_generate_with_http_info(o_auth_token_generate_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuthTokenResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling OAuthApi->oauth_token_generate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `o_auth_token_generate_request` | [**OAuthTokenGenerateRequest**](OAuthTokenGenerateRequest.md) |  |  |
+
+### Return type
+
+[**OAuthTokenResponse**](OAuthTokenResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## `oauth_token_refresh`
+
+> `<OAuthTokenResponse> oauth_token_refresh(o_auth_token_refresh_request)`
+
+OAuth Token Refresh
+
+Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired.
+
+### 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
+
+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
+
+```
+
+#### Using the `oauth_token_refresh_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<OAuthTokenResponse>, Integer, Hash)> oauth_token_refresh_with_http_info(o_auth_token_refresh_request)`
+
+```ruby
+begin
+  # OAuth Token Refresh
+  data, status_code, headers = api_instance.oauth_token_refresh_with_http_info(o_auth_token_refresh_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuthTokenResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling OAuthApi->oauth_token_refresh_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `o_auth_token_refresh_request` | [**OAuthTokenRefreshRequest**](OAuthTokenRefreshRequest.md) |  |  |
+
+### Return type
+
+[**OAuthTokenResponse**](OAuthTokenResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/OAuthTokenGenerateRequest.md

@@ -0,0 +1,14 @@
+# Dropbox::Sign::OAuthTokenGenerateRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `client_id`<sup>*_required_</sup> | ```String``` |  The client id of the app requesting authorization.  |  |
+| `client_secret`<sup>*_required_</sup> | ```String``` |  The secret token of your app.  |  |
+| `code`<sup>*_required_</sup> | ```String``` |  The code passed to your callback when the user granted access.  |  |
+| `grant_type`<sup>*_required_</sup> | ```String``` |  When generating a new token use `authorization_code`.  |  [default to 'authorization_code'] |
+| `state`<sup>*_required_</sup> | ```String``` |  Same as the state you specified earlier.  |  |
+

data/docs/OAuthTokenRefreshRequest.md

@@ -0,0 +1,11 @@
+# Dropbox::Sign::OAuthTokenRefreshRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `grant_type`<sup>*_required_</sup> | ```String``` |  When refreshing an existing token use `refresh_token`.  |  [default to 'refresh_token'] |
+| `refresh_token`<sup>*_required_</sup> | ```String``` |  The token provided when you got the expired access token.  |  |
+

data/docs/OAuthTokenResponse.md

@@ -0,0 +1,14 @@
+# Dropbox::Sign::OAuthTokenResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `access_token` | ```String``` |    |  |
+| `token_type` | ```String``` |    |  |
+| `refresh_token` | ```String``` |    |  |
+| `expires_in` | ```Integer``` |  Number of seconds until the `access_token` expires. Uses epoch time.  |  |
+| `state` | ```String``` |    |  |
+