https://github.com/ubill-ge/sdk-php
PHP SDK for working with the UBill API
https://github.com/ubill-ge/sdk-php
api openapi openapi-generator openapitools php rest sdk sms ubill
Last synced: 4 months ago
JSON representation
PHP SDK for working with the UBill API
- Host: GitHub
- URL: https://github.com/ubill-ge/sdk-php
- Owner: ubill-ge
- License: mit
- Created: 2025-06-02T18:54:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-27T14:21:05.000Z (about 1 year ago)
- Last Synced: 2025-06-27T15:36:18.960Z (about 1 year ago)
- Topics: api, openapi, openapi-generator, openapitools, php, rest, sdk, sms, ubill
- Language: PHP
- Homepage: https://packagist.org/packages/ubill/sdk
- Size: 71.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# sdk-php
UBill API - provides programmatic access to our resources.
You will be able to integrate our service into your system and communicate with clients easily.
For more information, please visit [https://ubill.ge/](https://ubill.ge/).
## Installation & Usage
### Requirements
PHP 8.1 and later.
### Composer
To install the package via [Composer](https://getcomposer.org/), run the following command:
```bash
composer require ubill/sdk
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```php
setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = UBill\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');
$apiInstance = new UBill\Sdk\Api\SmsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$createBrandNameRequest = new \UBill\Sdk\Model\CreateBrandNameRequest(); // \UBill\Sdk\Model\CreateBrandNameRequest | Brand Name payload to create
try {
$result = $apiInstance->createBrandName($createBrandNameRequest);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SmsApi->createBrandName: ', $e->getMessage(), PHP_EOL;
}
```
## API Endpoints
All URIs are relative to *https://api.ubill.dev/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SmsApi* | [**createBrandName**](docs/Api/SmsApi.md#createbrandname) | **POST** /sms/brandNameCreate | Create Brand Name
*SmsApi* | [**getDeliveryReport**](docs/Api/SmsApi.md#getdeliveryreport) | **GET** /sms/report/{smsID} | Get Delivery Report
*SmsApi* | [**getSMSBalance**](docs/Api/SmsApi.md#getsmsbalance) | **GET** /sms/balance | Get SMS Balance
*SmsApi* | [**listBrandNames**](docs/Api/SmsApi.md#listbrandnames) | **GET** /sms/brandNames | Get All Brand Names
*SmsApi* | [**sendSMS**](docs/Api/SmsApi.md#sendsms) | **POST** /sms/send | Send SMS
## Models
- [BaseResponse](docs/Model/BaseResponse.md)
- [BrandName](docs/Model/BrandName.md)
- [BrandNamesResponse](docs/Model/BrandNamesResponse.md)
- [CreateBrandNameRequest](docs/Model/CreateBrandNameRequest.md)
- [CreateBrandNameResponse](docs/Model/CreateBrandNameResponse.md)
- [DeliveryReportItem](docs/Model/DeliveryReportItem.md)
- [DeliveryReportResponse](docs/Model/DeliveryReportResponse.md)
- [SMSBalanceResponse](docs/Model/SMSBalanceResponse.md)
- [SendSMSRequest](docs/Model/SendSMSRequest.md)
- [SendSMSResponse](docs/Model/SendSMSResponse.md)
## Authorization
Authentication schemes defined for the API:
### apiKey
- **Type**: API key
- **API key parameter name**: key
- **Location**: URL query string
## Tests
To run the tests, use:
```bash
composer install
vendor/bin/phpunit
```
## About this package
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: `2.1.8`
- Package version: `0.2.0`
- Generator version: `7.13.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
## Contributing
Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines on how to contribute.
## Authors
- [Temuri Takalandze](https://www.abgeo.dev) - *Maintainer*
## License
Copyright (c) 2025-present UBill.
Released under the [MIT](./LICENSE) License.