allow vendord
All checks were successful
Build, Push and Deploy / build-and-push (push) Successful in 3m3s
Gitea Actions Demo / Explore-Gitea-Actions (push) Successful in 16s
Build, Push and Deploy / deploy-staging (push) Successful in 32s
Build, Push and Deploy / deploy-production (push) Has been skipped
Build, Push and Deploy / cleanup (push) Successful in 1s

This commit is contained in:
2026-03-30 14:54:57 +07:00
parent 66aed7c4e8
commit b5e3a778ce
21316 changed files with 2777892 additions and 13 deletions

View File

@@ -0,0 +1,18 @@
# Callback
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional]
**name** | **string** | | [optional]
**event** | **string** | | [optional]
**deviceId** | **int** | | [optional]
**filterType** | **string** | | [optional]
**filter** | **string** | | [optional]
**method** | **string** | | [optional]
**action** | **string** | | [optional]
**secret** | **string** | | [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)

View File

@@ -0,0 +1,206 @@
# SMSGatewayMe\Client\CallbackApi
All URIs are relative to *https://smsgateway.me/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createCallback**](CallbackApi.md#createCallback) | **POST** /callback | Create Callback
[**getCallback**](CallbackApi.md#getCallback) | **GET** /callback/{id} | Get a specific callback
[**searchCallbacks**](CallbackApi.md#searchCallbacks) | **POST** /callback/search | Search callbacks
[**updateCallback**](CallbackApi.md#updateCallback) | **PUT** /callback/{id} | Update callback
# **createCallback**
> \SMSGatewayMe\Client\Model\Callback createCallback($callback)
Create Callback
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\CallbackApi();
$callback = new \SMSGatewayMe\Client\Model\CreateCallbackRequest(); // \SMSGatewayMe\Client\Model\CreateCallbackRequest | callback to create
try {
$result = $api_instance->createCallback($callback);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CallbackApi->createCallback: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**callback** | [**\SMSGatewayMe\Client\Model\CreateCallbackRequest**](\SMSGatewayMe\Client\Model\CreateCallbackRequest.md)| callback to create |
### Return type
[**\SMSGatewayMe\Client\Model\Callback**](Callback.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **getCallback**
> \SMSGatewayMe\Client\Model\Callback getCallback($id)
Get a specific callback
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\CallbackApi();
$id = "id_example"; // string |
try {
$result = $api_instance->getCallback($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CallbackApi->getCallback: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **string**| |
### Return type
[**\SMSGatewayMe\Client\Model\Callback**](Callback.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **searchCallbacks**
> \SMSGatewayMe\Client\Model\CallbackSearchResult searchCallbacks($search)
Search callbacks
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\CallbackApi();
$search = new \SMSGatewayMe\Client\Model\Search(); // \SMSGatewayMe\Client\Model\Search | Search Criteria
try {
$result = $api_instance->searchCallbacks($search);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CallbackApi->searchCallbacks: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**search** | [**\SMSGatewayMe\Client\Model\Search**](\SMSGatewayMe\Client\Model\Search.md)| Search Criteria | [optional]
### Return type
[**\SMSGatewayMe\Client\Model\CallbackSearchResult**](CallbackSearchResult.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **updateCallback**
> \SMSGatewayMe\Client\Model\Callback updateCallback($id, $callback)
Update callback
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\CallbackApi();
$id = "id_example"; // string |
$callback = array(new UpdateCallbackRequest()); // \SMSGatewayMe\Client\Model\UpdateCallbackRequest[] | callback update data
try {
$result = $api_instance->updateCallback($id, $callback);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CallbackApi->updateCallback: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **string**| |
**callback** | [**\SMSGatewayMe\Client\Model\UpdateCallbackRequest[]**](UpdateCallbackRequest.md)| callback update data |
### Return type
[**\SMSGatewayMe\Client\Model\Callback**](Callback.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)

View File

@@ -0,0 +1,11 @@
# CallbackSearchResult
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | Total number of results | [optional]
**results** | [**\SMSGatewayMe\Client\Model\Callback[]**](Callback.md) | | [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)

View File

@@ -0,0 +1,10 @@
# CancelMessageRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | The id of the message you wish to cancel | [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)

View File

@@ -0,0 +1,14 @@
# Contact
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**name** | **string** | | [optional]
**phoneNumbers** | **string[]** | | [optional]
**createdAt** | [**\DateTime**](\DateTime.md) | | [optional]
**updatedAt** | [**\DateTime**](\DateTime.md) | | [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)

View File

@@ -0,0 +1,308 @@
# SMSGatewayMe\Client\ContactApi
All URIs are relative to *https://smsgateway.me/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
[**addPhoneNumber**](ContactApi.md#addPhoneNumber) | **PUT** /contact/{id}/phone-number/{phone-number} | The phone number to add
[**createContacts**](ContactApi.md#createContacts) | **POST** /contact | Create Contacts
[**deletePhoneNumber**](ContactApi.md#deletePhoneNumber) | **DELETE** /contact/{id}/phone-number/{phone-number} | The phone number to delete
[**getContact**](ContactApi.md#getContact) | **GET** /contact/{id} | Get a specific contact
[**searchContacts**](ContactApi.md#searchContacts) | **POST** /contact/search | Search contacts
[**updateContact**](ContactApi.md#updateContact) | **PUT** /contact/{id} | Update contact
# **addPhoneNumber**
> \SMSGatewayMe\Client\Model\Contact addPhoneNumber($id, $phoneNumber)
The phone number to add
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\ContactApi();
$id = "id_example"; // string |
$phoneNumber = "phoneNumber_example"; // string | phone number to add
try {
$result = $api_instance->addPhoneNumber($id, $phoneNumber);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactApi->addPhoneNumber: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **string**| |
**phoneNumber** | **string**| phone number to add |
### Return type
[**\SMSGatewayMe\Client\Model\Contact**](Contact.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **createContacts**
> \SMSGatewayMe\Client\Model\Contact[] createContacts($contacts)
Create Contacts
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\ContactApi();
$contacts = array(new CreateContactRequest()); // \SMSGatewayMe\Client\Model\CreateContactRequest[] | contacts to create
try {
$result = $api_instance->createContacts($contacts);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactApi->createContacts: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contacts** | [**\SMSGatewayMe\Client\Model\CreateContactRequest[]**](CreateContactRequest.md)| contacts to create |
### Return type
[**\SMSGatewayMe\Client\Model\Contact[]**](Contact.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **deletePhoneNumber**
> \SMSGatewayMe\Client\Model\Contact deletePhoneNumber($id, $phoneNumber)
The phone number to delete
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\ContactApi();
$id = "id_example"; // string |
$phoneNumber = "phoneNumber_example"; // string | phone number to add
try {
$result = $api_instance->deletePhoneNumber($id, $phoneNumber);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactApi->deletePhoneNumber: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **string**| |
**phoneNumber** | **string**| phone number to add |
### Return type
[**\SMSGatewayMe\Client\Model\Contact**](Contact.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **getContact**
> \SMSGatewayMe\Client\Model\Contact getContact($id)
Get a specific contact
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\ContactApi();
$id = "id_example"; // string |
try {
$result = $api_instance->getContact($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactApi->getContact: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **string**| |
### Return type
[**\SMSGatewayMe\Client\Model\Contact**](Contact.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **searchContacts**
> \SMSGatewayMe\Client\Model\ContactSearchResult searchContacts($search)
Search contacts
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\ContactApi();
$search = new \SMSGatewayMe\Client\Model\Search(); // \SMSGatewayMe\Client\Model\Search | Search Criteria
try {
$result = $api_instance->searchContacts($search);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactApi->searchContacts: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**search** | [**\SMSGatewayMe\Client\Model\Search**](\SMSGatewayMe\Client\Model\Search.md)| Search Criteria | [optional]
### Return type
[**\SMSGatewayMe\Client\Model\ContactSearchResult**](ContactSearchResult.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **updateContact**
> \SMSGatewayMe\Client\Model\Contact updateContact($id, $contact)
Update contact
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\ContactApi();
$id = "id_example"; // string |
$contact = new \SMSGatewayMe\Client\Model\UpdateContactRequest(); // \SMSGatewayMe\Client\Model\UpdateContactRequest | contacts details
try {
$result = $api_instance->updateContact($id, $contact);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactApi->updateContact: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **string**| |
**contact** | [**\SMSGatewayMe\Client\Model\UpdateContactRequest**](\SMSGatewayMe\Client\Model\UpdateContactRequest.md)| contacts details |
### Return type
[**\SMSGatewayMe\Client\Model\Contact**](Contact.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)

View File

@@ -0,0 +1,11 @@
# ContactSearchResult
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | Total number of results | [optional]
**results** | [**\SMSGatewayMe\Client\Model\Contact[]**](Contact.md) | | [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)

View File

@@ -0,0 +1,17 @@
# CreateCallbackRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [optional]
**event** | **string** | | [optional]
**deviceId** | **int** | | [optional]
**filterType** | **string** | | [optional]
**filter** | **string** | | [optional]
**method** | **string** | | [optional]
**action** | **string** | | [optional]
**secret** | **string** | | [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)

View File

@@ -0,0 +1,11 @@
# CreateContactRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [optional]
**phoneNumbers** | **string[]** | | [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)

View File

@@ -0,0 +1,12 @@
# Device
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**name** | **string** | | [optional]
**attributes** | [**\SMSGatewayMe\Client\Model\DeviceAttributes**](DeviceAttributes.md) | | [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)

View File

@@ -0,0 +1,106 @@
# SMSGatewayMe\Client\DeviceApi
All URIs are relative to *https://smsgateway.me/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getDevice**](DeviceApi.md#getDevice) | **GET** /device/{id} | Get a specific device
[**searchDevices**](DeviceApi.md#searchDevices) | **POST** /device/search | Search devices
# **getDevice**
> \SMSGatewayMe\Client\Model\Device getDevice($id)
Get a specific device
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\DeviceApi();
$id = "id_example"; // string |
try {
$result = $api_instance->getDevice($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceApi->getDevice: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **string**| |
### Return type
[**\SMSGatewayMe\Client\Model\Device**](Device.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **searchDevices**
> \SMSGatewayMe\Client\Model\DeviceSearchResult searchDevices($search)
Search devices
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\DeviceApi();
$search = new \SMSGatewayMe\Client\Model\Search(); // \SMSGatewayMe\Client\Model\Search | Search Criteria
try {
$result = $api_instance->searchDevices($search);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceApi->searchDevices: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**search** | [**\SMSGatewayMe\Client\Model\Search**](\SMSGatewayMe\Client\Model\Search.md)| Search Criteria | [optional]
### Return type
[**\SMSGatewayMe\Client\Model\DeviceSearchResult**](DeviceSearchResult.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)

View File

@@ -0,0 +1,21 @@
# DeviceAttributes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**phoneNumber** | **string** | | [optional]
**make** | **string** | | [optional]
**model** | **string** | | [optional]
**provider** | **string** | | [optional]
**country** | **string** | | [optional]
**connectionType** | **string** | | [optional]
**battery** | **string** | | [optional]
**signalPercent** | **string** | | [optional]
**wifi** | **bool** | | [optional]
**lat** | **string** | | [optional]
**lng** | **string** | | [optional]
**lastSeen** | [**\DateTime**](\DateTime.md) | | [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)

View File

@@ -0,0 +1,11 @@
# DeviceSearchResult
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | Total number of results | [optional]
**results** | [**\SMSGatewayMe\Client\Model\Device[]**](Device.md) | | [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)

View File

@@ -0,0 +1,12 @@
# Error
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **string** | | [optional]
**errors** | **string[]** | | [optional]
**children** | [**\SMSGatewayMe\Client\Model\Error[]**](Error.md) | | [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)

View File

@@ -0,0 +1,11 @@
# ErrorResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **string** | | [optional]
**data** | [**\SMSGatewayMe\Client\Model\Error[]**](Error.md) | | [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)

View File

@@ -0,0 +1,10 @@
# FatalResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **string** | | [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)

View File

@@ -0,0 +1,16 @@
# Message
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**deviceId** | **int** | | [optional]
**message** | **string** | | [optional]
**status** | **string** | | [optional]
**log** | [**\SMSGatewayMe\Client\Model\MessageLog[]**](MessageLog.md) | | [optional]
**createdAt** | [**\DateTime**](\DateTime.md) | | [optional]
**updatedAt** | [**\DateTime**](\DateTime.md) | | [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)

View File

@@ -0,0 +1,204 @@
# SMSGatewayMe\Client\MessageApi
All URIs are relative to *https://smsgateway.me/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
[**cancelMessages**](MessageApi.md#cancelMessages) | **POST** /message/cancel | Cancel messages
[**getMessage**](MessageApi.md#getMessage) | **GET** /message/{id} | Get a specific message
[**searchMessages**](MessageApi.md#searchMessages) | **POST** /message/search | Search messages
[**sendMessages**](MessageApi.md#sendMessages) | **POST** /message/send | Send messages
# **cancelMessages**
> \SMSGatewayMe\Client\Model\Message[] cancelMessages($messages)
Cancel messages
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\MessageApi();
$messages = array(new CancelMessageRequest()); // \SMSGatewayMe\Client\Model\CancelMessageRequest[] | messages to cancel
try {
$result = $api_instance->cancelMessages($messages);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling MessageApi->cancelMessages: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**messages** | [**\SMSGatewayMe\Client\Model\CancelMessageRequest[]**](CancelMessageRequest.md)| messages to cancel |
### Return type
[**\SMSGatewayMe\Client\Model\Message[]**](Message.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **getMessage**
> \SMSGatewayMe\Client\Model\Message getMessage($id)
Get a specific message
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\MessageApi();
$id = "id_example"; // string |
try {
$result = $api_instance->getMessage($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling MessageApi->getMessage: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **string**| |
### Return type
[**\SMSGatewayMe\Client\Model\Message**](Message.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **searchMessages**
> \SMSGatewayMe\Client\Model\MessageSearchResult searchMessages($search)
Search messages
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\MessageApi();
$search = new \SMSGatewayMe\Client\Model\Search(); // \SMSGatewayMe\Client\Model\Search | Search Criteria
try {
$result = $api_instance->searchMessages($search);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling MessageApi->searchMessages: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**search** | [**\SMSGatewayMe\Client\Model\Search**](\SMSGatewayMe\Client\Model\Search.md)| Search Criteria | [optional]
### Return type
[**\SMSGatewayMe\Client\Model\MessageSearchResult**](MessageSearchResult.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **sendMessages**
> \SMSGatewayMe\Client\Model\Message[] sendMessages($messages)
Send messages
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
// SMSGatewayMe\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'BEARER');
$api_instance = new SMSGatewayMe\Client\Api\MessageApi();
$messages = array(new SendMessageRequest()); // \SMSGatewayMe\Client\Model\SendMessageRequest[] | messages to send
try {
$result = $api_instance->sendMessages($messages);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling MessageApi->sendMessages: ', $e->getMessage(), "\n";
}
?>
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**messages** | [**\SMSGatewayMe\Client\Model\SendMessageRequest[]**](SendMessageRequest.md)| messages to send |
### Return type
[**\SMSGatewayMe\Client\Model\Message[]**](Message.md)
### Authorization
[Authorization](../README.md#Authorization)
### HTTP reuqest headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)

View File

@@ -0,0 +1,11 @@
# MessageLog
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **string** | | [optional]
**occurredAt** | [**\DateTime**](\DateTime.md) | | [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)

View File

@@ -0,0 +1,11 @@
# MessageSearchResult
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | Total number of results | [optional]
**results** | [**\SMSGatewayMe\Client\Model\Message[]**](Message.md) | | [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)

View File

@@ -0,0 +1,13 @@
# Search
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**filters** | [**\SMSGatewayMe\Client\Model\SearchFilter[][]**](array.md) | | [optional]
**orderBy** | [**\SMSGatewayMe\Client\Model\SearchOrderBy[]**](SearchOrderBy.md) | | [optional]
**limit** | **int** | | [optional]
**offset** | **int** | | [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)

View File

@@ -0,0 +1,12 @@
# SearchFilter
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**field** | **string** | |
**operator** | **string** | |
**value** | **string** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,11 @@
# SearchOrderBy
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**field** | **string** | |
**direction** | **string** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,12 @@
# SendMessageRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**phoneNumber** | **string** | The number you wish to send the message to | [optional]
**message** | **string** | The message you wish to send | [optional]
**deviceId** | **int** | The device you wish to send the message using | [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)

View File

@@ -0,0 +1,17 @@
# UpdateCallbackRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [optional]
**event** | **string** | | [optional]
**deviceId** | **int** | | [optional]
**filterType** | **string** | | [optional]
**filter** | **string** | | [optional]
**method** | **string** | | [optional]
**action** | **string** | | [optional]
**secret** | **string** | | [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)

View File

@@ -0,0 +1,11 @@
# UpdateContactRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [optional]
**phoneNumbers** | **string[]** | | [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)