rainbow-submarine-test-3356 1.2.2

data/docs/AppUserLink.md

@@ -0,0 +1,9 @@
+# RainbowSubmarineTest3356::AppUserLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**skip_confirmation** | **BOOLEAN** |  | [optional] 
+
+

data/docs/AppUserPreCreate.md

@@ -0,0 +1,14 @@
+# RainbowSubmarineTest3356::AppUserPreCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** |  | 
+**credential_required** | **BOOLEAN** |  | [optional] 
+**given_name** | **String** |  | [optional] 
+**surname** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**signed_up_at** | **String** |  | [optional] 
+**properties** | **Object** |  | [optional] 
+
+

data/docs/AppUserResponse.md

@@ -0,0 +1,8 @@
+# RainbowSubmarineTest3356::AppUserResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_user** | [**AppUser**](AppUser.md) |  | 
+
+

data/docs/AppUserUpdate.md

@@ -0,0 +1,12 @@
+# RainbowSubmarineTest3356::AppUserUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**given_name** | **String** |  | [optional] 
+**surname** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**signed_up_at** | **String** |  | [optional] 
+**properties** | **Object** |  | [optional] 
+
+

data/docs/Client.md

@@ -0,0 +1,12 @@
+# RainbowSubmarineTest3356::Client
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**active** | **BOOLEAN** |  | 
+**last_seen** | **String** |  | 
+**platform** | **String** |  | 
+**info** | [**ClientInfo**](ClientInfo.md) |  | 
+
+

data/docs/ClientInfo.md

@@ -0,0 +1,15 @@
+# RainbowSubmarineTest3356::ClientInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_name** | **String** |  | [optional] 
+**device_model** | **String** |  | [optional] 
+**os** | **String** |  | [optional] 
+**os_version** | **String** |  | [optional] 
+**radio_access_technology** | **String** |  | [optional] 
+**carrier** | **String** |  | [optional] 
+**device_platform** | **String** |  | [optional] 
+**wifi** | **String** |  | [optional] 
+
+

data/docs/ClientResponse.md

@@ -0,0 +1,8 @@
+# RainbowSubmarineTest3356::ClientResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**device** | [**Client**](Client.md) |  | [optional] 
+
+

data/docs/Conversation.md

@@ -0,0 +1,9 @@
+# RainbowSubmarineTest3356::Conversation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **String** |  | 
+**unread_count** | **Float** |  | 
+
+

data/docs/ConversationApi.md

@@ -0,0 +1,192 @@
+# RainbowSubmarineTest3356::ConversationApi
+
+All URIs are relative to *https://api.smooch.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_messages**](ConversationApi.md#get_messages) | **GET** /appusers/{userId}/messages | 
+[**reset_unread_count**](ConversationApi.md#reset_unread_count) | **POST** /appusers/{userId}/conversation/read | 
+[**trigger_typing_activity**](ConversationApi.md#trigger_typing_activity) | **POST** /appusers/{userId}/conversation/activity | 
+
+
+# **get_messages**
+> GetMessagesResponse get_messages(user_id, , opts)
+
+
+
+Get the specified app users messages.
+
+### Example
+```ruby
+# load the gem
+require 'rainbow-submarine-test-3356'
+# setup authorization
+RainbowSubmarineTest3356.configure do |config|
+  # Configure API key authorization: appToken
+  config.api_key['app-token'] = '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['app-token'] = 'Bearer'
+
+  # Configure API key authorization: jwt
+  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 = RainbowSubmarineTest3356::ConversationApi.new
+
+user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
+
+opts = { 
+  before: "before_example", # String | Timestamp of message. The API will return 100 messages before the specified timestamp (excluding any messages with the provided timestamp).
+  after: "after_example" # String | Timestamp of message. The API will return 100 messages after the specified timestamp (excluding any messages with the provided timestamp).
+}
+
+begin
+  result = api_instance.get_messages(user_id, , opts)
+  p result
+rescue RainbowSubmarineTest3356::ApiError => e
+  puts "Exception when calling ConversationApi->get_messages: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. | 
+ **before** | **String**| Timestamp of message. The API will return 100 messages before the specified timestamp (excluding any messages with the provided timestamp). | [optional] 
+ **after** | **String**| Timestamp of message. The API will return 100 messages after the specified timestamp (excluding any messages with the provided timestamp). | [optional] 
+
+### Return type
+
+[**GetMessagesResponse**](GetMessagesResponse.md)
+
+### Authorization
+
+[appToken](../README.md#appToken), [jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **reset_unread_count**
+> reset_unread_count(user_id, )
+
+
+
+Reset the unread count of the conversation to 0. If the conversation has not yet been created for the specified app user 404 will be returned.
+
+### Example
+```ruby
+# load the gem
+require 'rainbow-submarine-test-3356'
+# setup authorization
+RainbowSubmarineTest3356.configure do |config|
+  # Configure API key authorization: appToken
+  config.api_key['app-token'] = '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['app-token'] = 'Bearer'
+
+  # Configure API key authorization: jwt
+  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 = RainbowSubmarineTest3356::ConversationApi.new
+
+user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
+
+
+begin
+  api_instance.reset_unread_count(user_id, )
+rescue RainbowSubmarineTest3356::ApiError => e
+  puts "Exception when calling ConversationApi->reset_unread_count: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[appToken](../README.md#appToken), [jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **trigger_typing_activity**
+> trigger_typing_activity(user_id, typing_activity_trigger)
+
+
+
+Notify Smooch when an app maker starts or stops typing a response.
+
+### Example
+```ruby
+# load the gem
+require 'rainbow-submarine-test-3356'
+# setup authorization
+RainbowSubmarineTest3356.configure do |config|
+  # Configure API key authorization: appToken
+  config.api_key['app-token'] = '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['app-token'] = 'Bearer'
+
+  # Configure API key authorization: jwt
+  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 = RainbowSubmarineTest3356::ConversationApi.new
+
+user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
+
+typing_activity_trigger = RainbowSubmarineTest3356::TypingActivityTrigger.new # TypingActivityTrigger | Supported properties for a triggerTypingActivity request.
+
+
+begin
+  api_instance.trigger_typing_activity(user_id, typing_activity_trigger)
+rescue RainbowSubmarineTest3356::ApiError => e
+  puts "Exception when calling ConversationApi->trigger_typing_activity: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. | 
+ **typing_activity_trigger** | [**TypingActivityTrigger**](TypingActivityTrigger.md)| Supported properties for a triggerTypingActivity request. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[appToken](../README.md#appToken), [jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DeviceUpdate.md

@@ -0,0 +1,10 @@
+# RainbowSubmarineTest3356::DeviceUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**push_notification_token** | **String** |  | [optional] 
+**app_version** | **String** |  | [optional] 
+**info** | [**ClientInfo**](ClientInfo.md) |  | [optional] 
+
+

data/docs/Event.md

@@ -0,0 +1,8 @@
+# RainbowSubmarineTest3356::Event
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+
+

data/docs/GetMessagesResponse.md

@@ -0,0 +1,10 @@
+# RainbowSubmarineTest3356::GetMessagesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**Conversation**](Conversation.md) |  | [optional] 
+**messages** | [**Array<Message>**](Message.md) |  | [optional] 
+**_next** | **String** |  | [optional] 
+
+

data/docs/Menu.md

@@ -0,0 +1,9 @@
+# RainbowSubmarineTest3356::Menu
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**items** | [**Array<MenuItem>**](MenuItem.md) |  | 
+
+

data/docs/MenuApi.md

@@ -0,0 +1,163 @@
+# RainbowSubmarineTest3356::MenuApi
+
+All URIs are relative to *https://api.smooch.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_menu**](MenuApi.md#delete_menu) | **DELETE** /menu | 
+[**get_menu**](MenuApi.md#get_menu) | **GET** /menu | 
+[**update_menu**](MenuApi.md#update_menu) | **PUT** /menu | 
+
+
+# **delete_menu**
+> MenuResponse delete_menu
+
+
+
+Remove the specified app’s menu.
+
+### Example
+```ruby
+# load the gem
+require 'rainbow-submarine-test-3356'
+# setup authorization
+RainbowSubmarineTest3356.configure do |config|
+  # Configure API key authorization: appToken
+  config.api_key['app-token'] = '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['app-token'] = 'Bearer'
+
+  # Configure API key authorization: jwt
+  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 = RainbowSubmarineTest3356::MenuApi.new
+
+begin
+  result = api_instance.delete_menu
+  p result
+rescue RainbowSubmarineTest3356::ApiError => e
+  puts "Exception when calling MenuApi->delete_menu: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**MenuResponse**](MenuResponse.md)
+
+### Authorization
+
+[appToken](../README.md#appToken), [jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_menu**
+> MenuResponse get_menu
+
+
+
+Get the specified app’s menu.
+
+### Example
+```ruby
+# load the gem
+require 'rainbow-submarine-test-3356'
+# setup authorization
+RainbowSubmarineTest3356.configure do |config|
+  # Configure API key authorization: jwt
+  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 = RainbowSubmarineTest3356::MenuApi.new
+
+begin
+  result = api_instance.get_menu
+  p result
+rescue RainbowSubmarineTest3356::ApiError => e
+  puts "Exception when calling MenuApi->get_menu: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**MenuResponse**](MenuResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_menu**
+> MenuResponse update_menu(menu_update)
+
+
+
+Configure the specified app’s menu.
+
+### Example
+```ruby
+# load the gem
+require 'rainbow-submarine-test-3356'
+# setup authorization
+RainbowSubmarineTest3356.configure do |config|
+  # Configure API key authorization: jwt
+  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 = RainbowSubmarineTest3356::MenuApi.new
+
+menu_update = RainbowSubmarineTest3356::Menu.new # Menu | Supported properties for a updateMenu request.
+
+
+begin
+  result = api_instance.update_menu(menu_update)
+  p result
+rescue RainbowSubmarineTest3356::ApiError => e
+  puts "Exception when calling MenuApi->update_menu: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **menu_update** | [**Menu**](Menu.md)| Supported properties for a updateMenu request. | 
+
+### Return type
+
+[**MenuResponse**](MenuResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+