Skip to content

Commit 3649885

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

6 files changed

Lines changed: 1378 additions & 4 deletions

File tree

‎.openapi-generator/FILES‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ docs/Api/ContactsApi.md
1111
docs/Api/DeliveryReportApi.md
1212
docs/Api/GroupsApi.md
1313
docs/Api/NumberLookupApi.md
14+
docs/Api/NumberVerificationApi.md
1415
docs/Api/OmnimessageApi.md
1516
docs/Api/PricingApi.md
1617
docs/Api/StatisticsApi.md
@@ -102,6 +103,7 @@ lib/Api/ContactsApi.php
102103
lib/Api/DeliveryReportApi.php
103104
lib/Api/GroupsApi.php
104105
lib/Api/NumberLookupApi.php
106+
lib/Api/NumberVerificationApi.php
105107
lib/Api/OmnimessageApi.php
106108
lib/Api/PricingApi.php
107109
lib/Api/StatisticsApi.php

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,11 @@ Messente API Library provides the operations described below to access the featu
6161

6262
1. Requests info about phone numbers [`fetchInfo`](docs/Api/NumberLookupApi.md#fetchinfo)
6363

64+
### NumberVerificationApi
65+
66+
1. verify number [`verifyNumber`](docs/Api/NumberVerificationApi.md#verifynumber)
67+
1. verified the PIN code entered by the user. [`verifyPin`](docs/Api/NumberVerificationApi.md#verifypin)
68+
6469
### OmnimessageApi
6570

6671
1. Cancels a scheduled Omnimessage [`cancelScheduledMessage`](docs/Api/OmnimessageApi.md#cancelscheduledmessage)

‎docs/Api/NumberVerificationApi.md‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
# Messente\Api\NumberVerificationApi
2+
3+
All URIs are relative to https://api.messente.com/v1, except if the operation defines another base path.
4+
5+
| Method | HTTP request | Description |
6+
| ------------- | ------------- | ------------- |
7+
| [**verifyNumber()**](NumberVerificationApi.md#verifyNumber) | **POST** /verify/start | verify number |
8+
| [**verifyPin()**](NumberVerificationApi.md#verifyPin) | **POST** /verify/pin | verified the PIN code entered by the user. |
9+
10+
11+
## `verifyNumber()`
12+
13+
```php
14+
verifyNumber($username, $password, $to, $template, $pinLength, $from, $maxTries, $retryDelay, $validity, $ip, $browser, $cookie): string
15+
```
16+
### URI(s):
17+
- https://api2.messente.com Override base path for number verification API
18+
verify number
19+
20+
### Example
21+
22+
```php
23+
<?php
24+
require_once(__DIR__ . '/vendor/autoload.php');
25+
26+
27+
// Configure API key authorization: apiPassword
28+
$config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKey('password', 'YOUR_API_KEY');
29+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
30+
// $config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('password', 'Bearer');
31+
32+
// Configure API key authorization: apiUsername
33+
$config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKey('username', 'YOUR_API_KEY');
34+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
35+
// $config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('username', 'Bearer');
36+
37+
38+
$apiInstance = new Messente\Api\Api\NumberVerificationApi(
39+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
40+
// This is optional, `GuzzleHttp\Client` will be used as default.
41+
new GuzzleHttp\Client(),
42+
$config
43+
);
44+
$username = 'username_example'; // string | The API username
45+
$password = 'password_example'; // string | The API password
46+
$to = 'to_example'; // string | Receiver's phone number with the country code
47+
$template = 'template_example'; // string | 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>\".
48+
$pinLength = 'pinLength_example'; // string | Length of the PIN code. Minumum 4 digits, maximum 16. Defaults to 4.
49+
$from = 'from_example'; // string | Sender name. When not set, the default Sender name \"Verigator\" is used. This sender ID also needs to be added to your account beforehand.
50+
$maxTries = 'maxTries_example'; // string | 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.
51+
$retryDelay = 'retryDelay_example'; // string | For how long (in seconds) to wait for next retry, if the correct PIN code has not been entered yet? Defaults to 30 seconds.
52+
$validity = 'validity_example'; // string | For how long (in seconds) is the PIN code valid. Defaults to 5 minutes (300 seconds). Maximum 30 minutes (1800 seconds).
53+
$ip = 'ip_example'; // string | IP address of the client making verification request.
54+
$browser = 'browser_example'; // string | 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\".
55+
$cookie = 'cookie_example'; // string | 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.
56+
57+
$hostIndex = 0;
58+
$variables = [
59+
];
60+
61+
try {
62+
$result = $apiInstance->verifyNumber($username, $password, $to, $template, $pinLength, $from, $maxTries, $retryDelay, $validity, $ip, $browser, $cookie, $hostIndex, $variables);
63+
print_r($result);
64+
} catch (Exception $e) {
65+
echo 'Exception when calling NumberVerificationApi->verifyNumber: ', $e->getMessage(), PHP_EOL;
66+
}
67+
```
68+
69+
### Parameters
70+
71+
| Name | Type | Description | Notes |
72+
| ------------- | ------------- | ------------- | ------------- |
73+
| **username** | **string**| The API username | |
74+
| **password** | **string**| The API password | |
75+
| **to** | **string**| Receiver&#39;s phone number with the country code | |
76+
| **template** | **string**| 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] |
77+
| **pinLength** | **string**| Length of the PIN code. Minumum 4 digits, maximum 16. Defaults to 4. | [optional] |
78+
| **from** | **string**| 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] |
79+
| **maxTries** | **string**| 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] |
80+
| **retryDelay** | **string**| 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] |
81+
| **validity** | **string**| For how long (in seconds) is the PIN code valid. Defaults to 5 minutes (300 seconds). Maximum 30 minutes (1800 seconds). | [optional] |
82+
| **ip** | **string**| IP address of the client making verification request. | [optional] |
83+
| **browser** | **string**| 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] |
84+
| **cookie** | **string**| 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] |
85+
| hostIndex | null|int | Host index. Defaults to null. If null, then the library will use $this->hostIndex instead | [optional] |
86+
| variables | array | Associative array of variables to pass to the host. Defaults to empty array. | [optional] |
87+
88+
### Return type
89+
90+
**string**
91+
92+
### Authorization
93+
94+
[apiPassword](../../README.md#apiPassword), [apiUsername](../../README.md#apiUsername)
95+
96+
### HTTP request headers
97+
98+
- **Content-Type**: Not defined
99+
- **Accept**: `text/plain`
100+
101+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
102+
[[Back to Model list]](../../README.md#models)
103+
[[Back to README]](../../README.md)
104+
105+
## `verifyPin()`
106+
107+
```php
108+
verifyPin($username, $password, $verificationId, $pin, $ip, $browser, $cookie): string
109+
```
110+
### URI(s):
111+
- https://api2.messente.com Override base path for number verification API
112+
verified the PIN code entered by the user.
113+
114+
### Example
115+
116+
```php
117+
<?php
118+
require_once(__DIR__ . '/vendor/autoload.php');
119+
120+
121+
// Configure API key authorization: apiPassword
122+
$config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKey('password', 'YOUR_API_KEY');
123+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
124+
// $config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('password', 'Bearer');
125+
126+
// Configure API key authorization: apiUsername
127+
$config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKey('username', 'YOUR_API_KEY');
128+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
129+
// $config = Messente\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('username', 'Bearer');
130+
131+
132+
$apiInstance = new Messente\Api\Api\NumberVerificationApi(
133+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
134+
// This is optional, `GuzzleHttp\Client` will be used as default.
135+
new GuzzleHttp\Client(),
136+
$config
137+
);
138+
$username = 'username_example'; // string | The API username
139+
$password = 'password_example'; // string | The API password
140+
$verificationId = 'verificationId_example'; // string | Verification ID returned by the successful verification request.
141+
$pin = 'pin_example'; // string | PIN code entered by the user.
142+
$ip = 'ip_example'; // string | IP address of the client making verification request. If the IP address is from another country, PIN is required even if the cookies match.
143+
$browser = 'browser_example'; // string | 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\".
144+
$cookie = 'cookie_example'; // string | 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.
145+
146+
$hostIndex = 0;
147+
$variables = [
148+
];
149+
150+
try {
151+
$result = $apiInstance->verifyPin($username, $password, $verificationId, $pin, $ip, $browser, $cookie, $hostIndex, $variables);
152+
print_r($result);
153+
} catch (Exception $e) {
154+
echo 'Exception when calling NumberVerificationApi->verifyPin: ', $e->getMessage(), PHP_EOL;
155+
}
156+
```
157+
158+
### Parameters
159+
160+
| Name | Type | Description | Notes |
161+
| ------------- | ------------- | ------------- | ------------- |
162+
| **username** | **string**| The API username | |
163+
| **password** | **string**| The API password | |
164+
| **verificationId** | **string**| Verification ID returned by the successful verification request. | |
165+
| **pin** | **string**| PIN code entered by the user. | |
166+
| **ip** | **string**| 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] |
167+
| **browser** | **string**| 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] |
168+
| **cookie** | **string**| 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] |
169+
| hostIndex | null|int | Host index. Defaults to null. If null, then the library will use $this->hostIndex instead | [optional] |
170+
| variables | array | Associative array of variables to pass to the host. Defaults to empty array. | [optional] |
171+
172+
### Return type
173+
174+
**string**
175+
176+
### Authorization
177+
178+
[apiPassword](../../README.md#apiPassword), [apiUsername](../../README.md#apiUsername)
179+
180+
### HTTP request headers
181+
182+
- **Content-Type**: Not defined
183+
- **Accept**: `text/plain`
184+
185+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
186+
[[Back to Model list]](../../README.md#models)
187+
[[Back to README]](../../README.md)

‎docs/Api/PricingApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ All URIs are relative to https://api.messente.com/v1, except if the operation de
1414
getPricelist($username, $password): string
1515
```
1616
### URI(s):
17-
- https://api2.messente.com Override base path for account balance API
17+
- https://api2.messente.com Override base path for pricing API
1818
Get pricelist for account
1919

2020
### Example
@@ -88,7 +88,7 @@ try {
8888
getPrices($username, $password, $country, $format): \Messente\Api\Model\Price
8989
```
9090
### URI(s):
91-
- https://api2.messente.com Override base path for account balance API
91+
- https://api2.messente.com Override base path for pricing API
9292
Get pricing for a specific country
9393

9494
### Example

0 commit comments

Comments
 (0)