Go API client for openapi

The SMS Works provides a low-cost, reliable SMS API for developers. Pay only for delivered texts, all failed UK messages are refunded.

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: 1.9.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://thesmsworks.co.uk/contact

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 openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

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 openapi.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), openapi.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 openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://api.thesmsworks.co.uk/v1

Class	Method	HTTP request	Description
BatchMessagesAPI	BatchAnyPost	Post /batch/any
BatchMessagesAPI	BatchBatchidGet	Get /batch/{batchid}
BatchMessagesAPI	BatchSchedulePost	Post /batch/schedule
BatchMessagesAPI	BatchSendPost	Post /batch/send
BatchMessagesAPI	BatchesScheduleBatchidDelete	Delete /batches/schedule/{batchid}
CreditsAPI	CreditsBalanceGet	Get /credits/balance
MessagesAPI	MessageSchedulePost	Post /message/schedule
MessagesAPI	MessageSendPost	Post /message/send
MessagesAPI	MessagesFailedPost	Post /messages/failed
MessagesAPI	MessagesInboxPost	Post /messages/inbox
MessagesAPI	MessagesMessageidDelete	Delete /messages/{messageid}
MessagesAPI	MessagesMessageidGet	Get /messages/{messageid}
MessagesAPI	MessagesPost	Post /messages
MessagesAPI	MessagesScheduleGet	Get /messages/schedule
MessagesAPI	MessagesScheduleMessageidDelete	Delete /messages/schedule/{messageid}
MessagesAPI	SendFlashMessage	Post /message/flash
OneTimePasswordAPI	OtpMessageidGet	Get /otp/{messageid}
OneTimePasswordAPI	OtpSendPost	Post /otp/send
OneTimePasswordAPI	OtpVerifyPost	Post /otp/verify
UtilsAPI	UtilsErrorsErrorcodeGet	Get /utils/errors/{errorcode}
UtilsAPI	UtilsTestGet	Get /utils/test

Documentation For Models

• BatchMessage
• BatchMessageResponse
• CancelledMessageResponse
• CreditsResponse
• DeletedMessageResponse
• ErrorModel
• ExtendedErrorModel
• Message
• MessageMetadata
• MessageResponse
• MessageResponseFailurereason
• MetaData
• OTP
• OTPResponse
• OTPVerify
• OTPVerifyResponse
• Query
• QueryMetadata
• ScheduledBatchResponse
• ScheduledMessage
• ScheduledMessageResponse
• ScheduledMessagesResponse
• ScheduledMessagesResponseMessage
• SendMessageResponse
• TestResponse

Documentation For Authorization

Authentication schemes defined for the API:

JWT

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

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

Example

auth := context.WithValue(
		context.Background(),
		openapi.ContextAPIKeys,
		map[string]openapi.APIKey{
			"Authorization": {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

Author

support@thesmsworks.co.uk