smooch-api 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd48511580e303108b0d1b5097264640a3e8ea20
-  data.tar.gz: 331201e4876844eb949bb1cc0de525367c7aaae3
+  metadata.gz: 2add98aa2e76123ea96dc1a38650775455ac6e4a
+  data.tar.gz: 1bc63e33ebd887c9771725a20248a14d33ccccf8
 SHA512:
-  metadata.gz: 0ba3c207987d2681dcde95feb0fc2bba74b6abf8ae993c77bdb75bda0ec9a5ac7778a79f66b4d73ab16ff3848b2b6ffc247c5dc1edd4347aded5c15046495318
-  data.tar.gz: 8a0788d056a0e9d2c9d2f1ff0552d2cb5d56b1005efba1e58b32e1a3f85121a18e609232cdfd650c3e1805621d7bb1dc9b407858250f71ed226ac613c21e96f7
+  metadata.gz: d8c414b09dd41d4d0835de8f0c4a82b3158a29be1ce09918aa72d2f677837cec252ed6968b3748d48c37af51e63a2558d1180b5d314d3349d9db48a1c12cecda
+  data.tar.gz: 62eba2623e7387a324cba30233d81c33300426c3dd5e41a66a06ddbc948e8f0a48971efc24781c8dea5af1471c91f0ef52143ee9c3085dd8a93622da9ef946f4

data/README.md

@@ -1,13 +1,10 @@
-# smooch-api
+# smooch-ruby
 
 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
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project using the [Smooch api spec](https://github.com/smooch/api-spec).
 
 ## Installation
 
@@ -19,7 +16,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 1.0.0'
+    gem 'smooch-api', '~> 1.1.0'
 
 ## Getting Started
 
@@ -31,7 +28,7 @@ A JWT is composed of a header, a payload, and a signature. The payload contains
 
 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.
+#### **Step 1** Generate a KEY ID and SECRET on the settings tab in the [Smooch Dashboard](https://app.smooch.io/).
 
 ![secret key and id](https://docs.smooch.io/images/secret_keys.png)
 
@@ -84,11 +81,9 @@ 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 | 
@@ -109,7 +104,13 @@ Class | Method | HTTP request | Description
 *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* | [**create_integration_menu**](docs/IntegrationApi.md#create_integration_menu) | **POST** /apps/{appId}/integrations/{integrationId}/menu | 
+*SmoochApi::IntegrationApi* | [**delete_integration**](docs/IntegrationApi.md#delete_integration) | **DELETE** /apps/{appId}/integrations/{integrationId} | 
+*SmoochApi::IntegrationApi* | [**delete_integration_menu**](docs/IntegrationApi.md#delete_integration_menu) | **DELETE** /apps/{appId}/integrations/{integrationId}/menu | 
+*SmoochApi::IntegrationApi* | [**get_integration**](docs/IntegrationApi.md#get_integration) | **GET** /apps/{appId}/integrations/{integrationId} | 
+*SmoochApi::IntegrationApi* | [**get_integration_menu**](docs/IntegrationApi.md#get_integration_menu) | **GET** /apps/{appId}/integrations/{integrationId}/menu | 
 *SmoochApi::IntegrationApi* | [**list_integrations**](docs/IntegrationApi.md#list_integrations) | **GET** /apps/{appId}/integrations | 
+*SmoochApi::IntegrationApi* | [**update_integration_menu**](docs/IntegrationApi.md#update_integration_menu) | **PUT** /apps/{appId}/integrations/{integrationId}/menu | 
 *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 | 

data/docs/Action.md

@@ -12,5 +12,6 @@ Name | Type | Description | Notes
 **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] 
+**extra_channel_options** | **Object** | Extra options to pass directly to the channel API. See [Extra Channel Options](https://docs.smooch.io/rest#extra-channel-options-schema) | [optional] 
 
 

data/docs/AppApi.md

@@ -7,11 +7,9 @@ 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 | 
@@ -175,60 +173,6 @@ nil (empty response body)
 
 
 
-# **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)
 
@@ -390,61 +334,6 @@ Name | Type | Description  | Notes
 
 
 
-# **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)
 

data/docs/IntegrationApi.md

@@ -5,7 +5,13 @@ All URIs are relative to *https://api.smooch.io/v1*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create_integration**](IntegrationApi.md#create_integration) | **POST** /apps/{appId}/integrations | 
+[**create_integration_menu**](IntegrationApi.md#create_integration_menu) | **POST** /apps/{appId}/integrations/{integrationId}/menu | 
+[**delete_integration**](IntegrationApi.md#delete_integration) | **DELETE** /apps/{appId}/integrations/{integrationId} | 
+[**delete_integration_menu**](IntegrationApi.md#delete_integration_menu) | **DELETE** /apps/{appId}/integrations/{integrationId}/menu | 
+[**get_integration**](IntegrationApi.md#get_integration) | **GET** /apps/{appId}/integrations/{integrationId} | 
+[**get_integration_menu**](IntegrationApi.md#get_integration_menu) | **GET** /apps/{appId}/integrations/{integrationId}/menu | 
 [**list_integrations**](IntegrationApi.md#list_integrations) | **GET** /apps/{appId}/integrations | 
+[**update_integration_menu**](IntegrationApi.md#update_integration_menu) | **PUT** /apps/{appId}/integrations/{integrationId}/menu | 
 
 
 # **create_integration**
@@ -63,6 +69,282 @@ Name | Type | Description  | Notes
 
 
 
+# **create_integration_menu**
+> MenuResponse create_integration_menu(app_id, integration_idmenu_create_body)
+
+
+
+Create the specified integration’s menu, overriding the app menu if 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::IntegrationApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+integration_id = "integration_id_example" # String | Identifies the integration.
+
+menu_create_body = SmoochApi::Menu.new # Menu | Body for a createMenu request.
+
+
+begin
+  result = api_instance.create_integration_menu(app_id, integration_idmenu_create_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling IntegrationApi->create_integration_menu: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **integration_id** | **String**| Identifies the integration. | 
+ **menu_create_body** | [**Menu**](Menu.md)| Body for a createMenu request. | 
+
+### Return type
+
+[**MenuResponse**](MenuResponse.md)
+
+### 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::IntegrationApi.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 IntegrationApi->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_integration_menu**
+> delete_integration_menu(app_id, integration_id)
+
+
+
+Delete the specified integration’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::IntegrationApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+integration_id = "integration_id_example" # String | Identifies the integration.
+
+
+begin
+  api_instance.delete_integration_menu(app_id, integration_id)
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling IntegrationApi->delete_integration_menu: #{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
+
+
+
+# **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::IntegrationApi.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 IntegrationApi->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_integration_menu**
+> MenuResponse get_integration_menu(app_id, integration_id)
+
+
+
+Get the specified integration'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::IntegrationApi.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_menu(app_id, integration_id)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling IntegrationApi->get_integration_menu: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **integration_id** | **String**| Identifies the integration. | 
+
+### Return type
+
+[**MenuResponse**](MenuResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **list_integrations**
 > ListIntegrationsResponse list_integrations(app_id, , opts)
 
@@ -119,3 +401,61 @@ Name | Type | Description  | Notes
 
 
 
+# **update_integration_menu**
+> MenuResponse update_integration_menu(app_id, integration_idmenu_update_body)
+
+
+
+Update the specified integration’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::IntegrationApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+integration_id = "integration_id_example" # String | Identifies the integration.
+
+menu_update_body = SmoochApi::Menu.new # Menu | Body for a updateMenu request.
+
+
+begin
+  result = api_instance.update_integration_menu(app_id, integration_idmenu_update_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling IntegrationApi->update_integration_menu: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **integration_id** | **String**| Identifies the integration. | 
+ **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
+
+
+