ubill

package module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2025 License: MIT Imports: 20 Imported by: 0

README

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

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

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source
var (
	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient

type APIClient struct {
	SmsAPI SmsAPI
	// contains filtered or unexported fields
}

APIClient manages communication with the UBill API API v2.1.8 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiCreateBrandNameRequest

type ApiCreateBrandNameRequest struct {
	ApiService SmsAPI
	// contains filtered or unexported fields
}

func (ApiCreateBrandNameRequest) CreateBrandNameRequest added in v0.2.0

func (r ApiCreateBrandNameRequest) CreateBrandNameRequest(createBrandNameRequest CreateBrandNameRequest) ApiCreateBrandNameRequest

Brand Name payload to create

func (ApiCreateBrandNameRequest) Execute

type ApiGetDeliveryReportRequest

type ApiGetDeliveryReportRequest struct {
	ApiService SmsAPI
	// contains filtered or unexported fields
}

func (ApiGetDeliveryReportRequest) Execute

type ApiGetSMSBalanceRequest added in v0.2.0

type ApiGetSMSBalanceRequest struct {
	ApiService SmsAPI
	// contains filtered or unexported fields
}

func (ApiGetSMSBalanceRequest) Execute added in v0.2.0

type ApiListBrandNamesRequest added in v0.2.0

type ApiListBrandNamesRequest struct {
	ApiService SmsAPI
	// contains filtered or unexported fields
}

func (ApiListBrandNamesRequest) Execute added in v0.2.0

type ApiSendSMSRequest added in v0.2.0

type ApiSendSMSRequest struct {
	ApiService SmsAPI
	// contains filtered or unexported fields
}

func (ApiSendSMSRequest) Execute added in v0.2.0

func (ApiSendSMSRequest) SendSMSRequest added in v0.2.0

func (r ApiSendSMSRequest) SendSMSRequest(sendSMSRequest SendSMSRequest) ApiSendSMSRequest

SMS payload for sending messages

type BaseResponse

type BaseResponse struct {
	// Response status code
	StatusID int64 `json:"statusID"`
	// Human-readable response message
	Message *string `json:"message,omitempty"`
}

BaseResponse struct for BaseResponse

func NewBaseResponse

func NewBaseResponse(statusID int64) *BaseResponse

NewBaseResponse instantiates a new BaseResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBaseResponseWithDefaults

func NewBaseResponseWithDefaults() *BaseResponse

NewBaseResponseWithDefaults instantiates a new BaseResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BaseResponse) GetMessage

func (o *BaseResponse) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*BaseResponse) GetMessageOk

func (o *BaseResponse) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseResponse) GetStatusID

func (o *BaseResponse) GetStatusID() int64

GetStatusID returns the StatusID field value

func (*BaseResponse) GetStatusIDOk

func (o *BaseResponse) GetStatusIDOk() (*int64, bool)

GetStatusIDOk returns a tuple with the StatusID field value and a boolean to check if the value has been set.

func (*BaseResponse) HasMessage

func (o *BaseResponse) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (BaseResponse) MarshalJSON

func (o BaseResponse) MarshalJSON() ([]byte, error)

func (*BaseResponse) SetMessage

func (o *BaseResponse) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*BaseResponse) SetStatusID

func (o *BaseResponse) SetStatusID(v int64)

SetStatusID sets field value

func (BaseResponse) ToMap

func (o BaseResponse) ToMap() (map[string]interface{}, error)

func (*BaseResponse) UnmarshalJSON

func (o *BaseResponse) UnmarshalJSON(data []byte) (err error)

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BrandName

type BrandName struct {
	// Brand identifier
	Id string `json:"id"`
	// Brand name used as SMS sender
	Name string `json:"name"`
	// Authorization status
	Authorized string `json:"authorized"`
	// Brand creation timestamp
	CreatedAt string `json:"createdAt"`
}

BrandName SMS brand name information

func NewBrandName

func NewBrandName(id string, name string, authorized string, createdAt string) *BrandName

NewBrandName instantiates a new BrandName object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBrandNameWithDefaults

func NewBrandNameWithDefaults() *BrandName

NewBrandNameWithDefaults instantiates a new BrandName object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BrandName) GetAuthorized

func (o *BrandName) GetAuthorized() string

GetAuthorized returns the Authorized field value

func (*BrandName) GetAuthorizedOk

func (o *BrandName) GetAuthorizedOk() (*string, bool)

GetAuthorizedOk returns a tuple with the Authorized field value and a boolean to check if the value has been set.

func (*BrandName) GetCreatedAt

func (o *BrandName) GetCreatedAt() string

GetCreatedAt returns the CreatedAt field value

func (*BrandName) GetCreatedAtOk

func (o *BrandName) GetCreatedAtOk() (*string, bool)

GetCreatedAtOk returns a tuple with the CreatedAt field value and a boolean to check if the value has been set.

func (*BrandName) GetId

func (o *BrandName) GetId() string

GetId returns the Id field value

func (*BrandName) GetIdOk

func (o *BrandName) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*BrandName) GetName

func (o *BrandName) GetName() string

GetName returns the Name field value

func (*BrandName) GetNameOk

func (o *BrandName) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (BrandName) MarshalJSON

func (o BrandName) MarshalJSON() ([]byte, error)

func (*BrandName) SetAuthorized

func (o *BrandName) SetAuthorized(v string)

SetAuthorized sets field value

func (*BrandName) SetCreatedAt

func (o *BrandName) SetCreatedAt(v string)

SetCreatedAt sets field value

func (*BrandName) SetId

func (o *BrandName) SetId(v string)

SetId sets field value

func (*BrandName) SetName

func (o *BrandName) SetName(v string)

SetName sets field value

func (BrandName) ToMap

func (o BrandName) ToMap() (map[string]interface{}, error)

func (*BrandName) UnmarshalJSON

func (o *BrandName) UnmarshalJSON(data []byte) (err error)

type BrandNamesResponse

type BrandNamesResponse struct {
	// Response status code
	StatusID int64 `json:"statusID"`
	// Human-readable response message
	Message *string `json:"message,omitempty"`
	// List of available brand names
	Brands []BrandName `json:"brands"`
}

BrandNamesResponse struct for BrandNamesResponse

func NewBrandNamesResponse

func NewBrandNamesResponse(statusID int64, brands []BrandName) *BrandNamesResponse

NewBrandNamesResponse instantiates a new BrandNamesResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBrandNamesResponseWithDefaults

func NewBrandNamesResponseWithDefaults() *BrandNamesResponse

NewBrandNamesResponseWithDefaults instantiates a new BrandNamesResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BrandNamesResponse) GetBrands

func (o *BrandNamesResponse) GetBrands() []BrandName

GetBrands returns the Brands field value

func (*BrandNamesResponse) GetBrandsOk

func (o *BrandNamesResponse) GetBrandsOk() ([]BrandName, bool)

GetBrandsOk returns a tuple with the Brands field value and a boolean to check if the value has been set.

func (*BrandNamesResponse) GetMessage

func (o *BrandNamesResponse) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*BrandNamesResponse) GetMessageOk

func (o *BrandNamesResponse) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BrandNamesResponse) GetStatusID

func (o *BrandNamesResponse) GetStatusID() int64

GetStatusID returns the StatusID field value

func (*BrandNamesResponse) GetStatusIDOk

func (o *BrandNamesResponse) GetStatusIDOk() (*int64, bool)

GetStatusIDOk returns a tuple with the StatusID field value and a boolean to check if the value has been set.

func (*BrandNamesResponse) HasMessage

func (o *BrandNamesResponse) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (BrandNamesResponse) MarshalJSON

func (o BrandNamesResponse) MarshalJSON() ([]byte, error)

func (*BrandNamesResponse) SetBrands

func (o *BrandNamesResponse) SetBrands(v []BrandName)

SetBrands sets field value

func (*BrandNamesResponse) SetMessage

func (o *BrandNamesResponse) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*BrandNamesResponse) SetStatusID

func (o *BrandNamesResponse) SetStatusID(v int64)

SetStatusID sets field value

func (BrandNamesResponse) ToMap

func (o BrandNamesResponse) ToMap() (map[string]interface{}, error)

func (*BrandNamesResponse) UnmarshalJSON

func (o *BrandNamesResponse) UnmarshalJSON(data []byte) (err error)

type Configuration

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type CreateBrandNamePayload

type CreateBrandNamePayload struct {
	BrandName string `json:"brandName"`
}

CreateBrandNamePayload struct for CreateBrandNamePayload

func NewCreateBrandNamePayload

func NewCreateBrandNamePayload(brandName string) *CreateBrandNamePayload

NewCreateBrandNamePayload instantiates a new CreateBrandNamePayload object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateBrandNamePayloadWithDefaults

func NewCreateBrandNamePayloadWithDefaults() *CreateBrandNamePayload

NewCreateBrandNamePayloadWithDefaults instantiates a new CreateBrandNamePayload object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateBrandNamePayload) GetBrandName

func (o *CreateBrandNamePayload) GetBrandName() string

GetBrandName returns the BrandName field value

func (*CreateBrandNamePayload) GetBrandNameOk

func (o *CreateBrandNamePayload) GetBrandNameOk() (*string, bool)

GetBrandNameOk returns a tuple with the BrandName field value and a boolean to check if the value has been set.

func (CreateBrandNamePayload) MarshalJSON

func (o CreateBrandNamePayload) MarshalJSON() ([]byte, error)

func (*CreateBrandNamePayload) SetBrandName

func (o *CreateBrandNamePayload) SetBrandName(v string)

SetBrandName sets field value

func (CreateBrandNamePayload) ToMap

func (o CreateBrandNamePayload) ToMap() (map[string]interface{}, error)

func (*CreateBrandNamePayload) UnmarshalJSON

func (o *CreateBrandNamePayload) UnmarshalJSON(data []byte) (err error)

type CreateBrandNameRequest added in v0.2.0

type CreateBrandNameRequest struct {
	// Brand name to create
	BrandName string `json:"brandName"`
}

CreateBrandNameRequest Request payload for creating a brand name

func NewCreateBrandNameRequest added in v0.2.0

func NewCreateBrandNameRequest(brandName string) *CreateBrandNameRequest

NewCreateBrandNameRequest instantiates a new CreateBrandNameRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateBrandNameRequestWithDefaults added in v0.2.0

func NewCreateBrandNameRequestWithDefaults() *CreateBrandNameRequest

NewCreateBrandNameRequestWithDefaults instantiates a new CreateBrandNameRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateBrandNameRequest) GetBrandName added in v0.2.0

func (o *CreateBrandNameRequest) GetBrandName() string

GetBrandName returns the BrandName field value

func (*CreateBrandNameRequest) GetBrandNameOk added in v0.2.0

func (o *CreateBrandNameRequest) GetBrandNameOk() (*string, bool)

GetBrandNameOk returns a tuple with the BrandName field value and a boolean to check if the value has been set.

func (CreateBrandNameRequest) MarshalJSON added in v0.2.0

func (o CreateBrandNameRequest) MarshalJSON() ([]byte, error)

func (*CreateBrandNameRequest) SetBrandName added in v0.2.0

func (o *CreateBrandNameRequest) SetBrandName(v string)

SetBrandName sets field value

func (CreateBrandNameRequest) ToMap added in v0.2.0

func (o CreateBrandNameRequest) ToMap() (map[string]interface{}, error)

func (*CreateBrandNameRequest) UnmarshalJSON added in v0.2.0

func (o *CreateBrandNameRequest) UnmarshalJSON(data []byte) (err error)

type CreateBrandNameResponse

type CreateBrandNameResponse struct {
	// Response status code
	StatusID int64 `json:"statusID"`
	// Human-readable response message
	Message *string `json:"message,omitempty"`
	// Brand identifier as integer
	BrandID *int64 `json:"brandID,omitempty"`
}

CreateBrandNameResponse struct for CreateBrandNameResponse

func NewCreateBrandNameResponse

func NewCreateBrandNameResponse(statusID int64) *CreateBrandNameResponse

NewCreateBrandNameResponse instantiates a new CreateBrandNameResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCreateBrandNameResponseWithDefaults

func NewCreateBrandNameResponseWithDefaults() *CreateBrandNameResponse

NewCreateBrandNameResponseWithDefaults instantiates a new CreateBrandNameResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CreateBrandNameResponse) GetBrandID

func (o *CreateBrandNameResponse) GetBrandID() int64

GetBrandID returns the BrandID field value if set, zero value otherwise.

func (*CreateBrandNameResponse) GetBrandIDOk

func (o *CreateBrandNameResponse) GetBrandIDOk() (*int64, bool)

GetBrandIDOk returns a tuple with the BrandID field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreateBrandNameResponse) GetMessage

func (o *CreateBrandNameResponse) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*CreateBrandNameResponse) GetMessageOk

func (o *CreateBrandNameResponse) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CreateBrandNameResponse) GetStatusID

func (o *CreateBrandNameResponse) GetStatusID() int64

GetStatusID returns the StatusID field value

func (*CreateBrandNameResponse) GetStatusIDOk

func (o *CreateBrandNameResponse) GetStatusIDOk() (*int64, bool)

GetStatusIDOk returns a tuple with the StatusID field value and a boolean to check if the value has been set.

func (*CreateBrandNameResponse) HasBrandID

func (o *CreateBrandNameResponse) HasBrandID() bool

HasBrandID returns a boolean if a field has been set.

func (*CreateBrandNameResponse) HasMessage

func (o *CreateBrandNameResponse) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (CreateBrandNameResponse) MarshalJSON

func (o CreateBrandNameResponse) MarshalJSON() ([]byte, error)

func (*CreateBrandNameResponse) SetBrandID

func (o *CreateBrandNameResponse) SetBrandID(v int64)

SetBrandID gets a reference to the given int64 and assigns it to the BrandID field.

func (*CreateBrandNameResponse) SetMessage

func (o *CreateBrandNameResponse) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*CreateBrandNameResponse) SetStatusID

func (o *CreateBrandNameResponse) SetStatusID(v int64)

SetStatusID sets field value

func (CreateBrandNameResponse) ToMap

func (o CreateBrandNameResponse) ToMap() (map[string]interface{}, error)

func (*CreateBrandNameResponse) UnmarshalJSON

func (o *CreateBrandNameResponse) UnmarshalJSON(data []byte) (err error)

type DeliveryReportItem

type DeliveryReportItem struct {
	// Phone number as string
	Number string `json:"number"`
	// Delivery status as string
	StatusID string `json:"statusID"`
}

DeliveryReportItem SMS delivery status for a phone number

func NewDeliveryReportItem

func NewDeliveryReportItem(number string, statusID string) *DeliveryReportItem

NewDeliveryReportItem instantiates a new DeliveryReportItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDeliveryReportItemWithDefaults

func NewDeliveryReportItemWithDefaults() *DeliveryReportItem

NewDeliveryReportItemWithDefaults instantiates a new DeliveryReportItem object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DeliveryReportItem) GetNumber

func (o *DeliveryReportItem) GetNumber() string

GetNumber returns the Number field value

func (*DeliveryReportItem) GetNumberOk

func (o *DeliveryReportItem) GetNumberOk() (*string, bool)

GetNumberOk returns a tuple with the Number field value and a boolean to check if the value has been set.

func (*DeliveryReportItem) GetStatusID

func (o *DeliveryReportItem) GetStatusID() string

GetStatusID returns the StatusID field value

func (*DeliveryReportItem) GetStatusIDOk

func (o *DeliveryReportItem) GetStatusIDOk() (*string, bool)

GetStatusIDOk returns a tuple with the StatusID field value and a boolean to check if the value has been set.

func (DeliveryReportItem) MarshalJSON

func (o DeliveryReportItem) MarshalJSON() ([]byte, error)

func (*DeliveryReportItem) SetNumber

func (o *DeliveryReportItem) SetNumber(v string)

SetNumber sets field value

func (*DeliveryReportItem) SetStatusID

func (o *DeliveryReportItem) SetStatusID(v string)

SetStatusID sets field value

func (DeliveryReportItem) ToMap

func (o DeliveryReportItem) ToMap() (map[string]interface{}, error)

func (*DeliveryReportItem) UnmarshalJSON added in v0.2.0

func (o *DeliveryReportItem) UnmarshalJSON(data []byte) (err error)

type DeliveryReportResponse

type DeliveryReportResponse struct {
	// Response status code
	StatusID int64 `json:"statusID"`
	// Human-readable response message
	Message *string `json:"message,omitempty"`
	// Delivery report results
	Result []DeliveryReportItem `json:"result,omitempty"`
}

DeliveryReportResponse struct for DeliveryReportResponse

func NewDeliveryReportResponse

func NewDeliveryReportResponse(statusID int64) *DeliveryReportResponse

NewDeliveryReportResponse instantiates a new DeliveryReportResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDeliveryReportResponseWithDefaults

func NewDeliveryReportResponseWithDefaults() *DeliveryReportResponse

NewDeliveryReportResponseWithDefaults instantiates a new DeliveryReportResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DeliveryReportResponse) GetMessage

func (o *DeliveryReportResponse) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*DeliveryReportResponse) GetMessageOk

func (o *DeliveryReportResponse) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DeliveryReportResponse) GetResult

func (o *DeliveryReportResponse) GetResult() []DeliveryReportItem

GetResult returns the Result field value if set, zero value otherwise.

func (*DeliveryReportResponse) GetResultOk

func (o *DeliveryReportResponse) GetResultOk() ([]DeliveryReportItem, bool)

GetResultOk returns a tuple with the Result field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DeliveryReportResponse) GetStatusID

func (o *DeliveryReportResponse) GetStatusID() int64

GetStatusID returns the StatusID field value

func (*DeliveryReportResponse) GetStatusIDOk

func (o *DeliveryReportResponse) GetStatusIDOk() (*int64, bool)

GetStatusIDOk returns a tuple with the StatusID field value and a boolean to check if the value has been set.

func (*DeliveryReportResponse) HasMessage

func (o *DeliveryReportResponse) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*DeliveryReportResponse) HasResult

func (o *DeliveryReportResponse) HasResult() bool

HasResult returns a boolean if a field has been set.

func (DeliveryReportResponse) MarshalJSON

func (o DeliveryReportResponse) MarshalJSON() ([]byte, error)

func (*DeliveryReportResponse) SetMessage

func (o *DeliveryReportResponse) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*DeliveryReportResponse) SetResult

func (o *DeliveryReportResponse) SetResult(v []DeliveryReportItem)

SetResult gets a reference to the given []DeliveryReportItem and assigns it to the Result field.

func (*DeliveryReportResponse) SetStatusID

func (o *DeliveryReportResponse) SetStatusID(v int64)

SetStatusID sets field value

func (DeliveryReportResponse) ToMap

func (o DeliveryReportResponse) ToMap() (map[string]interface{}, error)

func (*DeliveryReportResponse) UnmarshalJSON

func (o *DeliveryReportResponse) UnmarshalJSON(data []byte) (err error)

type GenericOpenAPIError

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type MappedNullable

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type NullableBaseResponse

type NullableBaseResponse struct {
	// contains filtered or unexported fields
}

func NewNullableBaseResponse

func NewNullableBaseResponse(val *BaseResponse) *NullableBaseResponse

func (NullableBaseResponse) Get

func (NullableBaseResponse) IsSet

func (v NullableBaseResponse) IsSet() bool

func (NullableBaseResponse) MarshalJSON

func (v NullableBaseResponse) MarshalJSON() ([]byte, error)

func (*NullableBaseResponse) Set

func (v *NullableBaseResponse) Set(val *BaseResponse)

func (*NullableBaseResponse) UnmarshalJSON

func (v *NullableBaseResponse) UnmarshalJSON(src []byte) error

func (*NullableBaseResponse) Unset

func (v *NullableBaseResponse) Unset()

type NullableBool

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get

func (v NullableBool) Get() *bool

func (NullableBool) IsSet

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset

func (v *NullableBool) Unset()

type NullableBrandName

type NullableBrandName struct {
	// contains filtered or unexported fields
}

func NewNullableBrandName

func NewNullableBrandName(val *BrandName) *NullableBrandName

func (NullableBrandName) Get

func (v NullableBrandName) Get() *BrandName

func (NullableBrandName) IsSet

func (v NullableBrandName) IsSet() bool

func (NullableBrandName) MarshalJSON

func (v NullableBrandName) MarshalJSON() ([]byte, error)

func (*NullableBrandName) Set

func (v *NullableBrandName) Set(val *BrandName)

func (*NullableBrandName) UnmarshalJSON

func (v *NullableBrandName) UnmarshalJSON(src []byte) error

func (*NullableBrandName) Unset

func (v *NullableBrandName) Unset()

type NullableBrandNamesResponse

type NullableBrandNamesResponse struct {
	// contains filtered or unexported fields
}

func NewNullableBrandNamesResponse

func NewNullableBrandNamesResponse(val *BrandNamesResponse) *NullableBrandNamesResponse

func (NullableBrandNamesResponse) Get

func (NullableBrandNamesResponse) IsSet

func (v NullableBrandNamesResponse) IsSet() bool

func (NullableBrandNamesResponse) MarshalJSON

func (v NullableBrandNamesResponse) MarshalJSON() ([]byte, error)

func (*NullableBrandNamesResponse) Set

func (*NullableBrandNamesResponse) UnmarshalJSON

func (v *NullableBrandNamesResponse) UnmarshalJSON(src []byte) error

func (*NullableBrandNamesResponse) Unset

func (v *NullableBrandNamesResponse) Unset()

type NullableCreateBrandNamePayload

type NullableCreateBrandNamePayload struct {
	// contains filtered or unexported fields
}

func (NullableCreateBrandNamePayload) Get

func (NullableCreateBrandNamePayload) IsSet

func (NullableCreateBrandNamePayload) MarshalJSON

func (v NullableCreateBrandNamePayload) MarshalJSON() ([]byte, error)

func (*NullableCreateBrandNamePayload) Set

func (*NullableCreateBrandNamePayload) UnmarshalJSON

func (v *NullableCreateBrandNamePayload) UnmarshalJSON(src []byte) error

func (*NullableCreateBrandNamePayload) Unset

func (v *NullableCreateBrandNamePayload) Unset()

type NullableCreateBrandNameRequest added in v0.2.0

type NullableCreateBrandNameRequest struct {
	// contains filtered or unexported fields
}

func NewNullableCreateBrandNameRequest added in v0.2.0

func NewNullableCreateBrandNameRequest(val *CreateBrandNameRequest) *NullableCreateBrandNameRequest

func (NullableCreateBrandNameRequest) Get added in v0.2.0

func (NullableCreateBrandNameRequest) IsSet added in v0.2.0

func (NullableCreateBrandNameRequest) MarshalJSON added in v0.2.0

func (v NullableCreateBrandNameRequest) MarshalJSON() ([]byte, error)

func (*NullableCreateBrandNameRequest) Set added in v0.2.0

func (*NullableCreateBrandNameRequest) UnmarshalJSON added in v0.2.0

func (v *NullableCreateBrandNameRequest) UnmarshalJSON(src []byte) error

func (*NullableCreateBrandNameRequest) Unset added in v0.2.0

func (v *NullableCreateBrandNameRequest) Unset()

type NullableCreateBrandNameResponse

type NullableCreateBrandNameResponse struct {
	// contains filtered or unexported fields
}

func (NullableCreateBrandNameResponse) Get

func (NullableCreateBrandNameResponse) IsSet

func (NullableCreateBrandNameResponse) MarshalJSON

func (v NullableCreateBrandNameResponse) MarshalJSON() ([]byte, error)

func (*NullableCreateBrandNameResponse) Set

func (*NullableCreateBrandNameResponse) UnmarshalJSON

func (v *NullableCreateBrandNameResponse) UnmarshalJSON(src []byte) error

func (*NullableCreateBrandNameResponse) Unset

type NullableDeliveryReportItem

type NullableDeliveryReportItem struct {
	// contains filtered or unexported fields
}

func NewNullableDeliveryReportItem

func NewNullableDeliveryReportItem(val *DeliveryReportItem) *NullableDeliveryReportItem

func (NullableDeliveryReportItem) Get

func (NullableDeliveryReportItem) IsSet

func (v NullableDeliveryReportItem) IsSet() bool

func (NullableDeliveryReportItem) MarshalJSON

func (v NullableDeliveryReportItem) MarshalJSON() ([]byte, error)

func (*NullableDeliveryReportItem) Set

func (*NullableDeliveryReportItem) UnmarshalJSON

func (v *NullableDeliveryReportItem) UnmarshalJSON(src []byte) error

func (*NullableDeliveryReportItem) Unset

func (v *NullableDeliveryReportItem) Unset()

type NullableDeliveryReportResponse

type NullableDeliveryReportResponse struct {
	// contains filtered or unexported fields
}

func (NullableDeliveryReportResponse) Get

func (NullableDeliveryReportResponse) IsSet

func (NullableDeliveryReportResponse) MarshalJSON

func (v NullableDeliveryReportResponse) MarshalJSON() ([]byte, error)

func (*NullableDeliveryReportResponse) Set

func (*NullableDeliveryReportResponse) UnmarshalJSON

func (v *NullableDeliveryReportResponse) UnmarshalJSON(src []byte) error

func (*NullableDeliveryReportResponse) Unset

func (v *NullableDeliveryReportResponse) Unset()

type NullableFloat32

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset

func (v *NullableFloat32) Unset()

type NullableFloat64

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset

func (v *NullableFloat64) Unset()

type NullableInt

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get

func (v NullableInt) Get() *int

func (NullableInt) IsSet

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset

func (v *NullableInt) Unset()

type NullableInt32

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset

func (v *NullableInt32) Unset()

type NullableInt64

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset

func (v *NullableInt64) Unset()

type NullableSMSBalanceResponse

type NullableSMSBalanceResponse struct {
	// contains filtered or unexported fields
}

func NewNullableSMSBalanceResponse

func NewNullableSMSBalanceResponse(val *SMSBalanceResponse) *NullableSMSBalanceResponse

func (NullableSMSBalanceResponse) Get

func (NullableSMSBalanceResponse) IsSet

func (v NullableSMSBalanceResponse) IsSet() bool

func (NullableSMSBalanceResponse) MarshalJSON

func (v NullableSMSBalanceResponse) MarshalJSON() ([]byte, error)

func (*NullableSMSBalanceResponse) Set

func (*NullableSMSBalanceResponse) UnmarshalJSON

func (v *NullableSMSBalanceResponse) UnmarshalJSON(src []byte) error

func (*NullableSMSBalanceResponse) Unset

func (v *NullableSMSBalanceResponse) Unset()

type NullableSMSPayload

type NullableSMSPayload struct {
	// contains filtered or unexported fields
}

func NewNullableSMSPayload

func NewNullableSMSPayload(val *SMSPayload) *NullableSMSPayload

func (NullableSMSPayload) Get

func (v NullableSMSPayload) Get() *SMSPayload

func (NullableSMSPayload) IsSet

func (v NullableSMSPayload) IsSet() bool

func (NullableSMSPayload) MarshalJSON

func (v NullableSMSPayload) MarshalJSON() ([]byte, error)

func (*NullableSMSPayload) Set

func (v *NullableSMSPayload) Set(val *SMSPayload)

func (*NullableSMSPayload) UnmarshalJSON

func (v *NullableSMSPayload) UnmarshalJSON(src []byte) error

func (*NullableSMSPayload) Unset

func (v *NullableSMSPayload) Unset()

type NullableSendSMSRequest added in v0.2.0

type NullableSendSMSRequest struct {
	// contains filtered or unexported fields
}

func NewNullableSendSMSRequest added in v0.2.0

func NewNullableSendSMSRequest(val *SendSMSRequest) *NullableSendSMSRequest

func (NullableSendSMSRequest) Get added in v0.2.0

func (NullableSendSMSRequest) IsSet added in v0.2.0

func (v NullableSendSMSRequest) IsSet() bool

func (NullableSendSMSRequest) MarshalJSON added in v0.2.0

func (v NullableSendSMSRequest) MarshalJSON() ([]byte, error)

func (*NullableSendSMSRequest) Set added in v0.2.0

func (*NullableSendSMSRequest) UnmarshalJSON added in v0.2.0

func (v *NullableSendSMSRequest) UnmarshalJSON(src []byte) error

func (*NullableSendSMSRequest) Unset added in v0.2.0

func (v *NullableSendSMSRequest) Unset()

type NullableSendSMSResponse

type NullableSendSMSResponse struct {
	// contains filtered or unexported fields
}

func NewNullableSendSMSResponse

func NewNullableSendSMSResponse(val *SendSMSResponse) *NullableSendSMSResponse

func (NullableSendSMSResponse) Get

func (NullableSendSMSResponse) IsSet

func (v NullableSendSMSResponse) IsSet() bool

func (NullableSendSMSResponse) MarshalJSON

func (v NullableSendSMSResponse) MarshalJSON() ([]byte, error)

func (*NullableSendSMSResponse) Set

func (*NullableSendSMSResponse) UnmarshalJSON

func (v *NullableSendSMSResponse) UnmarshalJSON(src []byte) error

func (*NullableSendSMSResponse) Unset

func (v *NullableSendSMSResponse) Unset()

type NullableString

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString

func NewNullableString(val *string) *NullableString

func (NullableString) Get

func (v NullableString) Get() *string

func (NullableString) IsSet

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset

func (v *NullableString) Unset()

type NullableTime

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset

func (v *NullableTime) Unset()

type SMSBalanceResponse

type SMSBalanceResponse struct {
	// Response status code
	StatusID int64 `json:"statusID"`
	// Human-readable response message
	Message *string `json:"message,omitempty"`
	// SMS balance as string
	Sms *string `json:"sms,omitempty"`
}

SMSBalanceResponse struct for SMSBalanceResponse

func NewSMSBalanceResponse

func NewSMSBalanceResponse(statusID int64) *SMSBalanceResponse

NewSMSBalanceResponse instantiates a new SMSBalanceResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSMSBalanceResponseWithDefaults

func NewSMSBalanceResponseWithDefaults() *SMSBalanceResponse

NewSMSBalanceResponseWithDefaults instantiates a new SMSBalanceResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SMSBalanceResponse) GetMessage

func (o *SMSBalanceResponse) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*SMSBalanceResponse) GetMessageOk

func (o *SMSBalanceResponse) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SMSBalanceResponse) GetSms

func (o *SMSBalanceResponse) GetSms() string

GetSms returns the Sms field value if set, zero value otherwise.

func (*SMSBalanceResponse) GetSmsOk

func (o *SMSBalanceResponse) GetSmsOk() (*string, bool)

GetSmsOk returns a tuple with the Sms field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SMSBalanceResponse) GetStatusID

func (o *SMSBalanceResponse) GetStatusID() int64

GetStatusID returns the StatusID field value

func (*SMSBalanceResponse) GetStatusIDOk

func (o *SMSBalanceResponse) GetStatusIDOk() (*int64, bool)

GetStatusIDOk returns a tuple with the StatusID field value and a boolean to check if the value has been set.

func (*SMSBalanceResponse) HasMessage

func (o *SMSBalanceResponse) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*SMSBalanceResponse) HasSms

func (o *SMSBalanceResponse) HasSms() bool

HasSms returns a boolean if a field has been set.

func (SMSBalanceResponse) MarshalJSON

func (o SMSBalanceResponse) MarshalJSON() ([]byte, error)

func (*SMSBalanceResponse) SetMessage

func (o *SMSBalanceResponse) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*SMSBalanceResponse) SetSms

func (o *SMSBalanceResponse) SetSms(v string)

SetSms gets a reference to the given string and assigns it to the Sms field.

func (*SMSBalanceResponse) SetStatusID

func (o *SMSBalanceResponse) SetStatusID(v int64)

SetStatusID sets field value

func (SMSBalanceResponse) ToMap

func (o SMSBalanceResponse) ToMap() (map[string]interface{}, error)

func (*SMSBalanceResponse) UnmarshalJSON

func (o *SMSBalanceResponse) UnmarshalJSON(data []byte) (err error)

type SMSPayload

type SMSPayload struct {
	BrandID int64   `json:"brandID"`
	Numbers []int64 `json:"numbers"`
	Text    string  `json:"text"`
	// Enable/disable checking numbers in the stop list
	StopList bool `json:"stopList"`
}

SMSPayload struct for SMSPayload

func NewSMSPayload

func NewSMSPayload(brandID int64, numbers []int64, text string, stopList bool) *SMSPayload

NewSMSPayload instantiates a new SMSPayload object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSMSPayloadWithDefaults

func NewSMSPayloadWithDefaults() *SMSPayload

NewSMSPayloadWithDefaults instantiates a new SMSPayload object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SMSPayload) GetBrandID

func (o *SMSPayload) GetBrandID() int64

GetBrandID returns the BrandID field value

func (*SMSPayload) GetBrandIDOk

func (o *SMSPayload) GetBrandIDOk() (*int64, bool)

GetBrandIDOk returns a tuple with the BrandID field value and a boolean to check if the value has been set.

func (*SMSPayload) GetNumbers

func (o *SMSPayload) GetNumbers() []int64

GetNumbers returns the Numbers field value

func (*SMSPayload) GetNumbersOk

func (o *SMSPayload) GetNumbersOk() ([]int64, bool)

GetNumbersOk returns a tuple with the Numbers field value and a boolean to check if the value has been set.

func (*SMSPayload) GetStopList

func (o *SMSPayload) GetStopList() bool

GetStopList returns the StopList field value

func (*SMSPayload) GetStopListOk

func (o *SMSPayload) GetStopListOk() (*bool, bool)

GetStopListOk returns a tuple with the StopList field value and a boolean to check if the value has been set.

func (*SMSPayload) GetText

func (o *SMSPayload) GetText() string

GetText returns the Text field value

func (*SMSPayload) GetTextOk

func (o *SMSPayload) GetTextOk() (*string, bool)

GetTextOk returns a tuple with the Text field value and a boolean to check if the value has been set.

func (SMSPayload) MarshalJSON

func (o SMSPayload) MarshalJSON() ([]byte, error)

func (*SMSPayload) SetBrandID

func (o *SMSPayload) SetBrandID(v int64)

SetBrandID sets field value

func (*SMSPayload) SetNumbers

func (o *SMSPayload) SetNumbers(v []int64)

SetNumbers sets field value

func (*SMSPayload) SetStopList

func (o *SMSPayload) SetStopList(v bool)

SetStopList sets field value

func (*SMSPayload) SetText

func (o *SMSPayload) SetText(v string)

SetText sets field value

func (SMSPayload) ToMap

func (o SMSPayload) ToMap() (map[string]interface{}, error)

func (*SMSPayload) UnmarshalJSON

func (o *SMSPayload) UnmarshalJSON(data []byte) (err error)

type SendSMSRequest added in v0.2.0

type SendSMSRequest struct {
	// Brand identifier as integer
	BrandID int64 `json:"brandID"`
	// Array of phone numbers as integers
	Numbers []int64 `json:"numbers"`
	// SMS message text
	Text string `json:"text"`
	// Enable/disable checking numbers in the stop list
	StopList bool `json:"stopList"`
}

SendSMSRequest Request payload for sending SMS

func NewSendSMSRequest added in v0.2.0

func NewSendSMSRequest(brandID int64, numbers []int64, text string, stopList bool) *SendSMSRequest

NewSendSMSRequest instantiates a new SendSMSRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSendSMSRequestWithDefaults added in v0.2.0

func NewSendSMSRequestWithDefaults() *SendSMSRequest

NewSendSMSRequestWithDefaults instantiates a new SendSMSRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SendSMSRequest) GetBrandID added in v0.2.0

func (o *SendSMSRequest) GetBrandID() int64

GetBrandID returns the BrandID field value

func (*SendSMSRequest) GetBrandIDOk added in v0.2.0

func (o *SendSMSRequest) GetBrandIDOk() (*int64, bool)

GetBrandIDOk returns a tuple with the BrandID field value and a boolean to check if the value has been set.

func (*SendSMSRequest) GetNumbers added in v0.2.0

func (o *SendSMSRequest) GetNumbers() []int64

GetNumbers returns the Numbers field value

func (*SendSMSRequest) GetNumbersOk added in v0.2.0

func (o *SendSMSRequest) GetNumbersOk() ([]int64, bool)

GetNumbersOk returns a tuple with the Numbers field value and a boolean to check if the value has been set.

func (*SendSMSRequest) GetStopList added in v0.2.0

func (o *SendSMSRequest) GetStopList() bool

GetStopList returns the StopList field value

func (*SendSMSRequest) GetStopListOk added in v0.2.0

func (o *SendSMSRequest) GetStopListOk() (*bool, bool)

GetStopListOk returns a tuple with the StopList field value and a boolean to check if the value has been set.

func (*SendSMSRequest) GetText added in v0.2.0

func (o *SendSMSRequest) GetText() string

GetText returns the Text field value

func (*SendSMSRequest) GetTextOk added in v0.2.0

func (o *SendSMSRequest) GetTextOk() (*string, bool)

GetTextOk returns a tuple with the Text field value and a boolean to check if the value has been set.

func (SendSMSRequest) MarshalJSON added in v0.2.0

func (o SendSMSRequest) MarshalJSON() ([]byte, error)

func (*SendSMSRequest) SetBrandID added in v0.2.0

func (o *SendSMSRequest) SetBrandID(v int64)

SetBrandID sets field value

func (*SendSMSRequest) SetNumbers added in v0.2.0

func (o *SendSMSRequest) SetNumbers(v []int64)

SetNumbers sets field value

func (*SendSMSRequest) SetStopList added in v0.2.0

func (o *SendSMSRequest) SetStopList(v bool)

SetStopList sets field value

func (*SendSMSRequest) SetText added in v0.2.0

func (o *SendSMSRequest) SetText(v string)

SetText sets field value

func (SendSMSRequest) ToMap added in v0.2.0

func (o SendSMSRequest) ToMap() (map[string]interface{}, error)

func (*SendSMSRequest) UnmarshalJSON added in v0.2.0

func (o *SendSMSRequest) UnmarshalJSON(data []byte) (err error)

type SendSMSResponse

type SendSMSResponse struct {
	// Response status code
	StatusID int64 `json:"statusID"`
	// Human-readable response message
	Message *string `json:"message,omitempty"`
	// SMS identifier as string
	SmsID *string `json:"smsID,omitempty"`
}

SendSMSResponse struct for SendSMSResponse

func NewSendSMSResponse

func NewSendSMSResponse(statusID int64) *SendSMSResponse

NewSendSMSResponse instantiates a new SendSMSResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSendSMSResponseWithDefaults

func NewSendSMSResponseWithDefaults() *SendSMSResponse

NewSendSMSResponseWithDefaults instantiates a new SendSMSResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SendSMSResponse) GetMessage

func (o *SendSMSResponse) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*SendSMSResponse) GetMessageOk

func (o *SendSMSResponse) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SendSMSResponse) GetSmsID

func (o *SendSMSResponse) GetSmsID() string

GetSmsID returns the SmsID field value if set, zero value otherwise.

func (*SendSMSResponse) GetSmsIDOk

func (o *SendSMSResponse) GetSmsIDOk() (*string, bool)

GetSmsIDOk returns a tuple with the SmsID field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SendSMSResponse) GetStatusID

func (o *SendSMSResponse) GetStatusID() int64

GetStatusID returns the StatusID field value

func (*SendSMSResponse) GetStatusIDOk

func (o *SendSMSResponse) GetStatusIDOk() (*int64, bool)

GetStatusIDOk returns a tuple with the StatusID field value and a boolean to check if the value has been set.

func (*SendSMSResponse) HasMessage

func (o *SendSMSResponse) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*SendSMSResponse) HasSmsID

func (o *SendSMSResponse) HasSmsID() bool

HasSmsID returns a boolean if a field has been set.

func (SendSMSResponse) MarshalJSON

func (o SendSMSResponse) MarshalJSON() ([]byte, error)

func (*SendSMSResponse) SetMessage

func (o *SendSMSResponse) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*SendSMSResponse) SetSmsID

func (o *SendSMSResponse) SetSmsID(v string)

SetSmsID gets a reference to the given string and assigns it to the SmsID field.

func (*SendSMSResponse) SetStatusID

func (o *SendSMSResponse) SetStatusID(v int64)

SetStatusID sets field value

func (SendSMSResponse) ToMap

func (o SendSMSResponse) ToMap() (map[string]interface{}, error)

func (*SendSMSResponse) UnmarshalJSON

func (o *SendSMSResponse) UnmarshalJSON(data []byte) (err error)

type ServerConfiguration

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SmsAPI

type SmsAPI interface {

	/*
			CreateBrandName Create Brand Name

			Register a new brand name for SMS messaging.
		Brand names are used to identify the sender of SMS messages (e.g., "ubill-info").


			@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
			@return ApiCreateBrandNameRequest
	*/
	CreateBrandName(ctx context.Context) ApiCreateBrandNameRequest

	// CreateBrandNameExecute executes the request
	//  @return CreateBrandNameResponse
	CreateBrandNameExecute(r ApiCreateBrandNameRequest) (*CreateBrandNameResponse, *http.Response, error)

	/*
		GetDeliveryReport Get Delivery Report

		Fetch the delivery status of a previously sent SMS using its unique identifier.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param smsID Unique identifier of the SMS
		@return ApiGetDeliveryReportRequest
	*/
	GetDeliveryReport(ctx context.Context, smsID int64) ApiGetDeliveryReportRequest

	// GetDeliveryReportExecute executes the request
	//  @return DeliveryReportResponse
	GetDeliveryReportExecute(r ApiGetDeliveryReportRequest) (*DeliveryReportResponse, *http.Response, error)

	/*
		GetSMSBalance Get SMS Balance

		Retrieve your current SMS balance, indicating how many messages you can send.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@return ApiGetSMSBalanceRequest
	*/
	GetSMSBalance(ctx context.Context) ApiGetSMSBalanceRequest

	// GetSMSBalanceExecute executes the request
	//  @return SMSBalanceResponse
	GetSMSBalanceExecute(r ApiGetSMSBalanceRequest) (*SMSBalanceResponse, *http.Response, error)

	/*
		ListBrandNames Get All Brand Names

		Retrieve a list of all registered brand names associated with your account.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@return ApiListBrandNamesRequest
	*/
	ListBrandNames(ctx context.Context) ApiListBrandNamesRequest

	// ListBrandNamesExecute executes the request
	//  @return BrandNamesResponse
	ListBrandNamesExecute(r ApiListBrandNamesRequest) (*BrandNamesResponse, *http.Response, error)

	/*
		SendSMS Send SMS

		Send SMS messages to one or multiple recipients using a registered brand name.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@return ApiSendSMSRequest
	*/
	SendSMS(ctx context.Context) ApiSendSMSRequest

	// SendSMSExecute executes the request
	//  @return SendSMSResponse
	SendSMSExecute(r ApiSendSMSRequest) (*SendSMSResponse, *http.Response, error)
}

type SmsAPIService

type SmsAPIService service

SmsAPIService SmsAPI service

func (*SmsAPIService) CreateBrandName

func (a *SmsAPIService) CreateBrandName(ctx context.Context) ApiCreateBrandNameRequest

CreateBrandName Create Brand Name

Register a new brand name for SMS messaging. Brand names are used to identify the sender of SMS messages (e.g., "ubill-info").

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreateBrandNameRequest

func (*SmsAPIService) CreateBrandNameExecute

Execute executes the request

@return CreateBrandNameResponse

func (*SmsAPIService) GetDeliveryReport

func (a *SmsAPIService) GetDeliveryReport(ctx context.Context, smsID int64) ApiGetDeliveryReportRequest

GetDeliveryReport Get Delivery Report

Fetch the delivery status of a previously sent SMS using its unique identifier.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param smsID Unique identifier of the SMS
@return ApiGetDeliveryReportRequest

func (*SmsAPIService) GetDeliveryReportExecute

Execute executes the request

@return DeliveryReportResponse

func (*SmsAPIService) GetSMSBalance added in v0.2.0

func (a *SmsAPIService) GetSMSBalance(ctx context.Context) ApiGetSMSBalanceRequest

GetSMSBalance Get SMS Balance

Retrieve your current SMS balance, indicating how many messages you can send.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetSMSBalanceRequest

func (*SmsAPIService) GetSMSBalanceExecute added in v0.2.0

Execute executes the request

@return SMSBalanceResponse

func (*SmsAPIService) ListBrandNames added in v0.2.0

func (a *SmsAPIService) ListBrandNames(ctx context.Context) ApiListBrandNamesRequest

ListBrandNames Get All Brand Names

Retrieve a list of all registered brand names associated with your account.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiListBrandNamesRequest

func (*SmsAPIService) ListBrandNamesExecute added in v0.2.0

func (a *SmsAPIService) ListBrandNamesExecute(r ApiListBrandNamesRequest) (*BrandNamesResponse, *http.Response, error)

Execute executes the request

@return BrandNamesResponse

func (*SmsAPIService) SendSMS added in v0.2.0

SendSMS Send SMS

Send SMS messages to one or multiple recipients using a registered brand name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiSendSMSRequest

func (*SmsAPIService) SendSMSExecute added in v0.2.0

Execute executes the request

@return SendSMSResponse

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL