yousign_client 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b655e4e6d416e0ec0a70783c1d2b619763281a7a90b3029d75fc95fa835717a9
-  data.tar.gz: 69bf335ece5e389c5553690ecb8491966c9c3a9a0b80f8bfa320d806119a496d
+  metadata.gz: f7eb161ceaa2a054d68e72b56821a177ca90e8d1e5b3f87d99b8bdf6b6386837
+  data.tar.gz: 0c56dfa1c0bd8f81b4b39ccd926bf8df2d2747482847eff4429f3d1984c94b75
 SHA512:
-  metadata.gz: f62aaf807236dd05d15612df271a0e915abbccc47c935cdad53920f936b6ae4d3579dd226b86ba115bfb281d7d20711fddb14ccbbee1c030366dafc5fc2c8f51
-  data.tar.gz: fc02056d58441287b275b5764bef4152045f0ed5848f39e57859b4c743ec7f521e1e282178209d0a73cc48de496e0fbe785836422e76eb742ee60dfdbeed1e24
+  metadata.gz: 602d911addb002795bf3808e35c1e5b20d3bc2dd9ab647998877e8517dec92dd65c59b02d0faff989a515255338487aef124589ffd9ecdc620d966442b44fd84
+  data.tar.gz: 6ab147e53c7668d200e1481ab1a21c449681ea49fc4597176b8dcf010aad69c7e8bf793e628dc4eb7123a2b10883e7972548ac36e6a6d023c8a298ccc8b8a121

data/README.md

@@ -7,7 +7,7 @@ For your information, the Yousign API documentation is available at https://dev.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.1
-- Package version: 1.0.0
+- Package version: 1.0.1
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build yousign_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./yousign_client-1.0.0.gem
+gem install ./yousign_client-1.0.1.gem
 ```
-(for development, run `gem install --dev ./yousign_client-1.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./yousign_client-1.0.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'yousign_client', '~> 1.0.0'
+    gem 'yousign_client', '~> 1.0.1'
 
 ### Install from Git
 
@@ -54,16 +54,22 @@ Please follow the [installation](#installation) procedure and then run the follo
 # 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::AuthenticationsApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Find an Authentication by ID
-  result = api_instance.authentications_email_id_get(id, authorization)
+  result = api_instance.authentications_email_id_get(id, )
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling AuthenticationsApi->authentications_email_id_get: #{e}"
@@ -222,7 +228,7 @@ Class | Method | HTTP request | Description
 ## Documentation for Authorization
 
 
-### ApiKey
+### api_key
 
 - **Type**: API key
 - **API key parameter name**: Authorization

data/config.json

@@ -6,6 +6,6 @@
   "gemDescription": "Yousign API Documentation Ruby Gem",
   "gemHomepage": "https://github.com/cashbee-team/yousign_client",
   "moduleName": "YousignClient",
-  "gemLicense": "Apache 2.0",
-  "gemVersion": "1.0.0"
+  "gemLicense": "Apache-2.0",
+  "gemVersion": "1.0.1"
 }

data/docs/AuthenticationsApi.md

@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 
 # **authentications_email_id_get**
-> AuthenticationEmailOutput authentications_email_id_get(id, authorization)
+> AuthenticationEmailOutput authentications_email_id_get(id, )
 
 Find an Authentication by ID
 
@@ -21,17 +21,22 @@ Find an Authentication by 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::AuthenticationsApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Find an Authentication by ID
-  result = api_instance.authentications_email_id_get(id, authorization)
+  result = api_instance.authentications_email_id_get(id, )
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling AuthenticationsApi->authentications_email_id_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
 
 
 # **authentications_email_id_put**
-> AuthenticationEmailOutput authentications_email_id_put(id, authorization, content_type, body)
+> AuthenticationEmailOutput authentications_email_id_put(id, body)
 
 Update an Email Authentication
 
@@ -69,21 +73,24 @@ Update an Email Authentication
 ```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::AuthenticationsApi.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::Body2.new # Body2 | 
 
 
 begin
   #Update an Email Authentication
-  result = api_instance.authentications_email_id_put(id, authorization, content_type, body)
+  result = api_instance.authentications_email_id_put(id, body)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling AuthenticationsApi->authentications_email_id_put: #{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 | 
  **body** | [**Body2**](Body2.md)|  | 
 
 ### Return type
@@ -105,7 +110,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -115,7 +120,7 @@ No authorization required
 
 
 # **authentications_inwebo_id_get**
-> AuthenticationInweboOutput authentications_inwebo_id_get(id, authorization)
+> AuthenticationInweboOutput authentications_inwebo_id_get(id, )
 
 Get an Authentication
 
@@ -123,17 +128,22 @@ Get an Authentication
 ```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::AuthenticationsApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Get an Authentication
-  result = api_instance.authentications_inwebo_id_get(id, authorization)
+  result = api_instance.authentications_inwebo_id_get(id, )
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling AuthenticationsApi->authentications_inwebo_id_get: #{e}"
@@ -145,7 +155,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### Return type
 
@@ -153,7 +162,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -163,7 +172,7 @@ No authorization required
 
 
 # **authentications_inwebo_id_put**
-> AuthenticationInweboOutput authentications_inwebo_id_put(id, authorization, content_type, body)
+> AuthenticationInweboOutput authentications_inwebo_id_put(id, body)
 
 Update an inwebo Authentication
 
@@ -171,21 +180,24 @@ Update an inwebo Authentication
 ```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::AuthenticationsApi.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::Body.new # Body | 
 
 
 begin
   #Update an inwebo Authentication
-  result = api_instance.authentications_inwebo_id_put(id, authorization, content_type, body)
+  result = api_instance.authentications_inwebo_id_put(id, body)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling AuthenticationsApi->authentications_inwebo_id_put: #{e}"
@@ -197,8 +209,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** | [**Body**](Body.md)|  | 
 
 ### Return type
@@ -207,7 +217,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -217,7 +227,7 @@ No authorization required
 
 
 # **authentications_sms_id_get**
-> AuthenticationSmsOutput authentications_sms_id_get(id, authorization)
+> AuthenticationSmsOutput authentications_sms_id_get(id, )
 
 Find an Authentication by ID
 
@@ -225,17 +235,22 @@ Find an Authentication by 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::AuthenticationsApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Find an Authentication by ID
-  result = api_instance.authentications_sms_id_get(id, authorization)
+  result = api_instance.authentications_sms_id_get(id, )
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling AuthenticationsApi->authentications_sms_id_get: #{e}"
@@ -247,7 +262,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### Return type
 
@@ -255,7 +269,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -265,7 +279,7 @@ No authorization required
 
 
 # **authentications_sms_id_put**
-> AuthenticationSmsOutput authentications_sms_id_put(id, authorization, content_type, body)
+> AuthenticationSmsOutput authentications_sms_id_put(id, body)
 
 Update an SMS Authentication
 
@@ -273,21 +287,24 @@ Update an SMS Authentication
 ```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::AuthenticationsApi.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::Body1.new # Body1 | 
 
 
 begin
   #Update an SMS Authentication
-  result = api_instance.authentications_sms_id_put(id, authorization, content_type, body)
+  result = api_instance.authentications_sms_id_put(id, body)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling AuthenticationsApi->authentications_sms_id_put: #{e}"
@@ -299,8 +316,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** | [**Body1**](Body1.md)|  | 
 
 ### Return type
@@ -309,7 +324,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 

data/docs/CheckDocumentsApi.md

@@ -11,7 +11,7 @@ Method | HTTP request | Description
 
 
 # **check_document_bank_accounts_id_get**
-> CheckDocumentBankAccountsOutput check_document_bank_accounts_id_get(id, authorization)
+> CheckDocumentBankAccountsOutput check_document_bank_accounts_id_get(id)
 
 Get informations about a bank document (RIB)
 
@@ -19,17 +19,22 @@ Get informations about a bank document (RIB)
 ```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::CheckDocumentsApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Get informations about a bank document (RIB)
-  result = api_instance.check_document_bank_accounts_id_get(id, authorization)
+  result = api_instance.check_document_bank_accounts_id_get(id)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling CheckDocumentsApi->check_document_bank_accounts_id_get: #{e}"
@@ -41,7 +46,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### Return type
 
@@ -49,7 +53,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -59,7 +63,7 @@ No authorization required
 
 
 # **check_document_bank_accounts_post**
-> CheckDocumentBankAccountsOutput check_document_bank_accounts_post(authorization, content_type, body)
+> CheckDocumentBankAccountsOutput check_document_bank_accounts_post(body)
 
 Verify a bank document (RIB)
 
@@ -67,19 +71,22 @@ Verify a bank document (RIB)
 ```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::CheckDocumentsApi.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::CheckDocumentBankAccountsInput.new # CheckDocumentBankAccountsInput | 
 
 
 begin
   #Verify a bank document (RIB)
-  result = api_instance.check_document_bank_accounts_post(authorization, content_type, body)
+  result = api_instance.check_document_bank_accounts_post(body)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling CheckDocumentsApi->check_document_bank_accounts_post: #{e}"
@@ -90,8 +97,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** | [**CheckDocumentBankAccountsInput**](CheckDocumentBankAccountsInput.md)|  | 
 
 ### Return type
@@ -100,7 +105,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -110,7 +115,7 @@ No authorization required
 
 
 # **check_document_identities_id_get**
-> CheckDocumentIdentitiesOutput check_document_identities_id_get(id, authorization)
+> CheckDocumentIdentitiesOutput check_document_identities_id_get(id)
 
 Get informations about an identity document (passport, id cards)
 
@@ -118,17 +123,22 @@ Get informations about an identity document (passport, id cards)
 ```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::CheckDocumentsApi.new
 
 id = 'id_example' # String | 
 
-authorization = 'authorization_example' # String | Authentication credentials for HTTP authentication
-
 
 begin
   #Get informations about an identity document (passport, id cards)
-  result = api_instance.check_document_identities_id_get(id, authorization)
+  result = api_instance.check_document_identities_id_get(id)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling CheckDocumentsApi->check_document_identities_id_get: #{e}"
@@ -140,7 +150,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **authorization** | **String**| Authentication credentials for HTTP authentication | 
 
 ### Return type
 
@@ -148,7 +157,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -158,7 +167,7 @@ No authorization required
 
 
 # **check_document_identities_post**
-> CheckDocumentIdentitiesOutput check_document_identities_post(authorization, content_type, body)
+> CheckDocumentIdentitiesOutput check_document_identities_post(body)
 
 Verify an identity document (passport, id cards)
 
@@ -166,19 +175,22 @@ Verify an identity document (passport, id cards)
 ```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::CheckDocumentsApi.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::CheckDocumentIdentitiesInput.new # CheckDocumentIdentitiesInput | 
 
 
 begin
   #Verify an identity document (passport, id cards)
-  result = api_instance.check_document_identities_post(authorization, content_type, body)
+  result = api_instance.check_document_identities_post(body)
   p result
 rescue YousignClient::ApiError => e
   puts "Exception when calling CheckDocumentsApi->check_document_identities_post: #{e}"
@@ -189,8 +201,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** | [**CheckDocumentIdentitiesInput**](CheckDocumentIdentitiesInput.md)|  | 
 
 ### Return type
@@ -199,7 +209,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers