messente_api 1.3.1 → 2.1.0

data/docs/OmnimessageApi.md

@@ -2,11 +2,10 @@
 
 All URIs are relative to *https://api.messente.com/v1*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**cancel_scheduled_message**](OmnimessageApi.md#cancel_scheduled_message) | **DELETE** /omnimessage/{omnimessageId} | Cancels a scheduled Omnimessage
-[**send_omnimessage**](OmnimessageApi.md#send_omnimessage) | **POST** /omnimessage | Sends an Omnimessage
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cancel_scheduled_message**](OmnimessageApi.md#cancel_scheduled_message) | **DELETE** /omnimessage/{omnimessageId} | Cancels a scheduled Omnimessage |
+| [**send_omnimessage**](OmnimessageApi.md#send_omnimessage) | **POST** /omnimessage | Sends an Omnimessage |
 
 
 ## cancel_scheduled_message
@@ -15,10 +14,10 @@ Method | HTTP request | Description
 
 Cancels a scheduled Omnimessage
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -31,20 +30,37 @@ api_instance = MessenteApi::OmnimessageApi.new
 omnimessage_id = 'omnimessage_id_example' # String | UUID of the scheduled omnimessage to be cancelled
 
 begin
-  #Cancels a scheduled Omnimessage
+  # Cancels a scheduled Omnimessage
   result = api_instance.cancel_scheduled_message(omnimessage_id)
   p result
 rescue MessenteApi::ApiError => e
-  puts "Exception when calling OmnimessageApi->cancel_scheduled_message: #{e}"
+  puts "Error when calling OmnimessageApi->cancel_scheduled_message: #{e}"
 end
 ```
 
-### Parameters
+#### Using the cancel_scheduled_message_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(Object, Integer, Hash)> cancel_scheduled_message_with_http_info(omnimessage_id)
+
+```ruby
+begin
+  # Cancels a scheduled Omnimessage
+  data, status_code, headers = api_instance.cancel_scheduled_message_with_http_info(omnimessage_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MessenteApi::ApiError => e
+  puts "Error when calling OmnimessageApi->cancel_scheduled_message_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **omnimessage_id** | **String**| UUID of the scheduled omnimessage to be cancelled | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **omnimessage_id** | **String** | UUID of the scheduled omnimessage to be cancelled |  |
 
 ### Return type
 
@@ -62,14 +78,14 @@ Name | Type | Description  | Notes
 
 ## send_omnimessage
 
-> OmniMessageCreateSuccessResponse send_omnimessage(omnimessage)
+> <OmniMessageCreateSuccessResponse> send_omnimessage(omnimessage)
 
 Sends an Omnimessage
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -79,23 +95,40 @@ MessenteApi.configure do |config|
 end
 
 api_instance = MessenteApi::OmnimessageApi.new
-omnimessage = MessenteApi::Omnimessage.new # Omnimessage | Omnimessage to be sent
+omnimessage = MessenteApi::Omnimessage.new({to: 'to_example', messages: [MessenteApi::SMS.new({text: 'Hello world!'})]}) # Omnimessage | Omnimessage to be sent
 
 begin
-  #Sends an Omnimessage
+  # Sends an Omnimessage
   result = api_instance.send_omnimessage(omnimessage)
   p result
 rescue MessenteApi::ApiError => e
-  puts "Exception when calling OmnimessageApi->send_omnimessage: #{e}"
+  puts "Error when calling OmnimessageApi->send_omnimessage: #{e}"
 end
 ```
 
-### Parameters
+#### Using the send_omnimessage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OmniMessageCreateSuccessResponse>, Integer, Hash)> send_omnimessage_with_http_info(omnimessage)
+
+```ruby
+begin
+  # Sends an Omnimessage
+  data, status_code, headers = api_instance.send_omnimessage_with_http_info(omnimessage)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OmniMessageCreateSuccessResponse>
+rescue MessenteApi::ApiError => e
+  puts "Error when calling OmnimessageApi->send_omnimessage_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **omnimessage** | [**Omnimessage**](Omnimessage.md)| Omnimessage to be sent | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **omnimessage** | [**Omnimessage**](Omnimessage.md) | Omnimessage to be sent |  |
 
 ### Return type
 

data/docs/OmnimessageMessagesInner.md

@@ -0,0 +1,53 @@
+# MessenteApi::OmnimessageMessagesInner
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'messente_api'
+
+MessenteApi::OmnimessageMessagesInner.openapi_one_of
+# =>
+# [
+#   :'SMS',
+#   :'Telegram',
+#   :'Viber',
+#   :'WhatsApp'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'messente_api'
+
+MessenteApi::OmnimessageMessagesInner.build(data)
+# => #<SMS:0x00007fdd4aab02a0>
+
+MessenteApi::OmnimessageMessagesInner.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SMS`
+- `Telegram`
+- `Viber`
+- `WhatsApp`
+- `nil` (if no type matches)
+

data/docs/PriceInfo.md

@@ -0,0 +1,22 @@
+# MessenteApi::PriceInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **part_price** | **String** | price per message part - relevant mostly for SMS |  |
+| **parts_count** | **Integer** | the number of parts the message consists of |  |
+| **total_price** | **String** | total price for the message |  |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::PriceInfo.new(
+  part_price: null,
+  parts_count: null,
+  total_price: null
+)
+```
+

data/docs/Priority.md

@@ -0,0 +1,15 @@
+# MessenteApi::Priority
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::Priority.new()
+```
+

data/docs/SMS.md

@@ -2,26 +2,29 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**text** | **String** | Text content of the SMS | 
-**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] 
-**autoconvert** | **String** | 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] 
-**udh** | **String** | hex-encoded string containing SMS UDH | [optional] 
-**channel** | **String** | The channel used to deliver the message | [optional] [default to 'sms']
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | Text content of the SMS |  |
+| **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.                     Only one of \"ttl\" and \"validity\" can be used. | [optional] |
+| **ttl** | **Integer** | After how many seconds this channel is considered as failed and the next channel is attempted.                     Only one of \"ttl\" and \"validity\" can be used. | [optional] |
+| **autoconvert** | **String** | 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] |
+| **udh** | **String** | hex-encoded string containing SMS UDH | [optional] |
+| **channel** | **String** | The channel used to deliver the message | [optional][default to 'sms'] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::SMS.new(text: Hello world!,
-                                 sender: null,
-                                 validity: 360,
-                                 autoconvert: null,
-                                 udh: null,
-                                 channel: null)
+instance = MessenteApi::SMS.new(
+  text: Hello world!,
+  sender: null,
+  validity: 360,
+  ttl: 21600,
+  autoconvert: null,
+  udh: null,
+  channel: null
+)
 ```
 
-

data/docs/StatisticsApi.md

@@ -2,22 +2,21 @@
 
 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
-
+| 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)
+> <StatisticsReportSuccess> create_statistics_report(statistics_report_settings)
 
 Requests statistics reports for each country
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -27,23 +26,40 @@ MessenteApi.configure do |config|
 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
+statistics_report_settings = MessenteApi::StatisticsReportSettings.new({start_date: Date.today, end_date: Date.today}) # StatisticsReportSettings | Settings for statistics report
 
 begin
-  #Requests statistics reports for each country
+  # 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}"
+  puts "Error when calling StatisticsApi->create_statistics_report: #{e}"
 end
 ```
 
-### Parameters
+#### Using the create_statistics_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<StatisticsReportSuccess>, Integer, Hash)> create_statistics_report_with_http_info(statistics_report_settings)
+
+```ruby
+begin
+  # Requests statistics reports for each country
+  data, status_code, headers = api_instance.create_statistics_report_with_http_info(statistics_report_settings)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <StatisticsReportSuccess>
+rescue MessenteApi::ApiError => e
+  puts "Error when calling StatisticsApi->create_statistics_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **statistics_report_settings** | [**StatisticsReportSettings**](StatisticsReportSettings.md)| Settings for statistics report | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **statistics_report_settings** | [**StatisticsReportSettings**](StatisticsReportSettings.md) | Settings for statistics report |  |
 
 ### Return type
 

data/docs/StatisticsReport.md

@@ -2,20 +2,21 @@
 
 ## 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 | 
+| 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
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::StatisticsReport.new(total_messages: null,
-                                 total_price: null,
-                                 country: null)
+instance = MessenteApi::StatisticsReport.new(
+  total_messages: null,
+  total_price: null,
+  country: null
+)
 ```
 
-

data/docs/StatisticsReportSettings.md

@@ -2,20 +2,21 @@
 
 ## 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, telegram) | [optional] 
+| 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, telegram) | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::StatisticsReportSettings.new(start_date: null,
-                                 end_date: null,
-                                 message_types: null)
+instance = MessenteApi::StatisticsReportSettings.new(
+  start_date: null,
+  end_date: null,
+  message_types: null
+)
 ```
 
-

data/docs/StatisticsReportSuccess.md

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

data/docs/Status.md

@@ -2,15 +2,14 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
 instance = MessenteApi::Status.new()
 ```
 
-

data/docs/SyncNumberLookupResult.md

@@ -2,32 +2,33 @@
 
 ## 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** | [**AnyType**](.md) | Indicates if any error occurred while handling the request | [optional] 
+| 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
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-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)
+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

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

data/docs/Telegram.md

@@ -2,28 +2,29 @@
 
 ## 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] 
-**text** | **String** | Plaintext content for Telegram | [optional] 
-**image_url** | **String** | URL for the embedded image. Mutually exclusive with \"document_url\" and \"audio_url\" | [optional] 
-**document_url** | **String** | URL for the embedded image. Mutually exclusive with \"audio_url\" and \"image_url\" | [optional] 
-**audio_url** | **String** | URL for the embedded image. Mutually exclusive with \"document_url\" and \"image_url\" | [optional] 
-**channel** | **String** | The channel used to deliver the message | [optional] [default to 'telegram']
+| 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] |
+| **text** | **String** | Plaintext content for Telegram | [optional] |
+| **image_url** | **String** | URL for the embedded image. Mutually exclusive with \"document_url\" and \"audio_url\" | [optional] |
+| **document_url** | **String** | URL for the embedded image. Mutually exclusive with \"audio_url\" and \"image_url\" | [optional] |
+| **audio_url** | **String** | URL for the embedded image. Mutually exclusive with \"document_url\" and \"image_url\" | [optional] |
+| **channel** | **String** | The channel used to deliver the message | [optional][default to 'telegram'] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::Telegram.new(sender: null,
-                                 validity: 360,
-                                 text: null,
-                                 image_url: null,
-                                 document_url: null,
-                                 audio_url: null,
-                                 channel: null)
+instance = MessenteApi::Telegram.new(
+  sender: null,
+  validity: 360,
+  text: null,
+  image_url: null,
+  document_url: null,
+  audio_url: null,
+  channel: null
+)
 ```
 
-

data/docs/TextStore.md

@@ -2,15 +2,14 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
 instance = MessenteApi::TextStore.new()
 ```
 
-