@ubill/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @ubill/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for 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

Documentation For Models

• BaseResponse
• BrandName
• BrandNamesResponse
• CreateBrandNameRequest
• CreateBrandNameResponse
• DeliveryReportItem
• DeliveryReportResponse
• SMSBalanceResponse
• SendSMSRequest
• SendSMSResponse

Documentation For Authorization

Authentication schemes defined for the API:

apiKey

• Type: API key
• API key parameter name: key
• Location: URL query string

Authors

• Temuri Takalandze - Maintainer