Release Candidate 1.0.4

.openapi-generator/VERSION

@@ -1 +1 @@
-4.0.0
+4.0.3

README.md

@@ -1,7 +1,7 @@
 # Messente API Library
 
 - Messente API version: 1.0.2
-- Python package version: 1.0.3
+- Python package version: 1.0.4
 
 [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.
 
@@ -124,7 +124,7 @@ except ApiException as exception:
 
 ## License
 
-[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
+[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
 
 ## Terms
 

docs/BlacklistApi.md

@@ -29,9 +29,11 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.BlacklistApi(messente_api.ApiClient(configuration))
-number_to_blacklist = messente_api.NumberToBlacklist() # NumberToBlacklist | Phone number to be blacklisted
+number_to_blacklist = {"phoneNumber":"+37251000000"} # NumberToBlacklist | Phone number to be blacklisted
 
 try:
     # Adds a phone number to the blacklist
@@ -59,6 +61,15 @@ void (empty response body)
  - **Content-Type**: application/json
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Phone number added to the blacklist |  -  |
+**400** | Invalid phone number provided |  -  |
+**401** | Unauthorized |  -  |
+**409** | Phone number already blacklisted |  -  |
+**0** | General error |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **delete_from_blacklist**
@@ -80,9 +91,11 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.BlacklistApi(messente_api.ApiClient(configuration))
-phone = 'phone_example' # str | A phone number
+phone = '+37251000000' # str | A phone number
 
 try:
     # Deletes a phone number from the blacklist
@@ -110,6 +123,15 @@ void (empty response body)
  - **Content-Type**: Not defined
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Phone number deleted from the blacklist |  -  |
+**400** | Invalid phone number provided |  -  |
+**401** | Unauthorized |  -  |
+**404** | Phone number is not in the blacklist |  -  |
+**0** | General error |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **fetch_blacklist**
@@ -131,7 +153,9 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.BlacklistApi(messente_api.ApiClient(configuration))
 
 try:
@@ -158,6 +182,13 @@ This endpoint does not need any parameter.
  - **Content-Type**: Not defined
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | An object containing a list of blacklisted phone numbers |  -  |
+**401** | Unauthorized |  -  |
+**0** | General error |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **is_blacklisted**
@@ -179,9 +210,11 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.BlacklistApi(messente_api.ApiClient(configuration))
-phone = 'phone_example' # str | A phone number
+phone = '+37251000000' # str | A phone number
 
 try:
     # Checks if a phone number is blacklisted
@@ -209,5 +242,13 @@ void (empty response body)
  - **Content-Type**: Not defined
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Phone number is in the blacklist |  -  |
+**400** | Invalid phone number provided |  -  |
+**401** | Unauthorized |  -  |
+**404** | Phone number is not in the blacklist |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 

docs/ContactsApi.md

@@ -33,10 +33,12 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.ContactsApi(messente_api.ApiClient(configuration))
-group_id = 'group_id_example' # str | String in UUID format
-phone = 'phone_example' # str | A phone number
+group_id = '5792a02a-e5c2-422b-a0a0-0ae65d814663' # str | String in UUID format
+phone = '+37251000000' # str | A phone number
 
 try:
     # Adds a contact to a group
@@ -66,6 +68,16 @@ Name | Type | Description  | Notes
  - **Content-Type**: Not defined
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | An empty object |  -  |
+**400** | Invalid phone number provided |  -  |
+**401** | Unauthorized |  -  |
+**404** | Contact or group is missing |  -  |
+**409** | Contact already added to group |  -  |
+**0** | General error |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **create_contact**
@@ -87,9 +99,11 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.ContactsApi(messente_api.ApiClient(configuration))
-contact_fields = messente_api.ContactFields() # ContactFields | 
+contact_fields = {"phoneNumber":"+37251000000","email":"anyone@messente.com","firstName":"Any","lastName":"One","company":"Messente","title":"Sir","custom":"Any custom","custom2":"Any custom two","custom3":"Any custom three","custom4":"Any custom four"} # ContactFields | 
 
 try:
     # Creates a new contact
@@ -118,6 +132,15 @@ Name | Type | Description  | Notes
  - **Content-Type**: application/json
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | An object containing a contact object |  -  |
+**400** | Invalid phone number provided |  -  |
+**401** | Unauthorized |  -  |
+**409** | Contact with phone already created |  -  |
+**0** | General error |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **delete_contact**
@@ -139,9 +162,11 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.ContactsApi(messente_api.ApiClient(configuration))
-phone = 'phone_example' # str | A phone number
+phone = '+37251000000' # str | A phone number
 
 try:
     # Deletes a contact
@@ -169,6 +194,15 @@ void (empty response body)
  - **Content-Type**: Not defined
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Contact deleted |  -  |
+**400** | Invalid phone number provided |  -  |
+**401** | Unauthorized |  -  |
+**404** | Contact missing |  -  |
+**0** | General error |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **fetch_contact**
@@ -190,9 +224,11 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.ContactsApi(messente_api.ApiClient(configuration))
-phone = 'phone_example' # str | A phone number
+phone = '+37251000000' # str | A phone number
 
 try:
     # Lists a contact
@@ -221,6 +257,14 @@ Name | Type | Description  | Notes
  - **Content-Type**: Not defined
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | An object containing a contact object |  -  |
+**400** | Invalid phone number provided |  -  |
+**401** | Unauthorized |  -  |
+**404** | Contact missing |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **fetch_contact_groups**
@@ -242,9 +286,11 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.ContactsApi(messente_api.ApiClient(configuration))
-phone = 'phone_example' # str | A phone number
+phone = '+37251000000' # str | A phone number
 
 try:
     # Lists groups of a contact
@@ -273,6 +319,14 @@ Name | Type | Description  | Notes
  - **Content-Type**: Not defined
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | An object containing a list of group objects |  -  |
+**400** | Invalid phone number provided |  -  |
+**401** | Unauthorized |  -  |
+**404** | Contact missing |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **fetch_contacts**
@@ -294,9 +348,11 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.ContactsApi(messente_api.ApiClient(configuration))
-group_ids = ['group_ids_example'] # list[str] | Optional one or many group id strings in UUID format. For example: \"/contacts?groupIds=group_id_one&groupIds=group_id_two\"  (optional)
+group_ids = ['[\"5792a02a-e5c2-422b-a0a0-0ae65d814663\",\"4792a02a-e5c2-422b-a0a0-0ae65d814662\"]'] # list[str] | Optional one or many group id strings in UUID format. For example: \"/contacts?groupIds=group_id_one&groupIds=group_id_two\"  (optional)
 
 try:
     # Returns all contacts
@@ -325,6 +381,14 @@ Name | Type | Description  | Notes
  - **Content-Type**: Not defined
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | An object containing a list of contact objects |  -  |
+**400** | Invalid \"groupIds\" parameters provided |  -  |
+**401** | Unauthorized |  -  |
+**0** | General error |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **remove_contact_from_group**
@@ -346,10 +410,12 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.ContactsApi(messente_api.ApiClient(configuration))
-group_id = 'group_id_example' # str | String in UUID format
-phone = 'phone_example' # str | A phone number
+group_id = '5792a02a-e5c2-422b-a0a0-0ae65d814663' # str | String in UUID format
+phone = '+37251000000' # str | A phone number
 
 try:
     # Removes a contact from a group
@@ -378,6 +444,15 @@ void (empty response body)
  - **Content-Type**: Not defined
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Contact removed from group |  -  |
+**400** | Invalid phone number provided |  -  |
+**401** | Unauthorized |  -  |
+**404** | Contact or group is missing or contact is missing from group |  -  |
+**0** | General error |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **update_contact**
@@ -399,10 +474,12 @@ configuration = messente_api.Configuration()
 configuration.username = 'YOUR_USERNAME'
 configuration.password = 'YOUR_PASSWORD'
 
-# create an instance of the API class
+# Defining host is optional and default to https://api.messente.com/v1
+configuration.host = "https://api.messente.com/v1"
+# Create an instance of the API class
 api_instance = messente_api.ContactsApi(messente_api.ApiClient(configuration))
-phone = 'phone_example' # str | A phone number
-contact_update_fields = messente_api.ContactUpdateFields() # ContactUpdateFields | 
+phone = '+37251000000' # str | A phone number
+contact_update_fields = {"email":"anyone@messente.com","firstName":"Any","lastName":"One","company":"Messente","title":"Sir","custom":"Any custom","custom2":"Any custom two","custom3":"Any custom three","custom4":"Any custom four"} # ContactUpdateFields | 
 
 try:
     # Updates a contact
@@ -432,5 +509,14 @@ Name | Type | Description  | Notes
  - **Content-Type**: application/json
  - **Accept**: application/json
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | An object containing a contact object |  -  |
+**400** | Invalid phone number or empty patch body or unknown fields provided |  -  |
+**401** | Unauthorized |  -  |
+**404** | Contact missing |  -  |
+**0** | General error |  -  |
+
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)