messente_api 1.4.0 → 2.1.0

data/docs/GroupResponseFields.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Id string in UUID format | 
-**name** | **String** | The name of the group | 
-**created_on** | **String** | When the group was created | [optional] 
-**contacts_count** | **Integer** | The count of contacts in the group | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Id string in UUID format |  |
+| **name** | **String** | The name of the group |  |
+| **created_on** | **String** | When the group was created | [optional] |
+| **contacts_count** | **Integer** | The count of contacts in the group |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::GroupResponseFields.new(id: null,
-                                 name: null,
-                                 created_on: null,
-                                 contacts_count: null)
+instance = MessenteApi::GroupResponseFields.new(
+  id: null,
+  name: null,
+  created_on: null,
+  contacts_count: null
+)
 ```
 
-

data/docs/GroupsApi.md

@@ -2,26 +2,25 @@
 
 All URIs are relative to *https://api.messente.com/v1*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create_group**](GroupsApi.md#create_group) | **POST** /phonebook/groups | Creates a new group with the provided name
-[**delete_group**](GroupsApi.md#delete_group) | **DELETE** /phonebook/groups/{groupId} | Deletes a group
-[**fetch_group**](GroupsApi.md#fetch_group) | **GET** /phonebook/groups/{groupId} | Lists a group
-[**fetch_groups**](GroupsApi.md#fetch_groups) | **GET** /phonebook/groups | Returns all groups
-[**update_group**](GroupsApi.md#update_group) | **PUT** /phonebook/groups/{groupId} | Updates a group with the provided name
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_group**](GroupsApi.md#create_group) | **POST** /phonebook/groups | Creates a new group with the provided name |
+| [**delete_group**](GroupsApi.md#delete_group) | **DELETE** /phonebook/groups/{groupId} | Deletes a group |
+| [**fetch_group**](GroupsApi.md#fetch_group) | **GET** /phonebook/groups/{groupId} | Lists a group |
+| [**fetch_groups**](GroupsApi.md#fetch_groups) | **GET** /phonebook/groups | Returns all groups |
+| [**update_group**](GroupsApi.md#update_group) | **PUT** /phonebook/groups/{groupId} | Updates a group with the provided name |
 
 
 ## create_group
 
-> GroupEnvelope create_group(group_name)
+> <GroupEnvelope> create_group(group_name)
 
 Creates a new group with the provided name
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -31,23 +30,40 @@ MessenteApi.configure do |config|
 end
 
 api_instance = MessenteApi::GroupsApi.new
-group_name = {"name":"Any group name"} # GroupName | 
+group_name = MessenteApi::GroupName.new({name: 'name_example'}) # GroupName | 
 
 begin
-  #Creates a new group with the provided name
+  # 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}"
+  puts "Error when calling GroupsApi->create_group: #{e}"
 end
 ```
 
-### Parameters
+#### Using the create_group_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_name** | [**GroupName**](GroupName.md)|  | 
+> <Array(<GroupEnvelope>, Integer, Hash)> create_group_with_http_info(group_name)
+
+```ruby
+begin
+  # Creates a new group with the provided name
+  data, status_code, headers = api_instance.create_group_with_http_info(group_name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GroupEnvelope>
+rescue MessenteApi::ApiError => e
+  puts "Error when calling GroupsApi->create_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_name** | [**GroupName**](GroupName.md) |  |  |
 
 ### Return type
 
@@ -69,10 +85,10 @@ Name | Type | Description  | Notes
 
 Deletes a group
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -85,19 +101,36 @@ api_instance = MessenteApi::GroupsApi.new
 group_id = '5792a02a-e5c2-422b-a0a0-0ae65d814663' # String | String in UUID format
 
 begin
-  #Deletes a group
+  # Deletes a group
   api_instance.delete_group(group_id)
 rescue MessenteApi::ApiError => e
-  puts "Exception when calling GroupsApi->delete_group: #{e}"
+  puts "Error when calling GroupsApi->delete_group: #{e}"
 end
 ```
 
-### Parameters
+#### Using the delete_group_with_http_info variant
 
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_id** | **String**| String in UUID format | 
+> <Array(nil, Integer, Hash)> delete_group_with_http_info(group_id)
+
+```ruby
+begin
+  # Deletes a group
+  data, status_code, headers = api_instance.delete_group_with_http_info(group_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MessenteApi::ApiError => e
+  puts "Error when calling GroupsApi->delete_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_id** | **String** | String in UUID format |  |
 
 ### Return type
 
@@ -115,14 +148,14 @@ nil (empty response body)
 
 ## fetch_group
 
-> GroupEnvelope fetch_group(group_id)
+> <GroupEnvelope> fetch_group(group_id)
 
 Lists a group
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -135,20 +168,37 @@ api_instance = MessenteApi::GroupsApi.new
 group_id = '5792a02a-e5c2-422b-a0a0-0ae65d814663' # String | String in UUID format
 
 begin
-  #Lists a group
+  # Lists a group
   result = api_instance.fetch_group(group_id)
   p result
 rescue MessenteApi::ApiError => e
-  puts "Exception when calling GroupsApi->fetch_group: #{e}"
+  puts "Error when calling GroupsApi->fetch_group: #{e}"
 end
 ```
 
-### Parameters
+#### Using the fetch_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GroupEnvelope>, Integer, Hash)> fetch_group_with_http_info(group_id)
+
+```ruby
+begin
+  # Lists a group
+  data, status_code, headers = api_instance.fetch_group_with_http_info(group_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GroupEnvelope>
+rescue MessenteApi::ApiError => e
+  puts "Error when calling GroupsApi->fetch_group_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_id** | **String**| String in UUID format | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_id** | **String** | String in UUID format |  |
 
 ### Return type
 
@@ -166,14 +216,14 @@ Name | Type | Description  | Notes
 
 ## fetch_groups
 
-> GroupListEnvelope fetch_groups
+> <GroupListEnvelope> fetch_groups
 
 Returns all groups
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -185,11 +235,29 @@ end
 api_instance = MessenteApi::GroupsApi.new
 
 begin
-  #Returns all groups
+  # Returns all groups
   result = api_instance.fetch_groups
   p result
 rescue MessenteApi::ApiError => e
-  puts "Exception when calling GroupsApi->fetch_groups: #{e}"
+  puts "Error when calling GroupsApi->fetch_groups: #{e}"
+end
+```
+
+#### Using the fetch_groups_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GroupListEnvelope>, Integer, Hash)> fetch_groups_with_http_info
+
+```ruby
+begin
+  # Returns all groups
+  data, status_code, headers = api_instance.fetch_groups_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GroupListEnvelope>
+rescue MessenteApi::ApiError => e
+  puts "Error when calling GroupsApi->fetch_groups_with_http_info: #{e}"
 end
 ```
 
@@ -213,14 +281,14 @@ This endpoint does not need any parameter.
 
 ## update_group
 
-> GroupEnvelope update_group(group_id, group_name)
+> <GroupEnvelope> update_group(group_id, group_name)
 
 Updates a group with the provided name
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -231,24 +299,41 @@ end
 
 api_instance = MessenteApi::GroupsApi.new
 group_id = '5792a02a-e5c2-422b-a0a0-0ae65d814663' # String | String in UUID format
-group_name = {"name":"Any group name"} # GroupName | 
+group_name = MessenteApi::GroupName.new({name: 'name_example'}) # GroupName | 
 
 begin
-  #Updates a group with the provided name
+  # 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}"
+  puts "Error when calling GroupsApi->update_group: #{e}"
 end
 ```
 
-### Parameters
+#### Using the update_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GroupEnvelope>, Integer, Hash)> update_group_with_http_info(group_id, group_name)
+
+```ruby
+begin
+  # Updates a group with the provided name
+  data, status_code, headers = api_instance.update_group_with_http_info(group_id, group_name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GroupEnvelope>
+rescue MessenteApi::ApiError => e
+  puts "Error when calling GroupsApi->update_group_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_id** | **String**| String in UUID format | 
- **group_name** | [**GroupName**](GroupName.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_id** | **String** | String in UUID format |  |
+| **group_name** | [**GroupName**](GroupName.md) |  |  |
 
 ### Return type
 

data/docs/MessageResult.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message_id** | **String** | Unique identifier for the message | 
-**channel** | [**Channel**](Channel.md) |  | 
-**sender** | **String** | Sender that was used for the message | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_id** | **String** | Unique identifier for the message |  |
+| **channel** | [**Channel**](Channel.md) |  |  |
+| **sender** | **String** | Sender that was used for the message |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::MessageResult.new(message_id: null,
-                                 channel: null,
-                                 sender: null)
+instance = MessenteApi::MessageResult.new(
+  message_id: null,
+  channel: null,
+  sender: null
+)
 ```
 
-

data/docs/MobileNetwork.md

@@ -2,24 +2,25 @@
 
 ## 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] 
+| 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
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::MobileNetwork.new(mccmnc: null,
-                                 network_name: null,
-                                 country_name: null,
-                                 country_prefix: null,
-                                 country_code: null)
+instance = MessenteApi::MobileNetwork.new(
+  mccmnc: null,
+  network_name: null,
+  country_name: null,
+  country_prefix: null,
+  country_code: null
+)
 ```
 
-

data/docs/NumberLookupApi.md

@@ -2,22 +2,21 @@
 
 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
-
+| 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)
+> <SyncNumberLookupSuccess> fetch_info(numbers_to_investigate)
 
 Requests info about phone numbers
 
-### 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::NumberLookupApi.new
-numbers_to_investigate = {"numbers":["+37251000000","+37251000001"]} # NumbersToInvestigate | Numbers for lookup
+numbers_to_investigate = MessenteApi::NumbersToInvestigate.new({numbers: ['numbers_example']}) # NumbersToInvestigate | Numbers for lookup
 
 begin
-  #Requests info about phone numbers
+  # 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}"
+  puts "Error when calling NumberLookupApi->fetch_info: #{e}"
 end
 ```
 
-### Parameters
+#### Using the fetch_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<SyncNumberLookupSuccess>, Integer, Hash)> fetch_info_with_http_info(numbers_to_investigate)
+
+```ruby
+begin
+  # Requests info about phone numbers
+  data, status_code, headers = api_instance.fetch_info_with_http_info(numbers_to_investigate)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SyncNumberLookupSuccess>
+rescue MessenteApi::ApiError => e
+  puts "Error when calling NumberLookupApi->fetch_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **numbers_to_investigate** | [**NumbersToInvestigate**](NumbersToInvestigate.md)| Numbers for lookup | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **numbers_to_investigate** | [**NumbersToInvestigate**](NumbersToInvestigate.md) | Numbers for lookup |  |
 
 ### Return type
 

data/docs/NumberToBlacklist.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phone_number** | **String** | Phone number in e.164 format | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | Phone number in e.164 format |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::NumberToBlacklist.new(phone_number: null)
+instance = MessenteApi::NumberToBlacklist.new(
+  phone_number: null
+)
 ```
 
-

data/docs/NumbersToInvestigate.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**numbers** | **Array<String>** | Array of phone numbers | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **numbers** | **Array<String>** | A list of phone numbers. Max 10 numbers per request |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::NumbersToInvestigate.new(numbers: null)
+instance = MessenteApi::NumbersToInvestigate.new(
+  numbers: null
+)
 ```
 
-

data/docs/OmniMessageCreateSuccessResponse.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**messages** | [**Array<MessageResult>**](MessageResult.md) | List of messages that compose the omnimessage | 
-**to** | **String** | Phone number in e.164 format | 
-**omnimessage_id** | **String** | Unique identifier for the omnimessage | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **messages** | [**Array<MessageResult>**](MessageResult.md) | List of messages that compose the omnimessage |  |
+| **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::OmniMessageCreateSuccessResponse.new(messages: null,
-                                 to: null,
-                                 omnimessage_id: null)
+instance = MessenteApi::OmniMessageCreateSuccessResponse.new(
+  messages: null,
+  to: null,
+  omnimessage_id: null
+)
 ```
 
-

data/docs/Omnimessage.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**to** | **String** | Phone number in e.164 format | 
-**messages** | [**Array<OneOfViberSMSWhatsAppTelegram>**](OneOfViberSMSWhatsAppTelegram.md) | An array of messages | 
-**dlr_url** | **String** | URL where the delivery report will be sent | [optional] 
-**text_store** | [**TextStore**](TextStore.md) |  | [optional] 
-**time_to_send** | **DateTime** | Optional parameter for sending messages at some specific time in the future.   Time must be specified in the ISO-8601 format.   If no timezone is specified, then the timezone is assumed to be UTC    Examples:    * Time specified with timezone: 2018-06-22T09:05:07+00:00 Time specified in UTC: 2018-06-22T09:05:07Z   * Time specified without timezone: 2018-06-22T09:05 (equivalent to 2018-06-22T09:05+00:00) | [optional] 
-**priority** | [**Priority**](Priority.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **to** | **String** | Phone number in e.164 format |  |
+| **messages** | [**Array<OmnimessageMessagesInner>**](OmnimessageMessagesInner.md) | An array of messages |  |
+| **dlr_url** | **String** | URL where the delivery report will be sent | [optional] |
+| **text_store** | [**TextStore**](TextStore.md) |  | [optional] |
+| **time_to_send** | **Time** | Optional parameter for sending messages at some specific time in the future.   Time must be specified in the ISO-8601 format.   If no timezone is specified, then the timezone is assumed to be UTC    Examples:    * Time specified with timezone: 2018-06-22T09:05:07+00:00 Time specified in UTC: 2018-06-22T09:05:07Z   * Time specified without timezone: 2018-06-22T09:05 (equivalent to 2018-06-22T09:05+00:00) | [optional] |
+| **priority** | [**Priority**](Priority.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::Omnimessage.new(to: null,
-                                 messages: null,
-                                 dlr_url: null,
-                                 text_store: null,
-                                 time_to_send: null,
-                                 priority: null)
+instance = MessenteApi::Omnimessage.new(
+  to: null,
+  messages: null,
+  dlr_url: null,
+  text_store: null,
+  time_to_send: null,
+  priority: null
+)
 ```
 
-