docs/IntegrationApi.md in smooch-api-5.13.0 vs docs/IntegrationApi.md in smooch-api-5.15.0
- old
+ new
@@ -29,11 +29,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -65,11 +69,11 @@
[**IntegrationResponse**](IntegrationResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -87,11 +91,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -126,11 +134,11 @@
[**MenuResponse**](MenuResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -148,11 +156,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -183,11 +195,11 @@
nil (empty response body)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -205,11 +217,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -240,11 +256,11 @@
nil (empty response body)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -262,11 +278,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -298,11 +318,11 @@
[**IntegrationResponse**](IntegrationResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -320,11 +340,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -356,11 +380,11 @@
[**MenuResponse**](MenuResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -378,11 +402,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -414,11 +442,11 @@
[**GetIntegrationProfileResponse**](GetIntegrationProfileResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -436,11 +464,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -477,11 +509,11 @@
[**ListIntegrationsResponse**](ListIntegrationsResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -499,11 +531,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -538,11 +574,11 @@
[**IntegrationResponse**](IntegrationResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -560,11 +596,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -599,11 +639,11 @@
[**MenuResponse**](MenuResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -621,11 +661,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -659,11 +703,11 @@
nil (empty response body)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -681,11 +725,15 @@
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
+ # Configure HTTP basic authorization (recommended): basicAuth
+ config.username = 'API_KEY_ID'
+ config.password = 'API_KEY_SECRET'
+
# OR
# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
@@ -720,10 +768,10 @@
[**UploadIntegrationProfilePhotoResponse**](UploadIntegrationProfilePhotoResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json