smooch-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd48511580e303108b0d1b5097264640a3e8ea20
+  data.tar.gz: 331201e4876844eb949bb1cc0de525367c7aaae3
+SHA512:
+  metadata.gz: 0ba3c207987d2681dcde95feb0fc2bba74b6abf8ae993c77bdb75bda0ec9a5ac7778a79f66b4d73ab16ff3848b2b6ffc247c5dc1edd4347aded5c15046495318
+  data.tar.gz: 8a0788d056a0e9d2c9d2f1ff0552d2cb5d56b1005efba1e58b32e1a3f85121a18e609232cdfd650c3e1805621d7bb1dc9b407858250f71ed226ac613c21e96f7

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,181 @@
+# smooch-api
+
+SmoochApi - the Ruby gem for the Smooch API
+
+The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+Install the gem:
+
+```shell
+gem install smooch-api
+```
+
+Add this to the Gemfile:
+
+    gem 'smooch-api', '~> 1.0.0'
+
+## Getting Started
+
+### Authentication with JSON Web Tokens (JWTs)
+
+JSON Web Tokens (JWTs) are an industry standard authentication mechanism. A great introduction to the technology is available [here](https://jwt.io/introduction/), and a broad set of supported JWT libraries for a variety of languages and platforms are available.
+
+A JWT is composed of a header, a payload, and a signature. The payload contains information called claims which describe the subject to whom the token was issued.
+
+Before you can make calls to the Smooch API, you'll need to create a JWT that proves you are authorized to use the API.
+
+ #### **Step 1** Generate a KEY ID and SECRET on the settings tab in the Smooch Dashboard.
+
+![secret key and id](https://docs.smooch.io/images/secret_keys.png)
+
+ #### **Step 2** Generate the JWT
+
+Using the [ruby-jwt](https://github.com/jwt/ruby-jwt) gem:
+
+```ruby
+require 'jwt'
+
+payload = {:scope => 'app'}
+jwtHeader = {:kid => KEY_ID}
+
+token = JWT.encode payload, SECRET, 'HS256', jwtHeader
+```
+
+### Running the code
+
+```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::AppApi.new
+
+app_create_body = SmoochApi::AppCreate.new # AppCreate | Body for a createApp request.
+
+
+begin
+  result = api_instance.create_app(app_create_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->create_app: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.smooch.io/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SmoochApi::AppApi* | [**create_app**](docs/AppApi.md#create_app) | **POST** /apps | 
+*SmoochApi::AppApi* | [**create_secret_key**](docs/AppApi.md#create_secret_key) | **POST** /apps/{appId}/keys | 
+*SmoochApi::AppApi* | [**delete_app**](docs/AppApi.md#delete_app) | **DELETE** /apps/{appId} | 
+*SmoochApi::AppApi* | [**delete_integration**](docs/AppApi.md#delete_integration) | **DELETE** /apps/{appId}/integrations/{integrationId} | 
+*SmoochApi::AppApi* | [**delete_secret_key**](docs/AppApi.md#delete_secret_key) | **DELETE** /apps/{appId}/keys/{keyId} | 
+*SmoochApi::AppApi* | [**get_app**](docs/AppApi.md#get_app) | **GET** /apps/{appId} | 
+*SmoochApi::AppApi* | [**get_app_jwt**](docs/AppApi.md#get_app_jwt) | **GET** /apps/{appId}/keys/{keyId}/jwt | 
+*SmoochApi::AppApi* | [**get_integration**](docs/AppApi.md#get_integration) | **GET** /apps/{appId}/integrations/{integrationId} | 
+*SmoochApi::AppApi* | [**get_secret_key**](docs/AppApi.md#get_secret_key) | **GET** /apps/{appId}/keys/{keyId} | 
+*SmoochApi::AppApi* | [**list_apps**](docs/AppApi.md#list_apps) | **GET** /apps | 
+*SmoochApi::AppApi* | [**list_secret_keys**](docs/AppApi.md#list_secret_keys) | **GET** /apps/{appId}/keys | 
+*SmoochApi::AppUserApi* | [**app_user_device_update**](docs/AppUserApi.md#app_user_device_update) | **PUT** /appusers/{userId}/devices/{deviceId} | 
+*SmoochApi::AppUserApi* | [**delete_app_user_profile**](docs/AppUserApi.md#delete_app_user_profile) | **DELETE** /appusers/{userId}/profile | 
+*SmoochApi::AppUserApi* | [**get_app_user**](docs/AppUserApi.md#get_app_user) | **GET** /appusers/{userId} | 
+*SmoochApi::AppUserApi* | [**get_app_user_entity_ids**](docs/AppUserApi.md#get_app_user_entity_ids) | **GET** /appusers/{userId}/channels | 
+*SmoochApi::AppUserApi* | [**link_app_user**](docs/AppUserApi.md#link_app_user) | **POST** /appusers/{userId}/channels | 
+*SmoochApi::AppUserApi* | [**post_image_message**](docs/AppUserApi.md#post_image_message) | **POST** /appusers/{userId}/images | 
+*SmoochApi::AppUserApi* | [**pre_create_app_user**](docs/AppUserApi.md#pre_create_app_user) | **POST** /appusers | 
+*SmoochApi::AppUserApi* | [**track_event**](docs/AppUserApi.md#track_event) | **POST** /appusers/{userId}/events | 
+*SmoochApi::AppUserApi* | [**unlink_app_user**](docs/AppUserApi.md#unlink_app_user) | **DELETE** /appusers/{userId}/channels/{channel} | 
+*SmoochApi::AppUserApi* | [**update_app_user**](docs/AppUserApi.md#update_app_user) | **PUT** /appusers/{userId} | 
+*SmoochApi::ConversationApi* | [**delete_messages**](docs/ConversationApi.md#delete_messages) | **DELETE** /appusers/{userId}/messages | 
+*SmoochApi::ConversationApi* | [**get_messages**](docs/ConversationApi.md#get_messages) | **GET** /appusers/{userId}/messages | 
+*SmoochApi::ConversationApi* | [**post_message**](docs/ConversationApi.md#post_message) | **POST** /appusers/{userId}/messages | 
+*SmoochApi::ConversationApi* | [**reset_unread_count**](docs/ConversationApi.md#reset_unread_count) | **POST** /appusers/{userId}/conversation/read | 
+*SmoochApi::ConversationApi* | [**trigger_typing_activity**](docs/ConversationApi.md#trigger_typing_activity) | **POST** /appusers/{userId}/conversation/activity | 
+*SmoochApi::InitApi* | [**init**](docs/InitApi.md#init) | **POST** /init | 
+*SmoochApi::IntegrationApi* | [**create_integration**](docs/IntegrationApi.md#create_integration) | **POST** /apps/{appId}/integrations | 
+*SmoochApi::IntegrationApi* | [**list_integrations**](docs/IntegrationApi.md#list_integrations) | **GET** /apps/{appId}/integrations | 
+*SmoochApi::MenuApi* | [**delete_menu**](docs/MenuApi.md#delete_menu) | **DELETE** /menu | 
+*SmoochApi::MenuApi* | [**get_menu**](docs/MenuApi.md#get_menu) | **GET** /menu | 
+*SmoochApi::MenuApi* | [**update_menu**](docs/MenuApi.md#update_menu) | **PUT** /menu | 
+*SmoochApi::WebhookApi* | [**create_webhook**](docs/WebhookApi.md#create_webhook) | **POST** /apps/{appId}/webhooks | 
+*SmoochApi::WebhookApi* | [**delete_webhook**](docs/WebhookApi.md#delete_webhook) | **DELETE** /apps/{appId}/webhooks/{webhookId} | 
+*SmoochApi::WebhookApi* | [**get_webhook**](docs/WebhookApi.md#get_webhook) | **GET** /apps/{appId}/webhooks/{webhookId} | 
+*SmoochApi::WebhookApi* | [**list_webhooks**](docs/WebhookApi.md#list_webhooks) | **GET** /apps/{appId}/webhooks | 
+*SmoochApi::WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /apps/{appId}/webhooks/{webhookId} | 
+
+
+## Documentation for Models
+
+ - [SmoochApi::Action](docs/Action.md)
+ - [SmoochApi::App](docs/App.md)
+ - [SmoochApi::AppCreate](docs/AppCreate.md)
+ - [SmoochApi::AppResponse](docs/AppResponse.md)
+ - [SmoochApi::AppUser](docs/AppUser.md)
+ - [SmoochApi::AppUserLink](docs/AppUserLink.md)
+ - [SmoochApi::AppUserPreCreate](docs/AppUserPreCreate.md)
+ - [SmoochApi::AppUserResponse](docs/AppUserResponse.md)
+ - [SmoochApi::AppUserUpdate](docs/AppUserUpdate.md)
+ - [SmoochApi::Client](docs/Client.md)
+ - [SmoochApi::ClientInfo](docs/ClientInfo.md)
+ - [SmoochApi::Conversation](docs/Conversation.md)
+ - [SmoochApi::Destination](docs/Destination.md)
+ - [SmoochApi::DeviceInit](docs/DeviceInit.md)
+ - [SmoochApi::DeviceResponse](docs/DeviceResponse.md)
+ - [SmoochApi::DeviceUpdate](docs/DeviceUpdate.md)
+ - [SmoochApi::DisplaySettings](docs/DisplaySettings.md)
+ - [SmoochApi::Event](docs/Event.md)
+ - [SmoochApi::GetMessagesResponse](docs/GetMessagesResponse.md)
+ - [SmoochApi::Init](docs/Init.md)
+ - [SmoochApi::InitResponse](docs/InitResponse.md)
+ - [SmoochApi::Integration](docs/Integration.md)
+ - [SmoochApi::IntegrationCreate](docs/IntegrationCreate.md)
+ - [SmoochApi::IntegrationResponse](docs/IntegrationResponse.md)
+ - [SmoochApi::JwtResponse](docs/JwtResponse.md)
+ - [SmoochApi::ListAppsResponse](docs/ListAppsResponse.md)
+ - [SmoochApi::ListIntegrationsResponse](docs/ListIntegrationsResponse.md)
+ - [SmoochApi::ListSecretKeysResponse](docs/ListSecretKeysResponse.md)
+ - [SmoochApi::ListWebhooksResponse](docs/ListWebhooksResponse.md)
+ - [SmoochApi::Menu](docs/Menu.md)
+ - [SmoochApi::MenuItem](docs/MenuItem.md)
+ - [SmoochApi::MenuResponse](docs/MenuResponse.md)
+ - [SmoochApi::Message](docs/Message.md)
+ - [SmoochApi::MessageItem](docs/MessageItem.md)
+ - [SmoochApi::MessagePost](docs/MessagePost.md)
+ - [SmoochApi::MessageResponse](docs/MessageResponse.md)
+ - [SmoochApi::PostMessagesResponse](docs/PostMessagesResponse.md)
+ - [SmoochApi::SecretKey](docs/SecretKey.md)
+ - [SmoochApi::SecretKeyCreate](docs/SecretKeyCreate.md)
+ - [SmoochApi::SecretKeyResponse](docs/SecretKeyResponse.md)
+ - [SmoochApi::TrackEventResponse](docs/TrackEventResponse.md)
+ - [SmoochApi::TypingActivityTrigger](docs/TypingActivityTrigger.md)
+ - [SmoochApi::Webhook](docs/Webhook.md)
+ - [SmoochApi::WebhookCreate](docs/WebhookCreate.md)
+ - [SmoochApi::WebhookResponse](docs/WebhookResponse.md)
+ - [SmoochApi::WebhookUpdate](docs/WebhookUpdate.md)
+
+
+## Documentation for Authorization
+
+
+### jwt
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

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

data/docs/Action.md

@@ -0,0 +1,16 @@
+# SmoochApi::Action
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The action type. | 
+**text** | **String** | The button text. | 
+**payload** | **String** | The payload to be sent with the resulting webhook. Required for *postback* and *reply* actions.  | [optional] 
+**metadata** | **Object** | Flat JSON object containing any custom properties associated with the action. | [optional] 
+**amount** | **Integer** | The amount being charged. It needs to be specified in cents and is an integer. Required for *buy* actions.  | [optional] 
+**currency** | **String** | The currency of the amount being charged (USD, CAD, etc.). | [optional] 
+**default** | **BOOLEAN** | Flag indicating if the message action is the default for a message item in Facebook Messenger. | [optional] 
+**icon_url** | **String** | An icon to render next to the reply option (Facebook Messenger and Web Messenger only). | [optional] 
+**uri** | **String** | The action URI. This is the link that will be used in the clients when clicking the button. Required for *link* actions.  | [optional] 
+
+

data/docs/App.md

@@ -0,0 +1,10 @@
+# SmoochApi::App
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **String** | The app's ID. | 
+**app_token** | **String** | The appToken, used to initialize the Web, iOS and Android clients and to make calls to the app user facing API. | 
+**name** | **String** | The app's name. | 
+
+

data/docs/AppApi.md

@@ -0,0 +1,609 @@
+# SmoochApi::AppApi
+
+All URIs are relative to *https://api.smooch.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_app**](AppApi.md#create_app) | **POST** /apps | 
+[**create_secret_key**](AppApi.md#create_secret_key) | **POST** /apps/{appId}/keys | 
+[**delete_app**](AppApi.md#delete_app) | **DELETE** /apps/{appId} | 
+[**delete_integration**](AppApi.md#delete_integration) | **DELETE** /apps/{appId}/integrations/{integrationId} | 
+[**delete_secret_key**](AppApi.md#delete_secret_key) | **DELETE** /apps/{appId}/keys/{keyId} | 
+[**get_app**](AppApi.md#get_app) | **GET** /apps/{appId} | 
+[**get_app_jwt**](AppApi.md#get_app_jwt) | **GET** /apps/{appId}/keys/{keyId}/jwt | 
+[**get_integration**](AppApi.md#get_integration) | **GET** /apps/{appId}/integrations/{integrationId} | 
+[**get_secret_key**](AppApi.md#get_secret_key) | **GET** /apps/{appId}/keys/{keyId} | 
+[**list_apps**](AppApi.md#list_apps) | **GET** /apps | 
+[**list_secret_keys**](AppApi.md#list_secret_keys) | **GET** /apps/{appId}/keys | 
+
+
+# **create_app**
+> AppResponse create_app(app_create_body)
+
+
+
+Create a new 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::AppApi.new
+
+app_create_body = SmoochApi::AppCreate.new # AppCreate | Body for a createApp request.
+
+
+begin
+  result = api_instance.create_app(app_create_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->create_app: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_create_body** | [**AppCreate**](AppCreate.md)| Body for a createApp request. | 
+
+### Return type
+
+[**AppResponse**](AppResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_secret_key**
+> SecretKeyResponse create_secret_key(app_id, secret_key_create_body)
+
+
+
+Create a secret key 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::AppApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+secret_key_create_body = SmoochApi::SecretKeyCreate.new # SecretKeyCreate | Body for a createSecretKey request.
+
+
+begin
+  result = api_instance.create_secret_key(app_id, secret_key_create_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->create_secret_key: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **secret_key_create_body** | [**SecretKeyCreate**](SecretKeyCreate.md)| Body for a createSecretKey request. | 
+
+### Return type
+
+[**SecretKeyResponse**](SecretKeyResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_app**
+> delete_app(app_id, )
+
+
+
+Delete 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::AppApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+
+begin
+  api_instance.delete_app(app_id, )
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->delete_app: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_integration**
+> delete_integration(app_id, integration_id)
+
+
+
+Delete the specified integration.
+
+### 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::AppApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+integration_id = "integration_id_example" # String | Identifies the integration.
+
+
+begin
+  api_instance.delete_integration(app_id, integration_id)
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->delete_integration: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **integration_id** | **String**| Identifies the integration. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_secret_key**
+> delete_secret_key(app_id, key_id)
+
+
+
+Delete the specified secret key.
+
+### 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::AppApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+key_id = "key_id_example" # String | Identifies the secret key.
+
+
+begin
+  api_instance.delete_secret_key(app_id, key_id)
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->delete_secret_key: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **key_id** | **String**| Identifies the secret key. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_app**
+> AppResponse get_app(app_id, )
+
+
+
+Get 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::AppApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+
+begin
+  result = api_instance.get_app(app_id, )
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->get_app: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+
+### Return type
+
+[**AppResponse**](AppResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_app_jwt**
+> JwtResponse get_app_jwt(app_id, key_id)
+
+
+
+Get an app-scoped JWT for the specified secret key.
+
+### 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::AppApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+key_id = "key_id_example" # String | Identifies the secret key.
+
+
+begin
+  result = api_instance.get_app_jwt(app_id, key_id)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->get_app_jwt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **key_id** | **String**| Identifies the secret key. | 
+
+### Return type
+
+[**JwtResponse**](JwtResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_integration**
+> IntegrationResponse get_integration(app_id, integration_id)
+
+
+
+Get the specified integration.
+
+### 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::AppApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+integration_id = "integration_id_example" # String | Identifies the integration.
+
+
+begin
+  result = api_instance.get_integration(app_id, integration_id)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->get_integration: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **integration_id** | **String**| Identifies the integration. | 
+
+### Return type
+
+[**IntegrationResponse**](IntegrationResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_secret_key**
+> SecretKeyResponse get_secret_key(app_id, key_id)
+
+
+
+Get the specified secret key.
+
+### 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::AppApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+key_id = "key_id_example" # String | Identifies the secret key.
+
+
+begin
+  result = api_instance.get_secret_key(app_id, key_id)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->get_secret_key: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **key_id** | **String**| Identifies the secret key. | 
+
+### Return type
+
+[**SecretKeyResponse**](SecretKeyResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_apps**
+> ListAppsResponse list_apps(opts)
+
+
+
+List all apps configured.
+
+### 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::AppApi.new
+
+opts = { 
+  limit: 56, # Integer | The number of records to return.
+  offset: 56 # Integer | The number of initial records to skip before picking records to return.
+}
+
+begin
+  result = api_instance.list_apps(opts)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->list_apps: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| The number of records to return. | [optional] 
+ **offset** | **Integer**| The number of initial records to skip before picking records to return. | [optional] 
+
+### Return type
+
+[**ListAppsResponse**](ListAppsResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_secret_keys**
+> ListSecretKeysResponse list_secret_keys(app_id, )
+
+
+
+List the secret keys 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::AppApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+
+begin
+  result = api_instance.list_secret_keys(app_id, )
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->list_secret_keys: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+
+### Return type
+
+[**ListSecretKeysResponse**](ListSecretKeysResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+