smooch-api 5.10.0 → 5.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 587bde7bf174a7b97839522d32e08715733d6669
-  data.tar.gz: bdff5b46a534e7270b14155a4471cd45ff3c0602
+  metadata.gz: 99766cf8ae162fdfb817b859c8c032fff5ea3297
+  data.tar.gz: 57f9ac2b034dfa87c661e39863d204bef9913ec5
 SHA512:
-  metadata.gz: 1f30cc61104fe216f8fa01798e40ccf20159cd951c377fa3db56b84c2dceb8f76f5ec6358b29ded28716941c5f6b61c42ed2709ea5d0dcfbaafd330af7d5430a
-  data.tar.gz: b704b75ae17dc2c15a48f706699b26d99fbbed797b5f83773e13465731164c0d134460e78a00509076ad91c936635232b1af2c331780e52fe7f4ee24195def5b
+  metadata.gz: 410417280543eb4c0f7d282b4b04f59f6e8edfc918dfdfff69ef99fae06361aa226a080570be6112b9f5da20d0f78601b3e54ca750451fd8d2af562f2d4e9aa0
+  data.tar.gz: 310c818ded32962c3e15348c9ee48faca6319fda45c1e7f9c072717b9eb5517b77a14ec26e5735dbe464580e00d124c045633ed62d113ae18ffa833b1a33f93f

data/README.md

@@ -25,7 +25,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 5.10.0'
+    gem 'smooch-api', '~> 5.11.0'
 
 ## Getting Started
 
@@ -117,6 +117,7 @@ Class | Method | HTTP request | Description
 *SmoochApi::AppUserApi* | [**get_app_user_entity_ids**](docs/AppUserApi.md#get_app_user_entity_ids) | **GET** /v1.1/apps/{appId}/appusers/{userId}/channels | 
 *SmoochApi::AppUserApi* | [**get_link_requests**](docs/AppUserApi.md#get_link_requests) | **GET** /v1.1/apps/{appId}/appusers/{userId}/linkrequest | 
 *SmoochApi::AppUserApi* | [**link_app_user**](docs/AppUserApi.md#link_app_user) | **POST** /v1.1/apps/{appId}/appusers/{userId}/channels | 
+*SmoochApi::AppUserApi* | [**merge_users**](docs/AppUserApi.md#merge_users) | **POST** /v1.1/apps/{appId}/appusers/merge | 
 *SmoochApi::AppUserApi* | [**post_image_message**](docs/AppUserApi.md#post_image_message) | **POST** /v1.1/apps/{appId}/appusers/{userId}/images | 
 *SmoochApi::AppUserApi* | [**pre_create_app_user**](docs/AppUserApi.md#pre_create_app_user) | **POST** /v1.1/apps/{appId}/appusers | 
 *SmoochApi::AppUserApi* | [**unlink_app_user**](docs/AppUserApi.md#unlink_app_user) | **DELETE** /v1.1/apps/{appId}/appusers/{userId}/channels/{channel} | 
@@ -184,6 +185,7 @@ Class | Method | HTTP request | Description
  - [SmoochApi::AppUserBusinessSystemsResponse](docs/AppUserBusinessSystemsResponse.md)
  - [SmoochApi::AppUserChannelsResponse](docs/AppUserChannelsResponse.md)
  - [SmoochApi::AppUserLink](docs/AppUserLink.md)
+ - [SmoochApi::AppUserMerge](docs/AppUserMerge.md)
  - [SmoochApi::AppUserPreCreate](docs/AppUserPreCreate.md)
  - [SmoochApi::AppUserResponse](docs/AppUserResponse.md)
  - [SmoochApi::AppUserUpdate](docs/AppUserUpdate.md)
@@ -225,6 +227,7 @@ Class | Method | HTTP request | Description
  - [SmoochApi::Menu](docs/Menu.md)
  - [SmoochApi::MenuItem](docs/MenuItem.md)
  - [SmoochApi::MenuResponse](docs/MenuResponse.md)
+ - [SmoochApi::MergedUser](docs/MergedUser.md)
  - [SmoochApi::Message](docs/Message.md)
  - [SmoochApi::MessageItem](docs/MessageItem.md)
  - [SmoochApi::MessageOverride](docs/MessageOverride.md)

data/docs/AppUserApi.md

@@ -12,6 +12,7 @@ Method | HTTP request | Description
 [**get_app_user_entity_ids**](AppUserApi.md#get_app_user_entity_ids) | **GET** /v1.1/apps/{appId}/appusers/{userId}/channels | 
 [**get_link_requests**](AppUserApi.md#get_link_requests) | **GET** /v1.1/apps/{appId}/appusers/{userId}/linkrequest | 
 [**link_app_user**](AppUserApi.md#link_app_user) | **POST** /v1.1/apps/{appId}/appusers/{userId}/channels | 
+[**merge_users**](AppUserApi.md#merge_users) | **POST** /v1.1/apps/{appId}/appusers/merge | 
 [**post_image_message**](AppUserApi.md#post_image_message) | **POST** /v1.1/apps/{appId}/appusers/{userId}/images | 
 [**pre_create_app_user**](AppUserApi.md#pre_create_app_user) | **POST** /v1.1/apps/{appId}/appusers | 
 [**unlink_app_user**](AppUserApi.md#unlink_app_user) | **DELETE** /v1.1/apps/{appId}/appusers/{userId}/channels/{channel} | 
@@ -463,6 +464,60 @@ Name | Type | Description  | Notes
 
 
 
+# **merge_users**
+> merge_users(appId, appUserMergeBody)
+
+
+
+Force the merge of two specific users, when the business has determined that they represent the same person.
+
+### 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::AppUserApi.new
+
+appId = "appId_example" # String | Identifies the app.
+
+appUserMergeBody = SmoochApi::AppUserMerge.new # AppUserMerge | Body for a mergeUsers request.
+
+
+begin
+  api_instance.merge_users(appId, appUserMergeBody)
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppUserApi->merge_users: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appId** | **String**| Identifies the app. | 
+ **appUserMergeBody** | [**AppUserMerge**](AppUserMerge.md)| Body for a mergeUsers request. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **post_image_message**
 > MessageResponse post_image_message(appId, userId, source, role)
 

data/docs/AppUserMerge.md

@@ -0,0 +1,9 @@
+# SmoochApi::AppUserMerge
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**surviving** | [**MergedUser**](MergedUser.md) | Nested object representing the user that will survive at the end of the merge | 
+**discarded** | [**MergedUser**](MergedUser.md) | Nested object representing the user to merge into the surviving user. This user will be deleted as part of the process. | 
+
+

data/docs/MergedUser.md

@@ -0,0 +1,8 @@
+# SmoochApi::MergedUser
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The `_id` of the user to merge. | [optional] 
+
+

data/docs/Source.md

@@ -5,5 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | An identifier used by Smooch for internal purposes. | [optional] 
 **type** | **String** | An identifier for the channel from which a message originated. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. | [optional] 
+**originalMessageId** | **String** | Message identifier assigned by the originating channel. | [optional] 
+**originalMessageTimestamp** | **Float** | Message timestamp assigned by the originating channel. | [optional] 
 
 

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: 5.10
+OpenAPI spec version: 5.11
 
 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: 5.10
+OpenAPI spec version: 5.11
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -524,6 +524,66 @@ module SmoochApi
       return data, status_code, headers
     end
 
+    # 
+    # Force the merge of two specific users, when the business has determined that they represent the same person.
+    # @param appId Identifies the app.
+    # @param appUserMergeBody Body for a mergeUsers request.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def merge_users(appId, appUserMergeBody, opts = {})
+      merge_users_with_http_info(appId, appUserMergeBody, opts)
+      return nil
+    end
+
+    # 
+    # Force the merge of two specific users, when the business has determined that they represent the same person.
+    # @param appId Identifies the app.
+    # @param appUserMergeBody Body for a mergeUsers request.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def merge_users_with_http_info(appId, appUserMergeBody, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AppUserApi.merge_users ..."
+      end
+      # verify the required parameter 'appId' is set
+      if @api_client.config.client_side_validation && appId.nil?
+        fail ArgumentError, "Missing the required parameter 'appId' when calling AppUserApi.merge_users"
+      end
+      # verify the required parameter 'appUserMergeBody' is set
+      if @api_client.config.client_side_validation && appUserMergeBody.nil?
+        fail ArgumentError, "Missing the required parameter 'appUserMergeBody' when calling AppUserApi.merge_users"
+      end
+      # resource path
+      local_var_path = "/v1.1/apps/{appId}/appusers/merge".sub('{' + 'appId' + '}', appId.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(appUserMergeBody)
+      auth_names = ['jwt']
+      data, status_code, headers = @api_client.call_api(:POST, 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: AppUserApi#merge_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 
     # Send an image message to the conversation.
     # @param appId Identifies the app.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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