Skip to content

Commit c1b7b77

Browse files
refactor(spec): implement more reusable components; add descriptions (#25)
Co-authored-by: ubill-ci[bot] <214821999+ubill-ci[bot]@users.noreply.github.com>
1 parent a2aeb7a commit c1b7b77

30 files changed

+1449
-259
lines changed

.openapi-generator/FILES

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ docs/Api/SmsApi.md
1212
docs/Model/BaseResponse.md
1313
docs/Model/BrandName.md
1414
docs/Model/BrandNamesResponse.md
15-
docs/Model/CreateBrandNamePayload.md
15+
docs/Model/CreateBrandNameRequest.md
1616
docs/Model/CreateBrandNameResponse.md
1717
docs/Model/DeliveryReportItem.md
1818
docs/Model/DeliveryReportResponse.md
1919
docs/Model/SMSBalanceResponse.md
20-
docs/Model/SMSPayload.md
20+
docs/Model/SendSMSRequest.md
2121
docs/Model/SendSMSResponse.md
2222
phpunit.xml.dist
2323
src/Api/SmsApi.php
@@ -28,12 +28,14 @@ src/HeaderSelector.php
2828
src/Model/BaseResponse.php
2929
src/Model/BrandName.php
3030
src/Model/BrandNamesResponse.php
31-
src/Model/CreateBrandNamePayload.php
31+
src/Model/CreateBrandNameRequest.php
3232
src/Model/CreateBrandNameResponse.php
3333
src/Model/DeliveryReportItem.php
3434
src/Model/DeliveryReportResponse.php
3535
src/Model/ModelInterface.php
3636
src/Model/SMSBalanceResponse.php
37-
src/Model/SMSPayload.php
37+
src/Model/SendSMSRequest.php
3838
src/Model/SendSMSResponse.php
3939
src/ObjectSerializer.php
40+
test/Model/CreateBrandNameRequestTest.php
41+
test/Model/SendSMSRequestTest.php

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
UBill API - provides programmatic access to our resources.
44
You will be able to integrate our service into your system and communicate with clients easily.
55

6+
For more information, please visit [https://ubill.ge/](https://ubill.ge/).
67

78
## Installation & Usage
89

@@ -28,7 +29,7 @@ require_once(__DIR__ . '/vendor/autoload.php');
2829

2930

3031

31-
// Configure API key authorization: api_key
32+
// Configure API key authorization: apiKey
3233
$config = UBill\Sdk\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
3334
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
3435
// $config = UBill\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');
@@ -40,10 +41,10 @@ $apiInstance = new UBill\Sdk\Api\SmsApi(
4041
new GuzzleHttp\Client(),
4142
$config
4243
);
43-
$createBrandNamePayload = new \UBill\Sdk\Model\CreateBrandNamePayload(); // \UBill\Sdk\Model\CreateBrandNamePayload | Brand Name payload to create
44+
$createBrandNameRequest = new \UBill\Sdk\Model\CreateBrandNameRequest(); // \UBill\Sdk\Model\CreateBrandNameRequest | Brand Name payload to create
4445

4546
try {
46-
$result = $apiInstance->createBrandName($createBrandNamePayload);
47+
$result = $apiInstance->createBrandName($createBrandNameRequest);
4748
print_r($result);
4849
} catch (Exception $e) {
4950
echo 'Exception when calling SmsApi->createBrandName: ', $e->getMessage(), PHP_EOL;
@@ -58,28 +59,28 @@ All URIs are relative to *https://api.ubill.dev/v1*
5859
Class | Method | HTTP request | Description
5960
------------ | ------------- | ------------- | -------------
6061
*SmsApi* | [**createBrandName**](docs/Api/SmsApi.md#createbrandname) | **POST** /sms/brandNameCreate | Create Brand Name
61-
*SmsApi* | [**getBalance**](docs/Api/SmsApi.md#getbalance) | **GET** /sms/balance | Get SMS Balance
62-
*SmsApi* | [**getBrandNames**](docs/Api/SmsApi.md#getbrandnames) | **GET** /sms/brandNames | Get All Brand Names
6362
*SmsApi* | [**getDeliveryReport**](docs/Api/SmsApi.md#getdeliveryreport) | **GET** /sms/report/{smsID} | Get Delivery Report
64-
*SmsApi* | [**send**](docs/Api/SmsApi.md#send) | **POST** /sms/send | Send SMS
63+
*SmsApi* | [**getSMSBalance**](docs/Api/SmsApi.md#getsmsbalance) | **GET** /sms/balance | Get SMS Balance
64+
*SmsApi* | [**listBrandNames**](docs/Api/SmsApi.md#listbrandnames) | **GET** /sms/brandNames | Get All Brand Names
65+
*SmsApi* | [**sendSMS**](docs/Api/SmsApi.md#sendsms) | **POST** /sms/send | Send SMS
6566

6667
## Models
6768

6869
- [BaseResponse](docs/Model/BaseResponse.md)
6970
- [BrandName](docs/Model/BrandName.md)
7071
- [BrandNamesResponse](docs/Model/BrandNamesResponse.md)
71-
- [CreateBrandNamePayload](docs/Model/CreateBrandNamePayload.md)
72+
- [CreateBrandNameRequest](docs/Model/CreateBrandNameRequest.md)
7273
- [CreateBrandNameResponse](docs/Model/CreateBrandNameResponse.md)
7374
- [DeliveryReportItem](docs/Model/DeliveryReportItem.md)
7475
- [DeliveryReportResponse](docs/Model/DeliveryReportResponse.md)
7576
- [SMSBalanceResponse](docs/Model/SMSBalanceResponse.md)
76-
- [SMSPayload](docs/Model/SMSPayload.md)
77+
- [SendSMSRequest](docs/Model/SendSMSRequest.md)
7778
- [SendSMSResponse](docs/Model/SendSMSResponse.md)
7879

7980
## Authorization
8081

8182
Authentication schemes defined for the API:
82-
### api_key
83+
### apiKey
8384

8485
- **Type**: API key
8586
- **API key parameter name**: key
@@ -99,7 +100,7 @@ vendor/bin/phpunit
99100

100101
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
101102

102-
- API version: `2.1.7`
103+
- API version: `2.1.8`
103104
- Package version: `0.1.1`
104105
- Generator version: `7.13.0`
105106
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`

0 commit comments

Comments
 (0)