smooch-api 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14b38b896239d6bc2143366a0a1de6853c964637
-  data.tar.gz: 8377070e49b33a3e573efa159e5d84541c1b2f4b
+  metadata.gz: d7abed0d9ee066f9c0aa33fc9999a8f78abe5c75
+  data.tar.gz: 27bf5df7776a66158db89853bf3472f33a093993
 SHA512:
-  metadata.gz: 6230b74d1418a39701479ca1689e1366f14adf6181772547a5cc3520232d00b8c31d9b81a0f26d8ecdfcbaa7c489fa344316c34905499161926b0fd0d86c1734
-  data.tar.gz: f0e7ed3c04a7238ee1b001779092f29b5e69e3bfc38e891c0c5e1d7a82c86f6bc81559636ba7a19e9c8279b1613ebb64d7c83ee99e26bda4b2b78a8f9afcc19a
+  metadata.gz: 806094818f517edc02d8fe6e227fd9573ca058fcb5a5b36537bbbe850e29638989dde506b30bffca155bc0991a8180ebbe04884066d163a7c7f1847767c69f00
+  data.tar.gz: 4527d5bf845d8dedf220f25c86581c1efc0b1413063792ac63c5029de8a37a53c6319f28611e97037c36f97fa4f3d79bb25d476e93b4235ddab2cac63c1cc8ad

data/README.md

@@ -16,7 +16,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 2.1.0'
+    gem 'smooch-api', '~> 2.2.0'
 
 ## Getting Started
 
@@ -90,6 +90,7 @@ Class | Method | HTTP request | Description
 *SmoochApi::AppApi* | [**update_app**](docs/AppApi.md#update_app) | **PUT** /apps/{appId} | 
 *SmoochApi::AppUserApi* | [**delete_app_user_profile**](docs/AppUserApi.md#delete_app_user_profile) | **DELETE** /apps/{appId}/appusers/{userId}/profile | 
 *SmoochApi::AppUserApi* | [**get_app_user**](docs/AppUserApi.md#get_app_user) | **GET** /apps/{appId}/appusers/{userId} | 
+*SmoochApi::AppUserApi* | [**get_app_user_business_system_ids**](docs/AppUserApi.md#get_app_user_business_system_ids) | **GET** /apps/{appId}/appusers/{userId}/businesssystems | 
 *SmoochApi::AppUserApi* | [**get_app_user_entity_ids**](docs/AppUserApi.md#get_app_user_entity_ids) | **GET** /apps/{appId}/appusers/{userId}/channels | 
 *SmoochApi::AppUserApi* | [**link_app_user**](docs/AppUserApi.md#link_app_user) | **POST** /apps/{appId}/appusers/{userId}/channels | 
 *SmoochApi::AppUserApi* | [**post_image_message**](docs/AppUserApi.md#post_image_message) | **POST** /apps/{appId}/appusers/{userId}/images | 
@@ -129,11 +130,15 @@ Class | Method | HTTP request | Description
  - [SmoochApi::AppSettings](docs/AppSettings.md)
  - [SmoochApi::AppUpdate](docs/AppUpdate.md)
  - [SmoochApi::AppUser](docs/AppUser.md)
+ - [SmoochApi::AppUserBusinessSystemsResponse](docs/AppUserBusinessSystemsResponse.md)
+ - [SmoochApi::AppUserChannelsResponse](docs/AppUserChannelsResponse.md)
  - [SmoochApi::AppUserLink](docs/AppUserLink.md)
  - [SmoochApi::AppUserPreCreate](docs/AppUserPreCreate.md)
  - [SmoochApi::AppUserResponse](docs/AppUserResponse.md)
  - [SmoochApi::AppUserUpdate](docs/AppUserUpdate.md)
  - [SmoochApi::AttachmentResponse](docs/AttachmentResponse.md)
+ - [SmoochApi::BusinessSystemItem](docs/BusinessSystemItem.md)
+ - [SmoochApi::ChannelEntityItem](docs/ChannelEntityItem.md)
  - [SmoochApi::Client](docs/Client.md)
  - [SmoochApi::ClientInfo](docs/ClientInfo.md)
  - [SmoochApi::Confirmation](docs/Confirmation.md)

data/docs/AppUserApi.md

@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**delete_app_user_profile**](AppUserApi.md#delete_app_user_profile) | **DELETE** /apps/{appId}/appusers/{userId}/profile | 
 [**get_app_user**](AppUserApi.md#get_app_user) | **GET** /apps/{appId}/appusers/{userId} | 
+[**get_app_user_business_system_ids**](AppUserApi.md#get_app_user_business_system_ids) | **GET** /apps/{appId}/appusers/{userId}/businesssystems | 
 [**get_app_user_entity_ids**](AppUserApi.md#get_app_user_entity_ids) | **GET** /apps/{appId}/appusers/{userId}/channels | 
 [**link_app_user**](AppUserApi.md#link_app_user) | **POST** /apps/{appId}/appusers/{userId}/channels | 
 [**post_image_message**](AppUserApi.md#post_image_message) | **POST** /apps/{appId}/appusers/{userId}/images | 
@@ -124,8 +125,63 @@ Name | Type | Description  | Notes
 
 
 
+# **get_app_user_business_system_ids**
+> AppUserBusinessSystemsResponse get_app_user_business_system_ids(app_id, user_id, )
+
+
+
+Get specified app user's business system IDs.
+
+### 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
+
+app_id = "app_id_example" # String | Identifies the app.
+
+user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
+
+
+begin
+  result = api_instance.get_app_user_business_system_ids(app_id, user_id, )
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppUserApi->get_app_user_business_system_ids: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. | 
+
+### Return type
+
+[**AppUserBusinessSystemsResponse**](AppUserBusinessSystemsResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_app_user_entity_ids**
-> AppUserResponse get_app_user_entity_ids(app_id, user_id, )
+> AppUserChannelsResponse get_app_user_entity_ids(app_id, user_id, )
 
 
 
@@ -166,7 +222,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**AppUserResponse**](AppUserResponse.md)
+[**AppUserChannelsResponse**](AppUserChannelsResponse.md)
 
 ### Authorization
 

data/docs/AppUserBusinessSystemsResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::AppUserBusinessSystemsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**business_systems** | [**Array<BusinessSystemItem>**](BusinessSystemItem.md) | An array of objects containing the business system type and the id. | 
+
+

data/docs/AppUserChannelsResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::AppUserChannelsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channels** | [**Array<ChannelEntityItem>**](ChannelEntityItem.md) | An array of objects containing the channel type and the entity id. | 
+
+

data/docs/BusinessSystemItem.md

@@ -0,0 +1,12 @@
+# SmoochApi::BusinessSystemItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of business system (ex. slack, hipchat, zendesk etc...) | 
+**channel_id** | **String** | The channel id for a *slack* integration | [optional] 
+**ticket_id** | **String** | The ticket id for a *zendesk* integration | [optional] 
+**room_id** | **Integer** | The room id for a *hipchat* integration | [optional] 
+**conversation_id** | **String** | The conversation id for a *helpscout* integration | [optional] 
+
+

data/docs/ChannelEntityItem.md

@@ -0,0 +1,12 @@
+# SmoochApi::ChannelEntityItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of channel (ex. messenger, viber, twilio etc...) | 
+**phone_number** | **String** | The phone number for a *twilio*, *messageBird* integration | [optional] 
+**user_id** | **String** | The userId for a *messenger*, *viber*, *line*, *wechat* integration | [optional] 
+**address** | **String** | The email address for a *frontendEmail*, *mailgun* integration | [optional] 
+**chat_id** | **String** | The chat id for a *telegram* integration | [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: 2.1
+OpenAPI spec version: 2.2
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -24,11 +24,15 @@ require 'smooch-api/models/app_response'
 require 'smooch-api/models/app_settings'
 require 'smooch-api/models/app_update'
 require 'smooch-api/models/app_user'
+require 'smooch-api/models/app_user_business_systems_response'
+require 'smooch-api/models/app_user_channels_response'
 require 'smooch-api/models/app_user_link'
 require 'smooch-api/models/app_user_pre_create'
 require 'smooch-api/models/app_user_response'
 require 'smooch-api/models/app_user_update'
 require 'smooch-api/models/attachment_response'
+require 'smooch-api/models/business_system_item'
+require 'smooch-api/models/channel_entity_item'
 require 'smooch-api/models/client'
 require 'smooch-api/models/client_info'
 require 'smooch-api/models/confirmation'

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: 2.1
+OpenAPI spec version: 2.2
 
 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: 2.1
+OpenAPI spec version: 2.2
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -142,12 +142,73 @@ module SmoochApi
       return data, status_code, headers
     end
 
+    # 
+    # Get specified app user's business system IDs.
+    # @param app_id Identifies the app.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param [Hash] opts the optional parameters
+    # @return [AppUserBusinessSystemsResponse]
+    def get_app_user_business_system_ids(app_id, user_id, opts = {})
+      data, _status_code, _headers = get_app_user_business_system_ids_with_http_info(app_id, user_id, opts)
+      return data
+    end
+
+    # 
+    # Get specified app user's business system IDs.
+    # @param app_id Identifies the app.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AppUserBusinessSystemsResponse, Fixnum, Hash)>] AppUserBusinessSystemsResponse data, response status code and response headers
+    def get_app_user_business_system_ids_with_http_info(app_id, user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AppUserApi.get_app_user_business_system_ids ..."
+      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 AppUserApi.get_app_user_business_system_ids"
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling AppUserApi.get_app_user_business_system_ids"
+      end
+      # resource path
+      local_var_path = "/apps/{appId}/appusers/{userId}/businesssystems".sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'userId' + '}', user_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 = nil
+      auth_names = ['jwt']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AppUserBusinessSystemsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AppUserApi#get_app_user_business_system_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 
     # Get specified app user's channel entity IDs.
     # @param app_id Identifies the app.
     # @param user_id Identifies the user. Can be either the smoochId or the userId.
     # @param [Hash] opts the optional parameters
-    # @return [AppUserResponse]
+    # @return [AppUserChannelsResponse]
     def get_app_user_entity_ids(app_id, user_id, opts = {})
       data, _status_code, _headers = get_app_user_entity_ids_with_http_info(app_id, user_id, opts)
       return data
@@ -158,7 +219,7 @@ module SmoochApi
     # @param app_id Identifies the app.
     # @param user_id Identifies the user. Can be either the smoochId or the userId.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(AppUserResponse, Fixnum, Hash)>] AppUserResponse data, response status code and response headers
+    # @return [Array<(AppUserChannelsResponse, Fixnum, Hash)>] AppUserChannelsResponse data, response status code and response headers
     def get_app_user_entity_ids_with_http_info(app_id, user_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: AppUserApi.get_app_user_entity_ids ..."
@@ -196,7 +257,7 @@ module SmoochApi
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'AppUserResponse')
+        :return_type => 'AppUserChannelsResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: AppUserApi#get_app_user_entity_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

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