yousign_client 1.0.0 → 1.0.1

data/docs/ConsentProcessesApi.md

@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 
 # **consent_process_values_get**
-> ConsentProcessValueOutput consent_process_values_get(member, authorization)
+> ConsentProcessValueOutput consent_process_values_get(member)
 
 Get list of Consent Process Value
 
@@ -23,17 +23,22 @@ Get list of Consent Process Value
 ```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::ConsentProcessesApi.new
 
 member = '/members/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of member
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Get list of Consent Process Value
-  result = api_instance.consent_process_values_get(member, authorization)
+  result = api_instance.consent_process_values_get(member)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling ConsentProcessesApi->consent_process_values_get: #{e}"
@@ -45,7 +50,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **member** | **String**| id of member | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### 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
 
 
 # **consent_process_values_id_get**
-> ConsentProcessValueOutput consent_process_values_id_get(id, authorization, opts)
+> ConsentProcessValueOutput consent_process_values_id_get(id, opts)
 
 Get a Consent Process Value
 
@@ -71,20 +75,25 @@ Get a Consent Process Value
 ```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::ConsentProcessesApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 opts = { 
   member: '/members/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of member (required for anonymous)
 }
 
 begin
   #Get a Consent Process Value
-  result = api_instance.consent_process_values_id_get(id, authorization, opts)
+  result = api_instance.consent_process_values_id_get(id, opts)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling ConsentProcessesApi->consent_process_values_id_get: #{e}"
@@ -96,7 +105,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
  **member** | **String**| id of member (required for anonymous) | [optional] 
 
 ### Return type
@@ -105,7 +113,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -115,7 +123,7 @@ No authorization required
 
 
 # **consent_process_values_post**
-> ConsentProcessValueOutput consent_process_values_post(authorization, content_type, body)
+> ConsentProcessValueOutput consent_process_values_post(body)
 
 Create a new Consent Process Value
 
@@ -123,19 +131,22 @@ Create a new Consent Process Value
 ```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::ConsentProcessesApi.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::ConsentProcessValueInput.new # ConsentProcessValueInput | 
 
 
 begin
   #Create a new Consent Process Value
-  result = api_instance.consent_process_values_post(authorization, content_type, body)
+  result = api_instance.consent_process_values_post(body)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling ConsentProcessesApi->consent_process_values_post: #{e}"
@@ -146,8 +157,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** | [**ConsentProcessValueInput**](ConsentProcessValueInput.md)|  | 
 
 ### Return type
@@ -156,7 +165,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -166,7 +175,7 @@ No authorization required
 
 
 # **consent_processes_get**
-> Array<ConsentProcessOutput> consent_processes_get(authorization, opts)
+> Array<ConsentProcessOutput> consent_processes_get(opts)
 
 Get list of Consent Processes
 
@@ -174,11 +183,16 @@ Get list of Consent Processes
 ```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::ConsentProcessesApi.new
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 opts = { 
   member: '/members/17625df4-4ee7-498e-822d-3637c91b6f40', # String | id of member (required for anonymous)
   procedure: '/procedures/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of procedure (required if the member attribut is not set)
@@ -186,7 +200,7 @@ opts = {
 
 begin
   #Get list of Consent Processes
-  result = api_instance.consent_processes_get(authorization, opts)
+  result = api_instance.consent_processes_get(opts)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling ConsentProcessesApi->consent_processes_get: #{e}"
@@ -197,7 +211,6 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
  **member** | **String**| id of member (required for anonymous) | [optional] 
  **procedure** | **String**| id of procedure (required if the member attribut is not set) | [optional] 
 
@@ -207,7 +220,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -217,7 +230,7 @@ No authorization required
 
 
 # **consent_processes_id_delete**
-> consent_processes_id_delete(id, authorization)
+> consent_processes_id_delete(id)
 
 Delete a Consent Process
 
@@ -225,17 +238,22 @@ Delete a Consent Process
 ```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::ConsentProcessesApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Delete a Consent Process
-  api_instance.consent_processes_id_delete(id, authorization)
+  api_instance.consent_processes_id_delete(id)
 rescue YousignClient::ApiError => e
   puts "Exception when calling ConsentProcessesApi->consent_processes_id_delete: #{e}"
 end
@@ -246,7 +264,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### Return type
 
@@ -254,7 +271,7 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -264,7 +281,7 @@ No authorization required
 
 
 # **consent_processes_id_get**
-> ConsentProcessOutput consent_processes_id_get(id, authorization, opts)
+> ConsentProcessOutput consent_processes_id_get(id, opts)
 
 Get a Consent Process
 
@@ -272,20 +289,25 @@ Get a Consent Process
 ```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::ConsentProcessesApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 opts = { 
   member: '/members/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of member (required for anonymous)
 }
 
 begin
   #Get a Consent Process
-  result = api_instance.consent_processes_id_get(id, authorization, opts)
+  result = api_instance.consent_processes_id_get(id, opts)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling ConsentProcessesApi->consent_processes_id_get: #{e}"
@@ -297,7 +319,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
  **member** | **String**| id of member (required for anonymous) | [optional] 
 
 ### Return type
@@ -306,7 +327,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -316,7 +337,7 @@ No authorization required
 
 
 # **consent_processes_id_put**
-> ConsentProcessOutput consent_processes_id_put(id, authorization, content_type, body)
+> ConsentProcessOutput consent_processes_id_put(idbody)
 
 Update a Consent Process
 
@@ -324,21 +345,24 @@ Update a Consent Process
 ```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::ConsentProcessesApi.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::ConsentProcessInput.new # ConsentProcessInput | 
 
 
 begin
   #Update a Consent Process
-  result = api_instance.consent_processes_id_put(id, authorization, content_type, body)
+  result = api_instance.consent_processes_id_put(idbody)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling ConsentProcessesApi->consent_processes_id_put: #{e}"
@@ -350,8 +374,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** | [**ConsentProcessInput**](ConsentProcessInput.md)|  | 
 
 ### Return type
@@ -360,7 +382,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -370,7 +392,7 @@ No authorization required
 
 
 # **consent_processes_post**
-> ConsentProcessOutput consent_processes_post(authorization, content_type, body)
+> ConsentProcessOutput consent_processes_post(body)
 
 Create a new Consent Process
 
@@ -378,19 +400,22 @@ Create a new Consent Process
 ```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::ConsentProcessesApi.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::ConsentProcessInput.new # ConsentProcessInput | 
 
 
 begin
   #Create a new Consent Process
-  result = api_instance.consent_processes_post(authorization, content_type, body)
+  result = api_instance.consent_processes_post(body)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling ConsentProcessesApi->consent_processes_post: #{e}"
@@ -401,8 +426,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** | [**ConsentProcessInput**](ConsentProcessInput.md)|  | 
 
 ### Return type
@@ -411,7 +434,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 

data/docs/FileObjectsApi.md

@@ -11,7 +11,7 @@ Method | HTTP request | Description
 
 
 # **file_objects_id_delete**
-> file_objects_id_delete(id, authorization)
+> file_objects_id_delete(id)
 
 Delete a File Object
 
@@ -21,17 +21,22 @@ Delete a File Object
 ```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::FileObjectsApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Delete a File Object
-  api_instance.file_objects_id_delete(id, authorization)
+  api_instance.file_objects_id_delete(id)
 rescue YousignClient::ApiError => e
   puts "Exception when calling FileObjectsApi->file_objects_id_delete: #{e}"
 end
@@ -42,7 +47,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### Return type
 
@@ -50,7 +54,7 @@ nil (empty response body)
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -60,7 +64,7 @@ No authorization required
 
 
 # **file_objects_id_get**
-> FileObjectOutput file_objects_id_get(id, authorization)
+> FileObjectOutput file_objects_id_get(id)
 
 Find a File Object by ID
 
@@ -70,17 +74,22 @@ Get a File Object
 ```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::FileObjectsApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Find a File Object by ID
-  result = api_instance.file_objects_id_get(id, authorization)
+  result = api_instance.file_objects_id_get(id)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling FileObjectsApi->file_objects_id_get: #{e}"
@@ -92,7 +101,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### Return type
 
@@ -100,7 +108,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -110,7 +118,7 @@ No authorization required
 
 
 # **file_objects_id_put**
-> FileObjectOutput file_objects_id_put(id, authorization, content_type, body)
+> FileObjectOutput file_objects_id_put(idbody)
 
 Update a File Object
 
@@ -120,21 +128,24 @@ Update a File Object
 ```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::FileObjectsApi.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::FileObjectInput.new # FileObjectInput | 
 
 
 begin
   #Update a File Object
-  result = api_instance.file_objects_id_put(id, authorization, content_type, body)
+  result = api_instance.file_objects_id_put(idbody)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling FileObjectsApi->file_objects_id_put: #{e}"
@@ -146,8 +157,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** | [**FileObjectInput**](FileObjectInput.md)|  | 
 
 ### Return type
@@ -156,7 +165,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -166,7 +175,7 @@ No authorization required
 
 
 # **file_objects_post**
-> FileObjectOutput file_objects_post(authorization, content_type, body)
+> FileObjectOutput file_objects_post(body)
 
 Create a new File Object
 
@@ -176,19 +185,22 @@ Create a new fileObject
 ```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::FileObjectsApi.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::FileObjectInput.new # FileObjectInput | 
 
 
 begin
   #Create a new File Object
-  result = api_instance.file_objects_post(authorization, content_type, body)
+  result = api_instance.file_objects_post(body)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling FileObjectsApi->file_objects_post: #{e}"
@@ -199,8 +211,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** | [**FileObjectInput**](FileObjectInput.md)|  | 
 
 ### Return type
@@ -209,7 +219,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers