1.0.3 (#3)

- Fix some URLs where "/phonebook/" was missing
- Improve documentation

Author: Erik Räni

README.md

@@ -1,7 +1,7 @@
 # Messente API Library
 
-- Messente API version: 1.0.1
-- Python package version: 1.0.2
+- Messente API version: 1.0.2
+- Python package version: 1.0.3
 
 [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
 

docs/BlacklistApi.md

@@ -4,16 +4,16 @@ 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
 
 
 # **add_to_blacklist**
 > add_to_blacklist(number_to_blacklist)
 
-Adds a phone number to the blacklist.
+Adds a phone number to the blacklist
 
 ### Example
 
@@ -34,7 +34,7 @@ api_instance = messente_api.BlacklistApi(messente_api.ApiClient(configuration))
 number_to_blacklist = messente_api.NumberToBlacklist() # NumberToBlacklist | Phone number to be blacklisted
 
 try:
-    # Adds a phone number to the blacklist.
+    # Adds a phone number to the blacklist
     api_instance.add_to_blacklist(number_to_blacklist)
 except ApiException as e:
     print("Exception when calling BlacklistApi->add_to_blacklist: %s\n" % e)
@@ -64,7 +64,7 @@ void (empty response body)
 # **delete_from_blacklist**
 > delete_from_blacklist(phone)
 
-Deletes a phone number from the blacklist.
+Deletes a phone number from the blacklist
 
 ### Example
 
@@ -85,7 +85,7 @@ api_instance = messente_api.BlacklistApi(messente_api.ApiClient(configuration))
 phone = 'phone_example' # str | A phone number
 
 try:
-    # Deletes a phone number from the blacklist.
+    # Deletes a phone number from the blacklist
     api_instance.delete_from_blacklist(phone)
 except ApiException as e:
     print("Exception when calling BlacklistApi->delete_from_blacklist: %s\n" % e)
@@ -115,7 +115,7 @@ void (empty response body)
 # **fetch_blacklist**
 > FetchBlacklistSuccess fetch_blacklist()
 
-Returns all blacklisted phone numbers.
+Returns all blacklisted phone numbers
 
 ### Example
 
@@ -135,7 +135,7 @@ configuration.password = 'YOUR_PASSWORD'
 api_instance = messente_api.BlacklistApi(messente_api.ApiClient(configuration))
 
 try:
-    # Returns all blacklisted phone numbers.
+    # Returns all blacklisted phone numbers
     api_response = api_instance.fetch_blacklist()
     pprint(api_response)
 except ApiException as e:
@@ -163,7 +163,7 @@ This endpoint does not need any parameter.
 # **is_blacklisted**
 > is_blacklisted(phone)
 
-Checks if a phone number is blacklisted.
+Checks if a phone number is blacklisted
 
 ### Example
 
@@ -184,7 +184,7 @@ api_instance = messente_api.BlacklistApi(messente_api.ApiClient(configuration))
 phone = 'phone_example' # str | A phone number
 
 try:
-    # Checks if a phone number is blacklisted.
+    # Checks if a phone number is blacklisted
     api_instance.is_blacklisted(phone)
 except ApiException as e:
     print("Exception when calling BlacklistApi->is_blacklisted: %s\n" % e)

docs/ContactFields.md

@@ -4,15 +4,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **phone_number** | **str** | Phone number in e.164 format | 
-**email** | **str** |  | [optional] 
-**first_name** | **str** |  | [optional] 
-**last_name** | **str** |  | [optional] 
-**company** | **str** |  | [optional] 
-**title** | **str** |  | [optional] 
-**custom** | **str** |  | [optional] 
-**custom2** | **str** |  | [optional] 
-**custom3** | **str** |  | [optional] 
-**custom4** | **str** |  | [optional] 
+**email** | **str** | The email of the contact | [optional] 
+**first_name** | **str** | The first name of the contact | [optional] 
+**last_name** | **str** | The last name of the contact | [optional] 
+**company** | **str** | The company of the contact | [optional] 
+**title** | **str** | The title of the contact | [optional] 
+**custom** | **str** | The first custom field | [optional] 
+**custom2** | **str** | The second custom field | [optional] 
+**custom3** | **str** | The third custom field | [optional] 
+**custom4** | **str** | The fourth custom field | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/ContactListEnvelope.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**contacts** | [**list[ContactFields]**](ContactFields.md) |  | [optional] 
+**contacts** | [**list[ContactFields]**](ContactFields.md) | An array of contacts | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/ContactUpdateFields.md

@@ -3,15 +3,15 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **str** |  | [optional] 
-**first_name** | **str** |  | [optional] 
-**last_name** | **str** |  | [optional] 
-**company** | **str** |  | [optional] 
-**title** | **str** |  | [optional] 
-**custom** | **str** |  | [optional] 
-**custom2** | **str** |  | [optional] 
-**custom3** | **str** |  | [optional] 
-**custom4** | **str** |  | [optional] 
+**email** | **str** | The email of the contact | [optional] 
+**first_name** | **str** | The first name of the contact | [optional] 
+**last_name** | **str** | The last name of the contact | [optional] 
+**company** | **str** | The company of the contact | [optional] 
+**title** | **str** | The title of the contact | [optional] 
+**custom** | **str** | The first custom field | [optional] 
+**custom2** | **str** | The second custom field | [optional] 
+**custom3** | **str** | The third custom field | [optional] 
+**custom4** | **str** | The fourth custom field | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)