messente_api 1.0.1 → 1.0.2

data/docs/DeliveryReportResponse.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**statuses** | [**Array<DeliveryResult>**](DeliveryResult.md) | Contains the delivery reports for each channnel, ordered by send order | 
+**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 | 
+**omnimessage_id** | **String** | Unique identifier for the omnimessage | 
 
 ## Code Sample
 

data/docs/DeliveryResult.md

@@ -7,7 +7,7 @@ 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] 
+**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] 
 

data/docs/ErrorItemOmnichannel.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **title** | [**ErrorTitleOmnichannel**](ErrorTitleOmnichannel.md) |  | 
-**detail** | **String** | Free form more detailed description of the error. | 
+**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 | 
 

data/docs/ErrorItemPhonebook.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **title** | [**ErrorTitlePhonebook**](ErrorTitlePhonebook.md) |  | 
-**detail** | **String** | Free form more detailed description of the error. | 
+**detail** | **String** | Free form more detailed description of the error | 
 **code** | [**ErrorCodePhonebook**](ErrorCodePhonebook.md) |  | 
 
 ## Code Sample

data/docs/ErrorOmnichannel.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**errors** | [**Array<ErrorItemOmnichannel>**](ErrorItemOmnichannel.md) |  | 
+**errors** | [**Array<ErrorItemOmnichannel>**](ErrorItemOmnichannel.md) | An array of errors | 
 
 ## Code Sample
 

data/docs/ErrorPhonebook.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**errors** | [**Array<ErrorItemPhonebook>**](ErrorItemPhonebook.md) |  | 
+**errors** | [**Array<ErrorItemPhonebook>**](ErrorItemPhonebook.md) | An array of errors | 
 
 ## Code Sample
 

data/docs/FetchBlacklistSuccess.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**phone_numbers** | **Array<String>** |  | [optional] 
+**phone_numbers** | **Array<String>** | Array of unique phone numbers | [optional] 
 
 ## Code Sample
 

data/docs/GroupListEnvelope.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**groups** | [**Array<GroupResponseFields>**](GroupResponseFields.md) |  | [optional] 
+**groups** | [**Array<GroupResponseFields>**](GroupResponseFields.md) | An array of groups | [optional] 
 
 ## Code Sample
 

data/docs/GroupName.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** |  | 
+**name** | **String** | The name of the group | 
 
 ## Code Sample
 

data/docs/GroupResponseFields.md

@@ -4,10 +4,10 @@
 
 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** |  | 
+**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
 

data/docs/GroupsApi.md

@@ -4,11 +4,11 @@ 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**](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
 
 
 
@@ -16,7 +16,7 @@ Method | HTTP request | Description
 
 > GroupEnvelope create_group(group_name)
 
-Creates a new group with the provided name.
+Creates a new group with the provided name
 
 ### Example
 
@@ -34,7 +34,7 @@ api_instance = MessenteApi::GroupsApi.new
 group_name = MessenteApi::GroupName.new # 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
@@ -67,7 +67,7 @@ Name | Type | Description  | Notes
 
 > delete_group(group_id)
 
-Deletes a group.
+Deletes a group
 
 ### Example
 
@@ -82,10 +82,10 @@ MessenteApi.configure do |config|
 end
 
 api_instance = MessenteApi::GroupsApi.new
-group_id = 'group_id_example' # String | String in uuid format.
+group_id = 'group_id_example' # 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}"
@@ -97,7 +97,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **group_id** | **String**| String in uuid format. | 
+ **group_id** | **String**| String in UUID format | 
 
 ### Return type
 
@@ -117,7 +117,7 @@ nil (empty response body)
 
 > GroupEnvelope fetch_group(group_id)
 
-Lists a group.
+Lists a group
 
 ### Example
 
@@ -132,10 +132,10 @@ MessenteApi.configure do |config|
 end
 
 api_instance = MessenteApi::GroupsApi.new
-group_id = 'group_id_example' # String | String in uuid format.
+group_id = 'group_id_example' # 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
@@ -148,7 +148,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **group_id** | **String**| String in uuid format. | 
+ **group_id** | **String**| String in UUID format | 
 
 ### Return type
 
@@ -168,7 +168,7 @@ Name | Type | Description  | Notes
 
 > GroupListEnvelope fetch_groups
 
-Returns all groups.
+Returns all groups
 
 ### Example
 
@@ -185,7 +185,7 @@ end
 api_instance = MessenteApi::GroupsApi.new
 
 begin
-  #Returns all groups.
+  #Returns all groups
   result = api_instance.fetch_groups
   p result
 rescue MessenteApi::ApiError => e
@@ -215,7 +215,7 @@ This endpoint does not need any parameter.
 
 > GroupEnvelope update_group(group_id, group_name)
 
-Updates a group with the provided name.
+Updates a group with the provided name
 
 ### Example
 
@@ -230,11 +230,11 @@ MessenteApi.configure do |config|
 end
 
 api_instance = MessenteApi::GroupsApi.new
-group_id = 'group_id_example' # String | String in uuid format.
+group_id = 'group_id_example' # String | String in UUID format
 group_name = MessenteApi::GroupName.new # 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
@@ -247,7 +247,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **group_id** | **String**| String in uuid format. | 
+ **group_id** | **String**| String in UUID format | 
  **group_name** | [**GroupName**](GroupName.md)|  | 
 
 ### Return type

data/docs/OmniMessageCreateSuccessResponse.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**messages** | [**Array<MessageResult>**](MessageResult.md) | List of messages that compose the Omnimessage | 
+**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 | 
+**omnimessage_id** | **String** | Unique identifier for the omnimessage | 
 
 ## Code Sample
 

data/docs/Omnimessage.md

@@ -5,10 +5,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **to** | **String** | Phone number in e.164 format | 
-**messages** | [**Array<OneOfViberSMSWhatsApp>**](OneOfViberSMSWhatsApp.md) |  | 
+**messages** | [**Array<OneOfViberSMSWhatsApp>**](OneOfViberSMSWhatsApp.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] 
+**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] 
 
 ## Code Sample
 

data/docs/OmnimessageApi.md

@@ -4,8 +4,8 @@ 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.
+[**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
 
 
 
@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 > cancel_scheduled_message(omnimessage_id)
 
-Cancels a scheduled Omnimessage.
+Cancels a scheduled Omnimessage
 
 ### Example
 
@@ -28,10 +28,10 @@ MessenteApi.configure do |config|
 end
 
 api_instance = MessenteApi::OmnimessageApi.new
-omnimessage_id = 'omnimessage_id_example' # String | UUID of the scheduled Omnimessage to be cancelled
+omnimessage_id = 'omnimessage_id_example' # String | UUID of the scheduled omnimessage to be cancelled
 
 begin
-  #Cancels a scheduled Omnimessage.
+  #Cancels a scheduled Omnimessage
   api_instance.cancel_scheduled_message(omnimessage_id)
 rescue MessenteApi::ApiError => e
   puts "Exception when calling OmnimessageApi->cancel_scheduled_message: #{e}"
@@ -43,7 +43,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **omnimessage_id** | [**String**](.md)| UUID of the scheduled Omnimessage to be cancelled | 
+ **omnimessage_id** | **String**| UUID of the scheduled omnimessage to be cancelled | 
 
 ### Return type
 
@@ -63,7 +63,7 @@ nil (empty response body)
 
 > OmniMessageCreateSuccessResponse send_omnimessage(omnimessage)
 
-Sends an Omnimessage.
+Sends an Omnimessage
 
 ### Example
 
@@ -81,7 +81,7 @@ api_instance = MessenteApi::OmnimessageApi.new
 omnimessage = MessenteApi::Omnimessage.new # Omnimessage | Omnimessage to be sent
 
 begin
-  #Sends an Omnimessage.
+  #Sends an Omnimessage
   result = api_instance.send_omnimessage(omnimessage)
   p result
 rescue MessenteApi::ApiError => e

data/docs/SMS.md

@@ -7,9 +7,9 @@ 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] 
+**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** |  | [optional] [default to 'sms']
+**channel** | **String** | The channel used to deliver the message | [optional] [default to 'sms']
 
 ## Code Sample
 

data/docs/Viber.md

@@ -7,10 +7,10 @@ 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 Viber | [optional] 
-**image_url** | **String** | URL for the embedded image.    Valid combinations:    1) image_url,    2) text, image_url, button_url, button_text | [optional] 
+**image_url** | **String** | URL for the embedded image    Valid combinations:    1) image_url,    2) text, image_url, button_url, button_text | [optional] 
 **button_url** | **String** | URL of the button, must be specified along with ''text'', ''button_text'' and ''image_url'' (optional) | [optional] 
 **button_text** | **String** | Must be specified along with ''text'', ''button_url'', ''button_text'', ''image_url'' (optional) | [optional] 
-**channel** | **String** |  | [optional] [default to 'viber']
+**channel** | **String** | The channel used to deliver the message | [optional] [default to 'viber']
 
 ## Code Sample
 

data/docs/WhatsApp.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **image** | [**WhatsAppImage**](WhatsAppImage.md) |  | [optional] 
 **document** | [**WhatsAppDocument**](WhatsAppDocument.md) |  | [optional] 
 **audio** | [**WhatsAppAudio**](WhatsAppAudio.md) |  | [optional] 
-**channel** | **String** |  | [optional] [default to 'whatsapp']
+**channel** | **String** | The channel used to deliver the message | [optional] [default to 'whatsapp']
 
 ## Code Sample
 

data/docs/WhatsAppText.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**preview_url** | **Boolean** | Whether to display link preview if the message contains a hyperlink. | [optional] [default to true]
+**preview_url** | **Boolean** | Whether to display link preview if the message contains a hyperlink | [optional] [default to true]
 **body** | **String** | Plaintext content for WhatsApp, can contain URLs, emojis and formatting | 
 
 ## Code Sample

data/lib/messente_api.rb

@@ -3,7 +3,7 @@
 
 #[Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber and WhatsApp 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.
 
-The version of the OpenAPI document: 1.0.1
+The version of the OpenAPI document: 1.0.2
 Contact: messente@messente.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.0.0

data/lib/messente_api/api/blacklist_api.rb

@@ -3,7 +3,7 @@
 
 #[Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber and WhatsApp 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.
 
-The version of the OpenAPI document: 1.0.1
+The version of the OpenAPI document: 1.0.2
 Contact: messente@messente.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.0.0
@@ -19,7 +19,7 @@ module MessenteApi
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Adds a phone number to the blacklist.
+    # Adds a phone number to the blacklist
     # @param number_to_blacklist [NumberToBlacklist] Phone number to be blacklisted
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -28,7 +28,7 @@ module MessenteApi
       nil
     end
 
-    # Adds a phone number to the blacklist.
+    # Adds a phone number to the blacklist
     # @param number_to_blacklist [NumberToBlacklist] Phone number to be blacklisted
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -81,7 +81,7 @@ module MessenteApi
       return data, status_code, headers
     end
 
-    # Deletes a phone number from the blacklist.
+    # Deletes a phone number from the blacklist
     # @param phone [String] A phone number
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -90,7 +90,7 @@ module MessenteApi
       nil
     end
 
-    # Deletes a phone number from the blacklist.
+    # Deletes a phone number from the blacklist
     # @param phone [String] A phone number
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -103,7 +103,7 @@ module MessenteApi
         fail ArgumentError, "Missing the required parameter 'phone' when calling BlacklistApi.delete_from_blacklist"
       end
       # resource path
-      local_var_path = '/blacklist/{phone}'.sub('{' + 'phone' + '}', phone.to_s)
+      local_var_path = '/phonebook/blacklist/{phone}'.sub('{' + 'phone' + '}', phone.to_s)
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -141,7 +141,7 @@ module MessenteApi
       return data, status_code, headers
     end
 
-    # Returns all blacklisted phone numbers.
+    # Returns all blacklisted phone numbers
     # @param [Hash] opts the optional parameters
     # @return [FetchBlacklistSuccess]
     def fetch_blacklist(opts = {})
@@ -149,7 +149,7 @@ module MessenteApi
       data
     end
 
-    # Returns all blacklisted phone numbers.
+    # Returns all blacklisted phone numbers
     # @param [Hash] opts the optional parameters
     # @return [Array<(FetchBlacklistSuccess, Integer, Hash)>] FetchBlacklistSuccess data, response status code and response headers
     def fetch_blacklist_with_http_info(opts = {})
@@ -195,7 +195,7 @@ module MessenteApi
       return data, status_code, headers
     end
 
-    # Checks if a phone number is blacklisted.
+    # Checks if a phone number is blacklisted
     # @param phone [String] A phone number
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -204,7 +204,7 @@ module MessenteApi
       nil
     end
 
-    # Checks if a phone number is blacklisted.
+    # Checks if a phone number is blacklisted
     # @param phone [String] A phone number
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -217,7 +217,7 @@ module MessenteApi
         fail ArgumentError, "Missing the required parameter 'phone' when calling BlacklistApi.is_blacklisted"
       end
       # resource path
-      local_var_path = '/blacklist/{phone}'.sub('{' + 'phone' + '}', phone.to_s)
+      local_var_path = '/phonebook/blacklist/{phone}'.sub('{' + 'phone' + '}', phone.to_s)
 
       # query parameters
       query_params = opts[:query_params] || {}