README

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/.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the package via Composer, run the following command:

composer require ubill/sdk

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: apiKey
$config = UBill\Sdk\Configuration::getDefaultConfiguration()->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	POST /sms/brandNameCreate	Create Brand Name
SmsApi	getDeliveryReport	GET /sms/report/{smsID}	Get Delivery Report
SmsApi	getSMSBalance	GET /sms/balance	Get SMS Balance
SmsApi	listBrandNames	GET /sms/brandNames	Get All Brand Names
SmsApi	sendSMS	POST /sms/send	Send SMS

Models

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:

composer install
vendor/bin/phpunit

About this package

This PHP package is automatically generated by the OpenAPI Generator 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 file for guidelines on how to contribute.

Authors

Temuri Takalandze - Maintainer

ubill / sdk

Maintainers

Details