Go API client for smsir

API collection for SMS.ir services including sending SMS (Bulk, LikeToLike, Verify), managing reports, checking credit, and handling received messages.

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.0.0
• Package version: 1.0.0
• Generator version: 7.20.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://sms.ir

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 smsir "github.com/sobhaann/smsir"

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

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

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to https://api.sms.ir

Class	Method	HTTP request	Description
ReceiveAPI	ReceiveArchive	Get /v1/receive/archive	Receive Archived Messages
ReceiveAPI	ReceiveLatest	Get /v1/receive/latest	Receive Latest Messages
ReceiveAPI	ReceiveLive	Get /v1/receive/live	Receive Current Day Messages
ReportsAPI	GetReportArchive	Get /v1/send/archive	Report Archived Messages
ReportsAPI	GetReportArchivePack	Get /v1/send/archive/pack	Report Archived Packs
ReportsAPI	GetReportCurrentDayPack	Get /v1/send/pack	Report Current Day Packs
ReportsAPI	GetReportLive	Get /v1/send/live	Report Live (Current Day Details)
ReportsAPI	GetReportPack	Get /v1/send/pack/{packId}	Report for Pack (Bulk)
ReportsAPI	GetReportSingle	Get /v1/send/{messageId}	Report for Single Message
SendAPI	DeleteScheduled	Delete /v1/send/scheduled/{packId}	Delete Scheduled Pack
SendAPI	SendBulk	Post /v1/send/bulk	Send Bulk SMS
SendAPI	SendLikeToLike	Post /v1/send/likeToLike	Send Like-to-Like SMS
SendAPI	SendVerify	Post /v1/send/verify	Send Verification Code (Template)
SettingsAPI	GetCredit	Get /v1/credit	Get Account Credit
SettingsAPI	GetLines	Get /v1/line	Get Lines

Documentation For Models

• CreditResponse
• DeleteScheduledResponse
• DeleteScheduledResponseData
• GenericStatus
• GetLines200Response
• GetLines200ResponseAllOfDataInner
• GetReportCurrentDayPack200Response
• GetReportPack200Response
• GetReportSingle200Response
• MessageReportItem
• PackReportItem
• ReceiveLatest200Response
• SendBulkRequest
• SendLikeToLikeRequest
• SendResponse
• SendResponseData
• VerifyResponse
• VerifyResponseData
• VerifySendRequest
• VerifySendRequestParametersInner

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

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

Example

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