messente_api 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2382cbe5844da072ebb8b89ace9e7b180530a2c
+  data.tar.gz: 5d6145ffacbb12b431dacae17b32795fe971e23b
+SHA512:
+  metadata.gz: 26874e6db967293d70260653a99b6ecb95eae67a40b49a9dde6f3b55fe5f00e19ead53ee06381e36ae46504fd608bf740ff0d9c4d29b5da7ad0b74dc9acda7fd
+  data.tar.gz: 892c40ec0bf1d84a65ed3e669d675e6a91a1d5481f65c04a57101d1400285a0e29a4e8c4efeb8c8abf31cbd5ed1f7bd3265758006665c0939af39e10b1afa95e

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    messente_api (1.0.1)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.2)
+    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)
+  messente_api!
+  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,118 @@
+# Messente API Library
+
+- Messente API version: 1.0.1
+- Ruby gem version: 1.0.1
+
+[Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber and WhatsApp messages, blacklist phone numbers to make sure you're not sending any unwanted messages, manage contacts and groups.  Messente builds [tools](https://messente.com/documentation) to help organizations connect their services to people anywhere in the world.
+
+## Installation
+
+Install Messente API library with `gem install messente_api`.
+
+## Features
+
+Messente API has the following features:
+
+- Omnichannel ([external docs](https://messente.com/documentation/omnichannel-api)),
+- Phonebook ([external docs](https://messente.com/documentation/phonebook-api)).
+
+Messente API Library provides the operations described below to access the features.
+
+### BlacklistApi
+
+1. Adds a phone number to the blacklist. [`add_to_blacklist`](docs/BlacklistApi.md#add_to_blacklist)
+1. Deletes a phone number from the blacklist. [`delete_from_blacklist`](docs/BlacklistApi.md#delete_from_blacklist)
+1. Returns all blacklisted phone numbers. [`fetch_blacklist`](docs/BlacklistApi.md#fetch_blacklist)
+1. Checks if a phone number is blacklisted. [`is_blacklisted`](docs/BlacklistApi.md#is_blacklisted)
+
+### ContactsApi
+
+1. Adds a contact to a group. [`add_contact_to_group`](docs/ContactsApi.md#add_contact_to_group)
+1. Creates a new contact. [`create_contact`](docs/ContactsApi.md#create_contact)
+1. Deletes a contact. [`delete_contact`](docs/ContactsApi.md#delete_contact)
+1. Lists a contact. [`fetch_contact`](docs/ContactsApi.md#fetch_contact)
+1. Lists groups of a contact. [`fetch_contact_groups`](docs/ContactsApi.md#fetch_contact_groups)
+1. Returns all contacts. [`fetch_contacts`](docs/ContactsApi.md#fetch_contacts)
+1. Removes a contact from a group. [`remove_contact_from_group`](docs/ContactsApi.md#remove_contact_from_group)
+1. Updates a contact. [`update_contact`](docs/ContactsApi.md#update_contact)
+
+### DeliveryReportApi
+
+1. Retrieves the delivery report for the Omnimessage. [`retrieve_delivery_report`](docs/DeliveryReportApi.md#retrieve_delivery_report)
+
+### GroupsApi
+
+1. Creates a new group with the provided name. [`create_group`](docs/GroupsApi.md#create_group)
+1. Deletes a group. [`delete_group`](docs/GroupsApi.md#delete_group)
+1. Lists a group. [`fetch_group`](docs/GroupsApi.md#fetch_group)
+1. Returns all groups. [`fetch_groups`](docs/GroupsApi.md#fetch_groups)
+1. Updates a group with the provided name. [`update_group`](docs/GroupsApi.md#update_group)
+
+### OmnimessageApi
+
+1. Cancels a scheduled Omnimessage. [`cancel_scheduled_message`](docs/OmnimessageApi.md#cancel_scheduled_message)
+1. Sends an Omnimessage. [`send_omnimessage`](docs/OmnimessageApi.md#send_omnimessage)
+
+## Auth
+
+**Type**: HTTP basic authentication
+
+Read the [external getting-started article](https://messente.com/documentation/getting-started) which explains API keys and Sender ID logic.
+
+## Getting started: sending an omnimessage
+
+```ruby
+require 'messente_api'
+
+# setup authorization
+MessenteApi.configure do |config|
+    # Configure HTTP basic authorization: basicAuth
+    config.username = '<MESSENTE_API_USERNAME>'
+    config.password = '<MESSENTE_API_PASSWORD>'
+end
+
+api_instance = MessenteApi::OmnimessageApi.new
+omnimessage = MessenteApi::Omnimessage.new
+omnimessage.to = '<phone number in e.164 format>'
+omnimessage.messages = [
+    MessenteApi::SMS.new(
+        {
+            :sender => "<sender name or phone number in e.164 format>",
+            :text => "Hello SMS!"
+        }
+    ),
+    MessenteApi::WhatsApp.new(
+        {
+            :sender => "<sender name or phone number in e.164 format>",
+            :text => MessenteApi::WhatsAppText.new(
+                {
+                    :body => "Hello from WhatsApp!",
+                    :preview_url => false
+                }
+            )
+        }
+    ),
+    MessenteApi::Viber.new(
+        {
+            :sender => "<sender name or phone number in e.164 format>",
+            :text => "Hello from Viber!"
+        }
+    )
+]
+
+begin
+    result = api_instance.send_omnimessage(omnimessage)
+rescue MessenteApi::ApiError => e
+    puts "Exception when calling send_omnimessage: #{e}"
+    puts e.response_body
+end
+
+```
+
+## License
+
+[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+## Terms
+
+[https://messente.com/terms-and-conditions](https://messente.com/terms-and-conditions)

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/docs/BlacklistApi.md

@@ -0,0 +1,209 @@
+# MessenteApi::BlacklistApi
+
+All URIs are relative to *https://api.messente.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_to_blacklist**](BlacklistApi.md#add_to_blacklist) | **POST** /phonebook/blacklist | Adds a phone number to the blacklist.
+[**delete_from_blacklist**](BlacklistApi.md#delete_from_blacklist) | **DELETE** /blacklist/{phone} | Deletes a phone number from the blacklist.
+[**fetch_blacklist**](BlacklistApi.md#fetch_blacklist) | **GET** /phonebook/blacklist | Returns all blacklisted phone numbers.
+[**is_blacklisted**](BlacklistApi.md#is_blacklisted) | **GET** /blacklist/{phone} | Checks if a phone number is blacklisted.
+
+
+
+## add_to_blacklist
+
+> add_to_blacklist(number_to_blacklist)
+
+Adds a phone number to the blacklist.
+
+### Example
+
+```ruby
+# load the gem
+require 'messente_api'
+# setup authorization
+MessenteApi.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MessenteApi::BlacklistApi.new
+number_to_blacklist = MessenteApi::NumberToBlacklist.new # NumberToBlacklist | Phone number to be blacklisted
+
+begin
+  #Adds a phone number to the blacklist.
+  api_instance.add_to_blacklist(number_to_blacklist)
+rescue MessenteApi::ApiError => e
+  puts "Exception when calling BlacklistApi->add_to_blacklist: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **number_to_blacklist** | [**NumberToBlacklist**](NumberToBlacklist.md)| Phone number to be blacklisted | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_from_blacklist
+
+> delete_from_blacklist(phone)
+
+Deletes a phone number from the blacklist.
+
+### Example
+
+```ruby
+# load the gem
+require 'messente_api'
+# setup authorization
+MessenteApi.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MessenteApi::BlacklistApi.new
+phone = 'phone_example' # String | A phone number
+
+begin
+  #Deletes a phone number from the blacklist.
+  api_instance.delete_from_blacklist(phone)
+rescue MessenteApi::ApiError => e
+  puts "Exception when calling BlacklistApi->delete_from_blacklist: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **phone** | **String**| A phone number | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## fetch_blacklist
+
+> FetchBlacklistSuccess fetch_blacklist
+
+Returns all blacklisted phone numbers.
+
+### Example
+
+```ruby
+# load the gem
+require 'messente_api'
+# setup authorization
+MessenteApi.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MessenteApi::BlacklistApi.new
+
+begin
+  #Returns all blacklisted phone numbers.
+  result = api_instance.fetch_blacklist
+  p result
+rescue MessenteApi::ApiError => e
+  puts "Exception when calling BlacklistApi->fetch_blacklist: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FetchBlacklistSuccess**](FetchBlacklistSuccess.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## is_blacklisted
+
+> is_blacklisted(phone)
+
+Checks if a phone number is blacklisted.
+
+### Example
+
+```ruby
+# load the gem
+require 'messente_api'
+# setup authorization
+MessenteApi.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MessenteApi::BlacklistApi.new
+phone = 'phone_example' # String | A phone number
+
+begin
+  #Checks if a phone number is blacklisted.
+  api_instance.is_blacklisted(phone)
+rescue MessenteApi::ApiError => e
+  puts "Exception when calling BlacklistApi->is_blacklisted: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **phone** | **String**| A phone number | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Channel.md

@@ -0,0 +1,16 @@
+# MessenteApi::Channel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::Channel.new()
+```
+
+