smooch-api 1.0.0

data/docs/AppUserLink.md

@@ -0,0 +1,9 @@
+# SmoochApi::AppUserLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of the channel to link. | 
+**skip_confirmation** | **String** | Flag indicating if the linking confirmation should be skipped. | [optional] 
+
+

data/docs/AppUserPreCreate.md

@@ -0,0 +1,14 @@
+# SmoochApi::AppUserPreCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** | The app user's userId. This ID is specified by the appMaker.  | 
+**credential_required** | **BOOLEAN** | Flag indicating if the appUser is secured by a JSON Web Token or not. | [optional] 
+**given_name** | **String** | The app user's given name. | [optional] 
+**surname** | **String** | The app user's surname. | [optional] 
+**email** | **String** | The app user's email. | [optional] 
+**signed_up_at** | **String** | A datetime string with the format *yyyy-mm-ddThh:mm:ssZ* representing the moment an appUser was created. | [optional] 
+**properties** | **Object** | Custom properties for the app user. | [optional] 
+
+

data/docs/AppUserResponse.md

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

data/docs/AppUserUpdate.md

@@ -0,0 +1,12 @@
+# SmoochApi::AppUserUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**given_name** | **String** | The app user's given name. | [optional] 
+**surname** | **String** | The app user's surname. | [optional] 
+**email** | **String** | The app user's email. | [optional] 
+**signed_up_at** | **String** | A datetime string with the format *yyyy-mm-ddThh:mm:ssZ* representing the moment an appUser was created. | [optional] 
+**properties** | **Object** | Custom properties for the app user. | [optional] 
+
+

data/docs/Client.md

@@ -0,0 +1,14 @@
+# SmoochApi::Client
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | An identifier for the client. Must be globally unique. | 
+**active** | **BOOLEAN** | Flag indicating if the client is active. | [optional] 
+**last_seen** | **String** | The date time the client was last seen. | [optional] 
+**platform** | **String** | The client's platform. | 
+**push_notification_token** | **String** | The GCM or APN token to be used for sending push notifications to the device. Applies to only *android* and *ios* clients.  | [optional] 
+**app_version** | **String** | A reserved string field for reporting the app version running on the device. | [optional] 
+**info** | [**ClientInfo**](ClientInfo.md) |  | [optional] 
+
+

data/docs/ClientInfo.md

@@ -0,0 +1,15 @@
+# SmoochApi::ClientInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_name** | **String** | Name of the app associated with the client. | [optional] 
+**device_model** | **String** | The client's device model. | [optional] 
+**os** | **String** | The client's OS. | [optional] 
+**os_version** | **String** | The client's OS version. | [optional] 
+**radio_access_technology** | **String** | The client's radioAccessTechnology (Ex. HSDPA). | [optional] 
+**carrier** | **String** | The client's carrier. | [optional] 
+**device_platform** | **String** | The client's device platform. | [optional] 
+**wifi** | **String** | Whether or not the client has wifi. | [optional] 
+
+

data/docs/Conversation.md

@@ -0,0 +1,9 @@
+# SmoochApi::Conversation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **String** | The conversation ID, generated automatically. | 
+**unread_count** | **Integer** | The number of unread messages in the conversation. | 
+
+

data/docs/ConversationApi.md

@@ -0,0 +1,282 @@
+# SmoochApi::ConversationApi
+
+All URIs are relative to *https://api.smooch.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_messages**](ConversationApi.md#delete_messages) | **DELETE** /appusers/{userId}/messages | 
+[**get_messages**](ConversationApi.md#get_messages) | **GET** /appusers/{userId}/messages | 
+[**post_message**](ConversationApi.md#post_message) | **POST** /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 | 
+
+
+# **delete_messages**
+> delete_messages(user_id, )
+
+
+
+Clears the message history for a user, permanently deleting all messages, but leaving any connections to Messaging Channels and Business Systems intact. These connections allow for the conversation to continue in the future, while still being associated to the same appUser. 
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ConversationApi.new
+
+user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
+
+
+begin
+  api_instance.delete_messages(user_id, )
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ConversationApi->delete_messages: #{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
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_messages**
+> GetMessagesResponse get_messages(user_id, , opts)
+
+
+
+Get the specified app user's messages.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::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 SmoochApi::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
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_message**
+> PostMessagesResponse post_message(user_id, message_post_body)
+
+
+
+Post a message to or from the app user.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ConversationApi.new
+
+user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
+
+message_post_body = SmoochApi::MessagePost.new # MessagePost | Body for a postMessage request. Additional arguments are necessary based on message type ([text](https://docs.smooch.io/rest#text-message), [image](https://docs.smooch.io/rest#image-message), [carousel](https://docs.smooch.io/rest#carousel-message), [list](https://docs.smooch.io/rest#list-message)) 
+
+
+begin
+  result = api_instance.post_message(user_id, message_post_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ConversationApi->post_message: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. | 
+ **message_post_body** | [**MessagePost**](MessagePost.md)| Body for a postMessage request. Additional arguments are necessary based on message type ([text](https://docs.smooch.io/rest#text-message), [image](https://docs.smooch.io/rest#image-message), [carousel](https://docs.smooch.io/rest#carousel-message), [list](https://docs.smooch.io/rest#list-message))  | 
+
+### Return type
+
+[**PostMessagesResponse**](PostMessagesResponse.md)
+
+### Authorization
+
+[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.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::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 SmoochApi::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
+
+[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_body)
+
+
+
+Notify Smooch when an app maker starts or stops typing a response.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ConversationApi.new
+
+user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
+
+typing_activity_trigger_body = SmoochApi::TypingActivityTrigger.new # TypingActivityTrigger | Body for a triggerTypingActivity request.
+
+
+begin
+  api_instance.trigger_typing_activity(user_id, typing_activity_trigger_body)
+rescue SmoochApi::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_body** | [**TypingActivityTrigger**](TypingActivityTrigger.md)| Body for a triggerTypingActivity request. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Destination.md

@@ -0,0 +1,9 @@
+# SmoochApi::Destination
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integration_id** | **String** | The ID of the target integration. | 
+**integration_type** | **String** | The type of the target integration. | 
+
+

data/docs/DeviceInit.md

@@ -0,0 +1,12 @@
+# SmoochApi::DeviceInit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | An identifier for the client. Must be globally unique. | 
+**platform** | **String** | The client's platform. | 
+**push_notification_token** | **String** | The GCM or APN token to be used for sending push notifications to the device. Applies to only *android* and *ios* clients.  | [optional] 
+**app_version** | **String** | A reserved string field for reporting the app version running on the device. | [optional] 
+**info** | [**ClientInfo**](ClientInfo.md) |  | [optional] 
+
+

data/docs/DeviceResponse.md

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

data/docs/DeviceUpdate.md

@@ -0,0 +1,10 @@
+# SmoochApi::DeviceUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**push_notification_token** | **String** | The GCM or APN token to be used for sending push notifications to the device. Applies to only *android* and *ios* clients.  | [optional] 
+**app_version** | **String** | A reserved string field for reporting the app version running on the device. | [optional] 
+**info** | [**ClientInfo**](ClientInfo.md) |  | [optional] 
+
+

data/docs/DisplaySettings.md

@@ -0,0 +1,8 @@
+# SmoochApi::DisplaySettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image_aspect_ratio** | **String** | Specifies how to display all carousel images. Valid values are *horizontal* (default) and *square*. | [optional] 
+
+

data/docs/Event.md

@@ -0,0 +1,8 @@
+# SmoochApi::Event
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the event. | 
+
+

data/docs/GetMessagesResponse.md

@@ -0,0 +1,10 @@
+# SmoochApi::GetMessagesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**Conversation**](Conversation.md) | The conversation. | [optional] 
+**messages** | [**Array<Message>**](Message.md) | The messages. | [optional] 
+**_next** | **String** | The URI for the next set of messages in the conversation. | [optional] 
+
+