smooch-api 1.0.0

data/docs/Init.md

@@ -0,0 +1,9 @@
+# SmoochApi::Init
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**device** | [**DeviceInit**](DeviceInit.md) |  | 
+**user_id** | **String** | The app user's userId. If specified, this ID can be used to invoke APIs. If left blank, an ID will automatically be generated.  | [optional] 
+
+

data/docs/InitApi.md

@@ -0,0 +1,61 @@
+# SmoochApi::InitApi
+
+All URIs are relative to *https://api.smooch.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**init**](InitApi.md#init) | **POST** /init | 
+
+
+# **init**
+> InitResponse init(init_body)
+
+
+
+This API is called by an iOS, Android, or browser client when the app is first loaded. It serves a number of purposes. 1. Initializes a new *appUser* and *client* if they don’t yet exist. 2. Updates an existing app user’s profile and client information. 3. Authenticates the *appUser* if *jwt* credentials are provided. 
+
+### 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::InitApi.new
+
+init_body = SmoochApi::Init.new # Init | Body for an init request.
+
+
+begin
+  result = api_instance.init(init_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling InitApi->init: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **init_body** | [**Init**](Init.md)| Body for an init request. | 
+
+### Return type
+
+[**InitResponse**](InitResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/InitResponse.md

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

data/docs/Integration.md

@@ -0,0 +1,24 @@
+# SmoochApi::Integration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **String** | The integration ID, generated automatically. | 
+**type** | **String** | The integration type. | 
+**page_access_token** | **String** | Facebook Page Access Token. Required for *messenger* integrations.  | [optional] 
+**app_id** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger* and *wechat* integrations.  | [optional] 
+**app_secret** | **String** | Facebook Page App Secret OR WeChat App Secret. Required for *messenger* and *wechat* integrations.  | [optional] 
+**account_sid** | **String** | Twilio Account SID. Required for *twilio* integrations.  | [optional] 
+**auth_token** | **String** | Twilio Auth Token. Required for *twilio* integrations.  | [optional] 
+**phone_number_sid** | **String** | SID for specific phone number. Required for *twilio* integrations.  | [optional] 
+**token** | **String** | Telegram Bot Token OR Viber Public Account token. Required for *twilio* and *viber* integrations.  | [optional] 
+**channel_access_token** | **String** | LINE Channel Access Token. Required for *line* integrations.  | [optional] 
+**encoding_aes_key** | **String** | AES Encoding Key. (Optional) Used for *wechat* integrations.  | [optional] 
+**from_address** | **String** | Email will display as coming from this address. (Optional) Used for *frontendEmail* integrations.  | [optional] 
+**certificate** | **String** | The binary of your APN certificate base64 encoded. Required for *apn* integrations.  | [optional] 
+**password** | **String** | The password for your APN certificate. (Optional) Used for *apn* integrations.  | [optional] 
+**auto_update_badge** | **BOOLEAN** | Use the unread count of the conversation as the application badge. (Optional) Used for *apn* integrations.  | [optional] 
+**server_key** | **String** | Your server key from the fcm console. Required for *fcm* integrations.  | [optional] 
+**sender_id** | **String** | Your sender id from the fcm console. Required for *fcm* integrations.  | [optional] 
+
+

data/docs/IntegrationApi.md

@@ -0,0 +1,121 @@
+# SmoochApi::IntegrationApi
+
+All URIs are relative to *https://api.smooch.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_integration**](IntegrationApi.md#create_integration) | **POST** /apps/{appId}/integrations | 
+[**list_integrations**](IntegrationApi.md#list_integrations) | **GET** /apps/{appId}/integrations | 
+
+
+# **create_integration**
+> IntegrationResponse create_integration(app_id, integration_create_body)
+
+
+
+Create an integration for the specified app.
+
+### 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::IntegrationApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+integration_create_body = SmoochApi::IntegrationCreate.new # IntegrationCreate | Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration) 
+
+
+begin
+  result = api_instance.create_integration(app_id, integration_create_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling IntegrationApi->create_integration: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **integration_create_body** | [**IntegrationCreate**](IntegrationCreate.md)| Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration)  | 
+
+### Return type
+
+[**IntegrationResponse**](IntegrationResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_integrations**
+> ListIntegrationsResponse list_integrations(app_id, , opts)
+
+
+
+List integrations for the specified app.
+
+### 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::IntegrationApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+opts = { 
+  types: "types_example" # String | List of types to filter the query by. More than one value can be specified through comma separation e.g. ?types=*twilio*,*line*. 
+}
+
+begin
+  result = api_instance.list_integrations(app_id, , opts)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling IntegrationApi->list_integrations: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **types** | **String**| List of types to filter the query by. More than one value can be specified through comma separation e.g. ?types=*twilio*,*line*.  | [optional] 
+
+### Return type
+
+[**ListIntegrationsResponse**](ListIntegrationsResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/IntegrationCreate.md

@@ -0,0 +1,23 @@
+# SmoochApi::IntegrationCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The integration type. | 
+**page_access_token** | **String** | Facebook Page Access Token. Required for *messenger* integrations.  | [optional] 
+**app_id** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger* and *wechat* integrations.  | [optional] 
+**app_secret** | **String** | Facebook Page App Secret OR WeChat App Secret. Required for *messenger* and *wechat* integrations.  | [optional] 
+**account_sid** | **String** | Twilio Account SID. Required for *twilio* integrations.  | [optional] 
+**auth_token** | **String** | Twilio Auth Token. Required for *twilio* integrations.  | [optional] 
+**phone_number_sid** | **String** | SID for specific phone number. Required for *twilio* integrations.  | [optional] 
+**token** | **String** | Telegram Bot Token OR Viber Public Account token. Required for *twilio* and *viber* integrations.  | [optional] 
+**channel_access_token** | **String** | LINE Channel Access Token. Required for *line* integrations.  | [optional] 
+**encoding_aes_key** | **String** | AES Encoding Key. (Optional) Used for *wechat* integrations.  | [optional] 
+**from_address** | **String** | Email will display as coming from this address. (Optional) Used for *frontendEmail* integrations.  | [optional] 
+**certificate** | **String** | The binary of your APN certificate base64 encoded. Required for *apn* integrations.  | [optional] 
+**password** | **String** | The password for your APN certificate. (Optional) Used for *apn* integrations.  | [optional] 
+**auto_update_badge** | **BOOLEAN** | Use the unread count of the conversation as the application badge. (Optional) Used for *apn* integrations.  | [optional] 
+**server_key** | **String** | Your server key from the fcm console. Required for *fcm* integrations.  | [optional] 
+**sender_id** | **String** | Your sender id from the fcm console. Required for *fcm* integrations.  | [optional] 
+
+

data/docs/IntegrationResponse.md

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

data/docs/JwtResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::JwtResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jwt** | **String** | The JWT. | [optional] 
+
+

data/docs/ListAppsResponse.md

@@ -0,0 +1,10 @@
+# SmoochApi::ListAppsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**apps** | [**Array<App>**](App.md) | The list of apps. | [optional] 
+**has_more** | **BOOLEAN** | Flag indicating if there are more apps that are not present in the response. | [optional] 
+**offset** | **Integer** | The number of app records skipped in the returned list. | [optional] 
+
+

data/docs/ListIntegrationsResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::ListIntegrationsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integrations** | [**Array<Integration>**](Integration.md) | The list of integrations. | [optional] 
+
+

data/docs/ListSecretKeysResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::ListSecretKeysResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**keys** | [**Array<SecretKey>**](SecretKey.md) | The list of secret keys. | [optional] 
+
+

data/docs/ListWebhooksResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::ListWebhooksResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhooks** | [**Array<Webhook>**](Webhook.md) | The list of webhooks. | 
+
+

data/docs/Menu.md

@@ -0,0 +1,9 @@
+# SmoochApi::Menu
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the menu. | [optional] 
+**items** | [**Array<MenuItem>**](MenuItem.md) | A list of menu items. | 
+
+

data/docs/MenuApi.md

@@ -0,0 +1,155 @@
+# SmoochApi::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 '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::MenuApi.new
+
+begin
+  result = api_instance.delete_menu
+  p result
+rescue SmoochApi::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
+
+[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 '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::MenuApi.new
+
+begin
+  result = api_instance.get_menu
+  p result
+rescue SmoochApi::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_body)
+
+
+
+Configure the specified app’s menu.
+
+### 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::MenuApi.new
+
+menu_update_body = SmoochApi::Menu.new # Menu | Body for a updateMenu request.
+
+
+begin
+  result = api_instance.update_menu(menu_update_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling MenuApi->update_menu: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **menu_update_body** | [**Menu**](Menu.md)| Body for a updateMenu request. | 
+
+### Return type
+
+[**MenuResponse**](MenuResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+