smooch-api 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bcf90fd5bf64c3913ec4773fa5a284fab8db371
-  data.tar.gz: 6c232a0dd440981ca783b4dab744c5f03bf0df21
+  metadata.gz: a221c844774f83f430b1d1d24b8aa857869e4591
+  data.tar.gz: 1680da2b209644b72f9e6fd2327817762228e39e
 SHA512:
-  metadata.gz: feaa7f58f1ef5274042e69835e2e6a67410b8ba4a144556ffbbaa97ab579bb87159ab50a651d7cbebc645bf2021c10c11117c93ce43599823065b59e36a82736
-  data.tar.gz: 688579bc86d61813cbbf09315600a33d8795cf70a1500d36c0c36a274564be425b6744bd248aae00e84c0e77759dcdf59dd724626d7efa9b466f35d121e7b863
+  metadata.gz: 32ed4876eec093497d8eb0ae1bda26629425dffebd787fc994c098a326d406abfef61a001c4d5f5593e6f7e2fc6e471874f7a53edfcc9112a76c2ba5a9c4d8ee
+  data.tar.gz: 0fa0dbb085a22fb9b5365f287acfe8fc4a0257fcafc4343e205e0c9437283ecafe16c05a8830e6746a3b2d226da44096d380c06fe123aa6c233244138cac9842

data/README.md

@@ -16,7 +16,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 2.4.0'
+    gem 'smooch-api', '~> 2.5.0'
 
 ## Getting Started
 
@@ -93,6 +93,7 @@ Class | Method | HTTP request | Description
 *SmoochApi::AppUserApi* | [**get_app_user_auth_code**](docs/AppUserApi.md#get_app_user_auth_code) | **GET** /apps/{appId}/appusers/{userId}/authcode | 
 *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* | [**get_link_requests**](docs/AppUserApi.md#get_link_requests) | **GET** /apps/{appId}/appusers/{userId}/linkrequest | 
 *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 | 
 *SmoochApi::AppUserApi* | [**pre_create_app_user**](docs/AppUserApi.md#pre_create_app_user) | **POST** /apps/{appId}/appusers | 
@@ -152,6 +153,8 @@ Class | Method | HTTP request | Description
  - [SmoochApi::IntegrationCreate](docs/IntegrationCreate.md)
  - [SmoochApi::IntegrationResponse](docs/IntegrationResponse.md)
  - [SmoochApi::JwtResponse](docs/JwtResponse.md)
+ - [SmoochApi::LinkRequestResponse](docs/LinkRequestResponse.md)
+ - [SmoochApi::LinkRequestResponseLinkRequests](docs/LinkRequestResponseLinkRequests.md)
  - [SmoochApi::ListAppsResponse](docs/ListAppsResponse.md)
  - [SmoochApi::ListIntegrationsResponse](docs/ListIntegrationsResponse.md)
  - [SmoochApi::ListSecretKeysResponse](docs/ListSecretKeysResponse.md)

data/docs/AppUserApi.md

@@ -9,6 +9,7 @@ Method | HTTP request | Description
 [**get_app_user_auth_code**](AppUserApi.md#get_app_user_auth_code) | **GET** /apps/{appId}/appusers/{userId}/authcode | 
 [**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 | 
+[**get_link_requests**](AppUserApi.md#get_link_requests) | **GET** /apps/{appId}/appusers/{userId}/linkrequest | 
 [**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 | 
 [**pre_create_app_user**](AppUserApi.md#pre_create_app_user) | **POST** /apps/{appId}/appusers | 
@@ -291,6 +292,64 @@ Name | Type | Description  | Notes
 
 
 
+# **get_link_requests**
+> LinkRequestResponse get_link_requests(app_id, user_id, integration_ids)
+
+
+
+Fetch link requests for the specified app user.
+
+### 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.
+
+integration_ids = "integration_ids_example" # String | Comma separated list of integration IDs
+
+
+begin
+  result = api_instance.get_link_requests(app_id, user_id, integration_ids)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppUserApi->get_link_requests: #{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. | 
+ **integration_ids** | **String**| Comma separated list of integration IDs | 
+
+### Return type
+
+[**LinkRequestResponse**](LinkRequestResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **link_app_user**
 > AppUserResponse link_app_user(app_id, user_id, app_user_link_body)
 

data/docs/LinkRequestResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::LinkRequestResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**link_requests** | [**Array<LinkRequestResponseLinkRequests>**](LinkRequestResponseLinkRequests.md) | The list of link requests. | [optional] 
+
+

data/docs/LinkRequestResponseLinkRequests.md

@@ -0,0 +1,11 @@
+# SmoochApi::LinkRequestResponseLinkRequests
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integration_id** | **String** | The integration ID. | 
+**type** | **String** | The integration type. | 
+**code** | **String** | The link request code. | 
+**url** | **String** | The link request url. | 
+
+

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.4
+OpenAPI spec version: 2.5
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -45,6 +45,8 @@ require 'smooch-api/models/integration'
 require 'smooch-api/models/integration_create'
 require 'smooch-api/models/integration_response'
 require 'smooch-api/models/jwt_response'
+require 'smooch-api/models/link_request_response'
+require 'smooch-api/models/link_request_response_link_requests'
 require 'smooch-api/models/list_apps_response'
 require 'smooch-api/models/list_integrations_response'
 require 'smooch-api/models/list_secret_keys_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: 2.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -325,6 +325,74 @@ module SmoochApi
       return data, status_code, headers
     end
 
+    # 
+    # Fetch link requests for the specified app user.
+    # @param app_id Identifies the app.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param integration_ids Comma separated list of integration IDs
+    # @param [Hash] opts the optional parameters
+    # @return [LinkRequestResponse]
+    def get_link_requests(app_id, user_id, integration_ids, opts = {})
+      data, _status_code, _headers = get_link_requests_with_http_info(app_id, user_id, integration_ids, opts)
+      return data
+    end
+
+    # 
+    # Fetch link requests for the specified app user.
+    # @param app_id Identifies the app.
+    # @param user_id Identifies the user. Can be either the smoochId or the userId.
+    # @param integration_ids Comma separated list of integration IDs
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LinkRequestResponse, Fixnum, Hash)>] LinkRequestResponse data, response status code and response headers
+    def get_link_requests_with_http_info(app_id, user_id, integration_ids, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AppUserApi.get_link_requests ..."
+      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_link_requests"
+      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_link_requests"
+      end
+      # verify the required parameter 'integration_ids' is set
+      if @api_client.config.client_side_validation && integration_ids.nil?
+        fail ArgumentError, "Missing the required parameter 'integration_ids' when calling AppUserApi.get_link_requests"
+      end
+      # resource path
+      local_var_path = "/apps/{appId}/appusers/{userId}/linkrequest".sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'integrationIds'] = integration_ids
+
+      # 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 => 'LinkRequestResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AppUserApi#get_link_requests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 
     # Link specified app user to given channel.
     # @param app_id 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: 2.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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.4
+OpenAPI spec version: 2.5
 
 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: 2.4
+OpenAPI spec version: 2.5
 
 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: 2.4
+OpenAPI spec version: 2.5
 
 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: 2.4
+OpenAPI spec version: 2.5
 
 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: 2.4
+OpenAPI spec version: 2.5
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

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

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

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