yousign_client 1.0.0

data/docs/InlineResponse400.md

@@ -0,0 +1,8 @@
+# YousignClient::InlineResponse400
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | **String** | Description of error | [optional] 
+
+

data/docs/InweboUserRequest.md

@@ -0,0 +1,8 @@
+# YousignClient::InweboUserRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Id of the object | [optional] 
+
+

data/docs/MemberInput.md

@@ -0,0 +1,19 @@
+# YousignClient::MemberInput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | **String** | ID of the user in your companies. Informations about the member will be duplicate (first name, last name, email and phone number).  Required if none of fields above are specified. | [optional] 
+**type** | **String** | Type of a member. \"signer\" to sign documents (legally) and \"validator\" to validate documents. | [optional] [default to 'signer']
+**firstname** | **String** | Firstname of an external member. Required if user field is blank | [optional] 
+**lastname** | **String** | Lastname of an external member. Required if user field is blank | [optional] 
+**email** | **String** | Email of an external member. Required if user field is blank | [optional] 
+**phone** | **String** | Phone of an external member. Required if user field is blank | [optional] 
+**position** | **Integer** | If the procedure have the boolean \"ordered\" at true, you can define position of the order to invite your members to sign. Only the first member will be invited to sign.  When the first member have signed, the second will be invited, etc... | [optional] 
+**file_objects** | [**Array<FileObjectInput>**](FileObjectInput.md) |  | [optional] 
+**procedure** | **String** | Procedure id reference | [optional] 
+**operation_level** | **String** |  | [optional] 
+**operation_custom_modes** | **Array<String>** |  | [optional] 
+**mode_sms_configuration** | [**ModeSmsConfiguration**](ModeSmsConfiguration.md) |  | [optional] 
+
+

data/docs/MemberOutput.md

@@ -0,0 +1,24 @@
+# YousignClient::MemberOutput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Id of the object | [optional] 
+**user** | **String** | Internal user associated with the member. In this case, informations about the member will be informations of the user (first name, last name, phone number and email). | [optional] 
+**type** | **String** | Type of a member. \"signer\" to sign documents (legally) and \"validator\" to validate documents. | [optional] [default to 'signer']
+**firstname** | **String** | Firstname of an external member. | [optional] 
+**lastname** | **String** | Lastname of an external member. | [optional] 
+**email** | **String** | Email of an external member. | [optional] 
+**phone** | **String** | Phone of an external member. | [optional] 
+**position** | **Integer** | Position of the member if ordered is set to true. Example with two members, the first one could have a position set to 1, the second one set to 2. In this case, when the procedure starts, only the first member will be notified and could validate the documents. The second one could not validate the documents, he will be notified when the first signer is notified. | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**status** | **String** |  | [optional] 
+**file_objects** | [**Array<FileObjectOutput>**](FileObjectOutput.md) |  | [optional] 
+**comment** | **String** | Comment of a member when he refuses a signature | [optional] 
+**procedure** | **String** | Procedure id reference | [optional] 
+**operation_level** | **String** |  | [optional] 
+**operation_custom_modes** | **Array<String>** |  | [optional] 
+**mode_sms_configuration** | [**ModeSmsConfiguration**](ModeSmsConfiguration.md) |  | [optional] 
+
+

data/docs/MembersApi.md

@@ -0,0 +1,272 @@
+# YousignClient::MembersApi
+
+All URIs are relative to *https://api.yousign.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**members_get**](MembersApi.md#members_get) | **GET** /members | Get all Members
+[**members_id_delete**](MembersApi.md#members_id_delete) | **DELETE** /members/{id} | Delete a Member
+[**members_id_proof_get**](MembersApi.md#members_id_proof_get) | **GET** /members/{id}/proof | Get a proof file of a Member
+[**members_id_put**](MembersApi.md#members_id_put) | **PUT** /members/{id} | Edit a Member
+[**members_post**](MembersApi.md#members_post) | **POST** /members | Create a new Member
+
+
+# **members_get**
+> Array<MemberOutput> members_get(authorization, opts)
+
+Get all Members
+
+Returns the list of Members of a organization. It only usefull if you use the query params named \"procedure\" for retrieve all members of a procedure.
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::MembersApi.new
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+opts = { 
+  procedure: 'Id for filter about a procedure' # String | 
+}
+
+begin
+  #Get all Members
+  result = api_instance.members_get(authorization, opts)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling MembersApi->members_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+ **procedure** | **String**|  | [optional] 
+
+### Return type
+
+[**Array<MemberOutput>**](MemberOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **members_id_delete**
+> members_id_delete(id, authorization)
+
+Delete a Member
+
+Delete a member
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::MembersApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #Delete a Member
+  api_instance.members_id_delete(id, authorization)
+rescue YousignClient::ApiError => e
+  puts "Exception when calling MembersApi->members_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **members_id_proof_get**
+> String members_id_proof_get(id, authorization)
+
+Get a proof file of a Member
+
+Get a proof file of a member
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::MembersApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #Get a proof file of a Member
+  result = api_instance.members_id_proof_get(id, authorization)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling MembersApi->members_id_proof_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **members_id_put**
+> MemberOutput members_id_put(id, authorization, content_type, body)
+
+Edit a Member
+
+Edit a member
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::MembersApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+content_type = 'application/json' # String | The MIME type of the body of the request
+
+body = YousignClient::MemberInput.new # MemberInput | 
+
+
+begin
+  #Edit a Member
+  result = api_instance.members_id_put(id, authorization, content_type, body)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling MembersApi->members_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+ **content_type** | **String**| The MIME type of the body of the request | 
+ **body** | [**MemberInput**](MemberInput.md)|  | 
+
+### Return type
+
+[**MemberOutput**](MemberOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **members_post**
+> MemberOutput members_post(authorization, content_type, body)
+
+Create a new Member
+
+Create a new member
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::MembersApi.new
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+content_type = 'application/json' # String | The MIME type of the body of the request
+
+body = YousignClient::MemberInput.new # MemberInput | 
+
+
+begin
+  #Create a new Member
+  result = api_instance.members_post(authorization, content_type, body)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling MembersApi->members_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+ **content_type** | **String**| The MIME type of the body of the request | 
+ **body** | [**MemberInput**](MemberInput.md)|  | 
+
+### Return type
+
+[**MemberOutput**](MemberOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/ModeSmsConfiguration.md

@@ -0,0 +1,8 @@
+# YousignClient::ModeSmsConfiguration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **String** | Content of your custom sms message. Should contains the substring `{{code}}` | 
+
+

data/docs/OperationInput.md

@@ -0,0 +1,14 @@
+# YousignClient::OperationInput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Type of operation | 
+**mode** | **String** | Mode of authentication | 
+**all_members** | **BOOLEAN** |  | [optional] [default to false]
+**members** | **Array<String>** |  | [optional] 
+**status** | **String** | Status of operation | [optional] 
+**comment** | **String** |  | [optional] 
+**metadata** | [**OperationOutputMetadata**](OperationOutputMetadata.md) |  | [optional] 
+
+

data/docs/OperationOutput.md

@@ -0,0 +1,15 @@
+# YousignClient::OperationOutput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Id of operation | [optional] 
+**created_at** | **Date** | Date of creation | [optional] 
+**updated_at** | **Date** | Last date of update | [optional] 
+**authentication** | [**AuthenticationInweboOutput**](AuthenticationInweboOutput.md) |  | [optional] 
+**mode** | **String** | Mode of authentication | [optional] 
+**status** | **String** | Status of operation | [optional] 
+**type** | **String** | Type of operation | [optional] 
+**metadata** | [**OperationOutputMetadata**](OperationOutputMetadata.md) |  | [optional] 
+
+

data/docs/OperationOutputMetadata.md

@@ -0,0 +1,9 @@
+# YousignClient::OperationOutputMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key1** | **String** |  | [optional] 
+**key2** | **Integer** |  | [optional] 
+
+

data/docs/OperationsApi.md

@@ -0,0 +1,109 @@
+# YousignClient::OperationsApi
+
+All URIs are relative to *https://api.yousign.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**operations_id_get**](OperationsApi.md#operations_id_get) | **GET** /operations/{id} | Find an Operation by ID
+[**operations_post**](OperationsApi.md#operations_post) | **POST** /operations | Create a new Operation
+
+
+# **operations_id_get**
+> OperationOutput operations_id_get(id, authorization)
+
+Find an Operation by ID
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::OperationsApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #Find an Operation by ID
+  result = api_instance.operations_id_get(id, authorization)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling OperationsApi->operations_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+[**OperationOutput**](OperationOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **operations_post**
+> OperationOutput operations_post(authorization, content_type, body)
+
+Create a new Operation
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::OperationsApi.new
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+content_type = 'application/json' # String | The MIME type of the body of the request
+
+body = YousignClient::OperationInput.new # OperationInput | 
+
+
+begin
+  #Create a new Operation
+  result = api_instance.operations_post(authorization, content_type, body)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling OperationsApi->operations_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+ **content_type** | **String**| The MIME type of the body of the request | 
+ **body** | [**OperationInput**](OperationInput.md)|  | 
+
+### Return type
+
+[**OperationOutput**](OperationOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+