Skip to content

Commit 7d84dbe

Browse files
author
Erik Räni
authored
1.2.0 (#6)
1 parent f90308d commit 7d84dbe

File tree

79 files changed

+2772
-103
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+2772
-103
lines changed

‎README.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Messente API Library
22

3-
- Messente API version: 1.1.0
4-
- Python package version: 1.1.0
3+
- Messente API version: 1.2.0
4+
- Python package version: 1.2.0
55

6-
[Messente](https://messente.com) is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber, WhatsApp and Telegram 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.
6+
[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.
77

88
## Installation
99

@@ -48,11 +48,19 @@ Messente API Library provides the operations described below to access the featu
4848
1. Returns all groups [`fetch_groups`](docs/GroupsApi.md#fetch_groups)
4949
1. Updates a group with the provided name [`update_group`](docs/GroupsApi.md#update_group)
5050

51+
### NumberLookupApi
52+
53+
1. Requests info about phone numbers [`fetch_info`](docs/NumberLookupApi.md#fetch_info)
54+
5155
### OmnimessageApi
5256

5357
1. Cancels a scheduled Omnimessage [`cancel_scheduled_message`](docs/OmnimessageApi.md#cancel_scheduled_message)
5458
1. Sends an Omnimessage [`send_omnimessage`](docs/OmnimessageApi.md#send_omnimessage)
5559

60+
### StatisticsApi
61+
62+
1. Requests statistics reports for each country [`create_statistics_report`](docs/StatisticsApi.md#create_statistics_report)
63+
5664
## Auth
5765

5866
**Type**: HTTP basic authentication

‎docs/ErrorCodeStatistics.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ErrorCodeStatistics
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8+
9+

‎docs/ErrorItemNumberLookup.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ErrorItemNumberLookup
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**error** | [**ErrorItemNumberLookupError**](ErrorItemNumberLookupError.md) | |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/ErrorItemNumberLookupError.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ErrorItemNumberLookupError
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**description** | **str** | Error description |
7+
**code** | **int** | Matches the following error title. This field is a constant * 101 - Unauthorized * 102 - Invalid arguments or parameters * 103 - Server error * 104 - Crediting error #1 * 105 - Crediting error #2 * 106 - Client error |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/ErrorItemStatistics.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ErrorItemStatistics
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**title** | **str** | Error title |
7+
**details** | **str** | Error details |
8+
**code** | [**ErrorCodeStatistics**](ErrorCodeStatistics.md) | |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/ErrorNumberLookup.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ErrorNumberLookup
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**errors** | [**list[ErrorItemNumberLookup]**](ErrorItemNumberLookup.md) | An array of errors |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/ErrorStatistics.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ErrorStatistics
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**errors** | [**list[ErrorItemStatistics]**](ErrorItemStatistics.md) | An array of errors |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/MobileNetwork.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# MobileNetwork
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**mccmnc** | **str** | Mobile country and mobile network code | [optional]
7+
**network_name** | **str** | Mobile network name | [optional]
8+
**country_name** | **str** | Country name | [optional]
9+
**country_prefix** | **str** | Country prefix | [optional]
10+
**country_code** | **str** | Country code | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

‎docs/NumberLookupApi.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# messente_api.NumberLookupApi
2+
3+
All URIs are relative to *https://api.messente.com/v1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**fetch_info**](NumberLookupApi.md#fetch_info) | **POST** /hlr/sync | Requests info about phone numbers
8+
9+
10+
# **fetch_info**
11+
> SyncNumberLookupSuccess fetch_info(numbers_to_investigate)
12+
13+
Requests info about phone numbers
14+
15+
### Example
16+
17+
* Basic Authentication (basicAuth):
18+
```python
19+
from __future__ import print_function
20+
import time
21+
import messente_api
22+
from messente_api.rest import ApiException
23+
from pprint import pprint
24+
configuration = messente_api.Configuration()
25+
# Configure HTTP basic authorization: basicAuth
26+
configuration.username = 'YOUR_USERNAME'
27+
configuration.password = 'YOUR_PASSWORD'
28+
29+
# Defining host is optional and default to https://api.messente.com/v1
30+
configuration.host = "https://api.messente.com/v1"
31+
# Create an instance of the API class
32+
api_instance = messente_api.NumberLookupApi(messente_api.ApiClient(configuration))
33+
numbers_to_investigate = {"numbers":["+37251000000","+37251000001"]} # NumbersToInvestigate | Numbers for lookup
34+
35+
try:
36+
# Requests info about phone numbers
37+
api_response = api_instance.fetch_info(numbers_to_investigate)
38+
pprint(api_response)
39+
except ApiException as e:
40+
print("Exception when calling NumberLookupApi->fetch_info: %s\n" % e)
41+
```
42+
43+
### Parameters
44+
45+
Name | Type | Description | Notes
46+
------------- | ------------- | ------------- | -------------
47+
**numbers_to_investigate** | [**NumbersToInvestigate**](NumbersToInvestigate.md)| Numbers for lookup |
48+
49+
### Return type
50+
51+
[**SyncNumberLookupSuccess**](SyncNumberLookupSuccess.md)
52+
53+
### Authorization
54+
55+
[basicAuth](../README.md#basicAuth)
56+
57+
### HTTP request headers
58+
59+
- **Content-Type**: application/json
60+
- **Accept**: application/json
61+
62+
### HTTP response details
63+
| Status code | Description | Response headers |
64+
|-------------|-------------|------------------|
65+
**200** | Info about phone numbers returned | - |
66+
**400** | Invalid request | - |
67+
**401** | Unauthorized | - |
68+
**402** | Failed crediting | - |
69+
70+
[[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)
71+

‎docs/NumbersToInvestigate.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# NumbersToInvestigate
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**numbers** | **list[str]** | Array of phone numbers |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

0 commit comments

Comments
 (0)