messente_api 1.4.0 → 2.1.0

data/docs/DeliveryReportApi.md

@@ -2,22 +2,21 @@
 
 All URIs are relative to *https://api.messente.com/v1*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**retrieve_delivery_report**](DeliveryReportApi.md#retrieve_delivery_report) | **GET** /omnimessage/{omnimessageId}/status | Retrieves the delivery report for the Omnimessage
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**retrieve_delivery_report**](DeliveryReportApi.md#retrieve_delivery_report) | **GET** /omnimessage/{omnimessageId}/status | Retrieves the delivery report for the Omnimessage |
 
 
 ## retrieve_delivery_report
 
-> DeliveryReportResponse retrieve_delivery_report(omnimessage_id)
+> <DeliveryReportResponse> retrieve_delivery_report(omnimessage_id)
 
 Retrieves the delivery report for the Omnimessage
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -30,20 +29,37 @@ api_instance = MessenteApi::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
+  # Retrieves the delivery report for the Omnimessage
   result = api_instance.retrieve_delivery_report(omnimessage_id)
   p result
 rescue MessenteApi::ApiError => e
-  puts "Exception when calling DeliveryReportApi->retrieve_delivery_report: #{e}"
+  puts "Error when calling DeliveryReportApi->retrieve_delivery_report: #{e}"
 end
 ```
 
-### Parameters
+#### Using the retrieve_delivery_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<DeliveryReportResponse>, Integer, Hash)> retrieve_delivery_report_with_http_info(omnimessage_id)
+
+```ruby
+begin
+  # Retrieves the delivery report for the Omnimessage
+  data, status_code, headers = api_instance.retrieve_delivery_report_with_http_info(omnimessage_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeliveryReportResponse>
+rescue MessenteApi::ApiError => e
+  puts "Error when calling DeliveryReportApi->retrieve_delivery_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **omnimessage_id** | **String**| UUID of the omnimessage to for which the delivery report is to be retrieved | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **omnimessage_id** | **String** | UUID of the omnimessage to for which the delivery report is to be retrieved |  |
 
 ### Return type
 

data/docs/DeliveryReportResponse.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**statuses** | [**Array<DeliveryResult>**](DeliveryResult.md) | Contains the delivery reports for each channel, ordered by send order | 
-**to** | **String** | Phone number in e.164 format | 
-**omnimessage_id** | **String** | Unique identifier for the omnimessage | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **statuses** | [**Array<DeliveryResult>**](DeliveryResult.md) | Contains the delivery reports for each channel, ordered by send order |  |
+| **to** | **String** | Phone number in e.164 format |  |
+| **omnimessage_id** | **String** | Unique identifier for the omnimessage |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::DeliveryReportResponse.new(statuses: null,
-                                 to: null,
-                                 omnimessage_id: null)
+instance = MessenteApi::DeliveryReportResponse.new(
+  statuses: null,
+  to: null,
+  omnimessage_id: null
+)
 ```
 
-

data/docs/DeliveryResult.md

@@ -2,26 +2,31 @@
 
 ## 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 message has not been processed yet | [optional] 
-**err** | [**ErrorCodeOmnichannelMachine**](ErrorCodeOmnichannelMachine.md) |  | [optional] 
-**timestamp** | **DateTime** | When this status was received by Omnichannel API | [optional] 
+| 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 message has not been processed yet | [optional] |
+| **err** | [**ErrorCodeOmnichannelMachine**](ErrorCodeOmnichannelMachine.md) |  | [optional] |
+| **timestamp** | **Time** | When this status was received by Omnichannel API | [optional] |
+| **price_info** | [**PriceInfo**](PriceInfo.md) |  | [optional] |
+| **sender** | **String** | the sender of the message | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::DeliveryResult.new(status: null,
-                                 channel: null,
-                                 message_id: null,
-                                 error: null,
-                                 err: null,
-                                 timestamp: null)
+instance = MessenteApi::DeliveryResult.new(
+  status: null,
+  channel: null,
+  message_id: null,
+  error: null,
+  err: null,
+  timestamp: null,
+  price_info: null,
+  sender: null
+)
 ```
 
-

data/docs/ErrorCodeOmnichannel.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::ErrorCodeOmnichannel.new()
 ```
 
-

data/docs/ErrorCodeOmnichannelMachine.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::ErrorCodeOmnichannelMachine.new()
 ```
 
-

data/docs/ErrorCodePhonebook.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::ErrorCodePhonebook.new()
 ```
 
-

data/docs/ErrorCodeStatistics.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::ErrorCodeStatistics.new()
 ```
 
-

data/docs/ErrorItemNumberLookup.md

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

data/docs/ErrorItemNumberLookupError.md

@@ -2,18 +2,19 @@
 
 ## 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 | 
+| 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
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::ErrorItemNumberLookupError.new(description: null,
-                                 code: null)
+instance = MessenteApi::ErrorItemNumberLookupError.new(
+  description: null,
+  code: null
+)
 ```
 
-

data/docs/ErrorItemOmnichannel.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | [**ErrorTitleOmnichannel**](ErrorTitleOmnichannel.md) |  | 
-**detail** | **String** | Free form more detailed description of the error | 
-**code** | [**ErrorCodeOmnichannel**](ErrorCodeOmnichannel.md) |  | 
-**source** | **String** | Describes which field is causing the issue in the payload, null for non 400 status code responses | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | [**ErrorTitleOmnichannel**](ErrorTitleOmnichannel.md) |  |  |
+| **detail** | **String** | Free form more detailed description of the error |  |
+| **code** | [**ErrorCodeOmnichannel**](ErrorCodeOmnichannel.md) |  |  |
+| **source** | **String** | Describes which field is causing the issue in the payload, null for non 400 status code responses |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::ErrorItemOmnichannel.new(title: null,
-                                 detail: null,
-                                 code: null,
-                                 source: null)
+instance = MessenteApi::ErrorItemOmnichannel.new(
+  title: null,
+  detail: null,
+  code: null,
+  source: null
+)
 ```
 
-

data/docs/ErrorItemPhonebook.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | [**ErrorTitlePhonebook**](ErrorTitlePhonebook.md) |  | 
-**detail** | **String** | Free form more detailed description of the error | 
-**code** | [**ErrorCodePhonebook**](ErrorCodePhonebook.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | [**ErrorTitlePhonebook**](ErrorTitlePhonebook.md) |  |  |
+| **detail** | **String** | Free form more detailed description of the error |  |
+| **code** | [**ErrorCodePhonebook**](ErrorCodePhonebook.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::ErrorItemPhonebook.new(title: null,
-                                 detail: null,
-                                 code: null)
+instance = MessenteApi::ErrorItemPhonebook.new(
+  title: null,
+  detail: null,
+  code: null
+)
 ```
 
-

data/docs/ErrorItemStatistics.md

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

data/docs/ErrorNumberLookup.md

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

data/docs/ErrorOmnichannel.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**errors** | [**Array<ErrorItemOmnichannel>**](ErrorItemOmnichannel.md) | An array of errors | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array<ErrorItemOmnichannel>**](ErrorItemOmnichannel.md) | An array of errors |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::ErrorOmnichannel.new(errors: null)
+instance = MessenteApi::ErrorOmnichannel.new(
+  errors: null
+)
 ```
 
-

data/docs/ErrorPhonebook.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**errors** | [**Array<ErrorItemPhonebook>**](ErrorItemPhonebook.md) | An array of errors | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array<ErrorItemPhonebook>**](ErrorItemPhonebook.md) | An array of errors |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::ErrorPhonebook.new(errors: null)
+instance = MessenteApi::ErrorPhonebook.new(
+  errors: null
+)
 ```
 
-

data/docs/ErrorStatistics.md

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

data/docs/ErrorTitleOmnichannel.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::ErrorTitleOmnichannel.new()
 ```
 
-

data/docs/ErrorTitlePhonebook.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::ErrorTitlePhonebook.new()
 ```
 
-

data/docs/FetchBlacklistSuccess.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phone_numbers** | **Array<String>** | Array of unique phone numbers | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_numbers** | **Array<String>** | Array of unique phone numbers | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::FetchBlacklistSuccess.new(phone_numbers: null)
+instance = MessenteApi::FetchBlacklistSuccess.new(
+  phone_numbers: null
+)
 ```
 
-

data/docs/GroupEnvelope.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**group** | [**GroupResponseFields**](GroupResponseFields.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group** | [**GroupResponseFields**](GroupResponseFields.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::GroupEnvelope.new(group: null)
+instance = MessenteApi::GroupEnvelope.new(
+  group: null
+)
 ```
 
-

data/docs/GroupListEnvelope.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**groups** | [**Array<GroupResponseFields>**](GroupResponseFields.md) | An array of groups | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **groups** | [**Array<GroupResponseFields>**](GroupResponseFields.md) | An array of groups | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::GroupListEnvelope.new(groups: null)
+instance = MessenteApi::GroupListEnvelope.new(
+  groups: null
+)
 ```
 
-

data/docs/GroupName.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of the group | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the group |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::GroupName.new(name: null)
+instance = MessenteApi::GroupName.new(
+  name: null
+)
 ```
 
-