messente_api 1.4.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a42738696eae565729ee2087cc254d3000f442c791af10ef29446eb7a6699a37
-  data.tar.gz: a43474a47328423758c9786e37414073e30a8767ce93a407faf2eb78251dea2d
+  metadata.gz: ee58be9559a61fa1ea3a5574c3251075df0a2c81cfee73d6434d07aa56839356
+  data.tar.gz: ac898a07b96df35563ecd1c66949c9d666b3a3ebb8fefda2ed26543b40b099a3
 SHA512:
-  metadata.gz: e2ec6073025f0b124150cfe9351233d706694fcb5aba588b9daa92d16cc4734378b39bdd6137febf78df673d5b5031518f625d111d09147a52473176759de615
-  data.tar.gz: 0bbd80c32a9273ec7e89af795b6755332370c4ac789857c78f7dd4d50ea52f54e7cf10df63d6bceb362c172b1f6dfa58e85f6fc8c41b94a68d30db33cdb037da
+  metadata.gz: cbf1572d1dd1fe540b8d9547932b9ffb12e4c2486b45ff28c950c8b92c0e2de2a814f901915b3214f2f49af35b7a6e388e80db90ce3b820fac88d61c94398440
+  data.tar.gz: f9b9ed86b9d35d59d9861b4cc39d9e17c36b61a4aef0463e89421cede308da0d048f45d2339d743a2069bfaaaf92ccb6c4687aa80df24e05806a7119dbd00603

data/README.md

@@ -1,7 +1,7 @@
 # Messente API Library
 
-- Messente API version: 1.4.0
-- Ruby gem version: 1.4.0
+- Messente API version: 2.0.0
+- Ruby gem version: 2.2.0
 
 [Messente](https://messente.com) is a global provider of messaging and user verification services.  * Send and receive SMS, Viber, WhatsApp and Telegram messages. * Manage contacts and groups. * Fetch detailed info about phone numbers. * Blacklist phone numbers to make sure you're not sending any unwanted messages.  Messente builds [tools](https://messente.com/documentation) to help organizations connect their services to people anywhere in the world.
 
@@ -25,6 +25,10 @@ Messente API Library provides the operations described below to access the featu
 1. Returns all blacklisted phone numbers [`fetch_blacklist`](docs/BlacklistApi.md#fetch_blacklist)
 1. Checks if a phone number is blacklisted [`is_blacklisted`](docs/BlacklistApi.md#is_blacklisted)
 
+### BulkMessagingApi
+
+1. Sends a bulk Omnimessage [`send_bulk_omnimessage`](docs/BulkMessagingApi.md#send_bulk_omnimessage)
+
 ### ContactsApi
 
 1. Adds a contact to a group [`add_contact_to_group`](docs/ContactsApi.md#add_contact_to_group)
@@ -81,38 +85,37 @@ end
 
 api_instance = MessenteApi::OmnimessageApi.new
 omnimessage = MessenteApi::Omnimessage.new
-omnimessage.to = '<phone number in e.164 format>'
-omnimessage.messages = [
-    MessenteApi::SMS.new(
-        {
-            :sender => "<sender name or phone number in e.164 format>",
-            :text => "Hello SMS!"
-        }
-    ),
-    MessenteApi::WhatsApp.new(
-        {
-            :sender => "<sender name or phone number in e.164 format>",
-            :text => MessenteApi::WhatsAppText.new(
-                {
-                    :body => "Hello from WhatsApp!",
-                    :preview_url => false
-                }
-            )
-        }
-    ),
-    MessenteApi::Viber.new(
-        {
-            :sender => "<sender name or phone number in e.164 format>",
-            :text => "Hello from Viber!"
-        }
-    )
+omnimessage.to = '<recipient_phone_number>'
+
+sms = MessenteApi::SMS.new(
+    sender: "<sender name (optional)>",
+    text: "Hello SMS!"
+)
+
+viber = MessenteApi::Viber.new(
+    sender: "<sender name (optional)>",
+    text: "Hello from Viber!"
+)
+
+wa_parameters = [
+  MessenteApi::WhatsAppParameter.new(type: 'text', text: 'hello whatsapp'),
 ]
+wa_component = MessenteApi::WhatsAppComponent.new(type: 'body', parameters: wa_parameters)
+wa_lang = MessenteApi::WhatsAppLanguage.new(code: '<language_code>')
+wa_template = MessenteApi::WhatsAppTemplate.new(name: '<template_name>', language: wa_lang, components: [wa_component])
+whatsapp = MessenteApi::WhatsApp.new(
+    sender: '<sender name (optional)>',
+    template: wa_template,
+)
+
+omnimessage.messages = [sms, viber, whatsapp]
 
 begin
-    result = api_instance.send_omnimessage(omnimessage)
+  result = api_instance.send_omnimessage(omnimessage)
+  puts result
 rescue MessenteApi::ApiError => e
-    puts "Exception when calling send_omnimessage: #{e}"
-    puts e.response_body
+  puts "Exception when calling send_omnimessage: #{e}"
+  puts e.response_body
 end
 
 ```

data/docs/BlacklistApi.md

@@ -2,13 +2,12 @@
 
 All URIs are relative to *https://api.messente.com/v1*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**add_to_blacklist**](BlacklistApi.md#add_to_blacklist) | **POST** /phonebook/blacklist | Adds a phone number to the blacklist
-[**delete_from_blacklist**](BlacklistApi.md#delete_from_blacklist) | **DELETE** /phonebook/blacklist/{phone} | Deletes a phone number from the blacklist
-[**fetch_blacklist**](BlacklistApi.md#fetch_blacklist) | **GET** /phonebook/blacklist | Returns all blacklisted phone numbers
-[**is_blacklisted**](BlacklistApi.md#is_blacklisted) | **GET** /phonebook/blacklist/{phone} | Checks if a phone number is blacklisted
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_to_blacklist**](BlacklistApi.md#add_to_blacklist) | **POST** /phonebook/blacklist | Adds a phone number to the blacklist |
+| [**delete_from_blacklist**](BlacklistApi.md#delete_from_blacklist) | **DELETE** /phonebook/blacklist/{phone} | Deletes a phone number from the blacklist |
+| [**fetch_blacklist**](BlacklistApi.md#fetch_blacklist) | **GET** /phonebook/blacklist | Returns all blacklisted phone numbers |
+| [**is_blacklisted**](BlacklistApi.md#is_blacklisted) | **GET** /phonebook/blacklist/{phone} | Checks if a phone number is blacklisted |
 
 
 ## add_to_blacklist
@@ -17,10 +16,10 @@ Method | HTTP request | Description
 
 Adds a phone number to the blacklist
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -30,22 +29,39 @@ MessenteApi.configure do |config|
 end
 
 api_instance = MessenteApi::BlacklistApi.new
-number_to_blacklist = {"phoneNumber":"+37251000000"} # NumberToBlacklist | Phone number to be blacklisted
+number_to_blacklist = MessenteApi::NumberToBlacklist.new({phone_number: 'phone_number_example'}) # NumberToBlacklist | Phone number to be blacklisted
 
 begin
-  #Adds a phone number to the blacklist
+  # Adds a phone number to the blacklist
   api_instance.add_to_blacklist(number_to_blacklist)
 rescue MessenteApi::ApiError => e
-  puts "Exception when calling BlacklistApi->add_to_blacklist: #{e}"
+  puts "Error when calling BlacklistApi->add_to_blacklist: #{e}"
 end
 ```
 
-### Parameters
+#### Using the add_to_blacklist_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> add_to_blacklist_with_http_info(number_to_blacklist)
+
+```ruby
+begin
+  # Adds a phone number to the blacklist
+  data, status_code, headers = api_instance.add_to_blacklist_with_http_info(number_to_blacklist)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MessenteApi::ApiError => e
+  puts "Error when calling BlacklistApi->add_to_blacklist_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **number_to_blacklist** | [**NumberToBlacklist**](NumberToBlacklist.md)| Phone number to be blacklisted | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number_to_blacklist** | [**NumberToBlacklist**](NumberToBlacklist.md) | Phone number to be blacklisted |  |
 
 ### Return type
 
@@ -67,10 +83,10 @@ nil (empty response body)
 
 Deletes a phone number from the blacklist
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -83,19 +99,36 @@ api_instance = MessenteApi::BlacklistApi.new
 phone = '+37251000000' # String | A phone number
 
 begin
-  #Deletes a phone number from the blacklist
+  # Deletes a phone number from the blacklist
   api_instance.delete_from_blacklist(phone)
 rescue MessenteApi::ApiError => e
-  puts "Exception when calling BlacklistApi->delete_from_blacklist: #{e}"
+  puts "Error when calling BlacklistApi->delete_from_blacklist: #{e}"
 end
 ```
 
-### Parameters
+#### Using the delete_from_blacklist_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_from_blacklist_with_http_info(phone)
+
+```ruby
+begin
+  # Deletes a phone number from the blacklist
+  data, status_code, headers = api_instance.delete_from_blacklist_with_http_info(phone)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MessenteApi::ApiError => e
+  puts "Error when calling BlacklistApi->delete_from_blacklist_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **phone** | **String**| A phone number | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **String** | A phone number |  |
 
 ### Return type
 
@@ -113,14 +146,14 @@ nil (empty response body)
 
 ## fetch_blacklist
 
-> FetchBlacklistSuccess fetch_blacklist
+> <FetchBlacklistSuccess> fetch_blacklist
 
 Returns all blacklisted phone numbers
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -132,11 +165,29 @@ end
 api_instance = MessenteApi::BlacklistApi.new
 
 begin
-  #Returns all blacklisted phone numbers
+  # Returns all blacklisted phone numbers
   result = api_instance.fetch_blacklist
   p result
 rescue MessenteApi::ApiError => e
-  puts "Exception when calling BlacklistApi->fetch_blacklist: #{e}"
+  puts "Error when calling BlacklistApi->fetch_blacklist: #{e}"
+end
+```
+
+#### Using the fetch_blacklist_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FetchBlacklistSuccess>, Integer, Hash)> fetch_blacklist_with_http_info
+
+```ruby
+begin
+  # Returns all blacklisted phone numbers
+  data, status_code, headers = api_instance.fetch_blacklist_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FetchBlacklistSuccess>
+rescue MessenteApi::ApiError => e
+  puts "Error when calling BlacklistApi->fetch_blacklist_with_http_info: #{e}"
 end
 ```
 
@@ -164,10 +215,10 @@ This endpoint does not need any parameter.
 
 Checks if a phone number is blacklisted
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'messente_api'
 # setup authorization
 MessenteApi.configure do |config|
@@ -180,19 +231,36 @@ api_instance = MessenteApi::BlacklistApi.new
 phone = '+37251000000' # String | A phone number
 
 begin
-  #Checks if a phone number is blacklisted
+  # Checks if a phone number is blacklisted
   api_instance.is_blacklisted(phone)
 rescue MessenteApi::ApiError => e
-  puts "Exception when calling BlacklistApi->is_blacklisted: #{e}"
+  puts "Error when calling BlacklistApi->is_blacklisted: #{e}"
 end
 ```
 
-### Parameters
+#### Using the is_blacklisted_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> is_blacklisted_with_http_info(phone)
+
+```ruby
+begin
+  # Checks if a phone number is blacklisted
+  data, status_code, headers = api_instance.is_blacklisted_with_http_info(phone)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MessenteApi::ApiError => e
+  puts "Error when calling BlacklistApi->is_blacklisted_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **phone** | **String**| A phone number | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **String** | A phone number |  |
 
 ### Return type
 

data/docs/BulkMessagingApi.md

@@ -0,0 +1,76 @@
+# MessenteApi::BulkMessagingApi
+
+All URIs are relative to *https://api.messente.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**send_bulk_omnimessage**](BulkMessagingApi.md#send_bulk_omnimessage) | **POST** /omnimessages | Sends a bulk Omnimessage |
+
+
+## send_bulk_omnimessage
+
+> <BulkOmniMessageCreateSuccessResponse> send_bulk_omnimessage(bulk_omnimessage)
+
+Sends a bulk Omnimessage
+
+### Examples
+
+```ruby
+require 'time'
+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::BulkMessagingApi.new
+bulk_omnimessage = MessenteApi::BulkOmnimessage.new({messages: [MessenteApi::Omnimessage.new({to: 'to_example', messages: [MessenteApi::SMS.new({text: 'Hello world!'})]})]}) # BulkOmnimessage | Bulk Omnimessage to be sent
+
+begin
+  # Sends a bulk Omnimessage
+  result = api_instance.send_bulk_omnimessage(bulk_omnimessage)
+  p result
+rescue MessenteApi::ApiError => e
+  puts "Error when calling BulkMessagingApi->send_bulk_omnimessage: #{e}"
+end
+```
+
+#### Using the send_bulk_omnimessage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BulkOmniMessageCreateSuccessResponse>, Integer, Hash)> send_bulk_omnimessage_with_http_info(bulk_omnimessage)
+
+```ruby
+begin
+  # Sends a bulk Omnimessage
+  data, status_code, headers = api_instance.send_bulk_omnimessage_with_http_info(bulk_omnimessage)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkOmniMessageCreateSuccessResponse>
+rescue MessenteApi::ApiError => e
+  puts "Error when calling BulkMessagingApi->send_bulk_omnimessage_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bulk_omnimessage** | [**BulkOmnimessage**](BulkOmnimessage.md) | Bulk Omnimessage to be sent |  |
+
+### Return type
+
+[**BulkOmniMessageCreateSuccessResponse**](BulkOmniMessageCreateSuccessResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/BulkOmniMessageCreateSuccessResponse.md

@@ -0,0 +1,18 @@
+# MessenteApi::BulkOmniMessageCreateSuccessResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **messages** | [**Array<BulkOmniMessageCreateSuccessResponseMessagesInner>**](BulkOmniMessageCreateSuccessResponseMessagesInner.md) | List of responses for each Omnimessage in the bulk. These can be errors or successful responses |  |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::BulkOmniMessageCreateSuccessResponse.new(
+  messages: null
+)
+```
+

data/docs/BulkOmniMessageCreateSuccessResponseMessagesInner.md

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

data/docs/BulkOmnimessage.md

@@ -0,0 +1,18 @@
+# MessenteApi::BulkOmnimessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **messages** | [**Array<Omnimessage>**](Omnimessage.md) | A list of omnimessages. |  |
+
+## Example
+
+```ruby
+require 'messente_api'
+
+instance = MessenteApi::BulkOmnimessage.new(
+  messages: null
+)
+```
+

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

data/docs/ContactEnvelope.md

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

data/docs/ContactFields.md

@@ -2,34 +2,35 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phone_number** | **String** | Phone number in e.164 format | 
-**email** | **String** | The email of the contact | [optional] 
-**first_name** | **String** | The first name of the contact | [optional] 
-**last_name** | **String** | The last name of the contact | [optional] 
-**company** | **String** | The company of the contact | [optional] 
-**title** | **String** | The title of the contact | [optional] 
-**custom** | **String** | The first custom field | [optional] 
-**custom2** | **String** | The second custom field | [optional] 
-**custom3** | **String** | The third custom field | [optional] 
-**custom4** | **String** | The fourth custom field | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | Phone number in e.164 format |  |
+| **email** | **String** | The email of the contact | [optional] |
+| **first_name** | **String** | The first name of the contact | [optional] |
+| **last_name** | **String** | The last name of the contact | [optional] |
+| **company** | **String** | The company of the contact | [optional] |
+| **title** | **String** | The title of the contact | [optional] |
+| **custom** | **String** | The first custom field | [optional] |
+| **custom2** | **String** | The second custom field | [optional] |
+| **custom3** | **String** | The third custom field | [optional] |
+| **custom4** | **String** | The fourth custom field | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'MessenteApi'
+require 'messente_api'
 
-instance = MessenteApi::ContactFields.new(phone_number: null,
-                                 email: null,
-                                 first_name: null,
-                                 last_name: null,
-                                 company: null,
-                                 title: null,
-                                 custom: null,
-                                 custom2: null,
-                                 custom3: null,
-                                 custom4: null)
+instance = MessenteApi::ContactFields.new(
+  phone_number: null,
+  email: null,
+  first_name: null,
+  last_name: null,
+  company: null,
+  title: null,
+  custom: null,
+  custom2: null,
+  custom3: null,
+  custom4: null
+)
 ```
 
-

data/docs/ContactListEnvelope.md

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