smooch-api 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecd1ff2d48ffcd8550e10c8f77bdad91af2dc105
-  data.tar.gz: fc5186038d121cd5872388a01174deed4cd6b068
+  metadata.gz: d73c9ebf596cbd7aaf49c6130ed77ec64e81da67
+  data.tar.gz: 0f988ace167dea485798ff38fc656161e3c59513
 SHA512:
-  metadata.gz: c0fff14031c7011ef3c690859e9ca69cb1acd815652c93efd2b0b1153ca9a02e021d13414233d53ca1f58a21fbc6fdbc7784c064f613b904b3ea5a3cdc44a1cb
-  data.tar.gz: a6db853e580f7e1ef70984314e3b1dc0bbcbbc998d959d105d89f64994f85c9aaab20e772844e49887f72cba58d523f391e52ad6b6a766bce96443f8b386c51d
+  metadata.gz: c20e91ba26b4d346fae9af875f94e875783c97c24d5ca271a561aacf63b71f88a66a2a9503f256d66db28637bf8a5d50e7af107a96c4cc73e077dbfc1e3bcc5b
+  data.tar.gz: 5a10144a6539cfd276d20cfebdfc33f6802251c10e90ea427b60244abd5da62d66698d02dea3bdacf8a46c16cefedcc416625bc59789d6abb353485058c059ad

data/README.md

@@ -16,7 +16,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 1.8.0'
+    gem 'smooch-api', '~> 1.9.0'
 
 ## Getting Started
 
@@ -98,6 +98,7 @@ Class | Method | HTTP request | Description
 *SmoochApi::AppUserApi* | [**track_event**](docs/AppUserApi.md#track_event) | **POST** /appusers/{userId}/events | 
 *SmoochApi::AppUserApi* | [**unlink_app_user**](docs/AppUserApi.md#unlink_app_user) | **DELETE** /appusers/{userId}/channels/{channel} | 
 *SmoochApi::AppUserApi* | [**update_app_user**](docs/AppUserApi.md#update_app_user) | **PUT** /appusers/{userId} | 
+*SmoochApi::AttachmentsApi* | [**upload_attachment**](docs/AttachmentsApi.md#upload_attachment) | **POST** /apps/{appId}/attachments | 
 *SmoochApi::ConversationApi* | [**delete_messages**](docs/ConversationApi.md#delete_messages) | **DELETE** /appusers/{userId}/messages | 
 *SmoochApi::ConversationApi* | [**get_messages**](docs/ConversationApi.md#get_messages) | **GET** /appusers/{userId}/messages | 
 *SmoochApi::ConversationApi* | [**post_message**](docs/ConversationApi.md#post_message) | **POST** /appusers/{userId}/messages | 
@@ -135,6 +136,7 @@ Class | Method | HTTP request | Description
  - [SmoochApi::AppUserPreCreate](docs/AppUserPreCreate.md)
  - [SmoochApi::AppUserResponse](docs/AppUserResponse.md)
  - [SmoochApi::AppUserUpdate](docs/AppUserUpdate.md)
+ - [SmoochApi::AttachmentResponse](docs/AttachmentResponse.md)
  - [SmoochApi::Client](docs/Client.md)
  - [SmoochApi::ClientInfo](docs/ClientInfo.md)
  - [SmoochApi::Conversation](docs/Conversation.md)

data/docs/AttachmentResponse.md

@@ -0,0 +1,9 @@
+# SmoochApi::AttachmentResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**media_url** | **String** | The mediaUrl for the message. Required for image/file messages.  | 
+**media_type** | **String** | The mediaType for the message. Required for image/file messages.  | 
+
+

data/docs/AttachmentsApi.md

@@ -0,0 +1,67 @@
+# SmoochApi::AttachmentsApi
+
+All URIs are relative to *https://api.smooch.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**upload_attachment**](AttachmentsApi.md#upload_attachment) | **POST** /apps/{appId}/attachments | 
+
+
+# **upload_attachment**
+> AttachmentResponse upload_attachment(app_id, source, access)
+
+
+
+Upload an attachment to Smooch to use in future messages.
+
+### 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::AttachmentsApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+source = File.new("/path/to/file.txt") # File | File to be uploaded
+
+access = "access_example" # String | Access level for the resulting file
+
+
+begin
+  result = api_instance.upload_attachment(app_id, source, access)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AttachmentsApi->upload_attachment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **source** | **File**| File to be uploaded | 
+ **access** | **String**| Access level for the resulting file | 
+
+### Return type
+
+[**AttachmentResponse**](AttachmentResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+

data/docs/Message.md

@@ -12,8 +12,8 @@ Name | Type | Description | Notes
 **email** | **String** | The email address of the message author. | [optional] 
 **avatar_url** | **String** | The URL of the desired message avatar image. | 
 **received** | **Float** | The unix timestamp of the moment the message was received. | 
-**media_url** | **String** | The mediaUrl for the image. Required for image messages.  | [optional] 
-**media_type** | **String** | The mediaType for the image. Required for image messages.  | [optional] 
+**media_url** | **String** | The mediaUrl for the message. Required for image/file messages.  | [optional] 
+**media_type** | **String** | The mediaType for the message. Required for image/file messages.  | [optional] 
 **metadata** | **Object** | Flat JSON object containing any custom properties associated with the message. | [optional] 
 **items** | [**Array<MessageItem>**](MessageItem.md) | The items in the message list. Required for carousel and list messages.  | [optional] 
 **actions** | [**Array<Action>**](Action.md) | The actions in the message. | [optional] 

data/docs/MessagePost.md

@@ -11,8 +11,8 @@ Name | Type | Description | Notes
 **metadata** | **Object** | Flat JSON object containing any custom properties associated with the message. | [optional] 
 **payload** | **String** | The payload of a reply action, if applicable. | [optional] 
 **text** | **String** | The message text. Required for text messages.  | [optional] 
-**media_url** | **String** | The mediaUrl for the image. Required for image messages.  | [optional] 
-**media_type** | **String** | The mediaType for the image. Required for image messages.  | [optional] 
+**media_url** | **String** | The mediaUrl for the message. Required for image/file messages.  | [optional] 
+**media_type** | **String** | The mediaType for the message. Required for image/file messages.  | [optional] 
 **items** | [**Array<MessageItem>**](MessageItem.md) | The items in the message list. Required for carousel and list messages.  | [optional] 
 **actions** | [**Array<Action>**](Action.md) | The actions in the message. | [optional] 
 **destination** | [**Destination**](Destination.md) | Specifies which channel to deliver a message to. See [list integrations](https://docs.smooch.io/rest/#list-integrations) to get integration ID and type. | [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: 1.8
+OpenAPI spec version: 1.9
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -28,6 +28,7 @@ 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/client'
 require 'smooch-api/models/client_info'
 require 'smooch-api/models/conversation'
@@ -68,6 +69,7 @@ require 'smooch-api/models/webhook_update'
 # APIs
 require 'smooch-api/api/app_api'
 require 'smooch-api/api/app_user_api'
+require 'smooch-api/api/attachments_api'
 require 'smooch-api/api/conversation_api'
 require 'smooch-api/api/init_api'
 require 'smooch-api/api/integration_api'

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: 1.8
+OpenAPI spec version: 1.9
 
 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: 1.8
+OpenAPI spec version: 1.9
 
 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

@@ -0,0 +1,92 @@
+=begin
+#Smooch
+
+#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: 1.9
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3-SNAPSHOT
+
+=end
+
+require "uri"
+
+module SmoochApi
+  class AttachmentsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # 
+    # Upload an attachment to Smooch to use in future messages.
+    # @param app_id Identifies the app.
+    # @param source File to be uploaded
+    # @param access Access level for the resulting file
+    # @param [Hash] opts the optional parameters
+    # @return [AttachmentResponse]
+    def upload_attachment(app_id, source, access, opts = {})
+      data, _status_code, _headers = upload_attachment_with_http_info(app_id, source, access, opts)
+      return data
+    end
+
+    # 
+    # Upload an attachment to Smooch to use in future messages.
+    # @param app_id Identifies the app.
+    # @param source File to be uploaded
+    # @param access Access level for the resulting file
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AttachmentResponse, Fixnum, Hash)>] AttachmentResponse data, response status code and response headers
+    def upload_attachment_with_http_info(app_id, source, access, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AttachmentsApi.upload_attachment ..."
+      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 AttachmentsApi.upload_attachment"
+      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 AttachmentsApi.upload_attachment"
+      end
+      # verify the required parameter 'access' is set
+      if @api_client.config.client_side_validation && access.nil?
+        fail ArgumentError, "Missing the required parameter 'access' when calling AttachmentsApi.upload_attachment"
+      end
+      # resource path
+      local_var_path = "/apps/{appId}/attachments".sub('{' + 'appId' + '}', app_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'access'] = access
+
+      # 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(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AttachmentResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AttachmentsApi#upload_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

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