signrequest_client 0.1.0

data/docs/EventsApi.md

@@ -0,0 +1,145 @@
+# SignRequestClient::EventsApi
+
+All URIs are relative to *https://signrequest.com/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**events_list**](EventsApi.md#events_list) | **GET** /events/ | 
+[**events_read**](EventsApi.md#events_read) | **GET** /events/{id}/ | 
+
+
+# **events_list**
+> InlineResponse2004 events_list(opts)
+
+
+
+
+
+### Example
+```ruby
+# load the gem
+require 'signrequest_client'
+# setup authorization
+SignRequestClient.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = SignRequestClient::EventsApi.new
+
+opts = { 
+  document__uuid: "document__uuid_example", # String | 
+  document__external_id: "document__external_id_example", # String | 
+  document__signrequest__who: "document__signrequest__who_example", # String | 
+  document__signrequest__from_email: "document__signrequest__from_email_example", # String | 
+  document__status: "document__status_example", # String | 
+  document__user__email: "document__user__email_example", # String | 
+  document__user__first_name: "document__user__first_name_example", # String | 
+  document__user__last_name: "document__user__last_name_example", # String | 
+  delivered: "delivered_example", # String | 
+  delivered_on: "delivered_on_example", # String | 
+  timestamp: "timestamp_example", # String | 
+  status: "status_example", # String | 
+  event_type: "event_type_example", # String | 
+  page: 56, # Integer | A page number within the paginated result set.
+  limit: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  result = api_instance.events_list(opts)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling EventsApi->events_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **document__uuid** | **String**|  | [optional] 
+ **document__external_id** | **String**|  | [optional] 
+ **document__signrequest__who** | **String**|  | [optional] 
+ **document__signrequest__from_email** | **String**|  | [optional] 
+ **document__status** | **String**|  | [optional] 
+ **document__user__email** | **String**|  | [optional] 
+ **document__user__first_name** | **String**|  | [optional] 
+ **document__user__last_name** | **String**|  | [optional] 
+ **delivered** | **String**|  | [optional] 
+ **delivered_on** | **String**|  | [optional] 
+ **timestamp** | **String**|  | [optional] 
+ **status** | **String**|  | [optional] 
+ **event_type** | **String**|  | [optional] 
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **events_read**
+> Event events_read(id)
+
+
+
+
+
+### Example
+```ruby
+# load the gem
+require 'signrequest_client'
+# setup authorization
+SignRequestClient.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = SignRequestClient::EventsApi.new
+
+id = 56 # Integer | A unique integer value identifying this event.
+
+
+begin
+  result = api_instance.events_read(id)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling EventsApi->events_read: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| A unique integer value identifying this event. | 
+
+### Return type
+
+[**Event**](Event.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/FileFromSf.md

@@ -0,0 +1,9 @@
+# SignRequestClient::FileFromSf
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object_type** | **String** |  | 
+**object_id** | **String** |  | 
+
+

data/docs/InlineDocumentSignerIntegrationData.md

@@ -0,0 +1,9 @@
+# SignRequestClient::InlineDocumentSignerIntegrationData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integration** | **String** |  | [optional] 
+**integration_data** | **String** |  | [optional] 
+
+

data/docs/InlineIntegrationData.md

@@ -0,0 +1,9 @@
+# SignRequestClient::InlineIntegrationData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integration** | **String** |  | [optional] 
+**integration_data** | **String** |  | [optional] 
+
+

data/docs/InlinePrefillTags.md

@@ -0,0 +1,11 @@
+# SignRequestClient::InlinePrefillTags
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** |  | [optional] 
+**text** | **String** |  | [optional] 
+**checkbox_value** | **BOOLEAN** |  | [optional] 
+**date_value** | **Date** |  | [optional] 
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,11 @@
+# SignRequestClient::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<AuthToken>**](AuthToken.md) |  | 
+
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,11 @@
+# SignRequestClient::InlineResponse2001
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<DocumentAttachment>**](DocumentAttachment.md) |  | 
+
+

data/docs/InlineResponse2002.md

@@ -0,0 +1,11 @@
+# SignRequestClient::InlineResponse2002
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<DocumentSearch>**](DocumentSearch.md) |  | 
+
+

data/docs/InlineResponse2003.md

@@ -0,0 +1,11 @@
+# SignRequestClient::InlineResponse2003
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<Document>**](Document.md) |  | 
+
+

data/docs/InlineResponse2004.md

@@ -0,0 +1,11 @@
+# SignRequestClient::InlineResponse2004
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<Event>**](Event.md) |  | 
+
+

data/docs/InlineResponse2005.md

@@ -0,0 +1,11 @@
+# SignRequestClient::InlineResponse2005
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<SignRequest>**](SignRequest.md) |  | 
+
+

data/docs/InlineResponse2006.md

@@ -0,0 +1,11 @@
+# SignRequestClient::InlineResponse2006
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<TeamMember>**](TeamMember.md) |  | 
+
+

data/docs/InlineResponse2007.md

@@ -0,0 +1,11 @@
+# SignRequestClient::InlineResponse2007
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<Team>**](Team.md) |  | 
+
+

data/docs/InlineResponse2008.md

@@ -0,0 +1,11 @@
+# SignRequestClient::InlineResponse2008
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<Template>**](Template.md) |  | 
+
+

data/docs/InlineResponse2009.md

@@ -0,0 +1,11 @@
+# SignRequestClient::InlineResponse2009
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<WebhookSubscription>**](WebhookSubscription.md) |  | 
+
+

data/docs/InlineSignRequest.md

@@ -0,0 +1,25 @@
+# SignRequestClient::InlineSignRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from_email** | **String** |  | 
+**from_email_name** | **String** |  | [optional] 
+**is_being_prepared** | **BOOLEAN** |  | [optional] 
+**prepare_url** | **String** |  | [optional] 
+**redirect_url** | **String** |  | [optional] 
+**required_attachments** | [**Array<RequiredAttachment>**](RequiredAttachment.md) |  | [optional] 
+**disable_attachments** | **BOOLEAN** |  | [optional] 
+**disable_text_signatures** | **BOOLEAN** |  | [optional] 
+**disable_text** | **BOOLEAN** |  | [optional] 
+**disable_date** | **BOOLEAN** |  | [optional] 
+**disable_emails** | **BOOLEAN** |  | [optional] 
+**disable_upload_signatures** | **BOOLEAN** |  | [optional] 
+**subject** | **String** |  | [optional] 
+**message** | **String** |  | [optional] 
+**who** | **String** |  | [optional] 
+**send_reminders** | **BOOLEAN** |  | [optional] 
+**signers** | [**Array<Signer>**](Signer.md) |  | 
+**uuid** | **String** |  | [optional] 
+
+

data/docs/InlineTeam.md

@@ -0,0 +1,10 @@
+# SignRequestClient::InlineTeam
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**subdomain** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/InlineTeamMember.md

@@ -0,0 +1,13 @@
+# SignRequestClient::InlineTeamMember
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+**user** | [**User**](User.md) |  | [optional] 
+**is_admin** | **BOOLEAN** |  | [optional] 
+**is_active** | **BOOLEAN** |  | [optional] 
+**is_owner** | **BOOLEAN** |  | [optional] 
+
+

data/docs/InviteMember.md

@@ -0,0 +1,10 @@
+# SignRequestClient::InviteMember
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | 
+**is_admin** | **BOOLEAN** |  | [optional] [default to false]
+**is_owner** | **BOOLEAN** |  | [optional] [default to false]
+
+

data/docs/Placeholder.md

@@ -0,0 +1,15 @@
+# SignRequestClient::Placeholder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**page_index** | **Integer** |  | 
+**prefill** | **BOOLEAN** |  | 
+**text** | **String** |  | [optional] 
+**checkbox_value** | **BOOLEAN** |  | [optional] 
+**date_value** | **Date** |  | [optional] 
+**external_id** | **String** |  | [optional] 
+
+

data/docs/RequiredAttachment.md

@@ -0,0 +1,9 @@
+# SignRequestClient::RequiredAttachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**uuid** | **String** |  | [optional] 
+
+

data/docs/SignRequest.md

@@ -0,0 +1,29 @@
+# SignRequestClient::SignRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from_email** | **String** |  | [optional] 
+**from_email_name** | **String** |  | [optional] 
+**is_being_prepared** | **BOOLEAN** |  | [optional] 
+**prepare_url** | **String** |  | [optional] 
+**redirect_url** | **String** |  | [optional] 
+**required_attachments** | [**Array<RequiredAttachment>**](RequiredAttachment.md) |  | [optional] 
+**disable_attachments** | **BOOLEAN** |  | [optional] 
+**disable_text_signatures** | **BOOLEAN** |  | [optional] 
+**disable_text** | **BOOLEAN** |  | [optional] 
+**disable_date** | **BOOLEAN** |  | [optional] 
+**disable_emails** | **BOOLEAN** |  | [optional] 
+**disable_upload_signatures** | **BOOLEAN** |  | [optional] 
+**subject** | **String** |  | [optional] 
+**message** | **String** |  | [optional] 
+**who** | **String** |  | [optional] [default to "o"]
+**send_reminders** | **BOOLEAN** |  | [optional] 
+**signers** | [**Array<Signer>**](Signer.md) |  | 
+**uuid** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+**document** | **String** |  | 
+**integration** | **String** |  | [optional] 
+**integration_data** | **String** |  | [optional] 
+
+

data/docs/SignRequestQuickCreate.md

@@ -0,0 +1,42 @@
+# SignRequestClient::SignRequestQuickCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from_email** | **String** |  | [optional] 
+**from_email_name** | **String** |  | [optional] 
+**is_being_prepared** | **BOOLEAN** |  | [optional] 
+**prepare_url** | **String** |  | [optional] 
+**redirect_url** | **String** |  | [optional] 
+**required_attachments** | [**Array<RequiredAttachment>**](RequiredAttachment.md) |  | [optional] 
+**disable_attachments** | **BOOLEAN** |  | [optional] 
+**disable_text_signatures** | **BOOLEAN** |  | [optional] 
+**disable_text** | **BOOLEAN** |  | [optional] 
+**disable_date** | **BOOLEAN** |  | [optional] 
+**disable_emails** | **BOOLEAN** |  | [optional] 
+**disable_upload_signatures** | **BOOLEAN** |  | [optional] 
+**subject** | **String** |  | [optional] 
+**message** | **String** |  | [optional] 
+**who** | **String** |  | [optional] [default to "o"]
+**send_reminders** | **BOOLEAN** |  | [optional] 
+**signers** | [**Array<Signer>**](Signer.md) |  | 
+**uuid** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+**document** | **String** |  | [optional] 
+**integration** | **String** |  | [optional] 
+**integration_data** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**external_id** | **String** |  | [optional] 
+**frontend_id** | **String** |  | [optional] 
+**file** | **String** |  | [optional] 
+**file_from_url** | **String** |  | [optional] 
+**events_callback_url** | **String** |  | [optional] 
+**file_from_content** | **String** |  | [optional] 
+**file_from_content_name** | **String** |  | [optional] 
+**template** | **String** |  | [optional] 
+**prefill_tags** | [**Array<InlinePrefillTags>**](InlinePrefillTags.md) |  | [optional] 
+**integrations** | [**Array<InlineIntegrationData>**](InlineIntegrationData.md) |  | [optional] 
+**file_from_sf** | [**FileFromSf**](FileFromSf.md) |  | [optional] 
+**auto_delete_days** | **Integer** |  | [optional] 
+
+

data/docs/Signer.md

@@ -0,0 +1,40 @@
+# SignRequestClient::Signer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | 
+**display_name** | **String** |  | [optional] 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**email_viewed** | **BOOLEAN** |  | [optional] 
+**viewed** | **BOOLEAN** |  | [optional] 
+**signed** | **BOOLEAN** |  | [optional] 
+**downloaded** | **BOOLEAN** |  | [optional] 
+**signed_on** | **DateTime** |  | [optional] 
+**needs_to_sign** | **BOOLEAN** |  | [optional] [default to true]
+**approve_only** | **BOOLEAN** |  | [optional] 
+**notify_only** | **BOOLEAN** |  | [optional] 
+**in_person** | **BOOLEAN** |  | [optional] 
+**order** | **Integer** |  | [optional] 
+**language** | **String** |  | [optional] 
+**force_language** | **BOOLEAN** |  | [optional] 
+**emailed** | **BOOLEAN** |  | [optional] 
+**verify_phone_number** | **String** |  | [optional] 
+**verify_bank_account** | **String** |  | [optional] 
+**declined** | **BOOLEAN** |  | [optional] 
+**declined_on** | **DateTime** |  | [optional] 
+**forwarded** | **String** |  | [optional] 
+**forwarded_on** | **DateTime** |  | [optional] 
+**forwarded_to_email** | **String** |  | [optional] 
+**forwarded_reason** | **String** |  | [optional] 
+**message** | **String** |  | [optional] 
+**embed_url_user_id** | **String** |  | [optional] 
+**inputs** | [**Array<SignerInputs>**](SignerInputs.md) |  | [optional] 
+**embed_url** | **String** |  | [optional] 
+**attachments** | [**Array<SignerAttachment>**](SignerAttachment.md) |  | [optional] 
+**redirect_url** | **String** |  | [optional] 
+**after_document** | **String** |  | [optional] 
+**integrations** | [**Array<InlineDocumentSignerIntegrationData>**](InlineDocumentSignerIntegrationData.md) |  | [optional] 
+
+

data/docs/SignerAttachment.md

@@ -0,0 +1,11 @@
+# SignRequestClient::SignerAttachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**file** | **String** |  | [optional] 
+**for_attachment** | [**RequiredAttachment**](RequiredAttachment.md) |  | [optional] 
+
+

data/docs/SignerInputs.md

@@ -0,0 +1,14 @@
+# SignRequestClient::SignerInputs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**page_index** | **Integer** |  | 
+**text** | **String** |  | [optional] 
+**checkbox_value** | **BOOLEAN** |  | [optional] 
+**date_value** | **Date** |  | [optional] 
+**external_id** | **String** |  | [optional] 
+**placeholder_uuid** | **String** |  | [optional] 
+
+

data/docs/SigningLog.md

@@ -0,0 +1,9 @@
+# SignRequestClient::SigningLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pdf** | **String** |  | [optional] 
+**security_hash** | **String** |  | [optional] 
+
+

data/docs/SignrequestQuickCreateApi.md

@@ -0,0 +1,62 @@
+# SignRequestClient::SignrequestQuickCreateApi
+
+All URIs are relative to *https://signrequest.com/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**signrequest_quick_create_create**](SignrequestQuickCreateApi.md#signrequest_quick_create_create) | **POST** /signrequest-quick-create/ | 
+
+
+# **signrequest_quick_create_create**
+> SignRequestQuickCreate signrequest_quick_create_create(data)
+
+
+
+
+
+### Example
+```ruby
+# load the gem
+require 'signrequest_client'
+# setup authorization
+SignRequestClient.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = SignRequestClient::SignrequestQuickCreateApi.new
+
+data = SignRequestClient::SignRequestQuickCreate.new # SignRequestQuickCreate | 
+
+
+begin
+  result = api_instance.signrequest_quick_create_create(data)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling SignrequestQuickCreateApi->signrequest_quick_create_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**SignRequestQuickCreate**](SignRequestQuickCreate.md)|  | 
+
+### Return type
+
+[**SignRequestQuickCreate**](SignRequestQuickCreate.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+