smooch-api 3.12.0 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63b4c157b7dad5da44f3b69b47e4e39a84b44908
-  data.tar.gz: 48c729695bcf03f15d37f1871280e067d864df82
+  metadata.gz: 5dc5f1e63676c6403572e7e1211727be81bd79c2
+  data.tar.gz: 9b503b659b1a5c0007e633f362c691e2b13ba901
 SHA512:
-  metadata.gz: 5cc22f02300373729ca476d7081e68fc6fb8ab98b30ad1cd020ef6f2aba890de48570635bcac56e63d2ce7ef8a0d3696617cf6bed26d69180ceec71f287aaeb7
-  data.tar.gz: 040406403d0d32873c2d533fc23539481d23c259689c5787ec36f3d7e89012bb8fae9b947994785230425c8601012393a5b14b13ae1b77366f2f35c479161341
+  metadata.gz: b2d206cd06067ed35656ddec85042b253fc5e8a17ce259a011eb4ecb9222673fbfb268f122166ab9658e6006df81b83f8e617c827e50e35beae82979a53b1efe
+  data.tar.gz: ac5f0e2d94f77dc04f7df3b6d568d17664971bd5816fe3529a3ee480a7c0693746862c32558540467c0180a500114870c13c7f43b5dc556b1b704861c9132845

data/README.md

@@ -16,7 +16,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 3.12.0'
+    gem 'smooch-api', '~> 3.13.0'
 
 ## Getting Started
 
@@ -142,6 +142,11 @@ Class | Method | HTTP request | Description
 *SmoochApi::ServiceAccountApi* | [**list_secret_keys**](docs/ServiceAccountApi.md#list_secret_keys) | **GET** /v1/serviceaccounts/{serviceAccountId}/keys | 
 *SmoochApi::ServiceAccountApi* | [**list_service_accounts**](docs/ServiceAccountApi.md#list_service_accounts) | **GET** /v1/serviceaccounts | 
 *SmoochApi::ServiceAccountApi* | [**update_service_account**](docs/ServiceAccountApi.md#update_service_account) | **PUT** /v1/serviceaccounts/{serviceAccountId} | 
+*SmoochApi::TemplateApi* | [**create_template**](docs/TemplateApi.md#create_template) | **POST** /v1/apps/{appId}/templates | 
+*SmoochApi::TemplateApi* | [**delete_template**](docs/TemplateApi.md#delete_template) | **DELETE** /v1/apps/{appId}/templates/{templateId} | 
+*SmoochApi::TemplateApi* | [**get_template**](docs/TemplateApi.md#get_template) | **GET** /v1/apps/{appId}/templates/{templateId} | 
+*SmoochApi::TemplateApi* | [**list_templates**](docs/TemplateApi.md#list_templates) | **GET** /v1/apps/{appId}/templates | 
+*SmoochApi::TemplateApi* | [**update_template**](docs/TemplateApi.md#update_template) | **PUT** /v1/apps/{appId}/templates/{templateId} | 
 *SmoochApi::WebhookApi* | [**create_webhook**](docs/WebhookApi.md#create_webhook) | **POST** /v1/apps/{appId}/webhooks | 
 *SmoochApi::WebhookApi* | [**delete_webhook**](docs/WebhookApi.md#delete_webhook) | **DELETE** /v1/apps/{appId}/webhooks/{webhookId} | 
 *SmoochApi::WebhookApi* | [**get_webhook**](docs/WebhookApi.md#get_webhook) | **GET** /v1/apps/{appId}/webhooks/{webhookId} | 
@@ -187,6 +192,7 @@ Class | Method | HTTP request | Description
  - [SmoochApi::ListIntegrationsResponse](docs/ListIntegrationsResponse.md)
  - [SmoochApi::ListSecretKeysResponse](docs/ListSecretKeysResponse.md)
  - [SmoochApi::ListServiceAccountsResponse](docs/ListServiceAccountsResponse.md)
+ - [SmoochApi::ListTemplatesResponse](docs/ListTemplatesResponse.md)
  - [SmoochApi::ListWebhooksResponse](docs/ListWebhooksResponse.md)
  - [SmoochApi::Menu](docs/Menu.md)
  - [SmoochApi::MenuItem](docs/MenuItem.md)
@@ -204,6 +210,10 @@ Class | Method | HTTP request | Description
  - [SmoochApi::ServiceAccountUpdate](docs/ServiceAccountUpdate.md)
  - [SmoochApi::Source](docs/Source.md)
  - [SmoochApi::SubMenuItem](docs/SubMenuItem.md)
+ - [SmoochApi::Template](docs/Template.md)
+ - [SmoochApi::TemplateCreate](docs/TemplateCreate.md)
+ - [SmoochApi::TemplateResponse](docs/TemplateResponse.md)
+ - [SmoochApi::TemplateUpdate](docs/TemplateUpdate.md)
  - [SmoochApi::TypingActivityTrigger](docs/TypingActivityTrigger.md)
  - [SmoochApi::Webhook](docs/Webhook.md)
  - [SmoochApi::WebhookCreate](docs/WebhookCreate.md)

data/docs/Integration.md

@@ -55,5 +55,7 @@ Name | Type | Description | Notes
 **business_icon_url** | **String** | A custom business icon url for the Web Messenger. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **background_image_url** | **String** | A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **origin_whitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454 `scheme \"://\" host [ \":\" port ]`, where scheme is `http` or `https`. (Optional) Used for *Web Messenger* integrations.  | [optional] 
+**status** | **String** | The integration status. Possible values are active, inactive or error. [More info](https://docs.smooch.io/#integration-status). | [optional] 
+**error** | **String** | The error causing the integration to fail. Will be present when `status` is 'error'. | [optional] 
 
 

data/docs/ListTemplatesResponse.md

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

data/docs/Template.md

@@ -0,0 +1,10 @@
+# SmoochApi::Template
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **String** | The template ID, generated automatically. | 
+**name** | **String** | The name for the template, used when sending via [shorthand](https://docs.smooch.io/guide/shorthand/#sending-template-message-with-inline-syntax). | 
+**message** | [**Message**](Message.md) | The message sent when referencing the template via syntax. | 
+
+

data/docs/TemplateApi.md

@@ -0,0 +1,293 @@
+# SmoochApi::TemplateApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_template**](TemplateApi.md#create_template) | **POST** /v1/apps/{appId}/templates | 
+[**delete_template**](TemplateApi.md#delete_template) | **DELETE** /v1/apps/{appId}/templates/{templateId} | 
+[**get_template**](TemplateApi.md#get_template) | **GET** /v1/apps/{appId}/templates/{templateId} | 
+[**list_templates**](TemplateApi.md#list_templates) | **GET** /v1/apps/{appId}/templates | 
+[**update_template**](TemplateApi.md#update_template) | **PUT** /v1/apps/{appId}/templates/{templateId} | 
+
+
+# **create_template**
+> TemplateResponse create_template(app_id, template_create_body)
+
+
+
+Create a template 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::TemplateApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+template_create_body = SmoochApi::TemplateCreate.new # TemplateCreate | Body for a createTemplate request. 
+
+
+begin
+  result = api_instance.create_template(app_id, template_create_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling TemplateApi->create_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **template_create_body** | [**TemplateCreate**](TemplateCreate.md)| Body for a createTemplate request.  | 
+
+### Return type
+
+[**TemplateResponse**](TemplateResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_template**
+> delete_template(app_id, template_id)
+
+
+
+Delete the specified template.
+
+### 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::TemplateApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+template_id = "template_id_example" # String | Identifies the template.
+
+
+begin
+  api_instance.delete_template(app_id, template_id)
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling TemplateApi->delete_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **template_id** | **String**| Identifies the template. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_template**
+> TemplateResponse get_template(app_id, template_id)
+
+
+
+Get the specified template.
+
+### 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::TemplateApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+template_id = "template_id_example" # String | Identifies the template.
+
+
+begin
+  result = api_instance.get_template(app_id, template_id)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling TemplateApi->get_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **template_id** | **String**| Identifies the template. | 
+
+### Return type
+
+[**TemplateResponse**](TemplateResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_templates**
+> ListTemplatesResponse list_templates(app_id, , opts)
+
+
+
+List templates 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::TemplateApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+opts = { 
+  limit: 25, # Integer | The number of records to return.
+  offset: 0 # Integer | The number of initial records to skip before picking records to return.
+}
+
+begin
+  result = api_instance.list_templates(app_id, , opts)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling TemplateApi->list_templates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **limit** | **Integer**| The number of records to return. | [optional] [default to 25]
+ **offset** | **Integer**| The number of initial records to skip before picking records to return. | [optional] [default to 0]
+
+### Return type
+
+[**ListTemplatesResponse**](ListTemplatesResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_template**
+> TemplateResponse update_template(app_id, template_idtemplate_update_body)
+
+
+
+Update the specified template.
+
+### 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::TemplateApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+template_id = "template_id_example" # String | Identifies the template.
+
+template_update_body = SmoochApi::TemplateUpdate.new # TemplateUpdate | Body for an updateTemplate request. 
+
+
+begin
+  result = api_instance.update_template(app_id, template_idtemplate_update_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling TemplateApi->update_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **template_id** | **String**| Identifies the template. | 
+ **template_update_body** | [**TemplateUpdate**](TemplateUpdate.md)| Body for an updateTemplate request.  | 
+
+### Return type
+
+[**TemplateResponse**](TemplateResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/TemplateCreate.md

@@ -0,0 +1,9 @@
+# SmoochApi::TemplateCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name for the template, used when sending via [shorthand](https://docs.smooch.io/guide/shorthand/#sending-template-message-with-inline-syntax). | 
+**message** | [**Message**](Message.md) | The message sent when referencing the template via syntax. | 
+
+

data/docs/TemplateResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::TemplateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**template** | [**Template**](Template.md) | The template. | 
+
+

data/docs/TemplateUpdate.md

@@ -0,0 +1,9 @@
+# SmoochApi::TemplateUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name for the template, used when sending via [shorthand](https://docs.smooch.io/guide/shorthand/#sending-template-message-with-inline-syntax). | [optional] 
+**message** | [**Message**](Message.md) | The message sent when referencing the template via syntax. | [optional] 
+
+

data/lib/smooch-api.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 3.12
+OpenAPI spec version: 3.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -53,6 +53,7 @@ require 'smooch-api/models/list_apps_response'
 require 'smooch-api/models/list_integrations_response'
 require 'smooch-api/models/list_secret_keys_response'
 require 'smooch-api/models/list_service_accounts_response'
+require 'smooch-api/models/list_templates_response'
 require 'smooch-api/models/list_webhooks_response'
 require 'smooch-api/models/menu'
 require 'smooch-api/models/menu_item'
@@ -70,6 +71,10 @@ require 'smooch-api/models/service_account_response'
 require 'smooch-api/models/service_account_update'
 require 'smooch-api/models/source'
 require 'smooch-api/models/sub_menu_item'
+require 'smooch-api/models/template'
+require 'smooch-api/models/template_create'
+require 'smooch-api/models/template_response'
+require 'smooch-api/models/template_update'
 require 'smooch-api/models/typing_activity_trigger'
 require 'smooch-api/models/webhook'
 require 'smooch-api/models/webhook_create'
@@ -84,6 +89,7 @@ require 'smooch-api/api/conversation_api'
 require 'smooch-api/api/integration_api'
 require 'smooch-api/api/menu_api'
 require 'smooch-api/api/service_account_api'
+require 'smooch-api/api/template_api'
 require 'smooch-api/api/webhook_api'
 
 module SmoochApi

data/lib/smooch-api/api/app_api.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 3.12
+OpenAPI spec version: 3.13
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT