refactor(spec): implement more reusable components; add descriptions (#21)

Co-authored-by: ubill-ci[bot] <214821999+ubill-ci[bot]@users.noreply.github.com>

Author: ubill-ci[bot]

.openapi-generator/FILES

@@ -16,27 +16,27 @@ configuration.ts
 docs/BaseResponse.md
 docs/BrandName.md
 docs/BrandNamesResponse.md
-docs/CreateBrandNamePayload.md
+docs/CreateBrandNameRequest.md
 docs/CreateBrandNameResponse.md
 docs/DeliveryReportItem.md
 docs/DeliveryReportResponse.md
 docs/SMSBalanceResponse.md
-docs/SMSPayload.md
+docs/SendSMSRequest.md
 docs/SendSMSResponse.md
 docs/SmsApi.md
 eslint.config.mjs
 index.ts
 model/base-response.ts
 model/brand-name.ts
 model/brand-names-response.ts
-model/create-brand-name-payload.ts
+model/create-brand-name-request.ts
 model/create-brand-name-response.ts
 model/delivery-report-item.ts
 model/delivery-report-response.ts
 model/index.ts
+model/send-smsrequest.ts
 model/send-smsresponse.ts
 model/smsbalance-response.ts
-model/smspayload.ts
 package.json
 tsconfig.esm.json
 tsconfig.json

README.md

@@ -52,23 +52,23 @@ All URIs are relative to *https://api.ubill.dev/v1*
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *SmsApi* | [**createBrandName**](docs/SmsApi.md#createbrandname) | **POST** /sms/brandNameCreate | Create Brand Name
-*SmsApi* | [**getBalance**](docs/SmsApi.md#getbalance) | **GET** /sms/balance | Get SMS Balance
-*SmsApi* | [**getBrandNames**](docs/SmsApi.md#getbrandnames) | **GET** /sms/brandNames | Get All Brand Names
 *SmsApi* | [**getDeliveryReport**](docs/SmsApi.md#getdeliveryreport) | **GET** /sms/report/{smsID} | Get Delivery Report
-*SmsApi* | [**send**](docs/SmsApi.md#send) | **POST** /sms/send | Send SMS
+*SmsApi* | [**getSMSBalance**](docs/SmsApi.md#getsmsbalance) | **GET** /sms/balance | Get SMS Balance
+*SmsApi* | [**listBrandNames**](docs/SmsApi.md#listbrandnames) | **GET** /sms/brandNames | Get All Brand Names
+*SmsApi* | [**sendSMS**](docs/SmsApi.md#sendsms) | **POST** /sms/send | Send SMS
 
 
 ### Documentation For Models
 
  - [BaseResponse](docs/BaseResponse.md)
  - [BrandName](docs/BrandName.md)
  - [BrandNamesResponse](docs/BrandNamesResponse.md)
- - [CreateBrandNamePayload](docs/CreateBrandNamePayload.md)
+ - [CreateBrandNameRequest](docs/CreateBrandNameRequest.md)
  - [CreateBrandNameResponse](docs/CreateBrandNameResponse.md)
  - [DeliveryReportItem](docs/DeliveryReportItem.md)
  - [DeliveryReportResponse](docs/DeliveryReportResponse.md)
  - [SMSBalanceResponse](docs/SMSBalanceResponse.md)
- - [SMSPayload](docs/SMSPayload.md)
+ - [SendSMSRequest](docs/SendSMSRequest.md)
  - [SendSMSResponse](docs/SendSMSResponse.md)
 
 
@@ -77,8 +77,8 @@ Class | Method | HTTP request | Description
 
 
 Authentication schemes defined for the API:
-<a id="api_key"></a>
-### api_key
+<a id="apiKey"></a>
+### apiKey
 
 - **Type**: API key
 - **API key parameter name**: key

api.ts

@@ -4,7 +4,7 @@
  * UBill API
  * UBill API - provides programmatic access to our resources. You will be able to integrate our service into your system and communicate with clients easily.
  *
- * The version of the OpenAPI document: 2.1.7
+ * The version of the OpenAPI document: 2.1.8
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

api/sms-api.ts

@@ -4,7 +4,7 @@
  * UBill API
  * UBill API - provides programmatic access to our resources. You will be able to integrate our service into your system and communicate with clients easily.
  *
- * The version of the OpenAPI document: 2.1.7
+ * The version of the OpenAPI document: 2.1.8
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

base.ts

@@ -4,7 +4,7 @@
  * UBill API
  * UBill API - provides programmatic access to our resources. You will be able to integrate our service into your system and communicate with clients easily.
  *
- * The version of the OpenAPI document: 2.1.7
+ * The version of the OpenAPI document: 2.1.8
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

common.ts

@@ -4,7 +4,7 @@
  * UBill API
  * UBill API - provides programmatic access to our resources. You will be able to integrate our service into your system and communicate with clients easily.
  *
- * The version of the OpenAPI document: 2.1.7
+ * The version of the OpenAPI document: 2.1.8
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

configuration.ts

@@ -1,14 +1,15 @@
 # BrandName
 
+SMS brand name information
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**name** | **string** |  | [default to undefined]
-**authorized** | **string** |  | [default to undefined]
-**createdAt** | **string** |  | [default to undefined]
+**id** | **string** | Brand identifier | [default to undefined]
+**name** | **string** | Brand name used as SMS sender | [default to undefined]
+**authorized** | **string** | Authorization status | [default to undefined]
+**createdAt** | **string** | Brand creation timestamp | [default to undefined]
 
 ## Example
 

docs/BrandName.md

@@ -0,0 +1,21 @@
+# CreateBrandNameRequest
+
+Request payload for creating a brand name
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**brandName** | **string** | Brand name to create | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateBrandNameRequest } from '@ubill/sdk';
+
+const instance: CreateBrandNameRequest = {
+    brandName,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/CreateBrandNameRequest.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **statusID** | **number** | Response status code | [default to undefined]
 **message** | **string** | Human-readable response message | [optional] [default to undefined]
-**brandID** | **number** | Brand identifier | [optional] [default to undefined]
+**brandID** | **number** | Brand identifier as integer | [optional] [default to undefined]
 
 ## Example