messente_api 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2382cbe5844da072ebb8b89ace9e7b180530a2c
-  data.tar.gz: 5d6145ffacbb12b431dacae17b32795fe971e23b
+  metadata.gz: e6fd4c57c60b3b5d7f8af3a877103634e18a1e07
+  data.tar.gz: 18f8da6761f778861b8b571bd184b00d7c976b6a
 SHA512:
-  metadata.gz: 26874e6db967293d70260653a99b6ecb95eae67a40b49a9dde6f3b55fe5f00e19ead53ee06381e36ae46504fd608bf740ff0d9c4d29b5da7ad0b74dc9acda7fd
-  data.tar.gz: 892c40ec0bf1d84a65ed3e669d675e6a91a1d5481f65c04a57101d1400285a0e29a4e8c4efeb8c8abf31cbd5ed1f7bd3265758006665c0939af39e10b1afa95e
+  metadata.gz: 4cfc50a7ef1f5242e856ad716e61cb19e2483d1f3967a9cf36f540b2dc7a0303212f9cdc18533c033d2b8ed544e5c3c59474bdb353e480221d99dde7a3199d1f
+  data.tar.gz: 0c2993a67d955e5f4f0e05673a5bcbd99333ccad1baacb3c93ad39c19827bc6956358157a6606ab2b92c6bee51344f743a551ee0a180093c8d721fddf4c76876

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    messente_api (1.0.1)
+    messente_api (1.0.2)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/README.md

@@ -1,7 +1,7 @@
 # Messente API Library
 
-- Messente API version: 1.0.1
-- Ruby gem version: 1.0.1
+- Messente API version: 1.0.2
+- Ruby gem version: 1.0.2
 
 [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.
 
@@ -20,38 +20,38 @@ Messente API Library provides the operations described below to access the featu
 
 ### BlacklistApi
 
-1. Adds a phone number to the blacklist. [`add_to_blacklist`](docs/BlacklistApi.md#add_to_blacklist)
-1. Deletes a phone number from the blacklist. [`delete_from_blacklist`](docs/BlacklistApi.md#delete_from_blacklist)
-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)
+1. Adds a phone number to the blacklist [`add_to_blacklist`](docs/BlacklistApi.md#add_to_blacklist)
+1. Deletes a phone number from the blacklist [`delete_from_blacklist`](docs/BlacklistApi.md#delete_from_blacklist)
+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)
 
 ### ContactsApi
 
-1. Adds a contact to a group. [`add_contact_to_group`](docs/ContactsApi.md#add_contact_to_group)
-1. Creates a new contact. [`create_contact`](docs/ContactsApi.md#create_contact)
-1. Deletes a contact. [`delete_contact`](docs/ContactsApi.md#delete_contact)
-1. Lists a contact. [`fetch_contact`](docs/ContactsApi.md#fetch_contact)
-1. Lists groups of a contact. [`fetch_contact_groups`](docs/ContactsApi.md#fetch_contact_groups)
-1. Returns all contacts. [`fetch_contacts`](docs/ContactsApi.md#fetch_contacts)
-1. Removes a contact from a group. [`remove_contact_from_group`](docs/ContactsApi.md#remove_contact_from_group)
-1. Updates a contact. [`update_contact`](docs/ContactsApi.md#update_contact)
+1. Adds a contact to a group [`add_contact_to_group`](docs/ContactsApi.md#add_contact_to_group)
+1. Creates a new contact [`create_contact`](docs/ContactsApi.md#create_contact)
+1. Deletes a contact [`delete_contact`](docs/ContactsApi.md#delete_contact)
+1. Lists a contact [`fetch_contact`](docs/ContactsApi.md#fetch_contact)
+1. Lists groups of a contact [`fetch_contact_groups`](docs/ContactsApi.md#fetch_contact_groups)
+1. Returns all contacts [`fetch_contacts`](docs/ContactsApi.md#fetch_contacts)
+1. Removes a contact from a group [`remove_contact_from_group`](docs/ContactsApi.md#remove_contact_from_group)
+1. Updates a contact [`update_contact`](docs/ContactsApi.md#update_contact)
 
 ### DeliveryReportApi
 
-1. Retrieves the delivery report for the Omnimessage. [`retrieve_delivery_report`](docs/DeliveryReportApi.md#retrieve_delivery_report)
+1. Retrieves the delivery report for the Omnimessage [`retrieve_delivery_report`](docs/DeliveryReportApi.md#retrieve_delivery_report)
 
 ### GroupsApi
 
-1. Creates a new group with the provided name. [`create_group`](docs/GroupsApi.md#create_group)
-1. Deletes a group. [`delete_group`](docs/GroupsApi.md#delete_group)
-1. Lists a group. [`fetch_group`](docs/GroupsApi.md#fetch_group)
-1. Returns all groups. [`fetch_groups`](docs/GroupsApi.md#fetch_groups)
-1. Updates a group with the provided name. [`update_group`](docs/GroupsApi.md#update_group)
+1. Creates a new group with the provided name [`create_group`](docs/GroupsApi.md#create_group)
+1. Deletes a group [`delete_group`](docs/GroupsApi.md#delete_group)
+1. Lists a group [`fetch_group`](docs/GroupsApi.md#fetch_group)
+1. Returns all groups [`fetch_groups`](docs/GroupsApi.md#fetch_groups)
+1. Updates a group with the provided name [`update_group`](docs/GroupsApi.md#update_group)
 
 ### OmnimessageApi
 
-1. Cancels a scheduled Omnimessage. [`cancel_scheduled_message`](docs/OmnimessageApi.md#cancel_scheduled_message)
-1. Sends an Omnimessage. [`send_omnimessage`](docs/OmnimessageApi.md#send_omnimessage)
+1. Cancels a scheduled Omnimessage [`cancel_scheduled_message`](docs/OmnimessageApi.md#cancel_scheduled_message)
+1. Sends an Omnimessage [`send_omnimessage`](docs/OmnimessageApi.md#send_omnimessage)
 
 ## Auth
 

data/docs/BlacklistApi.md

@@ -4,10 +4,10 @@ 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** /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** /blacklist/{phone} | Checks if a phone number is blacklisted.
+[**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
 
 
 
@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 > add_to_blacklist(number_to_blacklist)
 
-Adds a phone number to the blacklist.
+Adds a phone number to the blacklist
 
 ### Example
 
@@ -33,7 +33,7 @@ api_instance = MessenteApi::BlacklistApi.new
 number_to_blacklist = MessenteApi::NumberToBlacklist.new # 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}"
@@ -65,7 +65,7 @@ nil (empty response body)
 
 > delete_from_blacklist(phone)
 
-Deletes a phone number from the blacklist.
+Deletes a phone number from the blacklist
 
 ### Example
 
@@ -83,7 +83,7 @@ api_instance = MessenteApi::BlacklistApi.new
 phone = 'phone_example' # 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}"
@@ -115,7 +115,7 @@ nil (empty response body)
 
 > FetchBlacklistSuccess fetch_blacklist
 
-Returns all blacklisted phone numbers.
+Returns all blacklisted phone numbers
 
 ### Example
 
@@ -132,7 +132,7 @@ 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
@@ -162,7 +162,7 @@ This endpoint does not need any parameter.
 
 > is_blacklisted(phone)
 
-Checks if a phone number is blacklisted.
+Checks if a phone number is blacklisted
 
 ### Example
 
@@ -180,7 +180,7 @@ api_instance = MessenteApi::BlacklistApi.new
 phone = 'phone_example' # 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}"

data/docs/ContactFields.md

@@ -5,15 +5,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **phone_number** | **String** | Phone number in e.164 format | 
-**email** | **String** |  | [optional] 
-**first_name** | **String** |  | [optional] 
-**last_name** | **String** |  | [optional] 
-**company** | **String** |  | [optional] 
-**title** | **String** |  | [optional] 
-**custom** | **String** |  | [optional] 
-**custom2** | **String** |  | [optional] 
-**custom3** | **String** |  | [optional] 
-**custom4** | **String** |  | [optional] 
+**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
 

data/docs/ContactListEnvelope.md

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

data/docs/ContactUpdateFields.md

@@ -4,15 +4,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **String** |  | [optional] 
-**first_name** | **String** |  | [optional] 
-**last_name** | **String** |  | [optional] 
-**company** | **String** |  | [optional] 
-**title** | **String** |  | [optional] 
-**custom** | **String** |  | [optional] 
-**custom2** | **String** |  | [optional] 
-**custom3** | **String** |  | [optional] 
-**custom4** | **String** |  | [optional] 
+**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
 

data/docs/ContactsApi.md

@@ -4,14 +4,14 @@ All URIs are relative to *https://api.messente.com/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**add_contact_to_group**](ContactsApi.md#add_contact_to_group) | **POST** /groups/{groupId}/contacts/{phone} | Adds a contact to a group.
-[**create_contact**](ContactsApi.md#create_contact) | **POST** /contacts | Creates a new contact.
-[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{phone} | Deletes a contact.
-[**fetch_contact**](ContactsApi.md#fetch_contact) | **GET** /contacts/{phone} | Lists a contact.
-[**fetch_contact_groups**](ContactsApi.md#fetch_contact_groups) | **GET** /contacts/{phone}/groups | Lists groups of a contact.
-[**fetch_contacts**](ContactsApi.md#fetch_contacts) | **GET** /contacts | Returns all contacts.
-[**remove_contact_from_group**](ContactsApi.md#remove_contact_from_group) | **DELETE** /groups/{groupId}/contacts/{phone} | Removes a contact from a group.
-[**update_contact**](ContactsApi.md#update_contact) | **PATCH** /contacts/{phone} | Updates a contact.
+[**add_contact_to_group**](ContactsApi.md#add_contact_to_group) | **POST** /phonebook/groups/{groupId}/contacts/{phone} | Adds a contact to a group
+[**create_contact**](ContactsApi.md#create_contact) | **POST** /phonebook/contacts | Creates a new contact
+[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /phonebook/contacts/{phone} | Deletes a contact
+[**fetch_contact**](ContactsApi.md#fetch_contact) | **GET** /phonebook/contacts/{phone} | Lists a contact
+[**fetch_contact_groups**](ContactsApi.md#fetch_contact_groups) | **GET** /phonebook/contacts/{phone}/groups | Lists groups of a contact
+[**fetch_contacts**](ContactsApi.md#fetch_contacts) | **GET** /phonebook/contacts | Returns all contacts
+[**remove_contact_from_group**](ContactsApi.md#remove_contact_from_group) | **DELETE** /phonebook/groups/{groupId}/contacts/{phone} | Removes a contact from a group
+[**update_contact**](ContactsApi.md#update_contact) | **PATCH** /phonebook/contacts/{phone} | Updates a contact
 
 
 
@@ -19,7 +19,7 @@ Method | HTTP request | Description
 
 > Object add_contact_to_group(group_id, phone)
 
-Adds a contact to a group.
+Adds a contact to a group
 
 ### Example
 
@@ -34,11 +34,11 @@ MessenteApi.configure do |config|
 end
 
 api_instance = MessenteApi::ContactsApi.new
-group_id = 'group_id_example' # String | String in uuid format.
+group_id = 'group_id_example' # String | String in UUID format
 phone = 'phone_example' # String | A phone number
 
 begin
-  #Adds a contact to a group.
+  #Adds a contact to a group
   result = api_instance.add_contact_to_group(group_id, phone)
   p result
 rescue MessenteApi::ApiError => e
@@ -51,7 +51,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **group_id** | **String**| String in uuid format. | 
+ **group_id** | **String**| String in UUID format | 
  **phone** | **String**| A phone number | 
 
 ### Return type
@@ -72,7 +72,7 @@ Name | Type | Description  | Notes
 
 > ContactEnvelope create_contact(contact_fields)
 
-Creates a new contact.
+Creates a new contact
 
 ### Example
 
@@ -90,7 +90,7 @@ api_instance = MessenteApi::ContactsApi.new
 contact_fields = MessenteApi::ContactFields.new # ContactFields | 
 
 begin
-  #Creates a new contact.
+  #Creates a new contact
   result = api_instance.create_contact(contact_fields)
   p result
 rescue MessenteApi::ApiError => e
@@ -123,7 +123,7 @@ Name | Type | Description  | Notes
 
 > delete_contact(phone)
 
-Deletes a contact.
+Deletes a contact
 
 ### Example
 
@@ -141,7 +141,7 @@ api_instance = MessenteApi::ContactsApi.new
 phone = 'phone_example' # String | A phone number
 
 begin
-  #Deletes a contact.
+  #Deletes a contact
   api_instance.delete_contact(phone)
 rescue MessenteApi::ApiError => e
   puts "Exception when calling ContactsApi->delete_contact: #{e}"
@@ -173,7 +173,7 @@ nil (empty response body)
 
 > ContactEnvelope fetch_contact(phone)
 
-Lists a contact.
+Lists a contact
 
 ### Example
 
@@ -191,7 +191,7 @@ api_instance = MessenteApi::ContactsApi.new
 phone = 'phone_example' # String | A phone number
 
 begin
-  #Lists a contact.
+  #Lists a contact
   result = api_instance.fetch_contact(phone)
   p result
 rescue MessenteApi::ApiError => e
@@ -224,7 +224,7 @@ Name | Type | Description  | Notes
 
 > GroupListEnvelope fetch_contact_groups(phone)
 
-Lists groups of a contact.
+Lists groups of a contact
 
 ### Example
 
@@ -242,7 +242,7 @@ api_instance = MessenteApi::ContactsApi.new
 phone = 'phone_example' # String | A phone number
 
 begin
-  #Lists groups of a contact.
+  #Lists groups of a contact
   result = api_instance.fetch_contact_groups(phone)
   p result
 rescue MessenteApi::ApiError => e
@@ -275,7 +275,7 @@ Name | Type | Description  | Notes
 
 > ContactListEnvelope fetch_contacts(opts)
 
-Returns all contacts.
+Returns all contacts
 
 ### Example
 
@@ -291,11 +291,11 @@ end
 
 api_instance = MessenteApi::ContactsApi.new
 opts = {
-  group_ids: ['group_ids_example'] # Array<String> | Optional one or many group id strings in uuid format. For example: \"/contacts?groupIds=group_id_one&groupIds=group_id_two\" 
+  group_ids: ['group_ids_example'] # Array<String> | Optional one or many group id strings in UUID format. For example: \"/contacts?groupIds=group_id_one&groupIds=group_id_two\" 
 }
 
 begin
-  #Returns all contacts.
+  #Returns all contacts
   result = api_instance.fetch_contacts(opts)
   p result
 rescue MessenteApi::ApiError => e
@@ -308,7 +308,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **group_ids** | [**Array&lt;String&gt;**](String.md)| Optional one or many group id strings in uuid format. For example: \&quot;/contacts?groupIds&#x3D;group_id_one&amp;groupIds&#x3D;group_id_two\&quot;  | [optional] 
+ **group_ids** | [**Array&lt;String&gt;**](String.md)| Optional one or many group id strings in UUID format. For example: \&quot;/contacts?groupIds&#x3D;group_id_one&amp;groupIds&#x3D;group_id_two\&quot;  | [optional] 
 
 ### Return type
 
@@ -328,7 +328,7 @@ Name | Type | Description  | Notes
 
 > remove_contact_from_group(group_id, phone)
 
-Removes a contact from a group.
+Removes a contact from a group
 
 ### Example
 
@@ -343,11 +343,11 @@ MessenteApi.configure do |config|
 end
 
 api_instance = MessenteApi::ContactsApi.new
-group_id = 'group_id_example' # String | String in uuid format.
+group_id = 'group_id_example' # String | String in UUID format
 phone = 'phone_example' # String | A phone number
 
 begin
-  #Removes a contact from a group.
+  #Removes a contact from a group
   api_instance.remove_contact_from_group(group_id, phone)
 rescue MessenteApi::ApiError => e
   puts "Exception when calling ContactsApi->remove_contact_from_group: #{e}"
@@ -359,7 +359,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **group_id** | **String**| String in uuid format. | 
+ **group_id** | **String**| String in UUID format | 
  **phone** | **String**| A phone number | 
 
 ### Return type
@@ -380,7 +380,7 @@ nil (empty response body)
 
 > ContactEnvelope update_contact(phone, contact_update_fields)
 
-Updates a contact.
+Updates a contact
 
 ### Example
 
@@ -399,7 +399,7 @@ phone = 'phone_example' # String | A phone number
 contact_update_fields = MessenteApi::ContactUpdateFields.new # ContactUpdateFields | 
 
 begin
-  #Updates a contact.
+  #Updates a contact
   result = api_instance.update_contact(phone, contact_update_fields)
   p result
 rescue MessenteApi::ApiError => e

data/docs/DeliveryReportApi.md

@@ -4,7 +4,7 @@ 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**](DeliveryReportApi.md#retrieve_delivery_report) | **GET** /omnimessage/{omnimessageId}/status | Retrieves the delivery report for the Omnimessage
 
 
 
@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 > DeliveryReportResponse retrieve_delivery_report(omnimessage_id)
 
-Retrieves the delivery report for the Omnimessage.
+Retrieves the delivery report for the Omnimessage
 
 ### Example
 
@@ -27,10 +27,10 @@ MessenteApi.configure do |config|
 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
+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
@@ -43,7 +43,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **omnimessage_id** | [**String**](.md)| UUID of the Omnimessage to for which the delivery report is to be retrieved | 
+ **omnimessage_id** | **String**| UUID of the omnimessage to for which the delivery report is to be retrieved | 
 
 ### Return type
 
@@ -56,5 +56,5 @@ Name | Type | Description  | Notes
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: */*
+- **Accept**: application/json