omnichannel 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcb40664af6082c343420b34b6e49529f9281008396b29a093c5bdc7fd2927ef
+  data.tar.gz: f232737461d35cbbf36de4a25613ce26a60883806f07fedd021c36cfe598c185
+SHA512:
+  metadata.gz: 0fe14171d0add910bae2c8a72f29e86d0a95cb21d10ab7a2d16642222bd5a78cfaef8ff657806678b5520da71d2113908b465c6640d21c8b401dc94df7be5b3d
+  data.tar.gz: 0b074b0928c0419c3fdbfa0b4d3426fec6beff41d41bb604a6b19ef04546185aca00108f0d8fc982c9a828bdddff83393783994494945fed385e9dd0fbb9420d

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    omnichannel (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  omnichannel!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,120 @@
+# omnichannel
+
+Omnichannel - the Ruby gem for the Omnichannel API
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build omnichannel.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./omnichannel-1.0.0.gem
+```
+(for development, run `gem install --dev ./omnichannel-1.0.0.gem` to install the development dependencies)
+
+Finally add this to the Gemfile:
+
+    gem 'omnichannel', '~> 1.0.0'
+
+### Install from Git
+
+    gem 'omnichannel', :git => 'https://github.com/messente/messente-omnichannel-ruby.git'
+
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+require 'omnichannel'
+# setup authorization
+Omnichannel.configure do |config|
+    # Configure HTTP basic authorization: basicAuth
+    config.username = '<MESSENTE_API_USERNAME>'
+    config.password = '<MESSENTE_API_PASSWORD>'
+end
+
+api_instance = Omnichannel::OmnimessageApi.new
+omnimessage = Omnichannel::Omnimessage.new
+omnimessage.to = '<phone number in e.164 format>'
+omnimessage.messages = [
+    Omnichannel::SMS.new(
+        {
+            :sender => "<sender name or phone number in e.164 format>",
+            :text => "Hello SMS!"
+        }
+    ),
+    Omnichannel::WhatsApp.new(
+        {
+            :sender => "<sender name or phone number in e.164 format>",
+            :text => Omnichannel::WhatsAppText.new(
+                {
+                    :body => "Hello from WhatsApp!",
+                    :preview_url => false
+                }
+            )
+        }
+    ),
+    Omnichannel::Viber.new(
+        {
+            :sender => "<sender name or phone number in e.164 format>",
+            :text => "Hello from Viber!"
+        }
+    )
+]
+
+begin
+    result = api_instance.send_omnimessage(omnimessage)
+rescue Omnichannel::ApiError => e
+    puts "Exception when calling OmnimessageApi->send_omnimessage: #{e}"
+    puts e.response_body
+end
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.messente.com/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Omnichannel::DeliveryReportApi* | [**retrieve_delivery_report**](docs/DeliveryReportApi.md#retrieve_delivery_report) | **GET** /omnimessage/{omnimessage_id}/status | Retrieves the delivery report for the Omnimessage
+*Omnichannel::OmnimessageApi* | [**cancel_scheduled_message**](docs/OmnimessageApi.md#cancel_scheduled_message) | **DELETE** /omnimessage/{omnimessage_id} | Cancels a scheduled Omnimessage
+*Omnichannel::OmnimessageApi* | [**send_omnimessage**](docs/OmnimessageApi.md#send_omnimessage) | **POST** /omnimessage | Sends an Omnimessage
+
+
+## Documentation for Models
+
+ - [Omnichannel::Channel](docs/Channel.md)
+ - [Omnichannel::DeliveryReportResponse](docs/DeliveryReportResponse.md)
+ - [Omnichannel::DeliveryResult](docs/DeliveryResult.md)
+ - [Omnichannel::Err](docs/Err.md)
+ - [Omnichannel::ErrorItem](docs/ErrorItem.md)
+ - [Omnichannel::ErrorResponse](docs/ErrorResponse.md)
+ - [Omnichannel::MessageResult](docs/MessageResult.md)
+ - [Omnichannel::OmniMessageCreateSuccessResponse](docs/OmniMessageCreateSuccessResponse.md)
+ - [Omnichannel::Omnimessage](docs/Omnimessage.md)
+ - [Omnichannel::ResponseErrorCode](docs/ResponseErrorCode.md)
+ - [Omnichannel::ResponseErrorTitle](docs/ResponseErrorTitle.md)
+ - [Omnichannel::SMS](docs/SMS.md)
+ - [Omnichannel::Status](docs/Status.md)
+ - [Omnichannel::Viber](docs/Viber.md)
+ - [Omnichannel::WhatsApp](docs/WhatsApp.md)
+ - [Omnichannel::WhatsAppAudio](docs/WhatsAppAudio.md)
+ - [Omnichannel::WhatsAppDocument](docs/WhatsAppDocument.md)
+ - [Omnichannel::WhatsAppImage](docs/WhatsAppImage.md)
+ - [Omnichannel::WhatsAppText](docs/WhatsAppText.md)
+
+
+## Documentation for Authorization
+
+
+### basicAuth
+
+- **Type**: HTTP basic authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/config.json

@@ -0,0 +1,12 @@
+{
+
+  "gemAuthor": "Messente",
+  "gemAuthorEmail": "messente@messente.com",
+  "gemSummary": "Ruby library for Messente Omnichannel API",
+  "gemDescription": "This libraries allows sending messages to various channels such as WhatsApp, Viber and SMS with fallback to backup channels in case of failure.",
+  "gemLicense": "Apache 2.0",
+  "gemVersion": "1.0.0",
+  "gemName": "omnichannel",
+  "gitUserId": "messente",
+  "gitRepoId": "messente-omnichannel-ruby"
+}

data/docs/Channel.md

@@ -0,0 +1,7 @@
+# Omnichannel::Channel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/DeliveryReportApi.md

@@ -0,0 +1,58 @@
+# Omnichannel::DeliveryReportApi
+
+All URIs are relative to *https://api.messente.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**retrieve_delivery_report**](DeliveryReportApi.md#retrieve_delivery_report) | **GET** /omnimessage/{omnimessage_id}/status | Retrieves the delivery report for the Omnimessage
+
+
+# **retrieve_delivery_report**
+> DeliveryReportResponse retrieve_delivery_report(omnimessage_id)
+
+Retrieves the delivery report for the Omnimessage
+
+### Example
+```ruby
+# load the gem
+require 'omnichannel'
+# setup authorization
+Omnichannel.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Omnichannel::DeliveryReportApi.new
+omnimessage_id = 'omnimessage_id_example' # String | UUID of the Omnimessage to for which the delivery report is to be retrieved
+
+begin
+  #Retrieves the delivery report for the Omnimessage
+  result = api_instance.retrieve_delivery_report(omnimessage_id)
+  p result
+rescue Omnichannel::ApiError => e
+  puts "Exception when calling DeliveryReportApi->retrieve_delivery_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **omnimessage_id** | [**String**](.md)| UUID of the Omnimessage to for which the delivery report is to be retrieved | 
+
+### Return type
+
+[**DeliveryReportResponse**](DeliveryReportResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/DeliveryReportResponse.md

@@ -0,0 +1,10 @@
+# Omnichannel::DeliveryReportResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statuses** | [**Array<DeliveryResult>**](DeliveryResult.md) | Contains the delivery reports for each channnel, ordered by send order | 
+**to** | **String** | Recipient phone number in e.164 format | 
+**omnimessage_id** | **String** | Unique identifier for the Omnimessage | 
+
+

data/docs/DeliveryResult.md

@@ -0,0 +1,13 @@
+# Omnichannel::DeliveryResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**Status**](Status.md) |  | [optional] 
+**channel** | [**Channel**](Channel.md) |  | [optional] 
+**message_id** | **String** | Unique identifier for the message | [optional] 
+**error** | **String** | Human-readable description of what went wrong, *null* in case of success or if the messages has not been processed yet | [optional] 
+**err** | [**Err**](Err.md) |  | [optional] 
+**timestamp** | **DateTime** | When this status was received by Omnichannel API | [optional] 
+
+

data/docs/Err.md

@@ -0,0 +1,7 @@
+# Omnichannel::Err
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/ErrorItem.md

@@ -0,0 +1,11 @@
+# Omnichannel::ErrorItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | [**ResponseErrorTitle**](ResponseErrorTitle.md) |  | 
+**detail** | **String** | Free form more detailed description of the error. | 
+**code** | [**ResponseErrorCode**](ResponseErrorCode.md) |  | 
+**source** | **String** | Describes which field is causing the issue in the payload, null for non 400 status code responses | 
+
+

data/docs/ErrorResponse.md

@@ -0,0 +1,8 @@
+# Omnichannel::ErrorResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<ErrorItem>**](ErrorItem.md) |  | 
+
+

data/docs/Message.md

@@ -0,0 +1,9 @@
+# Omnichannel::Message
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sender** | **String** | Phone number or alphanumeric sender name | [optional] 
+**validity** | **Integer** | After how many minutes this channel is considered as failed and the next channel is attempted | [optional] 
+
+

data/docs/MessageResult.md

@@ -0,0 +1,10 @@
+# Omnichannel::MessageResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message_id** | **String** | Unique identifier for the message | 
+**channel** | [**Channel**](Channel.md) |  | 
+**sender** | **String** | Sender that was used for the message | 
+
+

data/docs/OmniMessageCreateSuccessResponse.md

@@ -0,0 +1,10 @@
+# Omnichannel::OmniMessageCreateSuccessResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<MessageResult>**](MessageResult.md) | List of messages that compose the Omnimessage | 
+**to** | **String** | Recipient phone number in e.164 format | 
+**omnimessage_id** | **String** | Unique identifier for the Omnimessage | 
+
+

data/docs/Omnimessage.md

@@ -0,0 +1,11 @@
+# Omnichannel::Omnimessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<OneOfViberSMSWhatsApp>**](OneOfViberSMSWhatsApp.md) |  | 
+**to** | **String** | Phone number of the recipient in e.164 format | 
+**dlr_url** | **String** | URL where the delivery report will be sent | [optional] 
+**time_to_send** | **DateTime** | Optional parameter for sending messages at some specific time in the future. Time must be specified in the 8601 format. If no timezone is specified, then the timezone is assumed to be UTC. Examples: Time specified with timezone: 2018-06-22T09:05:07+00:00 Time specified in UTC: 2018-06-22T09:05:07Z Time specified without timezone: 2018-06-22T09:05 (equivalent to 2018-06-22T09:05+00:00)  | [optional] 
+
+

data/docs/OmnimessageApi.md

@@ -0,0 +1,107 @@
+# Omnichannel::OmnimessageApi
+
+All URIs are relative to *https://api.messente.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_scheduled_message**](OmnimessageApi.md#cancel_scheduled_message) | **DELETE** /omnimessage/{omnimessage_id} | Cancels a scheduled Omnimessage
+[**send_omnimessage**](OmnimessageApi.md#send_omnimessage) | **POST** /omnimessage | Sends an Omnimessage
+
+
+# **cancel_scheduled_message**
+> cancel_scheduled_message(omnimessage_id)
+
+Cancels a scheduled Omnimessage
+
+### Example
+```ruby
+# load the gem
+require 'omnichannel'
+# setup authorization
+Omnichannel.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Omnichannel::OmnimessageApi.new
+omnimessage_id = 'omnimessage_id_example' # String | UUID of the scheduled Omnimessage to be cancelled
+
+begin
+  #Cancels a scheduled Omnimessage
+  api_instance.cancel_scheduled_message(omnimessage_id)
+rescue Omnichannel::ApiError => e
+  puts "Exception when calling OmnimessageApi->cancel_scheduled_message: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **omnimessage_id** | [**String**](.md)| UUID of the scheduled Omnimessage to be cancelled | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **send_omnimessage**
+> OmniMessageCreateSuccessResponse send_omnimessage(omnimessage)
+
+Sends an Omnimessage
+
+### Example
+```ruby
+# load the gem
+require 'omnichannel'
+# setup authorization
+Omnichannel.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Omnichannel::OmnimessageApi.new
+omnimessage = Omnichannel::Omnimessage.new # Omnimessage | Omnimessage to be sent
+
+begin
+  #Sends an Omnimessage
+  result = api_instance.send_omnimessage(omnimessage)
+  p result
+rescue Omnichannel::ApiError => e
+  puts "Exception when calling OmnimessageApi->send_omnimessage: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **omnimessage** | [**Omnimessage**](Omnimessage.md)| Omnimessage to be sent | 
+
+### Return type
+
+[**OmniMessageCreateSuccessResponse**](OmniMessageCreateSuccessResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+