smooch-api 5.5.0 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1305e9a53caf50d3f5d88880c193e9a6c918b4a
-  data.tar.gz: 465960a177a16d0d57faee9cc4f34f4777d0c6ba
+  metadata.gz: a431facd88915753cfafcb33f8d2bd7e502aa2b5
+  data.tar.gz: 994cbfe3ca1bfab7a57463d3c357c360c0e20ce4
 SHA512:
-  metadata.gz: b57189fc4e3f4fdc2e6907bdc8719f084cc5b48c890597a0fb8c292037be2403d602cec6b6e513545f664d2c274b2321081ec8cf1cd1cdba95a512d1eddec0b5
-  data.tar.gz: 125b3d5b84eb8ef83ec2efdf19b7846d494413baffee39df7663a74c904ffbd8170fd2eac86d3cd4254622dd395eade9987983e53b253dae428106e9b6dedae8
+  metadata.gz: 4437932df56ff2216e13071877ac80d2ebebd523172b342f3a068cf19f950ced0d98986946f3a75ffb07568fa99606d9f176049f7d27e6db490e40300571e1f4
+  data.tar.gz: 81fb53a364192099ed4fb2fe0cb2058cd28aef13914fcbe8a36be1e630b2968508189b2760497dd62720fa0bfce76e4dc024435277e7bf533fd711c01e0e0994

data/README.md

@@ -25,7 +25,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 5.5.0'
+    gem 'smooch-api', '~> 5.6.0'
 
 ## Getting Started
 
@@ -135,10 +135,12 @@ Class | Method | HTTP request | Description
 *SmoochApi::IntegrationApi* | [**delete_integration_menu**](docs/IntegrationApi.md#delete_integration_menu) | **DELETE** /v1.1/apps/{appId}/integrations/{integrationId}/menu | 
 *SmoochApi::IntegrationApi* | [**get_integration**](docs/IntegrationApi.md#get_integration) | **GET** /v1.1/apps/{appId}/integrations/{integrationId} | 
 *SmoochApi::IntegrationApi* | [**get_integration_menu**](docs/IntegrationApi.md#get_integration_menu) | **GET** /v1.1/apps/{appId}/integrations/{integrationId}/menu | 
+*SmoochApi::IntegrationApi* | [**get_integration_profile**](docs/IntegrationApi.md#get_integration_profile) | **GET** /v1.1/apps/{appId}/integrations/{integrationId}/profile | 
 *SmoochApi::IntegrationApi* | [**list_integrations**](docs/IntegrationApi.md#list_integrations) | **GET** /v1.1/apps/{appId}/integrations | 
 *SmoochApi::IntegrationApi* | [**update_integration**](docs/IntegrationApi.md#update_integration) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId} | 
 *SmoochApi::IntegrationApi* | [**update_integration_menu**](docs/IntegrationApi.md#update_integration_menu) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId}/menu | 
 *SmoochApi::IntegrationApi* | [**update_integration_profile**](docs/IntegrationApi.md#update_integration_profile) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId}/profile | 
+*SmoochApi::IntegrationApi* | [**upload_integration_profile_photo**](docs/IntegrationApi.md#upload_integration_profile_photo) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId}/profile/photo | 
 *SmoochApi::MenuApi* | [**delete_menu**](docs/MenuApi.md#delete_menu) | **DELETE** /v1.1/apps/{appId}/menu | 
 *SmoochApi::MenuApi* | [**get_menu**](docs/MenuApi.md#get_menu) | **GET** /v1.1/apps/{appId}/menu | 
 *SmoochApi::MenuApi* | [**update_menu**](docs/MenuApi.md#update_menu) | **PUT** /v1.1/apps/{appId}/menu | 
@@ -192,6 +194,7 @@ Class | Method | HTTP request | Description
  - [SmoochApi::Destination](docs/Destination.md)
  - [SmoochApi::DisplaySettings](docs/DisplaySettings.md)
  - [SmoochApi::Enums](docs/Enums.md)
+ - [SmoochApi::GetIntegrationProfileResponse](docs/GetIntegrationProfileResponse.md)
  - [SmoochApi::GetMessagesResponse](docs/GetMessagesResponse.md)
  - [SmoochApi::Integration](docs/Integration.md)
  - [SmoochApi::IntegrationCreate](docs/IntegrationCreate.md)
@@ -229,6 +232,7 @@ Class | Method | HTTP request | Description
  - [SmoochApi::TemplateCreate](docs/TemplateCreate.md)
  - [SmoochApi::TemplateResponse](docs/TemplateResponse.md)
  - [SmoochApi::TemplateUpdate](docs/TemplateUpdate.md)
+ - [SmoochApi::UploadIntegrationProfilePhotoResponse](docs/UploadIntegrationProfilePhotoResponse.md)
  - [SmoochApi::Webhook](docs/Webhook.md)
  - [SmoochApi::WebhookCreate](docs/WebhookCreate.md)
  - [SmoochApi::WebhookResponse](docs/WebhookResponse.md)

data/docs/AppUserLink.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | The type of the channel to link. See Enums.md for available values. | 
-**phoneNumber** | **String** | A String of the appUser’s phone number. It must contain the + prefix and the country code. Required for *messenger*, *twilio* and *messagebird* linking.  | [optional] 
+**phoneNumber** | **String** | A String of the appUser’s phone number. It must contain the + prefix and the country code. Required for *messenger*, *twilio*, *messagebird* and *whatsapp* linking.  | [optional] 
 **address** | **String** | A String of the appUser’s email address. Required for *mailgun* linking.  | [optional] 
 **givenName** | **String** | A String of the appUser’s given name. Used as additional criteria to increase the likelihood of a match. (Optional) Used for *messenger* linking.  | [optional] 
 **surname** | **String** | A String of the appUser’s surname. Used as additional criteria to increase the likelihood of a match. (Optional) Used for *messenger* linking.  | [optional] 

data/docs/GetIntegrationProfileResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::GetIntegrationProfileResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**profile** | **Object** | JSON object containing the integration profile. [More info](https://docs.smooch.io/rest/#get-integration-profile) | [optional] 
+
+

data/docs/IntegrationApi.md

@@ -10,10 +10,12 @@ Method | HTTP request | Description
 [**delete_integration_menu**](IntegrationApi.md#delete_integration_menu) | **DELETE** /v1.1/apps/{appId}/integrations/{integrationId}/menu | 
 [**get_integration**](IntegrationApi.md#get_integration) | **GET** /v1.1/apps/{appId}/integrations/{integrationId} | 
 [**get_integration_menu**](IntegrationApi.md#get_integration_menu) | **GET** /v1.1/apps/{appId}/integrations/{integrationId}/menu | 
+[**get_integration_profile**](IntegrationApi.md#get_integration_profile) | **GET** /v1.1/apps/{appId}/integrations/{integrationId}/profile | 
 [**list_integrations**](IntegrationApi.md#list_integrations) | **GET** /v1.1/apps/{appId}/integrations | 
 [**update_integration**](IntegrationApi.md#update_integration) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId} | 
 [**update_integration_menu**](IntegrationApi.md#update_integration_menu) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId}/menu | 
 [**update_integration_profile**](IntegrationApi.md#update_integration_profile) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId}/profile | 
+[**upload_integration_profile_photo**](IntegrationApi.md#upload_integration_profile_photo) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId}/profile/photo | 
 
 
 # **create_integration**
@@ -347,6 +349,61 @@ Name | Type | Description  | Notes
 
 
 
+# **get_integration_profile**
+> GetIntegrationProfileResponse get_integration_profile(appId, integrationId, )
+
+
+
+Get 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
+
+appId = "appId_example" # String | Identifies the app.
+
+integrationId = "integrationId_example" # String | Identifies the integration.
+
+
+begin
+  result = api_instance.get_integration_profile(appId, integrationId, )
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling IntegrationApi->get_integration_profile: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appId** | **String**| Identifies the app. | 
+ **integrationId** | **String**| Identifies the integration. | 
+
+### Return type
+
+[**GetIntegrationProfileResponse**](GetIntegrationProfileResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **list_integrations**
 > ListIntegrationsResponse list_integrations(appId, , opts)
 
@@ -580,3 +637,61 @@ nil (empty response body)
 
 
 
+# **upload_integration_profile_photo**
+> UploadIntegrationProfilePhotoResponse upload_integration_profile_photo(appId, integrationId, source)
+
+
+
+Upload a photo to be used for the 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
+
+appId = "appId_example" # String | Identifies the app.
+
+integrationId = "integrationId_example" # String | Identifies the integration.
+
+source = File.new("/path/to/file.txt") # File | Photo to be uploaded
+
+
+begin
+  result = api_instance.upload_integration_profile_photo(appId, integrationId, source)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling IntegrationApi->upload_integration_profile_photo: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appId** | **String**| Identifies the app. | 
+ **integrationId** | **String**| Identifies the integration. | 
+ **source** | **File**| Photo to be uploaded | 
+
+### Return type
+
+[**UploadIntegrationProfilePhotoResponse**](UploadIntegrationProfilePhotoResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+

data/docs/UploadIntegrationProfilePhotoResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::UploadIntegrationProfilePhotoResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**photoUrl** | **String** | The photo URL after uploading. | 
+
+

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.5
+OpenAPI spec version: 5.6
 
 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.5
+OpenAPI spec version: 5.6
 
 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: 5.5
+OpenAPI spec version: 5.6
 
 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.5
+OpenAPI spec version: 5.6
 
 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.5
+OpenAPI spec version: 5.6
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -390,6 +390,67 @@ module SmoochApi
       return data, status_code, headers
     end
 
+    # 
+    # Get the specified integration’s profile.
+    # @param appId Identifies the app.
+    # @param integrationId Identifies the integration.
+    # @param [Hash] opts the optional parameters
+    # @return [GetIntegrationProfileResponse]
+    def get_integration_profile(appId, integrationId, opts = {})
+      data, _status_code, _headers = get_integration_profile_with_http_info(appId, integrationId, opts)
+      return data
+    end
+
+    # 
+    # Get the specified integration’s profile.
+    # @param appId Identifies the app.
+    # @param integrationId Identifies the integration.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetIntegrationProfileResponse, Fixnum, Hash)>] GetIntegrationProfileResponse data, response status code and response headers
+    def get_integration_profile_with_http_info(appId, integrationId, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: IntegrationApi.get_integration_profile ..."
+      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 IntegrationApi.get_integration_profile"
+      end
+      # verify the required parameter 'integrationId' is set
+      if @api_client.config.client_side_validation && integrationId.nil?
+        fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.get_integration_profile"
+      end
+      # resource path
+      local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}/profile".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.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 => 'GetIntegrationProfileResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IntegrationApi#get_integration_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 
     # List integrations for the specified app.
     # @param appId Identifies the app.
@@ -653,5 +714,73 @@ module SmoochApi
       end
       return data, status_code, headers
     end
+
+    # 
+    # Upload a photo to be used for the the specified integration’s profile.
+    # @param appId Identifies the app.
+    # @param integrationId Identifies the integration.
+    # @param source Photo to be uploaded
+    # @param [Hash] opts the optional parameters
+    # @return [UploadIntegrationProfilePhotoResponse]
+    def upload_integration_profile_photo(appId, integrationId, source, opts = {})
+      data, _status_code, _headers = upload_integration_profile_photo_with_http_info(appId, integrationId, source, opts)
+      return data
+    end
+
+    # 
+    # Upload a photo to be used for the the specified integration’s profile.
+    # @param appId Identifies the app.
+    # @param integrationId Identifies the integration.
+    # @param source Photo to be uploaded
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UploadIntegrationProfilePhotoResponse, Fixnum, Hash)>] UploadIntegrationProfilePhotoResponse data, response status code and response headers
+    def upload_integration_profile_photo_with_http_info(appId, integrationId, source, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: IntegrationApi.upload_integration_profile_photo ..."
+      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 IntegrationApi.upload_integration_profile_photo"
+      end
+      # verify the required parameter 'integrationId' is set
+      if @api_client.config.client_side_validation && integrationId.nil?
+        fail ArgumentError, "Missing the required parameter 'integrationId' when calling IntegrationApi.upload_integration_profile_photo"
+      end
+      # verify the required parameter 'source' is set
+      if @api_client.config.client_side_validation && source.nil?
+        fail ArgumentError, "Missing the required parameter 'source' when calling IntegrationApi.upload_integration_profile_photo"
+      end
+      # resource path
+      local_var_path = "/v1.1/apps/{appId}/integrations/{integrationId}/profile/photo".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'integrationId' + '}', integrationId.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(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params["source"] = source
+
+      # http body (model)
+      post_body = nil
+      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,
+        :return_type => 'UploadIntegrationProfilePhotoResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IntegrationApi#upload_integration_profile_photo\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: 5.5
+OpenAPI spec version: 5.6
 
 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.5
+OpenAPI spec version: 5.6
 
 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.5
+OpenAPI spec version: 5.6
 
 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.5
+OpenAPI spec version: 5.6
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT