docs/ConversationApi.md in smooch-api-5.13.0 vs docs/ConversationApi.md in smooch-api-5.15.0
- old
+ new
@@ -23,11 +23,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'
@@ -62,11 +66,11 @@
[**ActivityResponse**](ActivityResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -84,11 +88,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'
@@ -122,11 +130,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
@@ -144,11 +152,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'
@@ -179,11 +191,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
@@ -201,11 +213,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'
@@ -243,11 +259,11 @@
[**GetMessagesResponse**](GetMessagesResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -265,11 +281,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'
@@ -304,11 +324,11 @@
[**MessageResponse**](MessageResponse.md)
### Authorization
-[jwt](../README.md#jwt)
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -326,11 +346,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'
@@ -361,10 +385,10 @@
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