Go API client for ubill

UBill API - provides programmatic access to our resources. You will be able to integrate our service into your system and communicate with clients easily.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 2.1.8
• Package version: 0.2.0
• Generator version: 7.13.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://ubill.ge/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import ubill "github.com/ubill-ge/sdk-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value ubill.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), ubill.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value ubill.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), ubill.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using ubill.ContextOperationServerIndices and ubill.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), ubill.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), ubill.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

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

Note, each API key must be added to a map of map[string]APIKey where the key is: apiKey and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		ubill.ContextAPIKeys,
		map[string]ubill.APIKey{
			"apiKey": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Authors

• Temuri Takalandze - Maintainer