omnichannel 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +8 -0
- data/Gemfile.lock +79 -0
- data/README.md +120 -0
- data/Rakefile +10 -0
- data/config.json +12 -0
- data/docs/Channel.md +7 -0
- data/docs/DeliveryReportApi.md +58 -0
- data/docs/DeliveryReportResponse.md +10 -0
- data/docs/DeliveryResult.md +13 -0
- data/docs/Err.md +7 -0
- data/docs/ErrorItem.md +11 -0
- data/docs/ErrorResponse.md +8 -0
- data/docs/Message.md +9 -0
- data/docs/MessageResult.md +10 -0
- data/docs/OmniMessageCreateSuccessResponse.md +10 -0
- data/docs/Omnimessage.md +11 -0
- data/docs/OmnimessageApi.md +107 -0
- data/docs/ResponseErrorCode.md +7 -0
- data/docs/ResponseErrorTitle.md +7 -0
- data/docs/SMS.md +13 -0
- data/docs/Status.md +7 -0
- data/docs/Viber.md +14 -0
- data/docs/WhatsApp.md +14 -0
- data/docs/WhatsAppAudio.md +8 -0
- data/docs/WhatsAppDocument.md +9 -0
- data/docs/WhatsAppImage.md +9 -0
- data/docs/WhatsAppText.md +9 -0
- data/git_push.sh +55 -0
- data/lib/omnichannel.rb +60 -0
- data/lib/omnichannel/api/delivery_report_api.rb +74 -0
- data/lib/omnichannel/api/omnimessage_api.rb +126 -0
- data/lib/omnichannel/api_client.rb +387 -0
- data/lib/omnichannel/api_error.rb +38 -0
- data/lib/omnichannel/configuration.rb +251 -0
- data/lib/omnichannel/models/channel.rb +39 -0
- data/lib/omnichannel/models/delivery_report_response.rb +229 -0
- data/lib/omnichannel/models/delivery_result.rb +239 -0
- data/lib/omnichannel/models/err.rb +48 -0
- data/lib/omnichannel/models/error_item.rb +240 -0
- data/lib/omnichannel/models/error_response.rb +198 -0
- data/lib/omnichannel/models/message.rb +207 -0
- data/lib/omnichannel/models/message_result.rb +226 -0
- data/lib/omnichannel/models/omni_message_create_success_response.rb +229 -0
- data/lib/omnichannel/models/omnimessage.rb +233 -0
- data/lib/omnichannel/models/response_error_code.rb +43 -0
- data/lib/omnichannel/models/response_error_title.rb +42 -0
- data/lib/omnichannel/models/sms.rb +249 -0
- data/lib/omnichannel/models/status.rb +47 -0
- data/lib/omnichannel/models/viber.rb +254 -0
- data/lib/omnichannel/models/whats_app.rb +250 -0
- data/lib/omnichannel/models/whats_app_audio.rb +197 -0
- data/lib/omnichannel/models/whats_app_document.rb +207 -0
- data/lib/omnichannel/models/whats_app_image.rb +207 -0
- data/lib/omnichannel/models/whats_app_text.rb +209 -0
- data/lib/omnichannel/version.rb +15 -0
- data/lib/openapi_client.rb +61 -0
- data/lib/openapi_client/api/delivery_report_api.rb +74 -0
- data/lib/openapi_client/api/omnimessage_api.rb +126 -0
- data/lib/openapi_client/api_client.rb +387 -0
- data/lib/openapi_client/api_error.rb +38 -0
- data/lib/openapi_client/configuration.rb +251 -0
- data/lib/openapi_client/models/channel.rb +39 -0
- data/lib/openapi_client/models/delivery_report_response.rb +229 -0
- data/lib/openapi_client/models/delivery_result.rb +239 -0
- data/lib/openapi_client/models/err.rb +48 -0
- data/lib/openapi_client/models/error_item.rb +240 -0
- data/lib/openapi_client/models/error_response.rb +198 -0
- data/lib/openapi_client/models/message.rb +221 -0
- data/lib/openapi_client/models/message_result.rb +226 -0
- data/lib/openapi_client/models/omni_message_create_success_response.rb +229 -0
- data/lib/openapi_client/models/omnimessage.rb +233 -0
- data/lib/openapi_client/models/response_error_code.rb +43 -0
- data/lib/openapi_client/models/response_error_title.rb +42 -0
- data/lib/openapi_client/models/sms.rb +228 -0
- data/lib/openapi_client/models/status.rb +47 -0
- data/lib/openapi_client/models/viber.rb +233 -0
- data/lib/openapi_client/models/whats_app.rb +229 -0
- data/lib/openapi_client/models/whats_app_audio.rb +197 -0
- data/lib/openapi_client/models/whats_app_document.rb +207 -0
- data/lib/openapi_client/models/whats_app_image.rb +207 -0
- data/lib/openapi_client/models/whats_app_text.rb +209 -0
- data/lib/openapi_client/version.rb +15 -0
- data/omnichannel.gemspec +45 -0
- data/spec/api/delivery_report_api_spec.rb +46 -0
- data/spec/api/omnimessage_api_spec.rb +57 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/channel_spec.rb +35 -0
- data/spec/models/delivery_report_response_spec.rb +53 -0
- data/spec/models/delivery_result_spec.rb +71 -0
- data/spec/models/err_spec.rb +35 -0
- data/spec/models/error_item_spec.rb +59 -0
- data/spec/models/error_response_spec.rb +41 -0
- data/spec/models/message_result_spec.rb +53 -0
- data/spec/models/message_spec.rb +53 -0
- data/spec/models/omni_message_create_success_response_spec.rb +53 -0
- data/spec/models/omnimessage_spec.rb +59 -0
- data/spec/models/response_error_code_spec.rb +35 -0
- data/spec/models/response_error_title_spec.rb +35 -0
- data/spec/models/sms_spec.rb +71 -0
- data/spec/models/status_spec.rb +35 -0
- data/spec/models/viber_spec.rb +77 -0
- data/spec/models/whats_app_audio_spec.rb +41 -0
- data/spec/models/whats_app_document_spec.rb +47 -0
- data/spec/models/whats_app_image_spec.rb +47 -0
- data/spec/models/whats_app_spec.rb +77 -0
- data/spec/models/whats_app_text_spec.rb +47 -0
- data/spec/spec_helper.rb +111 -0
- data/templates/README.mustache +114 -0
- metadata +358 -0
data/docs/SMS.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# Omnichannel::SMS
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**sender** | **String** | Phone number or alphanumeric sender name | [optional]
|
7
|
+
**validity** | **Integer** | After how many minutes this channel is considered as failed and the next channel is attempted | [optional]
|
8
|
+
**text** | **String** | Text content of the SMS |
|
9
|
+
**autoconvert** | **Float** | Defines how non-GSM characters will be treated: - \"on\" Use replacement settings from the account's [API Auto Replace settings page](https://dashboard.messente.com/api-settings/auto-replace)(default) - \"full\" All non GSM 03.38 characters will be replaced with suitable alternatives - \"off\" Message content is not modified in any way | [optional]
|
10
|
+
**udh** | **String** | hex-encoded string containing SMS UDH | [optional]
|
11
|
+
**channel** | **String** | | [optional] [default to 'sms']
|
12
|
+
|
13
|
+
|
data/docs/Status.md
ADDED
data/docs/Viber.md
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
# Omnichannel::Viber
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**sender** | **String** | Phone number or alphanumeric sender name | [optional]
|
7
|
+
**validity** | **Integer** | After how many minutes this channel is considered as failed and the next channel is attempted | [optional]
|
8
|
+
**text** | **String** | Plaintext content for Viber | [optional]
|
9
|
+
**image_url** | **String** | URL for the embedded image. Valid combinations: 1) 'image_url' 2) 'text', 'image_url', 'button_url', 'button_text' | [optional]
|
10
|
+
**button_url** | **String** | URL of the button, must be specified along with 'text', 'button_text' and 'image_url' (optional) | [optional]
|
11
|
+
**button_text** | **String** | Must be specified along with 'text', 'button_url', 'button_text', 'image_url' (optional) | [optional]
|
12
|
+
**channel** | **String** | | [optional] [default to 'viber']
|
13
|
+
|
14
|
+
|
data/docs/WhatsApp.md
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
# Omnichannel::WhatsApp
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**sender** | **String** | Phone number or alphanumeric sender name | [optional]
|
7
|
+
**validity** | **Integer** | After how many minutes this channel is considered as failed and the next channel is attempted | [optional]
|
8
|
+
**text** | [**WhatsAppText**](WhatsAppText.md) | | [optional]
|
9
|
+
**image** | [**WhatsAppImage**](WhatsAppImage.md) | | [optional]
|
10
|
+
**document** | [**WhatsAppDocument**](WhatsAppDocument.md) | | [optional]
|
11
|
+
**audio** | [**WhatsAppAudio**](WhatsAppAudio.md) | | [optional]
|
12
|
+
**channel** | **String** | | [optional] [default to 'whatsapp']
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Omnichannel::WhatsAppDocument
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**caption** | **String** | Description for the document | [optional]
|
7
|
+
**content** | **String** | Base64-encoded image |
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Omnichannel::WhatsAppImage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**caption** | **String** | Description for the image | [optional]
|
7
|
+
**content** | **String** | Base64-encoded image |
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Omnichannel::WhatsAppText
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**preview_url** | **BOOLEAN** | Whether to display link preview if the message contains a hyperlink. | [optional] [default to true]
|
7
|
+
**body** | **String** | Plaintext content for WhatsApp, can contains URLs, emojis and formatting |
|
8
|
+
|
9
|
+
|
data/git_push.sh
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# Generated by: https://openapi-generator.tech
|
4
|
+
#
|
5
|
+
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
|
6
|
+
#
|
7
|
+
# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update"
|
8
|
+
|
9
|
+
git_user_id=$1
|
10
|
+
git_repo_id=$2
|
11
|
+
release_note=$3
|
12
|
+
|
13
|
+
if [ "$git_user_id" = "" ]; then
|
14
|
+
git_user_id="messente"
|
15
|
+
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
|
16
|
+
fi
|
17
|
+
|
18
|
+
if [ "$git_repo_id" = "" ]; then
|
19
|
+
git_repo_id="messente-omnichannel-ruby"
|
20
|
+
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
|
21
|
+
fi
|
22
|
+
|
23
|
+
if [ "$release_note" = "" ]; then
|
24
|
+
release_note="Minor update"
|
25
|
+
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
|
26
|
+
fi
|
27
|
+
|
28
|
+
# Initialize the local directory as a Git repository
|
29
|
+
git init
|
30
|
+
|
31
|
+
# Adds the files in the local repository and stages them for commit.
|
32
|
+
git add .
|
33
|
+
|
34
|
+
# Commits the tracked changes and prepares them to be pushed to a remote repository.
|
35
|
+
git commit -m "$release_note"
|
36
|
+
|
37
|
+
# Sets the new remote
|
38
|
+
git_remote=`git remote`
|
39
|
+
if [ "$git_remote" = "" ]; then # git remote not defined
|
40
|
+
|
41
|
+
if [ "$GIT_TOKEN" = "" ]; then
|
42
|
+
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
|
43
|
+
git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
|
44
|
+
else
|
45
|
+
git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
|
46
|
+
fi
|
47
|
+
|
48
|
+
fi
|
49
|
+
|
50
|
+
git pull origin master
|
51
|
+
|
52
|
+
# Pushes (Forces) the changes in the local repository up to the remote repository
|
53
|
+
echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
|
54
|
+
git push origin master 2>&1 | grep -v 'To https'
|
55
|
+
|
data/lib/omnichannel.rb
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
=begin
|
2
|
+
#Omnichannel API
|
3
|
+
|
4
|
+
#Messente's API which allows sending messages via various channels with fallback options.
|
5
|
+
|
6
|
+
OpenAPI spec version: 0.0.2
|
7
|
+
Contact: messente@messente.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.0.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
# Common files
|
14
|
+
require 'omnichannel/api_client'
|
15
|
+
require 'omnichannel/api_error'
|
16
|
+
require 'omnichannel/version'
|
17
|
+
require 'omnichannel/configuration'
|
18
|
+
|
19
|
+
# Models
|
20
|
+
require 'omnichannel/models/channel'
|
21
|
+
require 'omnichannel/models/delivery_report_response'
|
22
|
+
require 'omnichannel/models/delivery_result'
|
23
|
+
require 'omnichannel/models/err'
|
24
|
+
require 'omnichannel/models/error_item'
|
25
|
+
require 'omnichannel/models/error_response'
|
26
|
+
require 'omnichannel/models/message_result'
|
27
|
+
require 'omnichannel/models/omni_message_create_success_response'
|
28
|
+
require 'omnichannel/models/omnimessage'
|
29
|
+
require 'omnichannel/models/response_error_code'
|
30
|
+
require 'omnichannel/models/response_error_title'
|
31
|
+
require 'omnichannel/models/sms'
|
32
|
+
require 'omnichannel/models/status'
|
33
|
+
require 'omnichannel/models/viber'
|
34
|
+
require 'omnichannel/models/whats_app'
|
35
|
+
require 'omnichannel/models/whats_app_audio'
|
36
|
+
require 'omnichannel/models/whats_app_document'
|
37
|
+
require 'omnichannel/models/whats_app_image'
|
38
|
+
require 'omnichannel/models/whats_app_text'
|
39
|
+
|
40
|
+
# APIs
|
41
|
+
require 'omnichannel/api/delivery_report_api'
|
42
|
+
require 'omnichannel/api/omnimessage_api'
|
43
|
+
|
44
|
+
module Omnichannel
|
45
|
+
class << self
|
46
|
+
# Customize default settings for the SDK using block.
|
47
|
+
# Omnichannel.configure do |config|
|
48
|
+
# config.username = "xxx"
|
49
|
+
# config.password = "xxx"
|
50
|
+
# end
|
51
|
+
# If no block given, return the default Configuration object.
|
52
|
+
def configure
|
53
|
+
if block_given?
|
54
|
+
yield(Configuration.default)
|
55
|
+
else
|
56
|
+
Configuration.default
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
@@ -0,0 +1,74 @@
|
|
1
|
+
=begin
|
2
|
+
#Omnichannel API
|
3
|
+
|
4
|
+
#Messente's API which allows sending messages via various channels with fallback options.
|
5
|
+
|
6
|
+
OpenAPI spec version: 0.0.2
|
7
|
+
Contact: messente@messente.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.0.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module Omnichannel
|
16
|
+
class DeliveryReportApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Retrieves the delivery report for the Omnimessage
|
23
|
+
# @param omnimessage_id UUID of the Omnimessage to for which the delivery report is to be retrieved
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @return [DeliveryReportResponse]
|
26
|
+
def retrieve_delivery_report(omnimessage_id, opts = {})
|
27
|
+
data, _status_code, _headers = retrieve_delivery_report_with_http_info(omnimessage_id, opts)
|
28
|
+
data
|
29
|
+
end
|
30
|
+
|
31
|
+
# Retrieves the delivery report for the Omnimessage
|
32
|
+
# @param omnimessage_id UUID of the Omnimessage to for which the delivery report is to be retrieved
|
33
|
+
# @param [Hash] opts the optional parameters
|
34
|
+
# @return [Array<(DeliveryReportResponse, Fixnum, Hash)>] DeliveryReportResponse data, response status code and response headers
|
35
|
+
def retrieve_delivery_report_with_http_info(omnimessage_id, opts = {})
|
36
|
+
if @api_client.config.debugging
|
37
|
+
@api_client.config.logger.debug 'Calling API: DeliveryReportApi.retrieve_delivery_report ...'
|
38
|
+
end
|
39
|
+
# verify the required parameter 'omnimessage_id' is set
|
40
|
+
if @api_client.config.client_side_validation && omnimessage_id.nil?
|
41
|
+
fail ArgumentError, "Missing the required parameter 'omnimessage_id' when calling DeliveryReportApi.retrieve_delivery_report"
|
42
|
+
end
|
43
|
+
# resource path
|
44
|
+
local_var_path = '/omnimessage/{omnimessage_id}/status'.sub('{' + 'omnimessage_id' + '}', omnimessage_id.to_s)
|
45
|
+
|
46
|
+
# query parameters
|
47
|
+
query_params = {}
|
48
|
+
|
49
|
+
# header parameters
|
50
|
+
header_params = {}
|
51
|
+
# HTTP header 'Accept' (if needed)
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
53
|
+
|
54
|
+
# form parameters
|
55
|
+
form_params = {}
|
56
|
+
|
57
|
+
# http body (model)
|
58
|
+
post_body = nil
|
59
|
+
auth_names = ['basicAuth']
|
60
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
61
|
+
:header_params => header_params,
|
62
|
+
:query_params => query_params,
|
63
|
+
:form_params => form_params,
|
64
|
+
:body => post_body,
|
65
|
+
:auth_names => auth_names,
|
66
|
+
:return_type => 'DeliveryReportResponse')
|
67
|
+
if @api_client.config.debugging
|
68
|
+
@api_client.config.logger.debug "API called: DeliveryReportApi#retrieve_delivery_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
69
|
+
end
|
70
|
+
return data, status_code, headers
|
71
|
+
end
|
72
|
+
|
73
|
+
end
|
74
|
+
end
|
@@ -0,0 +1,126 @@
|
|
1
|
+
=begin
|
2
|
+
#Omnichannel API
|
3
|
+
|
4
|
+
#Messente's API which allows sending messages via various channels with fallback options.
|
5
|
+
|
6
|
+
OpenAPI spec version: 0.0.2
|
7
|
+
Contact: messente@messente.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.0.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module Omnichannel
|
16
|
+
class OmnimessageApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Cancels a scheduled Omnimessage
|
23
|
+
# @param omnimessage_id UUID of the scheduled Omnimessage to be cancelled
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @return [nil]
|
26
|
+
def cancel_scheduled_message(omnimessage_id, opts = {})
|
27
|
+
cancel_scheduled_message_with_http_info(omnimessage_id, opts)
|
28
|
+
nil
|
29
|
+
end
|
30
|
+
|
31
|
+
# Cancels a scheduled Omnimessage
|
32
|
+
# @param omnimessage_id UUID of the scheduled Omnimessage to be cancelled
|
33
|
+
# @param [Hash] opts the optional parameters
|
34
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
35
|
+
def cancel_scheduled_message_with_http_info(omnimessage_id, opts = {})
|
36
|
+
if @api_client.config.debugging
|
37
|
+
@api_client.config.logger.debug 'Calling API: OmnimessageApi.cancel_scheduled_message ...'
|
38
|
+
end
|
39
|
+
# verify the required parameter 'omnimessage_id' is set
|
40
|
+
if @api_client.config.client_side_validation && omnimessage_id.nil?
|
41
|
+
fail ArgumentError, "Missing the required parameter 'omnimessage_id' when calling OmnimessageApi.cancel_scheduled_message"
|
42
|
+
end
|
43
|
+
# resource path
|
44
|
+
local_var_path = '/omnimessage/{omnimessage_id}'.sub('{' + 'omnimessage_id' + '}', omnimessage_id.to_s)
|
45
|
+
|
46
|
+
# query parameters
|
47
|
+
query_params = {}
|
48
|
+
|
49
|
+
# header parameters
|
50
|
+
header_params = {}
|
51
|
+
# HTTP header 'Accept' (if needed)
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
53
|
+
|
54
|
+
# form parameters
|
55
|
+
form_params = {}
|
56
|
+
|
57
|
+
# http body (model)
|
58
|
+
post_body = nil
|
59
|
+
auth_names = ['basicAuth']
|
60
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
61
|
+
:header_params => header_params,
|
62
|
+
:query_params => query_params,
|
63
|
+
:form_params => form_params,
|
64
|
+
:body => post_body,
|
65
|
+
:auth_names => auth_names)
|
66
|
+
if @api_client.config.debugging
|
67
|
+
@api_client.config.logger.debug "API called: OmnimessageApi#cancel_scheduled_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
68
|
+
end
|
69
|
+
return data, status_code, headers
|
70
|
+
end
|
71
|
+
|
72
|
+
# Sends an Omnimessage
|
73
|
+
# @param omnimessage Omnimessage to be sent
|
74
|
+
# @param [Hash] opts the optional parameters
|
75
|
+
# @return [OmniMessageCreateSuccessResponse]
|
76
|
+
def send_omnimessage(omnimessage, opts = {})
|
77
|
+
data, _status_code, _headers = send_omnimessage_with_http_info(omnimessage, opts)
|
78
|
+
data
|
79
|
+
end
|
80
|
+
|
81
|
+
# Sends an Omnimessage
|
82
|
+
# @param omnimessage Omnimessage to be sent
|
83
|
+
# @param [Hash] opts the optional parameters
|
84
|
+
# @return [Array<(OmniMessageCreateSuccessResponse, Fixnum, Hash)>] OmniMessageCreateSuccessResponse data, response status code and response headers
|
85
|
+
def send_omnimessage_with_http_info(omnimessage, opts = {})
|
86
|
+
if @api_client.config.debugging
|
87
|
+
@api_client.config.logger.debug 'Calling API: OmnimessageApi.send_omnimessage ...'
|
88
|
+
end
|
89
|
+
# verify the required parameter 'omnimessage' is set
|
90
|
+
if @api_client.config.client_side_validation && omnimessage.nil?
|
91
|
+
fail ArgumentError, "Missing the required parameter 'omnimessage' when calling OmnimessageApi.send_omnimessage"
|
92
|
+
end
|
93
|
+
# resource path
|
94
|
+
local_var_path = '/omnimessage'
|
95
|
+
|
96
|
+
# query parameters
|
97
|
+
query_params = {}
|
98
|
+
|
99
|
+
# header parameters
|
100
|
+
header_params = {}
|
101
|
+
# HTTP header 'Accept' (if needed)
|
102
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
103
|
+
# HTTP header 'Content-Type'
|
104
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
105
|
+
|
106
|
+
# form parameters
|
107
|
+
form_params = {}
|
108
|
+
|
109
|
+
# http body (model)
|
110
|
+
post_body = @api_client.object_to_http_body(omnimessage)
|
111
|
+
auth_names = ['basicAuth']
|
112
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
113
|
+
:header_params => header_params,
|
114
|
+
:query_params => query_params,
|
115
|
+
:form_params => form_params,
|
116
|
+
:body => post_body,
|
117
|
+
:auth_names => auth_names,
|
118
|
+
:return_type => 'OmniMessageCreateSuccessResponse')
|
119
|
+
if @api_client.config.debugging
|
120
|
+
@api_client.config.logger.debug "API called: OmnimessageApi#send_omnimessage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
121
|
+
end
|
122
|
+
return data, status_code, headers
|
123
|
+
end
|
124
|
+
|
125
|
+
end
|
126
|
+
end
|
@@ -0,0 +1,387 @@
|
|
1
|
+
=begin
|
2
|
+
#Omnichannel API
|
3
|
+
|
4
|
+
#Messente's API which allows sending messages via various channels with fallback options.
|
5
|
+
|
6
|
+
OpenAPI spec version: 0.0.2
|
7
|
+
Contact: messente@messente.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.0.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'json'
|
15
|
+
require 'logger'
|
16
|
+
require 'tempfile'
|
17
|
+
require 'typhoeus'
|
18
|
+
require 'uri'
|
19
|
+
|
20
|
+
module Omnichannel
|
21
|
+
class ApiClient
|
22
|
+
# The Configuration object holding settings to be used in the API client.
|
23
|
+
attr_accessor :config
|
24
|
+
|
25
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
26
|
+
#
|
27
|
+
# @return [Hash]
|
28
|
+
attr_accessor :default_headers
|
29
|
+
|
30
|
+
# Initializes the ApiClient
|
31
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
32
|
+
def initialize(config = Configuration.default)
|
33
|
+
@config = config
|
34
|
+
@user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
|
35
|
+
@default_headers = {
|
36
|
+
'Content-Type' => 'application/json',
|
37
|
+
'User-Agent' => @user_agent
|
38
|
+
}
|
39
|
+
end
|
40
|
+
|
41
|
+
def self.default
|
42
|
+
@@default ||= ApiClient.new
|
43
|
+
end
|
44
|
+
|
45
|
+
# Call an API with given options.
|
46
|
+
#
|
47
|
+
# @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
|
48
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
49
|
+
def call_api(http_method, path, opts = {})
|
50
|
+
request = build_request(http_method, path, opts)
|
51
|
+
response = request.run
|
52
|
+
|
53
|
+
if @config.debugging
|
54
|
+
@config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
|
55
|
+
end
|
56
|
+
|
57
|
+
unless response.success?
|
58
|
+
if response.timed_out?
|
59
|
+
fail ApiError.new('Connection timed out')
|
60
|
+
elsif response.code == 0
|
61
|
+
# Errors from libcurl will be made visible here
|
62
|
+
fail ApiError.new(:code => 0,
|
63
|
+
:message => response.return_message)
|
64
|
+
else
|
65
|
+
fail ApiError.new(:code => response.code,
|
66
|
+
:response_headers => response.headers,
|
67
|
+
:response_body => response.body),
|
68
|
+
response.status_message
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
if opts[:return_type]
|
73
|
+
data = deserialize(response, opts[:return_type])
|
74
|
+
else
|
75
|
+
data = nil
|
76
|
+
end
|
77
|
+
return data, response.code, response.headers
|
78
|
+
end
|
79
|
+
|
80
|
+
# Builds the HTTP request
|
81
|
+
#
|
82
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
83
|
+
# @param [String] path URL path (e.g. /account/new)
|
84
|
+
# @option opts [Hash] :header_params Header parameters
|
85
|
+
# @option opts [Hash] :query_params Query parameters
|
86
|
+
# @option opts [Hash] :form_params Query parameters
|
87
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
88
|
+
# @return [Typhoeus::Request] A Typhoeus Request
|
89
|
+
def build_request(http_method, path, opts = {})
|
90
|
+
url = build_request_url(path)
|
91
|
+
http_method = http_method.to_sym.downcase
|
92
|
+
|
93
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
94
|
+
query_params = opts[:query_params] || {}
|
95
|
+
form_params = opts[:form_params] || {}
|
96
|
+
|
97
|
+
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
98
|
+
|
99
|
+
# set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
100
|
+
_verify_ssl_host = @config.verify_ssl_host ? 2 : 0
|
101
|
+
|
102
|
+
req_opts = {
|
103
|
+
:method => http_method,
|
104
|
+
:headers => header_params,
|
105
|
+
:params => query_params,
|
106
|
+
:params_encoding => @config.params_encoding,
|
107
|
+
:timeout => @config.timeout,
|
108
|
+
:ssl_verifypeer => @config.verify_ssl,
|
109
|
+
:ssl_verifyhost => _verify_ssl_host,
|
110
|
+
:sslcert => @config.cert_file,
|
111
|
+
:sslkey => @config.key_file,
|
112
|
+
:verbose => @config.debugging
|
113
|
+
}
|
114
|
+
|
115
|
+
# set custom cert, if provided
|
116
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
117
|
+
|
118
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
119
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
120
|
+
req_opts.update :body => req_body
|
121
|
+
if @config.debugging
|
122
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
123
|
+
end
|
124
|
+
end
|
125
|
+
|
126
|
+
request = Typhoeus::Request.new(url, req_opts)
|
127
|
+
download_file(request) if opts[:return_type] == 'File'
|
128
|
+
request
|
129
|
+
end
|
130
|
+
|
131
|
+
# Check if the given MIME is a JSON MIME.
|
132
|
+
# JSON MIME examples:
|
133
|
+
# application/json
|
134
|
+
# application/json; charset=UTF8
|
135
|
+
# APPLICATION/JSON
|
136
|
+
# */*
|
137
|
+
# @param [String] mime MIME
|
138
|
+
# @return [Boolean] True if the MIME is application/json
|
139
|
+
def json_mime?(mime)
|
140
|
+
(mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
141
|
+
end
|
142
|
+
|
143
|
+
# Deserialize the response to the given return type.
|
144
|
+
#
|
145
|
+
# @param [Response] response HTTP response
|
146
|
+
# @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
|
147
|
+
def deserialize(response, return_type)
|
148
|
+
body = response.body
|
149
|
+
|
150
|
+
# handle file downloading - return the File instance processed in request callbacks
|
151
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
152
|
+
return @tempfile if return_type == 'File'
|
153
|
+
|
154
|
+
return nil if body.nil? || body.empty?
|
155
|
+
|
156
|
+
# return response body directly for String return type
|
157
|
+
return body if return_type == 'String'
|
158
|
+
|
159
|
+
# ensuring a default content type
|
160
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
161
|
+
|
162
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
163
|
+
|
164
|
+
begin
|
165
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
166
|
+
rescue JSON::ParserError => e
|
167
|
+
if %w(String Date DateTime).include?(return_type)
|
168
|
+
data = body
|
169
|
+
else
|
170
|
+
raise e
|
171
|
+
end
|
172
|
+
end
|
173
|
+
|
174
|
+
convert_to_type data, return_type
|
175
|
+
end
|
176
|
+
|
177
|
+
# Convert data to the given return type.
|
178
|
+
# @param [Object] data Data to be converted
|
179
|
+
# @param [String] return_type Return type
|
180
|
+
# @return [Mixed] Data in a particular type
|
181
|
+
def convert_to_type(data, return_type)
|
182
|
+
return nil if data.nil?
|
183
|
+
case return_type
|
184
|
+
when 'String'
|
185
|
+
data.to_s
|
186
|
+
when 'Integer'
|
187
|
+
data.to_i
|
188
|
+
when 'Float'
|
189
|
+
data.to_f
|
190
|
+
when 'BOOLEAN'
|
191
|
+
data == true
|
192
|
+
when 'DateTime'
|
193
|
+
# parse date time (expecting ISO 8601 format)
|
194
|
+
DateTime.parse data
|
195
|
+
when 'Date'
|
196
|
+
# parse date time (expecting ISO 8601 format)
|
197
|
+
Date.parse data
|
198
|
+
when 'Object'
|
199
|
+
# generic object (usually a Hash), return directly
|
200
|
+
data
|
201
|
+
when /\AArray<(.+)>\z/
|
202
|
+
# e.g. Array<Pet>
|
203
|
+
sub_type = $1
|
204
|
+
data.map { |item| convert_to_type(item, sub_type) }
|
205
|
+
when /\AHash\<String, (.+)\>\z/
|
206
|
+
# e.g. Hash<String, Integer>
|
207
|
+
sub_type = $1
|
208
|
+
{}.tap do |hash|
|
209
|
+
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
210
|
+
end
|
211
|
+
else
|
212
|
+
# models, e.g. Pet
|
213
|
+
Omnichannel.const_get(return_type).build_from_hash(data)
|
214
|
+
end
|
215
|
+
end
|
216
|
+
|
217
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
218
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
219
|
+
# The response body is written to the file in chunks in order to handle files which
|
220
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
221
|
+
# process can use.
|
222
|
+
#
|
223
|
+
# @see Configuration#temp_folder_path
|
224
|
+
def download_file(request)
|
225
|
+
tempfile = nil
|
226
|
+
encoding = nil
|
227
|
+
request.on_headers do |response|
|
228
|
+
content_disposition = response.headers['Content-Disposition']
|
229
|
+
if content_disposition && content_disposition =~ /filename=/i
|
230
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
231
|
+
prefix = sanitize_filename(filename)
|
232
|
+
else
|
233
|
+
prefix = 'download-'
|
234
|
+
end
|
235
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
236
|
+
encoding = response.body.encoding
|
237
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
238
|
+
@tempfile = tempfile
|
239
|
+
end
|
240
|
+
request.on_body do |chunk|
|
241
|
+
chunk.force_encoding(encoding)
|
242
|
+
tempfile.write(chunk)
|
243
|
+
end
|
244
|
+
request.on_complete do |response|
|
245
|
+
tempfile.close if tempfile
|
246
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
247
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
248
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
249
|
+
"explicitly with `tempfile.delete`"
|
250
|
+
end
|
251
|
+
end
|
252
|
+
|
253
|
+
# Sanitize filename by removing path.
|
254
|
+
# e.g. ../../sun.gif becomes sun.gif
|
255
|
+
#
|
256
|
+
# @param [String] filename the filename to be sanitized
|
257
|
+
# @return [String] the sanitized filename
|
258
|
+
def sanitize_filename(filename)
|
259
|
+
filename.gsub(/.*[\/\\]/, '')
|
260
|
+
end
|
261
|
+
|
262
|
+
def build_request_url(path)
|
263
|
+
# Add leading and trailing slashes to path
|
264
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
265
|
+
URI.encode(@config.base_url + path)
|
266
|
+
end
|
267
|
+
|
268
|
+
# Builds the HTTP request body
|
269
|
+
#
|
270
|
+
# @param [Hash] header_params Header parameters
|
271
|
+
# @param [Hash] form_params Query parameters
|
272
|
+
# @param [Object] body HTTP body (JSON/XML)
|
273
|
+
# @return [String] HTTP body data in the form of string
|
274
|
+
def build_request_body(header_params, form_params, body)
|
275
|
+
# http form
|
276
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
277
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
278
|
+
data = {}
|
279
|
+
form_params.each do |key, value|
|
280
|
+
case value
|
281
|
+
when ::File, ::Array, nil
|
282
|
+
# let typhoeus handle File, Array and nil parameters
|
283
|
+
data[key] = value
|
284
|
+
else
|
285
|
+
data[key] = value.to_s
|
286
|
+
end
|
287
|
+
end
|
288
|
+
elsif body
|
289
|
+
data = body.is_a?(String) ? body : body.to_json
|
290
|
+
else
|
291
|
+
data = nil
|
292
|
+
end
|
293
|
+
data
|
294
|
+
end
|
295
|
+
|
296
|
+
# Update hearder and query params based on authentication settings.
|
297
|
+
#
|
298
|
+
# @param [Hash] header_params Header parameters
|
299
|
+
# @param [Hash] query_params Query parameters
|
300
|
+
# @param [String] auth_names Authentication scheme name
|
301
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
302
|
+
Array(auth_names).each do |auth_name|
|
303
|
+
auth_setting = @config.auth_settings[auth_name]
|
304
|
+
next unless auth_setting
|
305
|
+
case auth_setting[:in]
|
306
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
307
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
308
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
309
|
+
end
|
310
|
+
end
|
311
|
+
end
|
312
|
+
|
313
|
+
# Sets user agent in HTTP header
|
314
|
+
#
|
315
|
+
# @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
|
316
|
+
def user_agent=(user_agent)
|
317
|
+
@user_agent = user_agent
|
318
|
+
@default_headers['User-Agent'] = @user_agent
|
319
|
+
end
|
320
|
+
|
321
|
+
# Return Accept header based on an array of accepts provided.
|
322
|
+
# @param [Array] accepts array for Accept
|
323
|
+
# @return [String] the Accept header (e.g. application/json)
|
324
|
+
def select_header_accept(accepts)
|
325
|
+
return nil if accepts.nil? || accepts.empty?
|
326
|
+
# use JSON when present, otherwise use all of the provided
|
327
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
328
|
+
json_accept || accepts.join(',')
|
329
|
+
end
|
330
|
+
|
331
|
+
# Return Content-Type header based on an array of content types provided.
|
332
|
+
# @param [Array] content_types array for Content-Type
|
333
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
334
|
+
def select_header_content_type(content_types)
|
335
|
+
# use application/json by default
|
336
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
337
|
+
# use JSON when present, otherwise use the first one
|
338
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
339
|
+
json_content_type || content_types.first
|
340
|
+
end
|
341
|
+
|
342
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
343
|
+
# @param [Object] model object to be converted into JSON string
|
344
|
+
# @return [String] JSON string representation of the object
|
345
|
+
def object_to_http_body(model)
|
346
|
+
return model if model.nil? || model.is_a?(String)
|
347
|
+
local_body = nil
|
348
|
+
if model.is_a?(Array)
|
349
|
+
local_body = model.map { |m| object_to_hash(m) }
|
350
|
+
else
|
351
|
+
local_body = object_to_hash(model)
|
352
|
+
end
|
353
|
+
local_body.to_json
|
354
|
+
end
|
355
|
+
|
356
|
+
# Convert object(non-array) to hash.
|
357
|
+
# @param [Object] obj object to be converted into JSON string
|
358
|
+
# @return [String] JSON string representation of the object
|
359
|
+
def object_to_hash(obj)
|
360
|
+
if obj.respond_to?(:to_hash)
|
361
|
+
obj.to_hash
|
362
|
+
else
|
363
|
+
obj
|
364
|
+
end
|
365
|
+
end
|
366
|
+
|
367
|
+
# Build parameter value according to the given collection format.
|
368
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
369
|
+
def build_collection_param(param, collection_format)
|
370
|
+
case collection_format
|
371
|
+
when :csv
|
372
|
+
param.join(',')
|
373
|
+
when :ssv
|
374
|
+
param.join(' ')
|
375
|
+
when :tsv
|
376
|
+
param.join("\t")
|
377
|
+
when :pipes
|
378
|
+
param.join('|')
|
379
|
+
when :multi
|
380
|
+
# return the array directly as typhoeus will handle it as expected
|
381
|
+
param
|
382
|
+
else
|
383
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
384
|
+
end
|
385
|
+
end
|
386
|
+
end
|
387
|
+
end
|