messente_api 1.0.1

data/docs/DeliveryReportApi.md

@@ -0,0 +1,60 @@
+# MessenteApi::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/{omnimessageId}/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 '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::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 MessenteApi::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,21 @@
+# MessenteApi::DeliveryReportResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statuses** | [**Array<DeliveryResult>**](DeliveryResult.md) | Contains the delivery reports for each channnel, ordered by send order | 
+**to** | **String** | Phone number in e.164 format | 
+**omnimessage_id** | **String** | Unique identifier for the Omnimessage | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::DeliveryReportResponse.new(statuses: null,
+                                 to: null,
+                                 omnimessage_id: null)
+```
+
+

data/docs/DeliveryResult.md

@@ -0,0 +1,27 @@
+# MessenteApi::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** | [**ErrorCodeOmnichannelMachine**](ErrorCodeOmnichannelMachine.md) |  | [optional] 
+**timestamp** | **DateTime** | When this status was received by Omnichannel API | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::DeliveryResult.new(status: null,
+                                 channel: null,
+                                 message_id: null,
+                                 error: null,
+                                 err: null,
+                                 timestamp: null)
+```
+
+

data/docs/ErrorCodeOmnichannel.md

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

data/docs/ErrorCodeOmnichannelMachine.md

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

data/docs/ErrorCodePhonebook.md

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

data/docs/ErrorItemOmnichannel.md

@@ -0,0 +1,23 @@
+# MessenteApi::ErrorItemOmnichannel
+
+## 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 | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::ErrorItemOmnichannel.new(title: null,
+                                 detail: null,
+                                 code: null,
+                                 source: null)
+```
+
+

data/docs/ErrorItemPhonebook.md

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

data/docs/ErrorOmnichannel.md

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

data/docs/ErrorPhonebook.md

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

data/docs/ErrorTitleOmnichannel.md

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

data/docs/ErrorTitlePhonebook.md

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

data/docs/FetchBlacklistSuccess.md

@@ -0,0 +1,17 @@
+# MessenteApi::FetchBlacklistSuccess
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone_numbers** | **Array<String>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::FetchBlacklistSuccess.new(phone_numbers: null)
+```
+
+

data/docs/GroupEnvelope.md

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

data/docs/GroupListEnvelope.md

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

data/docs/GroupName.md

@@ -0,0 +1,17 @@
+# MessenteApi::GroupName
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::GroupName.new(name: null)
+```
+
+

data/docs/GroupResponseFields.md

@@ -0,0 +1,23 @@
+# MessenteApi::GroupResponseFields
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Id string in uuid format | 
+**name** | **String** |  | 
+**created_on** | **String** | format %Y-%m-%dT%H:%M:%S.%fZ | [optional] 
+**contacts_count** | **Integer** |  | 
+
+## Code Sample
+
+```ruby
+require 'MessenteApi'
+
+instance = MessenteApi::GroupResponseFields.new(id: null,
+                                 name: null,
+                                 created_on: null,
+                                 contacts_count: null)
+```
+
+

data/docs/GroupsApi.md

@@ -0,0 +1,265 @@
+# MessenteApi::GroupsApi
+
+All URIs are relative to *https://api.messente.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_group**](GroupsApi.md#create_group) | **POST** /groups | Creates a new group with the provided name.
+[**delete_group**](GroupsApi.md#delete_group) | **DELETE** /groups/{groupId} | Deletes a group.
+[**fetch_group**](GroupsApi.md#fetch_group) | **GET** /groups/{groupId} | Lists a group.
+[**fetch_groups**](GroupsApi.md#fetch_groups) | **GET** /groups | Returns all groups.
+[**update_group**](GroupsApi.md#update_group) | **PUT** /groups/{groupId} | Updates a group with the provided name.
+
+
+
+## create_group
+
+> GroupEnvelope create_group(group_name)
+
+Creates a new group with the provided name.
+
+### 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::GroupsApi.new
+group_name = MessenteApi::GroupName.new # GroupName | 
+
+begin
+  #Creates a new group with the provided name.
+  result = api_instance.create_group(group_name)
+  p result
+rescue MessenteApi::ApiError => e
+  puts "Exception when calling GroupsApi->create_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_name** | [**GroupName**](GroupName.md)|  | 
+
+### Return type
+
+[**GroupEnvelope**](GroupEnvelope.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_group
+
+> delete_group(group_id)
+
+Deletes a group.
+
+### 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::GroupsApi.new
+group_id = 'group_id_example' # String | String in uuid format.
+
+begin
+  #Deletes a group.
+  api_instance.delete_group(group_id)
+rescue MessenteApi::ApiError => e
+  puts "Exception when calling GroupsApi->delete_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| String in uuid format. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## fetch_group
+
+> GroupEnvelope fetch_group(group_id)
+
+Lists a group.
+
+### 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::GroupsApi.new
+group_id = 'group_id_example' # String | String in uuid format.
+
+begin
+  #Lists a group.
+  result = api_instance.fetch_group(group_id)
+  p result
+rescue MessenteApi::ApiError => e
+  puts "Exception when calling GroupsApi->fetch_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| String in uuid format. | 
+
+### Return type
+
+[**GroupEnvelope**](GroupEnvelope.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## fetch_groups
+
+> GroupListEnvelope fetch_groups
+
+Returns all groups.
+
+### 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::GroupsApi.new
+
+begin
+  #Returns all groups.
+  result = api_instance.fetch_groups
+  p result
+rescue MessenteApi::ApiError => e
+  puts "Exception when calling GroupsApi->fetch_groups: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GroupListEnvelope**](GroupListEnvelope.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_group
+
+> GroupEnvelope update_group(group_id, group_name)
+
+Updates a group with the provided name.
+
+### 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::GroupsApi.new
+group_id = 'group_id_example' # String | String in uuid format.
+group_name = MessenteApi::GroupName.new # GroupName | 
+
+begin
+  #Updates a group with the provided name.
+  result = api_instance.update_group(group_id, group_name)
+  p result
+rescue MessenteApi::ApiError => e
+  puts "Exception when calling GroupsApi->update_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| String in uuid format. | 
+ **group_name** | [**GroupName**](GroupName.md)|  | 
+
+### Return type
+
+[**GroupEnvelope**](GroupEnvelope.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+