Skip to content

Commit e292e0a

Browse files
api-librarianapi-librarian
committed
Travis update: May 2025 (Build 843)
[skip ci]
1 parent ef8eb28 commit e292e0a

File tree

6 files changed

+1075
-0
lines changed

6 files changed

+1075
-0
lines changed

‎.openapi-generator/FILES‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ docs/MessageResult.md
4545
docs/MobileNetwork.md
4646
docs/NumberLookupApi.md
4747
docs/NumberToBlacklist.md
48+
docs/NumberVerificationApi.md
4849
docs/NumbersToInvestigate.md
4950
docs/OmniMessageCreateSuccessResponse.md
5051
docs/Omnimessage.md
@@ -104,6 +105,7 @@ messente_api/api/contacts_api.py
104105
messente_api/api/delivery_report_api.py
105106
messente_api/api/groups_api.py
106107
messente_api/api/number_lookup_api.py
108+
messente_api/api/number_verification_api.py
107109
messente_api/api/omnimessage_api.py
108110
messente_api/api/pricing_api.py
109111
messente_api/api/statistics_api.py

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,11 @@ Messente API Library provides the operations described below to access the featu
5757
1. Returns all groups [`fetch_groups`](docs/GroupsApi.md#fetch_groups)
5858
1. Updates a group with the provided name [`update_group`](docs/GroupsApi.md#update_group)
5959

60+
### NumberVerificationApi
61+
62+
1. verify number [`verify_number`](docs/NumberVerificationApi.md#verify_number)
63+
1. verified the PIN code entered by the user. [`verify_pin`](docs/NumberVerificationApi.md#verify_pin)
64+
6065
### NumberLookupApi
6166

6267
1. Requests info about phone numbers [`fetch_info`](docs/NumberLookupApi.md#fetch_info)

‎docs/NumberVerificationApi.md‎

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
# messente_api.NumberVerificationApi
2+
3+
All URIs are relative to *https://api.messente.com/v1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**verify_number**](NumberVerificationApi.md#verify_number) | **POST** /verify/start | verify number
8+
[**verify_pin**](NumberVerificationApi.md#verify_pin) | **POST** /verify/pin | verified the PIN code entered by the user.
9+
10+
11+
# **verify_number**
12+
> str verify_number(username, password, to, template=template, pin_length=pin_length, var_from=var_from, max_tries=max_tries, retry_delay=retry_delay, validity=validity, ip=ip, browser=browser, cookie=cookie)
13+
14+
verify number
15+
16+
### Example
17+
18+
* Api Key Authentication (apiPassword):
19+
* Api Key Authentication (apiUsername):
20+
21+
```python
22+
import messente_api
23+
from messente_api.rest import ApiException
24+
from pprint import pprint
25+
26+
# Defining the host is optional and defaults to https://api.messente.com/v1
27+
# See configuration.py for a list of all supported configuration parameters.
28+
configuration = messente_api.Configuration(
29+
host = "https://api.messente.com/v1"
30+
)
31+
32+
# The client must configure the authentication and authorization parameters
33+
# in accordance with the API server security policy.
34+
# Examples for each auth method are provided below, use the example that
35+
# satisfies your auth use case.
36+
37+
# Configure API key authorization: apiPassword
38+
configuration.api_key['apiPassword'] = os.environ["API_KEY"]
39+
40+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
41+
# configuration.api_key_prefix['apiPassword'] = 'Bearer'
42+
43+
# Configure API key authorization: apiUsername
44+
configuration.api_key['apiUsername'] = os.environ["API_KEY"]
45+
46+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
47+
# configuration.api_key_prefix['apiUsername'] = 'Bearer'
48+
49+
# Enter a context with an instance of the API client
50+
with messente_api.ApiClient(configuration) as api_client:
51+
# Create an instance of the API class
52+
api_instance = messente_api.NumberVerificationApi(api_client)
53+
username = 'username_example' # str | The API username
54+
password = 'password_example' # str | The API password
55+
to = 'to_example' # str | Receiver's phone number with the country code
56+
template = 'template_example' # str | Template of the message, including PIN code. Placeholder for PIN code is <PIN>. When not set, default template is used: \"Your Verification PIN code is <PIN>\". (optional)
57+
pin_length = 'pin_length_example' # str | Length of the PIN code. Minumum 4 digits, maximum 16. Defaults to 4. (optional)
58+
var_from = 'var_from_example' # str | Sender name. When not set, the default Sender name \"Verigator\" is used. This sender ID also needs to be added to your account beforehand. (optional)
59+
max_tries = 'max_tries_example' # str | Maximum number of times the PIN code is sent in total. Defaults to \"2\" - initial PIN code and one retry. It is discouraged to set this value to \"1\" as only the initial PIN code is sent and retry is disabled. (optional)
60+
retry_delay = 'retry_delay_example' # str | For how long (in seconds) to wait for next retry, if the correct PIN code has not been entered yet? Defaults to 30 seconds. (optional)
61+
validity = 'validity_example' # str | For how long (in seconds) is the PIN code valid. Defaults to 5 minutes (300 seconds). Maximum 30 minutes (1800 seconds). (optional)
62+
ip = 'ip_example' # str | IP address of the client making verification request. (optional)
63+
browser = 'browser_example' # str | User Agent of the browser. For example \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.130 Safari/537.36\". (optional)
64+
cookie = 'cookie_example' # str | Unique cookie assigned to this session. If a user tries logging in with the same cookie present, user is automatically logged in and no PIN code verification is needed. (optional)
65+
66+
try:
67+
# verify number
68+
api_response = api_instance.verify_number(username, password, to, template=template, pin_length=pin_length, var_from=var_from, max_tries=max_tries, retry_delay=retry_delay, validity=validity, ip=ip, browser=browser, cookie=cookie)
69+
print("The response of NumberVerificationApi->verify_number:\n")
70+
pprint(api_response)
71+
except Exception as e:
72+
print("Exception when calling NumberVerificationApi->verify_number: %s\n" % e)
73+
```
74+
75+
76+
77+
### Parameters
78+
79+
80+
Name | Type | Description | Notes
81+
------------- | ------------- | ------------- | -------------
82+
**username** | **str**| The API username |
83+
**password** | **str**| The API password |
84+
**to** | **str**| Receiver&#39;s phone number with the country code |
85+
**template** | **str**| Template of the message, including PIN code. Placeholder for PIN code is &lt;PIN&gt;. When not set, default template is used: \&quot;Your Verification PIN code is &lt;PIN&gt;\&quot;. | [optional]
86+
**pin_length** | **str**| Length of the PIN code. Minumum 4 digits, maximum 16. Defaults to 4. | [optional]
87+
**var_from** | **str**| Sender name. When not set, the default Sender name \&quot;Verigator\&quot; is used. This sender ID also needs to be added to your account beforehand. | [optional]
88+
**max_tries** | **str**| Maximum number of times the PIN code is sent in total. Defaults to \&quot;2\&quot; - initial PIN code and one retry. It is discouraged to set this value to \&quot;1\&quot; as only the initial PIN code is sent and retry is disabled. | [optional]
89+
**retry_delay** | **str**| For how long (in seconds) to wait for next retry, if the correct PIN code has not been entered yet? Defaults to 30 seconds. | [optional]
90+
**validity** | **str**| For how long (in seconds) is the PIN code valid. Defaults to 5 minutes (300 seconds). Maximum 30 minutes (1800 seconds). | [optional]
91+
**ip** | **str**| IP address of the client making verification request. | [optional]
92+
**browser** | **str**| User Agent of the browser. For example \&quot;Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.130 Safari/537.36\&quot;. | [optional]
93+
**cookie** | **str**| Unique cookie assigned to this session. If a user tries logging in with the same cookie present, user is automatically logged in and no PIN code verification is needed. | [optional]
94+
95+
### Return type
96+
97+
**str**
98+
99+
### Authorization
100+
101+
[apiPassword](../README.md#apiPassword), [apiUsername](../README.md#apiUsername)
102+
103+
### HTTP request headers
104+
105+
- **Content-Type**: Not defined
106+
- **Accept**: text/plain
107+
108+
### HTTP response details
109+
110+
| Status code | Description | Response headers |
111+
|-------------|-------------|------------------|
112+
**200** | Both errors and success responses are returned as plain text with HTTP status 200. | - |
113+
114+
[[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)
115+
116+
# **verify_pin**
117+
> str verify_pin(username, password, verification_id, pin, ip=ip, browser=browser, cookie=cookie)
118+
119+
verified the PIN code entered by the user.
120+
121+
### Example
122+
123+
* Api Key Authentication (apiPassword):
124+
* Api Key Authentication (apiUsername):
125+
126+
```python
127+
import messente_api
128+
from messente_api.rest import ApiException
129+
from pprint import pprint
130+
131+
# Defining the host is optional and defaults to https://api.messente.com/v1
132+
# See configuration.py for a list of all supported configuration parameters.
133+
configuration = messente_api.Configuration(
134+
host = "https://api.messente.com/v1"
135+
)
136+
137+
# The client must configure the authentication and authorization parameters
138+
# in accordance with the API server security policy.
139+
# Examples for each auth method are provided below, use the example that
140+
# satisfies your auth use case.
141+
142+
# Configure API key authorization: apiPassword
143+
configuration.api_key['apiPassword'] = os.environ["API_KEY"]
144+
145+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
146+
# configuration.api_key_prefix['apiPassword'] = 'Bearer'
147+
148+
# Configure API key authorization: apiUsername
149+
configuration.api_key['apiUsername'] = os.environ["API_KEY"]
150+
151+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
152+
# configuration.api_key_prefix['apiUsername'] = 'Bearer'
153+
154+
# Enter a context with an instance of the API client
155+
with messente_api.ApiClient(configuration) as api_client:
156+
# Create an instance of the API class
157+
api_instance = messente_api.NumberVerificationApi(api_client)
158+
username = 'username_example' # str | The API username
159+
password = 'password_example' # str | The API password
160+
verification_id = 'verification_id_example' # str | Verification ID returned by the successful verification request.
161+
pin = 'pin_example' # str | PIN code entered by the user.
162+
ip = 'ip_example' # str | IP address of the client making verification request. If the IP address is from another country, PIN is required even if the cookies match. (optional)
163+
browser = 'browser_example' # str | User Agent of the browser. For example \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.130 Safari/537.36\". (optional)
164+
cookie = 'cookie_example' # str | Unique cookie assigned to this session. If a user tries logging in with the same cookie present, user is automatically logged in and no PIN code verification is needed. (optional)
165+
166+
try:
167+
# verified the PIN code entered by the user.
168+
api_response = api_instance.verify_pin(username, password, verification_id, pin, ip=ip, browser=browser, cookie=cookie)
169+
print("The response of NumberVerificationApi->verify_pin:\n")
170+
pprint(api_response)
171+
except Exception as e:
172+
print("Exception when calling NumberVerificationApi->verify_pin: %s\n" % e)
173+
```
174+
175+
176+
177+
### Parameters
178+
179+
180+
Name | Type | Description | Notes
181+
------------- | ------------- | ------------- | -------------
182+
**username** | **str**| The API username |
183+
**password** | **str**| The API password |
184+
**verification_id** | **str**| Verification ID returned by the successful verification request. |
185+
**pin** | **str**| PIN code entered by the user. |
186+
**ip** | **str**| IP address of the client making verification request. If the IP address is from another country, PIN is required even if the cookies match. | [optional]
187+
**browser** | **str**| User Agent of the browser. For example \&quot;Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.130 Safari/537.36\&quot;. | [optional]
188+
**cookie** | **str**| Unique cookie assigned to this session. If a user tries logging in with the same cookie present, user is automatically logged in and no PIN code verification is needed. | [optional]
189+
190+
### Return type
191+
192+
**str**
193+
194+
### Authorization
195+
196+
[apiPassword](../README.md#apiPassword), [apiUsername](../README.md#apiUsername)
197+
198+
### HTTP request headers
199+
200+
- **Content-Type**: Not defined
201+
- **Accept**: text/plain
202+
203+
### HTTP response details
204+
205+
| Status code | Description | Response headers |
206+
|-------------|-------------|------------------|
207+
**200** | Both errors and success responses are returned as plain text with HTTP status 200. | - |
208+
209+
[[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)
210+

‎messente_api/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
from messente_api.api.contacts_api import ContactsApi
2525
from messente_api.api.delivery_report_api import DeliveryReportApi
2626
from messente_api.api.groups_api import GroupsApi
27+
from messente_api.api.number_verification_api import NumberVerificationApi
2728
from messente_api.api.number_lookup_api import NumberLookupApi
2829
from messente_api.api.omnimessage_api import OmnimessageApi
2930
from messente_api.api.pricing_api import PricingApi

‎messente_api/api/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
from messente_api.api.contacts_api import ContactsApi
88
from messente_api.api.delivery_report_api import DeliveryReportApi
99
from messente_api.api.groups_api import GroupsApi
10+
from messente_api.api.number_verification_api import NumberVerificationApi
1011
from messente_api.api.number_lookup_api import NumberLookupApi
1112
from messente_api.api.omnimessage_api import OmnimessageApi
1213
from messente_api.api.pricing_api import PricingApi

0 commit comments

Comments
 (0)