sunshine-conversations-client 9.1.1

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AcceptControlBody.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::AcceptControlBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | **Object** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. The metadata object will be included in the `switchboard:acceptControl` and `switchboard:acceptControl:failure` webhooks. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AcceptControlBody.new(metadata: null)
+```
+
+

data/docs/Action.md

@@ -0,0 +1,41 @@
+# SunshineConversationsClient::Action
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of action. | 
+**text** | **String** | The button text. | 
+**amount** | **Integer** | The amount being charged. It needs to be specified in cents and is an integer (9.99$ -> 999). | 
+**currency** | **String** | An ISO 4217 standard currency code in lowercase. Used for actions of type buy. | [optional] 
+**metadata** | [**Object**](.md) | Flat object containing custom properties. Strings, numbers and booleans  are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.  | [optional] 
+**uri** | **String** | The webview URI. This is the URI that will open in the webview when clicking the button. | 
+**default** | **Boolean** | Boolean value indicating whether the action is the default action for a message item in Facebook Messenger. | [optional] 
+**extra_channel_options** | [**ExtraChannelOptions**](ExtraChannelOptions.md) |  | [optional] 
+**payload** | **String** | A string payload to help you identify the action context. Used when posting the reply. You can also use metadata for more complex needs. | 
+**icon_url** | **String** | An icon to render next to the reply option. | [optional] 
+**size** | **String** | The size to display a webview. Used for actions of type webview. | [optional] 
+**fallback** | **String** | The fallback uri for channels that don’t support webviews. Used for actions of type webview. | 
+**open_on_receive** | **Boolean** | Boolean value indicating if the webview should open automatically. Only one action per message can be set to true. Currently only supported on the Web Messenger. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Action.new(type: null,
+                                 text: null,
+                                 amount: 8000,
+                                 currency: CAD,
+                                 metadata: {"lang":"en-ca"},
+                                 uri: null,
+                                 default: null,
+                                 extra_channel_options: null,
+                                 payload: null,
+                                 icon_url: null,
+                                 size: null,
+                                 fallback: null,
+                                 open_on_receive: null)
+```
+
+

data/docs/ActionSubset.md

@@ -0,0 +1,39 @@
+# SunshineConversationsClient::ActionSubset
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of action. | 
+**text** | **String** | The button text. | 
+**amount** | **Integer** | The amount being charged. It needs to be specified in cents and is an integer (9.99$ -> 999). | 
+**currency** | **String** | An ISO 4217 standard currency code in lowercase. Used for actions of type buy. | [optional] 
+**metadata** | [**Object**](.md) | Flat object containing custom properties. Strings, numbers and booleans  are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.  | [optional] 
+**uri** | **String** | The webview URI. This is the URI that will open in the webview when clicking the button. | 
+**default** | **Boolean** | Boolean value indicating whether the action is the default action for a message item in Facebook Messenger. | [optional] 
+**extra_channel_options** | [**ExtraChannelOptions**](ExtraChannelOptions.md) |  | [optional] 
+**payload** | **String** | The payload of a postback or reply button. | 
+**size** | **String** | The size to display a webview. Used for actions of type webview. | [optional] 
+**fallback** | **String** | The fallback uri for channels that don’t support webviews. Used for actions of type webview. | 
+**open_on_receive** | **Boolean** | Boolean value indicating if the webview should open automatically. Only one action per message can be set to true. Currently only supported on the Web Messenger. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ActionSubset.new(type: null,
+                                 text: null,
+                                 amount: 8000,
+                                 currency: CAD,
+                                 metadata: {"lang":"en-ca"},
+                                 uri: null,
+                                 default: null,
+                                 extra_channel_options: null,
+                                 payload: null,
+                                 size: null,
+                                 fallback: null,
+                                 open_on_receive: null)
+```
+
+

data/docs/ActivitiesApi.md

@@ -0,0 +1,71 @@
+# SunshineConversationsClient::ActivitiesApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**post_activity**](ActivitiesApi.md#post_activity) | **POST** /v2/apps/{appId}/conversations/{conversationId}/activity | Post Activity
+
+
+
+## post_activity
+
+> Object post_activity(app_id, conversation_id, activity_post)
+
+Post Activity
+
+Notify Sunshine Conversations of different conversation activities. Supported activity types are: * Typing activity * Conversation read event 
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::ActivitiesApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+activity_post = {"author":{"type":"user","userId":"5963c0d619a30a2e00de36b8"},"type":"conversation:read"} # ActivityPost | 
+# Be sure to add the required body parameters
+
+begin
+  #Post Activity
+  result = api_instance.post_activity(app_id, conversation_id, activity_post)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ActivitiesApi->post_activity: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+ **activity_post** | [**ActivityPost**](ActivityPost.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Activity.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::Activity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | If the author type is `user`, only `conversation:read` is supported. | [optional] 
+**source** | [**SourceWebhook**](SourceWebhook.md) | The source of the activity. | [optional] 
+**author** | [**AuthorWebhook**](AuthorWebhook.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Activity.new(type: null,
+                                 source: null,
+                                 author: null)
+```
+
+

data/docs/ActivityAllOf.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::ActivityAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source** | [**SourceWebhook**](SourceWebhook.md) | The source of the activity. | [optional] 
+**author** | [**AuthorWebhook**](AuthorWebhook.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ActivityAllOf.new(source: null,
+                                 author: null)
+```
+
+

data/docs/ActivityPost.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::ActivityPost
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**author** | [**Author**](Author.md) | The author of the activity. | 
+**type** | **String** | If the author type is `user`, only `conversation:read` is supported. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ActivityPost.new(author: null,
+                                 type: null)
+```
+
+

data/docs/ActivityPostAllOf.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::ActivityPostAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**author** | [**Author**](Author.md) | The author of the activity. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ActivityPostAllOf.new(author: null)
+```
+
+

data/docs/ActivityTypes.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::ActivityTypes
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | If the author type is `user`, only `conversation:read` is supported. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ActivityTypes.new(type: null)
+```
+
+

data/docs/Android.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::Android
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'android']
+**server_key** | **String** | Your server key from the fcm console. | [optional] 
+**sender_id** | **String** | Your sender id from the fcm console. | [optional] 
+**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the android integration. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Android.new(type: null,
+                                 server_key: <server-key>,
+                                 sender_id: <sender-id>,
+                                 can_user_create_more_conversations: null)
+```
+
+

data/docs/AndroidAllOf.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::AndroidAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'android']
+**server_key** | **String** | Your server key from the fcm console. | [optional] 
+**sender_id** | **String** | Your sender id from the fcm console. | [optional] 
+**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the android integration. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AndroidAllOf.new(type: null,
+                                 server_key: <server-key>,
+                                 sender_id: <sender-id>,
+                                 can_user_create_more_conversations: null)
+```
+
+

data/docs/AndroidUpdate.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::AndroidUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional] 
+**server_key** | **String** | Your server key from the fcm console. | [optional] 
+**sender_id** | **String** | Your sender id from the fcm console. | [optional] 
+**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the android integration. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AndroidUpdate.new(display_name: My awesome integration,
+                                 server_key: <server-key>,
+                                 sender_id: <sender-id>,
+                                 can_user_create_more_conversations: null)
+```
+
+

data/docs/AndroidUpdateAllOf.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::AndroidUpdateAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**server_key** | **String** | Your server key from the fcm console. | [optional] 
+**sender_id** | **String** | Your sender id from the fcm console. | [optional] 
+**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the android integration. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AndroidUpdateAllOf.new(server_key: <server-key>,
+                                 sender_id: <sender-id>,
+                                 can_user_create_more_conversations: null)
+```
+
+

data/docs/ApiKey.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::ApiKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the API key, used when signing JWTs or accessing the API using Basic Authentication. | [optional] 
+**display_name** | **String** | The name of the API key. | [optional] 
+**secret** | **String** | The secret of the API key, used when signing JWTs or accessing the API using Basic Authentication | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ApiKey.new(id: int_5e4b0f225aca01092928f917,
+                                 display_name: My custom key,
+                                 secret: Ck1LjzzlUzvlCTtqAdQ2z1QukuBTrN3TIx)
+```
+
+

data/docs/App.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::App
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A canonical ID that can be used to retrieve the Sunshine Conversations app. | [optional] 
+**display_name** | **String** | The friendly name of the app. | [optional] 
+**settings** | [**AppSettings**](AppSettings.md) |  | [optional] 
+**metadata** | [**Object**](.md) | Flat object containing custom properties. Strings, numbers and booleans  are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::App.new(id: 5d8cff3cd55b040010928b5b,
+                                 display_name: My App,
+                                 settings: null,
+                                 metadata: {"lang":"en-ca"})
+```
+
+

data/docs/AppCreateBody.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::AppCreateBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** | The friendly name of the app. | 
+**settings** | [**AppSettings**](AppSettings.md) |  | [optional] 
+**metadata** | [**Object**](.md) | Flat object containing custom properties. Strings, numbers and booleans  are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AppCreateBody.new(display_name: My App,
+                                 settings: null,
+                                 metadata: {"lang":"en-ca"})
+```
+
+