yousign_client 1.0.0 → 1.0.1

data/docs/FilesApi.md

@@ -11,7 +11,7 @@ Method | HTTP request | Description
 
 
 # **files_id_download_get**
-> String files_id_download_get(id, authorization)
+> String files_id_download_get(id)
 
 Download a File
 
@@ -21,17 +21,22 @@ Used to get the base64 content of a file
 ```ruby
 # load the gem
 require 'yousign_client'
+# setup authorization
+YousignClient.configure do |config|
+  # Configure API key authorization: api_key
+  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 = YousignClient::FilesApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Download a File
-  result = api_instance.files_id_download_get(id, authorization)
+  result = api_instance.files_id_download_get(id)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling FilesApi->files_id_download_get: #{e}"
@@ -43,7 +48,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### Return type
 
@@ -51,7 +55,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -61,7 +65,7 @@ No authorization required
 
 
 # **files_id_duplicate_post**
-> FileOutput files_id_duplicate_post(id, authorization, content_type)
+> FileOutput files_id_duplicate_post(id)
 
 Duplicate a File
 
@@ -71,19 +75,22 @@ Duplicate a file. It will be create a clone of this file, with a new ID.
 ```ruby
 # load the gem
 require 'yousign_client'
+# setup authorization
+YousignClient.configure do |config|
+  # Configure API key authorization: api_key
+  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 = YousignClient::FilesApi.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
-
 
 begin
   #Duplicate a File
-  result = api_instance.files_id_duplicate_post(id, authorization, content_type)
+  result = api_instance.files_id_duplicate_post(id)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling FilesApi->files_id_duplicate_post: #{e}"
@@ -95,8 +102,6 @@ end
 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 | 
 
 ### Return type
 
@@ -104,7 +109,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -114,7 +119,7 @@ No authorization required
 
 
 # **files_id_get**
-> FileOutput files_id_get(id, authorization)
+> FileOutput files_id_get(id)
 
 Find a File by ID
 
@@ -124,17 +129,22 @@ Returns all the information regarding the File but without its content (for perf
 ```ruby
 # load the gem
 require 'yousign_client'
+# setup authorization
+YousignClient.configure do |config|
+  # Configure API key authorization: api_key
+  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 = YousignClient::FilesApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Find a File by ID
-  result = api_instance.files_id_get(id, authorization)
+  result = api_instance.files_id_get(id)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling FilesApi->files_id_get: #{e}"
@@ -146,7 +156,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### Return type
 
@@ -154,7 +163,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -164,7 +173,7 @@ No authorization required
 
 
 # **files_post**
-> FileOutput files_post(authorization, content_type, body)
+> FileOutput files_post(body)
 
 Create a new File
 
@@ -174,19 +183,22 @@ Used to upload a file in base64 on our platform
 ```ruby
 # load the gem
 require 'yousign_client'
+# setup authorization
+YousignClient.configure do |config|
+  # Configure API key authorization: api_key
+  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 = YousignClient::FilesApi.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::FileInput.new # FileInput | 
 
 
 begin
   #Create a new File
-  result = api_instance.files_post(authorization, content_type, body)
+  result = api_instance.files_post(body)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling FilesApi->files_post: #{e}"
@@ -197,8 +209,6 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
- **content_type** | **String**| The MIME type of the body of the request | 
  **body** | [**FileInput**](FileInput.md)|  | 
 
 ### Return type
@@ -207,7 +217,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 

data/docs/InlineObject.md

@@ -0,0 +1,17 @@
+# YousignClient::InlineObject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sign_image** | **String** | Image of signature (base 64) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'YousignClient'
+
+instance = YousignClient::InlineObject.new(sign_image: null)
+```
+
+

data/docs/InlineObject1.md

@@ -0,0 +1,19 @@
+# YousignClient::InlineObject1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Code sms received by user | 
+**sign_image** | **String** | Image of signature (base 64) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'YousignClient'
+
+instance = YousignClient::InlineObject1.new(code: null,
+                                 sign_image: null)
+```
+
+

data/docs/InlineObject2.md

@@ -0,0 +1,19 @@
+# YousignClient::InlineObject2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Code sms received by user | 
+**sign_image** | **String** | Image of signature (base 64) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'YousignClient'
+
+instance = YousignClient::InlineObject2.new(code: null,
+                                 sign_image: null)
+```
+
+

data/docs/MembersApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 
 # **members_get**
-> Array<MemberOutput> members_get(authorization, opts)
+> Array<MemberOutput> members_get(opts)
 
 Get all Members
 
@@ -22,18 +22,23 @@ Returns the list of Members of a organization. It only usefull if you use the qu
 ```ruby
 # load the gem
 require 'yousign_client'
+# setup authorization
+YousignClient.configure do |config|
+  # Configure API key authorization: api_key
+  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 = 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)
+  result = api_instance.members_get(opts)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling MembersApi->members_get: #{e}"
@@ -44,7 +49,6 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
  **procedure** | **String**|  | [optional] 
 
 ### Return type
@@ -53,7 +57,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -63,7 +67,7 @@ No authorization required
 
 
 # **members_id_delete**
-> members_id_delete(id, authorization)
+> members_id_delete(id)
 
 Delete a Member
 
@@ -73,17 +77,22 @@ Delete a member
 ```ruby
 # load the gem
 require 'yousign_client'
+# setup authorization
+YousignClient.configure do |config|
+  # Configure API key authorization: api_key
+  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 = 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)
+  api_instance.members_id_delete(id)
 rescue YousignClient::ApiError => e
   puts "Exception when calling MembersApi->members_id_delete: #{e}"
 end
@@ -94,7 +103,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### Return type
 
@@ -102,7 +110,7 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -112,7 +120,7 @@ No authorization required
 
 
 # **members_id_proof_get**
-> String members_id_proof_get(id, authorization)
+> String members_id_proof_get(id)
 
 Get a proof file of a Member
 
@@ -122,17 +130,22 @@ Get a proof file of a member
 ```ruby
 # load the gem
 require 'yousign_client'
+# setup authorization
+YousignClient.configure do |config|
+  # Configure API key authorization: api_key
+  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 = 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)
+  result = api_instance.members_id_proof_get(id)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling MembersApi->members_id_proof_get: #{e}"
@@ -144,7 +157,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### Return type
 
@@ -152,7 +164,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -162,7 +174,7 @@ No authorization required
 
 
 # **members_id_put**
-> MemberOutput members_id_put(id, authorization, content_type, body)
+> MemberOutput members_id_put(idbody)
 
 Edit a Member
 
@@ -172,21 +184,24 @@ Edit a member
 ```ruby
 # load the gem
 require 'yousign_client'
+# setup authorization
+YousignClient.configure do |config|
+  # Configure API key authorization: api_key
+  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 = 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)
+  result = api_instance.members_id_put(idbody)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling MembersApi->members_id_put: #{e}"
@@ -198,8 +213,6 @@ end
 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
@@ -208,7 +221,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -218,7 +231,7 @@ No authorization required
 
 
 # **members_post**
-> MemberOutput members_post(authorization, content_type, body)
+> MemberOutput members_post(body)
 
 Create a new Member
 
@@ -228,19 +241,22 @@ Create a new member
 ```ruby
 # load the gem
 require 'yousign_client'
+# setup authorization
+YousignClient.configure do |config|
+  # Configure API key authorization: api_key
+  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 = 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)
+  result = api_instance.members_post(body)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling MembersApi->members_post: #{e}"
@@ -251,8 +267,6 @@ end
 
 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
@@ -261,7 +275,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers