smooch-api 3.17.0 → 3.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6746b1079707193fda67e7d2431778215de1bab
-  data.tar.gz: de8a0a45b0e9adc20d930ef311b4964f2599c499
+  metadata.gz: be4c7bd05691f46762124c3bbffcda0f812a3758
+  data.tar.gz: 53f314854a19309072fd6ae3324269fb04dcb0a3
 SHA512:
-  metadata.gz: 5f33799e5f8c1c2ae8d3f26eae09371060e8ab9414169bf8391323879d4e3fe780bd54a2a2ea3a2fba8368eeb630675beaa473b8eab60c28bd5481259984290e
-  data.tar.gz: 955c1ac1ea0d4a8d2405e136a4f9ba2b1181d633a6f0c800488ce781b0cf031aa76dda81e141f19258996bfd9c443df0d5cf589966821cfc46ef63f9b11d1c41
+  metadata.gz: 9da0fe380400faef3ebb2dc8e9c6a397683b4de0df950ee270e9745d273c1b7e7fb727993113c9e5044025350a542688c2434a44766ef879e0bb99b099cc4618
+  data.tar.gz: 790c9155eda64a617a53665df1863c53e1b29cc06337e387b8d05de67323b386fef0366245b1ee94c7619634d755f49e7d976119d9aa28478705b18009a4a087

data/README.md

@@ -16,7 +16,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 3.17.0'
+    gem 'smooch-api', '~> 3.19.0'
 
 ## Getting Started
 
@@ -129,6 +129,7 @@ Class | Method | HTTP request | Description
 *SmoochApi::IntegrationApi* | [**list_integrations**](docs/IntegrationApi.md#list_integrations) | **GET** /v1/apps/{appId}/integrations | 
 *SmoochApi::IntegrationApi* | [**update_integration**](docs/IntegrationApi.md#update_integration) | **PUT** /v1/apps/{appId}/integrations/{integrationId} | 
 *SmoochApi::IntegrationApi* | [**update_integration_menu**](docs/IntegrationApi.md#update_integration_menu) | **PUT** /v1/apps/{appId}/integrations/{integrationId}/menu | 
+*SmoochApi::IntegrationApi* | [**update_integration_profile**](docs/IntegrationApi.md#update_integration_profile) | **PUT** /v1/apps/{appId}/integrations/{integrationId}/profile | 
 *SmoochApi::MenuApi* | [**delete_menu**](docs/MenuApi.md#delete_menu) | **DELETE** /v1/apps/{appId}/menu | 
 *SmoochApi::MenuApi* | [**get_menu**](docs/MenuApi.md#get_menu) | **GET** /v1/apps/{appId}/menu | 
 *SmoochApi::MenuApi* | [**update_menu**](docs/MenuApi.md#update_menu) | **PUT** /v1/apps/{appId}/menu | 
@@ -183,6 +184,7 @@ Class | Method | HTTP request | Description
  - [SmoochApi::GetMessagesResponse](docs/GetMessagesResponse.md)
  - [SmoochApi::Integration](docs/Integration.md)
  - [SmoochApi::IntegrationCreate](docs/IntegrationCreate.md)
+ - [SmoochApi::IntegrationProfileUpdate](docs/IntegrationProfileUpdate.md)
  - [SmoochApi::IntegrationResponse](docs/IntegrationResponse.md)
  - [SmoochApi::IntegrationUpdate](docs/IntegrationUpdate.md)
  - [SmoochApi::JwtResponse](docs/JwtResponse.md)

data/docs/Integration.md

@@ -25,7 +25,9 @@ Name | Type | Description | Notes
 **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] 
+**base_url** | **String** | Your WhatsApp API client's URL. Required for *WhatsApp* integrations.  | [optional] 
+**hsm_fallback_language** | **String** | Specification of a fallback language. (Optional) Used for *WhatsApp* integrations.  | [optional] 
+**password** | **String** | The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (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] 
 **production** | **BOOLEAN** | Flag specifying whether the certificate is production. Returned on successful *apn* integrations.  | [optional] 
 **server_key** | **String** | Your server key from the fcm console. Required for *fcm* integrations.  | [optional] 
@@ -37,7 +39,7 @@ Name | Type | Description | Notes
 **access_token_key** | **String** | The access token key obtained from your user via oauth. Required for *twitter* integrations.  | [optional] 
 **access_token_secret** | **String** | The access token secret obtained from your user via oauth. Required for *twitter* integrations.  | [optional] 
 **user_id** | **String** | The twitter userId. Returned on successful *twitter* integrations.  | [optional] 
-**username** | **String** | The username for the account. Returned on successful *twitter* and *telegram* integrations.  | [optional] 
+**username** | **String** | The username for the account. Required for *WhatsApp* integrations. Returned on successful *twitter* and *telegram* integrations.  | [optional] 
 **api_key** | **String** | The public API key of your Mailgun account. Required for *mailgun* integrations.  | [optional] 
 **domain** | **String** | The domain used to relay email. Required for *mailgun* integrations.  | [optional] 
 **incoming_address** | **String** | Smooch will receive all emails sent to this address. Required for *mailgun* integrations.  | [optional] 

data/docs/IntegrationApi.md

@@ -13,6 +13,7 @@ Method | HTTP request | Description
 [**list_integrations**](IntegrationApi.md#list_integrations) | **GET** /v1/apps/{appId}/integrations | 
 [**update_integration**](IntegrationApi.md#update_integration) | **PUT** /v1/apps/{appId}/integrations/{integrationId} | 
 [**update_integration_menu**](IntegrationApi.md#update_integration_menu) | **PUT** /v1/apps/{appId}/integrations/{integrationId}/menu | 
+[**update_integration_profile**](IntegrationApi.md#update_integration_profile) | **PUT** /v1/apps/{appId}/integrations/{integrationId}/profile | 
 
 
 # **create_integration**
@@ -71,7 +72,7 @@ Name | Type | Description  | Notes
 
 
 # **create_integration_menu**
-> MenuResponse create_integration_menu(app_id, integration_idmenu_create_body)
+> MenuResponse create_integration_menu(app_id, integration_id, menu_create_body)
 
 
 
@@ -98,7 +99,7 @@ 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)
+  result = api_instance.create_integration_menu(app_id, integration_id, menu_create_body)
   p result
 rescue SmoochApi::ApiError => e
   puts "Exception when calling IntegrationApi->create_integration_menu: #{e}"
@@ -129,7 +130,7 @@ Name | Type | Description  | Notes
 
 
 # **delete_integration**
-> delete_integration(app_id, integration_id)
+> delete_integration(app_id, integration_id, )
 
 
 
@@ -154,7 +155,7 @@ integration_id = "integration_id_example" # String | Identifies the integration.
 
 
 begin
-  api_instance.delete_integration(app_id, integration_id)
+  api_instance.delete_integration(app_id, integration_id, )
 rescue SmoochApi::ApiError => e
   puts "Exception when calling IntegrationApi->delete_integration: #{e}"
 end
@@ -183,7 +184,7 @@ nil (empty response body)
 
 
 # **delete_integration_menu**
-> delete_integration_menu(app_id, integration_id)
+> delete_integration_menu(app_id, integration_id, )
 
 
 
@@ -208,7 +209,7 @@ integration_id = "integration_id_example" # String | Identifies the integration.
 
 
 begin
-  api_instance.delete_integration_menu(app_id, integration_id)
+  api_instance.delete_integration_menu(app_id, integration_id, )
 rescue SmoochApi::ApiError => e
   puts "Exception when calling IntegrationApi->delete_integration_menu: #{e}"
 end
@@ -237,7 +238,7 @@ nil (empty response body)
 
 
 # **get_integration**
-> IntegrationResponse get_integration(app_id, integration_id)
+> IntegrationResponse get_integration(app_id, integration_id, )
 
 
 
@@ -262,7 +263,7 @@ integration_id = "integration_id_example" # String | Identifies the integration.
 
 
 begin
-  result = api_instance.get_integration(app_id, integration_id)
+  result = api_instance.get_integration(app_id, integration_id, )
   p result
 rescue SmoochApi::ApiError => e
   puts "Exception when calling IntegrationApi->get_integration: #{e}"
@@ -292,7 +293,7 @@ Name | Type | Description  | Notes
 
 
 # **get_integration_menu**
-> MenuResponse get_integration_menu(app_id, integration_id)
+> MenuResponse get_integration_menu(app_id, integration_id, )
 
 
 
@@ -317,7 +318,7 @@ integration_id = "integration_id_example" # String | Identifies the integration.
 
 
 begin
-  result = api_instance.get_integration_menu(app_id, integration_id)
+  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}"
@@ -403,7 +404,7 @@ Name | Type | Description  | Notes
 
 
 # **update_integration**
-> IntegrationResponse update_integration(app_id, integration_idintegration_update_body)
+> IntegrationResponse update_integration(app_id, integration_id, integration_update_body)
 
 
 
@@ -430,7 +431,7 @@ integration_update_body = SmoochApi::IntegrationUpdate.new # IntegrationUpdate |
 
 
 begin
-  result = api_instance.update_integration(app_id, integration_idintegration_update_body)
+  result = api_instance.update_integration(app_id, integration_id, integration_update_body)
   p result
 rescue SmoochApi::ApiError => e
   puts "Exception when calling IntegrationApi->update_integration: #{e}"
@@ -461,7 +462,7 @@ Name | Type | Description  | Notes
 
 
 # **update_integration_menu**
-> MenuResponse update_integration_menu(app_id, integration_idmenu_update_body)
+> MenuResponse update_integration_menu(app_id, integration_id, menu_update_body)
 
 
 
@@ -488,7 +489,7 @@ 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)
+  result = api_instance.update_integration_menu(app_id, integration_id, menu_update_body)
   p result
 rescue SmoochApi::ApiError => e
   puts "Exception when calling IntegrationApi->update_integration_menu: #{e}"
@@ -518,3 +519,60 @@ Name | Type | Description  | Notes
 
 
 
+# **update_integration_profile**
+> update_integration_profile(app_id, integration_id, integration_profile_body)
+
+
+
+Update the specified integration’s profile.
+
+### 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.
+
+integration_profile_body = SmoochApi::IntegrationProfileUpdate.new # IntegrationProfileUpdate | Body for a profileUpdate request.
+
+
+begin
+  api_instance.update_integration_profile(app_id, integration_id, integration_profile_body)
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling IntegrationApi->update_integration_profile: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **integration_id** | **String**| Identifies the integration. | 
+ **integration_profile_body** | [**IntegrationProfileUpdate**](IntegrationProfileUpdate.md)| Body for a profileUpdate request. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/IntegrationCreate.md

@@ -9,6 +9,8 @@ Name | Type | Description | Notes
 **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] 
+**base_url** | **String** | Your WhatsApp API client's URL. Required for *WhatsApp* integrations.  | [optional] 
+**hsm_fallback_language** | **String** | Specification of a fallback language. (Optional) Used for *WhatsApp* 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_id** | **String** | LINE Channel ID. Required for *line* integrations.  | [optional] 
@@ -17,7 +19,8 @@ Name | Type | Description | Notes
 **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] 
+**password** | **String** | The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (Optional) Used for *apn* integrations.  | [optional] 
+**username** | **String** | The username for the account. Required for *WhatsApp* integrations. Returned on successful *twitter* and *telegram* 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/IntegrationProfileUpdate.md

@@ -0,0 +1,14 @@
+# SmoochApi::IntegrationProfileUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**about** | **String** | Text to display in your profile's About section. Can be used as a status update. Maximum of 139 characters. | [optional] 
+**address** | **String** | Address of the business. Maximum of 256 characters. | [optional] 
+**description** | **String** | Description of the business. Maximum of 256 characters. | [optional] 
+**email** | **String** | Email address to contact the business. Maximum of 128 characters. | [optional] 
+**photo_url** | **String** | URL where the business' profile photo is hosted. WhatsApp recommends an image with dimensions of 640x640 and max size of 63KB. | [optional] 
+**vertical** | **String** | Industry of the business. Maximum of 128 characters. | [optional] 
+**websites** | **Array<String>** | URLs associated with the business. Maximum of 2 websites. | [optional] 
+
+

data/docs/IntegrationUpdate.md

@@ -18,5 +18,6 @@ Name | Type | Description | Notes
 **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] 
 **channel_id** | **String** | LINE Channel ID. Required for *line* integrations.  | [optional] 
 **channel_secret** | **String** | LINE Channel Secret. Required for *line* integrations.  | [optional] 
+**hsm_fallback_language** | **String** | Specification of a fallback language. (Optional) Used for *WhatsApp* integrations.  | [optional] 
 
 

data/docs/MessageResponse.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **message** | [**Message**](Message.md) | The message. | 
+**extra_messages** | [**Array<Message>**](Message.md) | List of extra messages created. | [optional] 
 **conversation** | [**Conversation**](Conversation.md) | The conversation. | 
 
 

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.17
+OpenAPI spec version: 3.19
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -44,6 +44,7 @@ require 'smooch-api/models/display_settings'
 require 'smooch-api/models/get_messages_response'
 require 'smooch-api/models/integration'
 require 'smooch-api/models/integration_create'
+require 'smooch-api/models/integration_profile_update'
 require 'smooch-api/models/integration_response'
 require 'smooch-api/models/integration_update'
 require 'smooch-api/models/jwt_response'

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.17
+OpenAPI spec version: 3.19
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/api/app_user_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.17
+OpenAPI spec version: 3.19
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/api/attachments_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.17
+OpenAPI spec version: 3.19
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/api/conversation_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.17
+OpenAPI spec version: 3.19
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/api/integration_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.17
+OpenAPI spec version: 3.19
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -581,5 +581,71 @@ module SmoochApi
       end
       return data, status_code, headers
     end
+
+    # 
+    # Update the specified integration’s profile.
+    # @param app_id Identifies the app.
+    # @param integration_id Identifies the integration.
+    # @param integration_profile_body Body for a profileUpdate request.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_integration_profile(app_id, integration_id, integration_profile_body, opts = {})
+      update_integration_profile_with_http_info(app_id, integration_id, integration_profile_body, opts)
+      return nil
+    end
+
+    # 
+    # Update the specified integration’s profile.
+    # @param app_id Identifies the app.
+    # @param integration_id Identifies the integration.
+    # @param integration_profile_body Body for a profileUpdate request.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_integration_profile_with_http_info(app_id, integration_id, integration_profile_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: IntegrationApi.update_integration_profile ..."
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling IntegrationApi.update_integration_profile"
+      end
+      # verify the required parameter 'integration_id' is set
+      if @api_client.config.client_side_validation && integration_id.nil?
+        fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationApi.update_integration_profile"
+      end
+      # verify the required parameter 'integration_profile_body' is set
+      if @api_client.config.client_side_validation && integration_profile_body.nil?
+        fail ArgumentError, "Missing the required parameter 'integration_profile_body' when calling IntegrationApi.update_integration_profile"
+      end
+      # resource path
+      local_var_path = "/v1/apps/{appId}/integrations/{integrationId}/profile".sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'integrationId' + '}', integration_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(integration_profile_body)
+      auth_names = ['jwt']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IntegrationApi#update_integration_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/smooch-api/api/menu_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.17
+OpenAPI spec version: 3.19
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT