messente_api 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fd882f4b79bd2dc9e804c999e81cf4e3e4366986e97c9b62b1ae113a77ff6a2
-  data.tar.gz: e37894538a46765feb464b5e733ea9ac78f25383cfd1c0e70073b2d14ccc9ee2
+  metadata.gz: bd77dcfab20d6927ba0bff6a8aa7a2d85aecc73742fdf09093b3063fcabb148d
+  data.tar.gz: cd516da741e8f78eba6c71712a80750051c1690056f603700652ace4631d443a
 SHA512:
-  metadata.gz: c2e2be95c7bfe17c31fed3cd534922c6242f76b7ba53211ffa44a748fbf36994c8b9ca4815ef288294f337ce4e663a94cbd2684cd4877a4a776962a7c6cbbd93
-  data.tar.gz: 7d9b9c02efa09817dd0f5fa8b5fb25338a63fbbf9918c37c8dc76a93e2d964b7fe0bf34e8779c22e696c6a791c5bedc3d02ff51bed61efb34b4f3bd3f0ee191d
+  metadata.gz: 255085afc92ce6ca1966ba37a5da37006df87247fd06c6b16a26d5041628a10594942f19fdd9ee68ba94b3a1f38d22248851633ecc1d12d89d35916a4945af2f
+  data.tar.gz: 026e3b7091708def43b19321fb4d53d81e8318d6fba4d55a77ad9c65a8e12273c724dbbd287244fb3c159d13f69e639e226c20ab498994e8fc479c5d4ad9391a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    messente_api (1.1.0)
+    messente_api (1.2.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/README.md

@@ -1,9 +1,9 @@
 # Messente API Library
 
-- Messente API version: 1.1.0
-- Ruby gem version: 1.1.0
+- Messente API version: 1.2.0
+- Ruby gem version: 1.2.0
 
-[Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber, WhatsApp and Telegram 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.
+[Messente](https://messente.com) is a global provider of messaging and user verification services.  * Send and receive SMS, Viber, WhatsApp and Telegram messages. * Manage contacts and groups. * Fetch detailed info about phone numbers. * Blacklist phone numbers to make sure you're not sending any unwanted messages.  Messente builds [tools](https://messente.com/documentation) to help organizations connect their services to people anywhere in the world.
 
 ## Installation
 
@@ -48,11 +48,19 @@ Messente API Library provides the operations described below to access the featu
 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)
 
+### NumberLookupApi
+
+1. Requests info about phone numbers [`fetch_info`](docs/NumberLookupApi.md#fetch_info)
+
 ### 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)
 
+### StatisticsApi
+
+1. Requests statistics reports for each country [`create_statistics_report`](docs/StatisticsApi.md#create_statistics_report)
+
 ## Auth
 
 **Type**: HTTP basic authentication

data/docs/ErrorCodeStatistics.md

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

data/docs/ErrorItemNumberLookup.md

@@ -0,0 +1,17 @@
+# MessenteApi::ErrorItemNumberLookup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**ErrorItemNumberLookupError**](ErrorItemNumberLookupError.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::ErrorItemNumberLookup.new(error: null)
+```
+
+

data/docs/ErrorItemNumberLookupError.md

@@ -0,0 +1,19 @@
+# MessenteApi::ErrorItemNumberLookupError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Error description | 
+**code** | **Integer** | Matches the following error title.   This field is a constant  * 101 - Unauthorized * 102 - Invalid arguments or parameters * 103 - Server error * 104 - Crediting error #1 * 105 - Crediting error #2 * 106 - Client error | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::ErrorItemNumberLookupError.new(description: null,
+                                 code: null)
+```
+
+

data/docs/ErrorItemStatistics.md

@@ -0,0 +1,21 @@
+# MessenteApi::ErrorItemStatistics
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Error title | 
+**details** | **String** | Error details | 
+**code** | [**ErrorCodeStatistics**](ErrorCodeStatistics.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::ErrorItemStatistics.new(title: null,
+                                 details: null,
+                                 code: null)
+```
+
+

data/docs/ErrorNumberLookup.md

@@ -0,0 +1,17 @@
+# MessenteApi::ErrorNumberLookup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<ErrorItemNumberLookup>**](ErrorItemNumberLookup.md) | An array of errors | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::ErrorNumberLookup.new(errors: null)
+```
+
+

data/docs/ErrorStatistics.md

@@ -0,0 +1,17 @@
+# MessenteApi::ErrorStatistics
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<ErrorItemStatistics>**](ErrorItemStatistics.md) | An array of errors | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::ErrorStatistics.new(errors: null)
+```
+
+

data/docs/MobileNetwork.md

@@ -0,0 +1,25 @@
+# MessenteApi::MobileNetwork
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mccmnc** | **String** | Mobile country and mobile network code | [optional] 
+**network_name** | **String** | Mobile network name | [optional] 
+**country_name** | **String** | Country name | [optional] 
+**country_prefix** | **String** | Country prefix | [optional] 
+**country_code** | **String** | Country code | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::MobileNetwork.new(mccmnc: null,
+                                 network_name: null,
+                                 country_name: null,
+                                 country_prefix: null,
+                                 country_code: null)
+```
+
+

data/docs/NumberLookupApi.md

@@ -0,0 +1,60 @@
+# MessenteApi::NumberLookupApi
+
+All URIs are relative to *https://api.messente.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**fetch_info**](NumberLookupApi.md#fetch_info) | **POST** /hlr/sync | Requests info about phone numbers
+
+
+
+## fetch_info
+
+> SyncNumberLookupSuccess fetch_info(numbers_to_investigate)
+
+Requests info about 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::NumberLookupApi.new
+numbers_to_investigate = {"numbers":["+37251000000","+37251000001"]} # NumbersToInvestigate | Numbers for lookup
+
+begin
+  #Requests info about phone numbers
+  result = api_instance.fetch_info(numbers_to_investigate)
+  p result
+rescue MessenteApi::ApiError => e
+  puts "Exception when calling NumberLookupApi->fetch_info: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **numbers_to_investigate** | [**NumbersToInvestigate**](NumbersToInvestigate.md)| Numbers for lookup | 
+
+### Return type
+
+[**SyncNumberLookupSuccess**](SyncNumberLookupSuccess.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/NumbersToInvestigate.md

@@ -0,0 +1,17 @@
+# MessenteApi::NumbersToInvestigate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**numbers** | **Array<String>** | Array of phone numbers | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::NumbersToInvestigate.new(numbers: null)
+```
+
+

data/docs/StatisticsApi.md

@@ -0,0 +1,60 @@
+# MessenteApi::StatisticsApi
+
+All URIs are relative to *https://api.messente.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_statistics_report**](StatisticsApi.md#create_statistics_report) | **POST** /statistics/reports | Requests statistics reports for each country
+
+
+
+## create_statistics_report
+
+> StatisticsReportSuccess create_statistics_report(statistics_report_settings)
+
+Requests statistics reports for each country
+
+### 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::StatisticsApi.new
+statistics_report_settings = {"start_date":"2017-01-01","end_date":"2019-06-20","message_types":["sms"]} # StatisticsReportSettings | Settings for statistics report
+
+begin
+  #Requests statistics reports for each country
+  result = api_instance.create_statistics_report(statistics_report_settings)
+  p result
+rescue MessenteApi::ApiError => e
+  puts "Exception when calling StatisticsApi->create_statistics_report: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **statistics_report_settings** | [**StatisticsReportSettings**](StatisticsReportSettings.md)| Settings for statistics report | 
+
+### Return type
+
+[**StatisticsReportSuccess**](StatisticsReportSuccess.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/StatisticsReport.md

@@ -0,0 +1,21 @@
+# MessenteApi::StatisticsReport
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_messages** | **Integer** | Sum of all messages | 
+**total_price** | **String** | Price for all messages | 
+**country** | **String** | Target country of all messages | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::StatisticsReport.new(total_messages: null,
+                                 total_price: null,
+                                 country: null)
+```
+
+

data/docs/StatisticsReportSettings.md

@@ -0,0 +1,21 @@
+# MessenteApi::StatisticsReportSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_date** | **Date** | Start date for the report | 
+**end_date** | **Date** | End date for the report | 
+**message_types** | **Array<String>** | Optional list of message types (sms, viber, whatsapp, hlr) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::StatisticsReportSettings.new(start_date: null,
+                                 end_date: null,
+                                 message_types: null)
+```
+
+

data/docs/StatisticsReportSuccess.md

@@ -0,0 +1,17 @@
+# MessenteApi::StatisticsReportSuccess
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reports** | [**Array<StatisticsReport>**](StatisticsReport.md) | Array of report objects | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::StatisticsReportSuccess.new(reports: null)
+```
+
+

data/docs/SyncNumberLookupResult.md

@@ -0,0 +1,33 @@
+# MessenteApi::SyncNumberLookupResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number** | **String** | Phone number in e.164 format | 
+**roaming** | **Boolean** | Indicates if a number is roaming | [optional] 
+**ported** | **Boolean** | Indicates if a number is ported | [optional] 
+**roaming_network** | [**MobileNetwork**](MobileNetwork.md) |  | [optional] 
+**current_network** | [**MobileNetwork**](MobileNetwork.md) |  | [optional] 
+**original_network** | [**MobileNetwork**](MobileNetwork.md) |  | [optional] 
+**ported_network** | [**MobileNetwork**](MobileNetwork.md) |  | [optional] 
+**status** | **String** | Status of the phone number | [optional] 
+**error** | **Object** | Indicates if any error occurred while handling the request | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::SyncNumberLookupResult.new(number: null,
+                                 roaming: null,
+                                 ported: null,
+                                 roaming_network: null,
+                                 current_network: null,
+                                 original_network: null,
+                                 ported_network: null,
+                                 status: null,
+                                 error: null)
+```
+
+

data/docs/SyncNumberLookupSuccess.md

@@ -0,0 +1,19 @@
+# MessenteApi::SyncNumberLookupSuccess
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_id** | **String** | ID of the request | 
+**result** | [**Array<SyncNumberLookupResult>**](SyncNumberLookupResult.md) | A container for phone number info objects | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::SyncNumberLookupSuccess.new(request_id: null,
+                                 result: null)
+```
+
+