Help us shape the future of Go! Take the 2026 Go Developer Survey

smspool

package module
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Oct 18, 2026 License: MIT Imports: 20 Imported by: 0

README

SMSPool Go SDK

Official Go client for the SMSPool API: one-time SMS verification numbers, rentals, pre-orders, eSIMs and more.

Package: github.com/smspool/smspool-go on the Go module proxy.

Install

go get github.com/smspool/smspool-go

Quick start

Get your API key from your settings page.

import smspool "github.com/smspool/smspool-go"

client := smspool.NewAPIClient(smspool.NewConfiguration())
ctx := context.WithValue(context.Background(), smspool.ContextAccessToken, "YOUR_API_KEY")
balance, _, err := client.InformationAPI.RequestBalance(ctx).Execute()
countries, _, err := client.InformationAPI.CountryRetrieveAll(ctx).Execute()
order, _, err := client.SMSAPI.PurchaseSms(ctx).Country("US").Service("1").Execute()

Responses are decoded JSON (map[string]interface{} or []interface{}). Errors (HTTP 4xx/5xx) are *smspool.GenericOpenAPIError; Body() holds the response.

Calling endpoints

Every endpoint in the API reference is a method named after its path, on the class for its section: /sms/check is SmsCheck() on client.SMSAPI. Endpoints that need your API key send it as a bearer token.

Responses are returned as decoded JSON exactly as the API sends them: many endpoints answer 200 with "success": 0 and a message when a request is refused, so check success.

How this SDK is made

The code is generated from the API's OpenAPI spec (openapi.json) with OpenAPI Generator. Do not edit generated files by hand: a workflow regenerates them every week and opens a pull request when the API changed. Hand-written files are listed in .openapi-generator-ignore.

Releasing (maintainers)

  1. Set the new version in openapi-generator.yaml (packageVersion).
  2. Run scripts/generate.sh (needs Docker) and scripts/smoke.sh, then commit.
  3. Tag and push: git tag vX.Y.Z && git push origin vX.Y.Z.

The Release workflow checks the tag against the version, runs the smoke test and publishes. There is no publish step: a Go version is the git tag. The workflow asks the module proxy to fetch it so it shows on pkg.go.dev right away.

License

MIT

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 (
	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// 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 {
	BusinessAPI BusinessAPI

	CarrierAPI CarrierAPI

	ESIMsAPI ESIMsAPI

	InformationAPI InformationAPI

	PreordersAPI PreordersAPI

	PricingAPI PricingAPI

	RentalAPI RentalAPI

	SMSAPI SMSAPI

	VoucherAPI VoucherAPI
	// contains filtered or unexported fields
}

APIClient manages communication with the SMSPool API API v1.0 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 ApiBusinessCreateRequest 

type ApiBusinessCreateRequest struct {
	ApiService BusinessAPI
	// contains filtered or unexported fields
}

func (ApiBusinessCreateRequest) DailySpendLimit 

func (r ApiBusinessCreateRequest) DailySpendLimit(dailySpendLimit float32) ApiBusinessCreateRequest

Optional daily spend cap in USD. Omit for no limit.

func (ApiBusinessCreateRequest) Execute 

func (r ApiBusinessCreateRequest) Execute() (interface{}, *http.Response, error)

func (ApiBusinessCreateRequest) Password 

func (r ApiBusinessCreateRequest) Password(password string) ApiBusinessCreateRequest

func (ApiBusinessCreateRequest) Username 

func (r ApiBusinessCreateRequest) Username(username string) ApiBusinessCreateRequest

type ApiBusinessUserHistoryRequest 

type ApiBusinessUserHistoryRequest struct {
	ApiService BusinessAPI
	// contains filtered or unexported fields
}

func (ApiBusinessUserHistoryRequest) Execute 

func (r ApiBusinessUserHistoryRequest) Execute() (interface{}, *http.Response, error)

func (ApiBusinessUserHistoryRequest) Id 

func (r ApiBusinessUserHistoryRequest) Id(id int32) ApiBusinessUserHistoryRequest

User ID retrievd from `Retrieve users` endpoint

type ApiBusinessUserUpdateRequest 

type ApiBusinessUserUpdateRequest struct {
	ApiService BusinessAPI
	// contains filtered or unexported fields
}

func (ApiBusinessUserUpdateRequest) Active 

func (r ApiBusinessUserUpdateRequest) Active(active int32) ApiBusinessUserUpdateRequest

Disable/enable user account (optional)

func (ApiBusinessUserUpdateRequest) Balance 

func (r ApiBusinessUserUpdateRequest) Balance(balance float32) ApiBusinessUserUpdateRequest

Leave empty if you do not wish to update the balance, sets the balance by the requested value

func (ApiBusinessUserUpdateRequest) DailySpendLimit 

func (r ApiBusinessUserUpdateRequest) DailySpendLimit(dailySpendLimit float32) ApiBusinessUserUpdateRequest

Daily spend cap in USD. Leave empty to leave unchanged, send -1 to remove the cap, 0 to block all spending.

func (ApiBusinessUserUpdateRequest) Execute 

func (r ApiBusinessUserUpdateRequest) Execute() (interface{}, *http.Response, error)

func (ApiBusinessUserUpdateRequest) Id 

func (r ApiBusinessUserUpdateRequest) Id(id int32) ApiBusinessUserUpdateRequest

User ID retrievd from `Retrieve users` endpoint

func (ApiBusinessUserUpdateRequest) Password 

func (r ApiBusinessUserUpdateRequest) Password(password string) ApiBusinessUserUpdateRequest

Leave empty if you do not wish to update the password

type ApiBusinessUsersRequest 

type ApiBusinessUsersRequest struct {
	ApiService BusinessAPI
	// contains filtered or unexported fields
}

func (ApiBusinessUsersRequest) Execute 

func (r ApiBusinessUsersRequest) Execute() (interface{}, *http.Response, error)

type ApiCarrierPaidLookupRequest 

type ApiCarrierPaidLookupRequest struct {
	ApiService CarrierAPI
	// contains filtered or unexported fields
}

func (ApiCarrierPaidLookupRequest) Execute 

func (r ApiCarrierPaidLookupRequest) Execute() (interface{}, *http.Response, error)

func (ApiCarrierPaidLookupRequest) Phonenumber 

func (r ApiCarrierPaidLookupRequest) Phonenumber(phonenumber int32) ApiCarrierPaidLookupRequest

type ApiCountryRetrieveAllRequest 

type ApiCountryRetrieveAllRequest struct {
	ApiService InformationAPI
	// contains filtered or unexported fields
}

func (ApiCountryRetrieveAllRequest) Execute 

func (r ApiCountryRetrieveAllRequest) Execute() (interface{}, *http.Response, error)

func (ApiCountryRetrieveAllRequest) ShowAll 

func (r ApiCountryRetrieveAllRequest) ShowAll(showAll string) ApiCountryRetrieveAllRequest

type ApiEsimDeleteRequest 

type ApiEsimDeleteRequest struct {
	ApiService ESIMsAPI
	// contains filtered or unexported fields
}

func (ApiEsimDeleteRequest) Execute 

func (r ApiEsimDeleteRequest) Execute() (interface{}, *http.Response, error)

func (ApiEsimDeleteRequest) TransactionId 

func (r ApiEsimDeleteRequest) TransactionId(transactionId string) ApiEsimDeleteRequest

transactionId retrieved from /esim/purchase

type ApiEsimHistoryRequest 

type ApiEsimHistoryRequest struct {
	ApiService ESIMsAPI
	// contains filtered or unexported fields
}

func (ApiEsimHistoryRequest) Execute 

func (r ApiEsimHistoryRequest) Execute() (interface{}, *http.Response, error)

func (ApiEsimHistoryRequest) Length 

func (r ApiEsimHistoryRequest) Length(length int32) ApiEsimHistoryRequest

Amount of rows per page

func (ApiEsimHistoryRequest) Search 

func (r ApiEsimHistoryRequest) Search(search string) ApiEsimHistoryRequest

Alphanumeric search

func (ApiEsimHistoryRequest) Start 

func (r ApiEsimHistoryRequest) Start(start int32) ApiEsimHistoryRequest

Start page

type ApiEsimLabelUpdateRequest 

type ApiEsimLabelUpdateRequest struct {
	ApiService ESIMsAPI
	// contains filtered or unexported fields
}

func (ApiEsimLabelUpdateRequest) Execute 

func (r ApiEsimLabelUpdateRequest) Execute() (interface{}, *http.Response, error)

func (ApiEsimLabelUpdateRequest) Label 

func (r ApiEsimLabelUpdateRequest) Label(label string) ApiEsimLabelUpdateRequest

The new label: letters, numbers and spaces, at most 30 characters. Empty or left out removes the label.

func (ApiEsimLabelUpdateRequest) TransactionId 

func (r ApiEsimLabelUpdateRequest) TransactionId(transactionId string) ApiEsimLabelUpdateRequest

transactionId retrieved from /esim/purchase

type ApiEsimPlansRequest 

type ApiEsimPlansRequest struct {
	ApiService ESIMsAPI
	// contains filtered or unexported fields
}

func (ApiEsimPlansRequest) Country 

func (r ApiEsimPlansRequest) Country(country string) ApiEsimPlansRequest

ISO 3166 country code

func (ApiEsimPlansRequest) Execute 

func (r ApiEsimPlansRequest) Execute() (interface{}, *http.Response, error)

type ApiEsimPricingRequest 

type ApiEsimPricingRequest struct {
	ApiService ESIMsAPI
	// contains filtered or unexported fields
}

func (ApiEsimPricingRequest) Execute 

func (r ApiEsimPricingRequest) Execute() (interface{}, *http.Response, error)

func (ApiEsimPricingRequest) Length 

func (r ApiEsimPricingRequest) Length(length int32) ApiEsimPricingRequest

Amount of rows per page

func (ApiEsimPricingRequest) Search 

func (r ApiEsimPricingRequest) Search(search string) ApiEsimPricingRequest

Search query for country

func (ApiEsimPricingRequest) Start 

func (r ApiEsimPricingRequest) Start(start int32) ApiEsimPricingRequest

Start page

type ApiEsimProfileRequest 

type ApiEsimProfileRequest struct {
	ApiService ESIMsAPI
	// contains filtered or unexported fields
}

func (ApiEsimProfileRequest) Execute 

func (r ApiEsimProfileRequest) Execute() (interface{}, *http.Response, error)

func (ApiEsimProfileRequest) TransactionId 

func (r ApiEsimProfileRequest) TransactionId(transactionId string) ApiEsimProfileRequest

transactionId retrieved from /esim/purchase

type ApiEsimPurchaseRequest 

type ApiEsimPurchaseRequest struct {
	ApiService ESIMsAPI
	// contains filtered or unexported fields
}

func (ApiEsimPurchaseRequest) Execute 

func (r ApiEsimPurchaseRequest) Execute() (interface{}, *http.Response, error)

func (ApiEsimPurchaseRequest) Plan 

func (r ApiEsimPurchaseRequest) Plan(plan int32) ApiEsimPurchaseRequest

The plan ID which is obtained from /esim/pricing

type ApiEsimTopupPlansRequest 

type ApiEsimTopupPlansRequest struct {
	ApiService ESIMsAPI
	// contains filtered or unexported fields
}

func (ApiEsimTopupPlansRequest) Execute 

func (r ApiEsimTopupPlansRequest) Execute() (interface{}, *http.Response, error)

func (ApiEsimTopupPlansRequest) Plan 

func (r ApiEsimTopupPlansRequest) Plan(plan int32) ApiEsimTopupPlansRequest

`plan` retrieved from eSIM history

type ApiEsimTopupRequest 

type ApiEsimTopupRequest struct {
	ApiService ESIMsAPI
	// contains filtered or unexported fields
}

func (ApiEsimTopupRequest) Execute 

func (r ApiEsimTopupRequest) Execute() (interface{}, *http.Response, error)

func (ApiEsimTopupRequest) Plan 

func (r ApiEsimTopupRequest) Plan(plan int32) ApiEsimTopupRequest

Topup plan retrieved from \\\"Top Up Plans\\\"

func (ApiEsimTopupRequest) TransactionId 

func (r ApiEsimTopupRequest) TransactionId(transactionId string) ApiEsimTopupRequest

Transaction ID retrieved from eSIM history

type ApiPoolRetrieveAllRequest 

type ApiPoolRetrieveAllRequest struct {
	ApiService InformationAPI
	// contains filtered or unexported fields
}

func (ApiPoolRetrieveAllRequest) Execute 

func (r ApiPoolRetrieveAllRequest) Execute() (interface{}, *http.Response, error)

type ApiPoolRetrieveValidRequest 

type ApiPoolRetrieveValidRequest struct {
	ApiService InformationAPI
	// contains filtered or unexported fields
}

func (ApiPoolRetrieveValidRequest) Country 

func (r ApiPoolRetrieveValidRequest) Country(country string) ApiPoolRetrieveValidRequest

Country retrieved from ''Country list\\\" endpoint

func (ApiPoolRetrieveValidRequest) Execute 

func (r ApiPoolRetrieveValidRequest) Execute() (interface{}, *http.Response, error)

func (ApiPoolRetrieveValidRequest) IncludeStock 

func (r ApiPoolRetrieveValidRequest) IncludeStock(includeStock string) ApiPoolRetrieveValidRequest

func (ApiPoolRetrieveValidRequest) Service 

func (r ApiPoolRetrieveValidRequest) Service(service string) ApiPoolRetrieveValidRequest

Service retrieved from ''Service list\\\" endpoint

func (ApiPoolRetrieveValidRequest) Web 

func (r ApiPoolRetrieveValidRequest) Web(web string) ApiPoolRetrieveValidRequest

Return array format

type ApiPreorderCancelRequest 

type ApiPreorderCancelRequest struct {
	ApiService PreordersAPI
	// contains filtered or unexported fields
}

func (ApiPreorderCancelRequest) Execute 

func (r ApiPreorderCancelRequest) Execute() (interface{}, *http.Response, error)

func (ApiPreorderCancelRequest) Orderid 

func (r ApiPreorderCancelRequest) Orderid(orderid string) ApiPreorderCancelRequest

type ApiPreorderCheckRequest 

type ApiPreorderCheckRequest struct {
	ApiService PreordersAPI
	// contains filtered or unexported fields
}

func (ApiPreorderCheckRequest) Execute 

func (r ApiPreorderCheckRequest) Execute() (interface{}, *http.Response, error)

func (ApiPreorderCheckRequest) Orderid 

func (r ApiPreorderCheckRequest) Orderid(orderid string) ApiPreorderCheckRequest

type ApiPreorderCreateRequest 

type ApiPreorderCreateRequest struct {
	ApiService PreordersAPI
	// contains filtered or unexported fields
}

func (ApiPreorderCreateRequest) Areacode 

func (r ApiPreorderCreateRequest) Areacode(areacode string) ApiPreorderCreateRequest

func (ApiPreorderCreateRequest) Country 

func (r ApiPreorderCreateRequest) Country(country string) ApiPreorderCreateRequest

Country name or country ID which can be retrieved at the /country/retrieve_all endpoint

func (ApiPreorderCreateRequest) Execute 

func (r ApiPreorderCreateRequest) Execute() (interface{}, *http.Response, error)

func (ApiPreorderCreateRequest) MaxPrice 

func (r ApiPreorderCreateRequest) MaxPrice(maxPrice float32) ApiPreorderCreateRequest

func (ApiPreorderCreateRequest) Pool 

func (r ApiPreorderCreateRequest) Pool(pool string) ApiPreorderCreateRequest

func (ApiPreorderCreateRequest) Service 

func (r ApiPreorderCreateRequest) Service(service string) ApiPreorderCreateRequest

Service name or service ID which can be retrieved at the /service/retrieve_all endpoint

type ApiPreorderPriceRequest 

type ApiPreorderPriceRequest struct {
	ApiService PreordersAPI
	// contains filtered or unexported fields
}

func (ApiPreorderPriceRequest) Country 

func (r ApiPreorderPriceRequest) Country(country string) ApiPreorderPriceRequest

Country name or country ID which can be retrieved at the /country/retrieve_all endpoint

func (ApiPreorderPriceRequest) Execute 

func (r ApiPreorderPriceRequest) Execute() (interface{}, *http.Response, error)

func (ApiPreorderPriceRequest) Pool 

func (r ApiPreorderPriceRequest) Pool(pool string) ApiPreorderPriceRequest

func (ApiPreorderPriceRequest) Service 

func (r ApiPreorderPriceRequest) Service(service string) ApiPreorderPriceRequest

Service name or service ID which can be retrieved at the /service/retrieve_all endpoint

type ApiPreorderRetrieveRequest 

type ApiPreorderRetrieveRequest struct {
	ApiService PreordersAPI
	// contains filtered or unexported fields
}

func (ApiPreorderRetrieveRequest) Execute 

func (r ApiPreorderRetrieveRequest) Execute() (interface{}, *http.Response, error)

type ApiPurchaseRentalRequest 

type ApiPurchaseRentalRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiPurchaseRentalRequest) City 

func (r ApiPurchaseRentalRequest) City(city string) ApiPurchaseRentalRequest

func (ApiPurchaseRentalRequest) CreateToken 

func (r ApiPurchaseRentalRequest) CreateToken(createToken int32) ApiPurchaseRentalRequest

Create a rental token which allows you to share this specific rental

func (ApiPurchaseRentalRequest) Days 

func (r ApiPurchaseRentalRequest) Days(days int32) ApiPurchaseRentalRequest

func (ApiPurchaseRentalRequest) Execute 

func (r ApiPurchaseRentalRequest) Execute() (interface{}, *http.Response, error)

func (ApiPurchaseRentalRequest) Id 

func (r ApiPurchaseRentalRequest) Id(id int32) ApiPurchaseRentalRequest

Rental ID retrieved from Retrieve Rental IDs

func (ApiPurchaseRentalRequest) ServiceId 

func (r ApiPurchaseRentalRequest) ServiceId(serviceId int32) ApiPurchaseRentalRequest

Optional value on which service you'd purchase the rental for

func (ApiPurchaseRentalRequest) State 

func (r ApiPurchaseRentalRequest) State(state string) ApiPurchaseRentalRequest

func (ApiPurchaseRentalRequest) Zipcode 

func (r ApiPurchaseRentalRequest) Zipcode(zipcode string) ApiPurchaseRentalRequest

type ApiPurchaseSmsRequest 

type ApiPurchaseSmsRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiPurchaseSmsRequest) ActivationType 

func (r ApiPurchaseSmsRequest) ActivationType(activationType string) ApiPurchaseSmsRequest

Options: SMS, VOICE, FLASH. SMS will receive regular SMS, VOICE will receive phone calls that mentions the SMS and FLASH is for FLASH calls for verification.

func (ApiPurchaseSmsRequest) Areacode 

func (r ApiPurchaseSmsRequest) Areacode(areacode string) ApiPurchaseSmsRequest

Areacodes you would like to include or exclude in JSON format

func (ApiPurchaseSmsRequest) Carrier 

func (r ApiPurchaseSmsRequest) Carrier(carrier int32) ApiPurchaseSmsRequest

Options: 1 or 2. Pick a carrier (only works for pool Foxtrot US)

func (ApiPurchaseSmsRequest) Country 

func (r ApiPurchaseSmsRequest) Country(country string) ApiPurchaseSmsRequest

The country in ISO format or number retrieved from the `Country List` endpoint

func (ApiPurchaseSmsRequest) CreateToken 

func (r ApiPurchaseSmsRequest) CreateToken(createToken int32) ApiPurchaseSmsRequest

Optional param; set to 1 if you'd like to create a token link that anyone can access.

func (ApiPurchaseSmsRequest) Exclude 

func (r ApiPurchaseSmsRequest) Exclude(exclude int32) ApiPurchaseSmsRequest

Set exclude to 1 if you would like to exclude all listed area codes.

func (ApiPurchaseSmsRequest) Execute 

func (r ApiPurchaseSmsRequest) Execute() (interface{}, *http.Response, error)

func (ApiPurchaseSmsRequest) MaxPrice 

func (r ApiPurchaseSmsRequest) MaxPrice(maxPrice float32) ApiPurchaseSmsRequest

The max price you are willing to pay per number

func (ApiPurchaseSmsRequest) Phonenumber 

func (r ApiPurchaseSmsRequest) Phonenumber(phonenumber int32) ApiPurchaseSmsRequest

In case you want to select a specific phone number to order

func (ApiPurchaseSmsRequest) Pool 

func (r ApiPurchaseSmsRequest) Pool(pool string) ApiPurchaseSmsRequest

The pool or number retrieved from the `Pool List` endpoint (optional)

func (ApiPurchaseSmsRequest) PricingOption 

func (r ApiPurchaseSmsRequest) PricingOption(pricingOption int32) ApiPurchaseSmsRequest

Set to 0 if you'd like the cheapest numbers, set to 1 for highest success rate

func (ApiPurchaseSmsRequest) Quantity 

func (r ApiPurchaseSmsRequest) Quantity(quantity int32) ApiPurchaseSmsRequest

Quantity of numbers ordered

func (ApiPurchaseSmsRequest) Service 

func (r ApiPurchaseSmsRequest) Service(service string) ApiPurchaseSmsRequest

The service or number retrieved from the `Service List` endpoint

func (ApiPurchaseSmsRequest) Software 

func (r ApiPurchaseSmsRequest) Software(software int32) ApiPurchaseSmsRequest

type ApiRentalAutoExtendRequest 

type ApiRentalAutoExtendRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalAutoExtendRequest) Execute 

func (r ApiRentalAutoExtendRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalAutoExtendRequest) RentalCode 

func (r ApiRentalAutoExtendRequest) RentalCode(rentalCode string) ApiRentalAutoExtendRequest

The retrieved rental code from the `Order rental` endpoint.

type ApiRentalExtendRequest 

type ApiRentalExtendRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalExtendRequest) Days 

func (r ApiRentalExtendRequest) Days(days int32) ApiRentalExtendRequest

func (ApiRentalExtendRequest) Execute 

func (r ApiRentalExtendRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalExtendRequest) RentalCode 

func (r ApiRentalExtendRequest) RentalCode(rentalCode string) ApiRentalExtendRequest

The retrieved rental code from the `Order rental` endpoint.

type ApiRentalHistoryRequest 

type ApiRentalHistoryRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalHistoryRequest) Execute 

func (r ApiRentalHistoryRequest) Execute() (interface{}, *http.Response, error)

type ApiRentalInfoRequest 

type ApiRentalInfoRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalInfoRequest) Execute 

func (r ApiRentalInfoRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalInfoRequest) RentalCode 

func (r ApiRentalInfoRequest) RentalCode(rentalCode string) ApiRentalInfoRequest

The retrieved rental code from the `Order rental` endpoint.

type ApiRentalRefundRequest 

type ApiRentalRefundRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalRefundRequest) Execute 

func (r ApiRentalRefundRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalRefundRequest) RentalCode 

func (r ApiRentalRefundRequest) RentalCode(rentalCode string) ApiRentalRefundRequest

The retrieved rental code from the `Order rental` endpoint.

type ApiRentalResetRequest 

type ApiRentalResetRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalResetRequest) Execute 

func (r ApiRentalResetRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalResetRequest) RentalCode 

func (r ApiRentalResetRequest) RentalCode(rentalCode string) ApiRentalResetRequest

The retrieved rental code from the `Order rental` endpoint.

type ApiRentalRetrieveAllRequest 

type ApiRentalRetrieveAllRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalRetrieveAllRequest) Execute 

func (r ApiRentalRetrieveAllRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalRetrieveAllRequest) Type_ 

func (r ApiRentalRetrieveAllRequest) Type_(type_ int32) ApiRentalRetrieveAllRequest

Choose whether the rental is extendable or not with a 0 or 1

type ApiRentalRetrieveHistoryRequest 

type ApiRentalRetrieveHistoryRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalRetrieveHistoryRequest) Execute 

func (r ApiRentalRetrieveHistoryRequest) Execute() (interface{}, *http.Response, error)

type ApiRentalRetrieveMessagesRequest 

type ApiRentalRetrieveMessagesRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalRetrieveMessagesRequest) Execute 

func (r ApiRentalRetrieveMessagesRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalRetrieveMessagesRequest) RentalCode 

func (r ApiRentalRetrieveMessagesRequest) RentalCode(rentalCode string) ApiRentalRetrieveMessagesRequest

The retrieved rental code from the `Order rental` endpoint.

type ApiRentalRetrievePricingRequest 

type ApiRentalRetrievePricingRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalRetrievePricingRequest) Execute 

func (r ApiRentalRetrievePricingRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalRetrievePricingRequest) Id 

func (r ApiRentalRetrievePricingRequest) Id(id int32) ApiRentalRetrievePricingRequest

The rental ID retrieved from `Retrieve Rental IDs`

func (ApiRentalRetrievePricingRequest) Service 

func (r ApiRentalRetrievePricingRequest) Service(service string) ApiRentalRetrievePricingRequest

Service name or service ID which can be retrieved at the /service/retrieve_all endpoint

type ApiRentalRetrieveRequest 

type ApiRentalRetrieveRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalRetrieveRequest) Execute 

func (r ApiRentalRetrieveRequest) Execute() (interface{}, *http.Response, error)

type ApiRentalRetrieveServicesRequest 

type ApiRentalRetrieveServicesRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalRetrieveServicesRequest) Execute 

func (r ApiRentalRetrieveServicesRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalRetrieveServicesRequest) Rental 

func (r ApiRentalRetrieveServicesRequest) Rental(rental int32) ApiRentalRetrieveServicesRequest

The rental ID retrieved from `Retrieve Rental IDs`

type ApiRentalRetrieveStatusRequest 

type ApiRentalRetrieveStatusRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalRetrieveStatusRequest) Execute 

func (r ApiRentalRetrieveStatusRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalRetrieveStatusRequest) RentalCode 

func (r ApiRentalRetrieveStatusRequest) RentalCode(rentalCode string) ApiRentalRetrieveStatusRequest

The retrieved rental code from the `Order rental` endpoint.

type ApiRentalServicePriceRequest 

type ApiRentalServicePriceRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalServicePriceRequest) Execute 

func (r ApiRentalServicePriceRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalServicePriceRequest) Id 

func (r ApiRentalServicePriceRequest) Id(id int32) ApiRentalServicePriceRequest

The rental ID retrieved from `Retrieve Rental IDs`

func (ApiRentalServicePriceRequest) ServiceId 

func (r ApiRentalServicePriceRequest) ServiceId(serviceId int32) ApiRentalServicePriceRequest

The service ID retrieved from `Retrieve Rental Services`

type ApiRentalStockRequest 

type ApiRentalStockRequest struct {
	ApiService RentalAPI
	// contains filtered or unexported fields
}

func (ApiRentalStockRequest) Days 

func (r ApiRentalStockRequest) Days(days int32) ApiRentalStockRequest

func (ApiRentalStockRequest) Execute 

func (r ApiRentalStockRequest) Execute() (interface{}, *http.Response, error)

func (ApiRentalStockRequest) Id 

func (r ApiRentalStockRequest) Id(id int32) ApiRentalStockRequest

The rental ID retrieved from `Retrieve Rental IDs`

func (ApiRentalStockRequest) ServiceId 

func (r ApiRentalStockRequest) ServiceId(serviceId int32) ApiRentalStockRequest

type ApiRequestActiveRequest 

type ApiRequestActiveRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiRequestActiveRequest) Execute 

func (r ApiRequestActiveRequest) Execute() (interface{}, *http.Response, error)

type ApiRequestArchiveRequest 

type ApiRequestArchiveRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiRequestArchiveRequest) Execute 

func (r ApiRequestArchiveRequest) Execute() (interface{}, *http.Response, error)

type ApiRequestAreacodesRequest 

type ApiRequestAreacodesRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiRequestAreacodesRequest) Country 

func (r ApiRequestAreacodesRequest) Country(country string) ApiRequestAreacodesRequest

The country in ISO format or number retrieved from the `Country List` endpoint

func (ApiRequestAreacodesRequest) Execute 

func (r ApiRequestAreacodesRequest) Execute() (interface{}, *http.Response, error)

func (ApiRequestAreacodesRequest) Pool 

func (r ApiRequestAreacodesRequest) Pool(pool string) ApiRequestAreacodesRequest

The pool or number retrieved from the `Pool List` endpoint (optional)

func (ApiRequestAreacodesRequest) Service 

func (r ApiRequestAreacodesRequest) Service(service string) ApiRequestAreacodesRequest

The service or number retrieved from the `Service List` endpoint

type ApiRequestBalanceRequest 

type ApiRequestBalanceRequest struct {
	ApiService InformationAPI
	// contains filtered or unexported fields
}

func (ApiRequestBalanceRequest) Execute 

func (r ApiRequestBalanceRequest) Execute() (interface{}, *http.Response, error)

type ApiRequestHistoryRequest 

type ApiRequestHistoryRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiRequestHistoryRequest) Execute 

func (r ApiRequestHistoryRequest) Execute() (interface{}, *http.Response, error)

func (ApiRequestHistoryRequest) Length 

func (r ApiRequestHistoryRequest) Length(length int32) ApiRequestHistoryRequest

Max length of all rows

func (ApiRequestHistoryRequest) Search 

func (r ApiRequestHistoryRequest) Search(search string) ApiRequestHistoryRequest

Search query for phone number, order_code, service or country

func (ApiRequestHistoryRequest) Start 

func (r ApiRequestHistoryRequest) Start(start int32) ApiRequestHistoryRequest

Which row you'd like to start from

type ApiRequestPriceRequest 

type ApiRequestPriceRequest struct {
	ApiService PricingAPI
	// contains filtered or unexported fields
}

func (ApiRequestPriceRequest) Country 

func (r ApiRequestPriceRequest) Country(country string) ApiRequestPriceRequest

Country retrieved from ''Country list\\\" endpoint

func (ApiRequestPriceRequest) Execute 

func (r ApiRequestPriceRequest) Execute() (interface{}, *http.Response, error)

func (ApiRequestPriceRequest) Pool 

func (r ApiRequestPriceRequest) Pool(pool string) ApiRequestPriceRequest

Pool retrieved from ''Pool list\\\" endpoint

func (ApiRequestPriceRequest) Service 

func (r ApiRequestPriceRequest) Service(service string) ApiRequestPriceRequest

Service retrieved from ''Service list\\\" endpoint

func (ApiRequestPriceRequest) SkipSuccessRate 

func (r ApiRequestPriceRequest) SkipSuccessRate(skipSuccessRate string) ApiRequestPriceRequest

type ApiRequestPricingRequest 

type ApiRequestPricingRequest struct {
	ApiService PricingAPI
	// contains filtered or unexported fields
}

func (ApiRequestPricingRequest) Country 

func (r ApiRequestPricingRequest) Country(country string) ApiRequestPricingRequest

Optional parameter to request services per country

func (ApiRequestPricingRequest) Execute 

func (r ApiRequestPricingRequest) Execute() (interface{}, *http.Response, error)

func (ApiRequestPricingRequest) MaxPrice 

func (r ApiRequestPricingRequest) MaxPrice(maxPrice float32) ApiRequestPricingRequest

func (ApiRequestPricingRequest) Pool 

func (r ApiRequestPricingRequest) Pool(pool string) ApiRequestPricingRequest

func (ApiRequestPricingRequest) Service 

func (r ApiRequestPricingRequest) Service(service string) ApiRequestPricingRequest

Service name or service ID which can be retrieved at the /service/retrieve_all endpoint

type ApiRequestSuccessRateRequest 

type ApiRequestSuccessRateRequest struct {
	ApiService InformationAPI
	// contains filtered or unexported fields
}

func (ApiRequestSuccessRateRequest) Country 

func (r ApiRequestSuccessRateRequest) Country(country string) ApiRequestSuccessRateRequest

Country name or country ID which can be retrieved at the /country/retrieve_all endpoint

func (ApiRequestSuccessRateRequest) Execute 

func (r ApiRequestSuccessRateRequest) Execute() (interface{}, *http.Response, error)

func (ApiRequestSuccessRateRequest) Service 

func (r ApiRequestSuccessRateRequest) Service(service string) ApiRequestSuccessRateRequest

Service name or service ID which can be retrieved at the /service/retrieve_all endpoint

type ApiRequestSuggestedCountriesRequest 

type ApiRequestSuggestedCountriesRequest struct {
	ApiService InformationAPI
	// contains filtered or unexported fields
}

func (ApiRequestSuggestedCountriesRequest) Execute 

func (r ApiRequestSuggestedCountriesRequest) Execute() (interface{}, *http.Response, error)

func (ApiRequestSuggestedCountriesRequest) Service 

func (r ApiRequestSuggestedCountriesRequest) Service(service string) ApiRequestSuggestedCountriesRequest

Service name or service ID which can be retrieved at the /service/retrieve_all endpoint

type ApiServiceRetrieveAllRequest 

type ApiServiceRetrieveAllRequest struct {
	ApiService InformationAPI
	// contains filtered or unexported fields
}

func (ApiServiceRetrieveAllRequest) Country 

func (r ApiServiceRetrieveAllRequest) Country(country string) ApiServiceRetrieveAllRequest

func (ApiServiceRetrieveAllRequest) Execute 

func (r ApiServiceRetrieveAllRequest) Execute() (interface{}, *http.Response, error)

type ApiSmsActivateRequest 

type ApiSmsActivateRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsActivateRequest) Execute 

func (r ApiSmsActivateRequest) Execute() (interface{}, *http.Response, error)

func (ApiSmsActivateRequest) Orderid 

func (r ApiSmsActivateRequest) Orderid(orderid string) ApiSmsActivateRequest

type ApiSmsAllStockRequest 

type ApiSmsAllStockRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsAllStockRequest) Country 

func (r ApiSmsAllStockRequest) Country(country string) ApiSmsAllStockRequest

Country retrieved from ''Country list\\\" endpoint (optional)

func (ApiSmsAllStockRequest) Execute 

func (r ApiSmsAllStockRequest) Execute() (interface{}, *http.Response, error)

func (ApiSmsAllStockRequest) Pool 

func (r ApiSmsAllStockRequest) Pool(pool string) ApiSmsAllStockRequest

Pool retrieved from ''Pool list\\\" endpoint (optional)

func (ApiSmsAllStockRequest) Service 

func (r ApiSmsAllStockRequest) Service(service string) ApiSmsAllStockRequest

Service retrieved from ''Service list\\\" endpoint (optional)

type ApiSmsCancelAllRequest 

type ApiSmsCancelAllRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsCancelAllRequest) Execute 

func (r ApiSmsCancelAllRequest) Execute() (interface{}, *http.Response, error)

type ApiSmsCancelRequest 

type ApiSmsCancelRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsCancelRequest) Ban 

func (r ApiSmsCancelRequest) Ban(ban int32) ApiSmsCancelRequest

func (ApiSmsCancelRequest) Execute 

func (r ApiSmsCancelRequest) Execute() (interface{}, *http.Response, error)

func (ApiSmsCancelRequest) Expiry 

func (r ApiSmsCancelRequest) Expiry(expiry int32) ApiSmsCancelRequest

func (ApiSmsCancelRequest) Orderid 

func (r ApiSmsCancelRequest) Orderid(orderid string) ApiSmsCancelRequest

func (ApiSmsCancelRequest) Orderids 

func (r ApiSmsCancelRequest) Orderids(orderids string) ApiSmsCancelRequest

type ApiSmsCheckRequest 

type ApiSmsCheckRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsCheckRequest) Execute 

func (r ApiSmsCheckRequest) Execute() (interface{}, *http.Response, error)

func (ApiSmsCheckRequest) Orderid 

func (r ApiSmsCheckRequest) Orderid(orderid string) ApiSmsCheckRequest

type ApiSmsCheckResendRequest 

type ApiSmsCheckResendRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsCheckResendRequest) Execute 

func (r ApiSmsCheckResendRequest) Execute() (interface{}, *http.Response, error)

func (ApiSmsCheckResendRequest) Orderid 

func (r ApiSmsCheckResendRequest) Orderid(orderid string) ApiSmsCheckResendRequest

type ApiSmsClearCacheRequest 

type ApiSmsClearCacheRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsClearCacheRequest) Execute 

func (r ApiSmsClearCacheRequest) Execute() (interface{}, *http.Response, error)

type ApiSmsMissedRequest 

type ApiSmsMissedRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsMissedRequest) Execute 

func (r ApiSmsMissedRequest) Execute() (interface{}, *http.Response, error)

func (ApiSmsMissedRequest) Limit 

func (r ApiSmsMissedRequest) Limit(limit int32) ApiSmsMissedRequest

Maximum number of messages. Defaults to 100, at most 500.

func (ApiSmsMissedRequest) Phonenumber 

func (r ApiSmsMissedRequest) Phonenumber(phonenumber int32) ApiSmsMissedRequest

Only return messages for this number, including the country code. Leave it out for all your numbers.

type ApiSmsReactivateRequest 

type ApiSmsReactivateRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsReactivateRequest) Execute 

func (r ApiSmsReactivateRequest) Execute() (interface{}, *http.Response, error)

func (ApiSmsReactivateRequest) Orderid 

func (r ApiSmsReactivateRequest) Orderid(orderid string) ApiSmsReactivateRequest

type ApiSmsResendRequest 

type ApiSmsResendRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsResendRequest) Execute 

func (r ApiSmsResendRequest) Execute() (interface{}, *http.Response, error)

func (ApiSmsResendRequest) Orderid 

func (r ApiSmsResendRequest) Orderid(orderid string) ApiSmsResendRequest

type ApiSmsStockRequest 

type ApiSmsStockRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsStockRequest) Country 

func (r ApiSmsStockRequest) Country(country string) ApiSmsStockRequest

Country retrieved from ''Country list\\\" endpoint

func (ApiSmsStockRequest) Execute 

func (r ApiSmsStockRequest) Execute() (interface{}, *http.Response, error)

func (ApiSmsStockRequest) IncludePrice 

func (r ApiSmsStockRequest) IncludePrice(includePrice int32) ApiSmsStockRequest

func (ApiSmsStockRequest) Pool 

func (r ApiSmsStockRequest) Pool(pool string) ApiSmsStockRequest

Pool retrieved from ''Pool list\\\" endpoint

func (ApiSmsStockRequest) Service 

func (r ApiSmsStockRequest) Service(service string) ApiSmsStockRequest

Service retrieved from ''Service list\\\" endpoint

type ApiSmsUnarchiveRequest 

type ApiSmsUnarchiveRequest struct {
	ApiService SMSAPI
	// contains filtered or unexported fields
}

func (ApiSmsUnarchiveRequest) Execute 

func (r ApiSmsUnarchiveRequest) Execute() (interface{}, *http.Response, error)

func (ApiSmsUnarchiveRequest) Orderid 

func (r ApiSmsUnarchiveRequest) Orderid(orderid string) ApiSmsUnarchiveRequest

The order ID retrieved from /purchase/sms

type ApiVoucherBulkGenerateRequest 

type ApiVoucherBulkGenerateRequest struct {
	ApiService VoucherAPI
	// contains filtered or unexported fields
}

func (ApiVoucherBulkGenerateRequest) Amount 

func (r ApiVoucherBulkGenerateRequest) Amount(amount float32) ApiVoucherBulkGenerateRequest

func (ApiVoucherBulkGenerateRequest) Execute 

func (r ApiVoucherBulkGenerateRequest) Execute() (interface{}, *http.Response, error)

func (ApiVoucherBulkGenerateRequest) Quantity 

func (r ApiVoucherBulkGenerateRequest) Quantity(quantity int32) ApiVoucherBulkGenerateRequest

type ApiVoucherDeleteRequest 

type ApiVoucherDeleteRequest struct {
	ApiService VoucherAPI
	// contains filtered or unexported fields
}

func (ApiVoucherDeleteRequest) Execute 

func (r ApiVoucherDeleteRequest) Execute() (interface{}, *http.Response, error)

func (ApiVoucherDeleteRequest) Voucher 

func (r ApiVoucherDeleteRequest) Voucher(voucher string) ApiVoucherDeleteRequest

Your voucher code

type ApiVoucherGenerateRequest 

type ApiVoucherGenerateRequest struct {
	ApiService VoucherAPI
	// contains filtered or unexported fields
}

func (ApiVoucherGenerateRequest) Amount 

func (r ApiVoucherGenerateRequest) Amount(amount float32) ApiVoucherGenerateRequest

The amount per promocode

func (ApiVoucherGenerateRequest) Execute 

func (r ApiVoucherGenerateRequest) Execute() (interface{}, *http.Response, error)

type ApiVoucherRetrieveRequest 

type ApiVoucherRetrieveRequest struct {
	ApiService VoucherAPI
	// contains filtered or unexported fields
}

func (ApiVoucherRetrieveRequest) Execute 

func (r ApiVoucherRetrieveRequest) Execute() (interface{}, *http.Response, 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 BusinessAPI 

type BusinessAPI interface {

	/*
		BusinessCreate Register user

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

	// BusinessCreateExecute executes the request
	//  @return interface{}
	BusinessCreateExecute(r ApiBusinessCreateRequest) (interface{}, *http.Response, error)

	/*
		BusinessUserHistory History

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

	// BusinessUserHistoryExecute executes the request
	//  @return interface{}
	BusinessUserHistoryExecute(r ApiBusinessUserHistoryRequest) (interface{}, *http.Response, error)

	/*
		BusinessUserUpdate Update

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

	// BusinessUserUpdateExecute executes the request
	//  @return interface{}
	BusinessUserUpdateExecute(r ApiBusinessUserUpdateRequest) (interface{}, *http.Response, error)

	/*
		BusinessUsers Retrieve users

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

	// BusinessUsersExecute executes the request
	//  @return interface{}
	BusinessUsersExecute(r ApiBusinessUsersRequest) (interface{}, *http.Response, error)
}

type BusinessAPIService 

type BusinessAPIService service

BusinessAPIService BusinessAPI service

func (*BusinessAPIService) BusinessCreate 

func (a *BusinessAPIService) BusinessCreate(ctx context.Context) ApiBusinessCreateRequest

BusinessCreate Register user 

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

func (*BusinessAPIService) BusinessCreateExecute 

func (a *BusinessAPIService) BusinessCreateExecute(r ApiBusinessCreateRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*BusinessAPIService) BusinessUserHistory 

func (a *BusinessAPIService) BusinessUserHistory(ctx context.Context) ApiBusinessUserHistoryRequest

BusinessUserHistory History 

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

func (*BusinessAPIService) BusinessUserHistoryExecute 

func (a *BusinessAPIService) BusinessUserHistoryExecute(r ApiBusinessUserHistoryRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*BusinessAPIService) BusinessUserUpdate 

func (a *BusinessAPIService) BusinessUserUpdate(ctx context.Context) ApiBusinessUserUpdateRequest

BusinessUserUpdate Update 

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

func (*BusinessAPIService) BusinessUserUpdateExecute 

func (a *BusinessAPIService) BusinessUserUpdateExecute(r ApiBusinessUserUpdateRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*BusinessAPIService) BusinessUsers 

func (a *BusinessAPIService) BusinessUsers(ctx context.Context) ApiBusinessUsersRequest

BusinessUsers Retrieve users 

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

func (*BusinessAPIService) BusinessUsersExecute 

func (a *BusinessAPIService) BusinessUsersExecute(r ApiBusinessUsersRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

type CarrierAPI 

type CarrierAPI interface {

	/*
		CarrierPaidLookup Lookup

		This API endpoint is used to perform a paid lookup for a phone number. The request is sent via an HTTP POST method to the following URL: `https://api.smspool.net/carrier/paid_lookup`

	“` json
	{
	  "success": true,
	  "phonenumber": "",
	  "country": "",
	  "carrier": "",
	  "carrier_type": "",
	  "charge": 0
	}

	 “`

	The `success` field indicates whether the lookup was successful or not. The `phonenumber` field represents the phone number for which the lookup was performed. The `country` field indicates the country associated with the phone number. The `carrier` field provides the name of the carrier associated with the phone number. The `carrier_type` field specifies the type of carrier. The `charge` field represents the cost charged for the lookup operation.

	Please note that specific values for `phonenumber`, `country`, `carrier`, and `carrier_type` were not provided in the response, and the `charge` field had a value of 0.

	To use this endpoint, send an HTTP POST request to the provided URL with the necessary parameters. The request should include the phone number for which you want to perform the lookup. The response will contain the details of the carrier and associated information.

	Make sure to handle any errors that may occur during the lookup process and check the `success` field in the response to determine the outcome of the operation.

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

	// CarrierPaidLookupExecute executes the request
	//  @return interface{}
	CarrierPaidLookupExecute(r ApiCarrierPaidLookupRequest) (interface{}, *http.Response, error)
}

type CarrierAPIService 

type CarrierAPIService service

CarrierAPIService CarrierAPI service

func (*CarrierAPIService) CarrierPaidLookup 

func (a *CarrierAPIService) CarrierPaidLookup(ctx context.Context) ApiCarrierPaidLookupRequest

CarrierPaidLookup Lookup

This API endpoint is used to perform a paid lookup for a phone number. The request is sent via an HTTP POST method to the following URL: `https://api.smspool.net/carrier/paid_lookup`

``` json 

{
  "success": true,
  "phonenumber": "",
  "country": "",
  "carrier": "",
  "carrier_type": "",
  "charge": 0
}

```

The `success` field indicates whether the lookup was successful or not. The `phonenumber` field represents the phone number for which the lookup was performed. The `country` field indicates the country associated with the phone number. The `carrier` field provides the name of the carrier associated with the phone number. The `carrier_type` field specifies the type of carrier. The `charge` field represents the cost charged for the lookup operation.

Please note that specific values for `phonenumber`, `country`, `carrier`, and `carrier_type` were not provided in the response, and the `charge` field had a value of 0.

To use this endpoint, send an HTTP POST request to the provided URL with the necessary parameters. The request should include the phone number for which you want to perform the lookup. The response will contain the details of the carrier and associated information.

Make sure to handle any errors that may occur during the lookup process and check the `success` field in the response to determine the outcome of the operation. 

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

func (*CarrierAPIService) CarrierPaidLookupExecute 

func (a *CarrierAPIService) CarrierPaidLookupExecute(r ApiCarrierPaidLookupRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

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 ESIMsAPI 

type ESIMsAPI interface {

	/*
		EsimDelete Delete eSIM

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

	// EsimDeleteExecute executes the request
	//  @return interface{}
	EsimDeleteExecute(r ApiEsimDeleteRequest) (interface{}, *http.Response, error)

	/*
		EsimHistory View eSIM history

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

	// EsimHistoryExecute executes the request
	//  @return interface{}
	EsimHistoryExecute(r ApiEsimHistoryRequest) (interface{}, *http.Response, error)

	/*
		EsimLabelUpdate Update eSIM label

		Set or clear the label of one of your eSIMs. The label is returned as `label` by **View eSIM history**, so you can use it to tell your eSIMs apart.

	A label can be up to 30 characters long and may only contain letters, numbers and spaces. Leave `label` out, or send it empty, to remove the label.

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

	// EsimLabelUpdateExecute executes the request
	//  @return interface{}
	EsimLabelUpdateExecute(r ApiEsimLabelUpdateRequest) (interface{}, *http.Response, error)

	/*
		EsimPlans View eSIM plans per country

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

	// EsimPlansExecute executes the request
	//  @return interface{}
	EsimPlansExecute(r ApiEsimPlansRequest) (interface{}, *http.Response, error)

	/*
		EsimPricing View eSIM countries

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

	// EsimPricingExecute executes the request
	//  @return interface{}
	EsimPricingExecute(r ApiEsimPricingRequest) (interface{}, *http.Response, error)

	/*
		EsimProfile View eSIM profile

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

	// EsimProfileExecute executes the request
	//  @return interface{}
	EsimProfileExecute(r ApiEsimProfileRequest) (interface{}, *http.Response, error)

	/*
		EsimPurchase Purchase eSIM

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

	// EsimPurchaseExecute executes the request
	//  @return interface{}
	EsimPurchaseExecute(r ApiEsimPurchaseRequest) (interface{}, *http.Response, error)

	/*
		EsimTopup Top up eSIM

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

	// EsimTopupExecute executes the request
	//  @return interface{}
	EsimTopupExecute(r ApiEsimTopupRequest) (interface{}, *http.Response, error)

	/*
		EsimTopupPlans Top Up Plans

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

	// EsimTopupPlansExecute executes the request
	//  @return interface{}
	EsimTopupPlansExecute(r ApiEsimTopupPlansRequest) (interface{}, *http.Response, error)
}

type ESIMsAPIService 

type ESIMsAPIService service

ESIMsAPIService ESIMsAPI service

func (*ESIMsAPIService) EsimDelete 

func (a *ESIMsAPIService) EsimDelete(ctx context.Context) ApiEsimDeleteRequest

EsimDelete Delete eSIM 

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

func (*ESIMsAPIService) EsimDeleteExecute 

func (a *ESIMsAPIService) EsimDeleteExecute(r ApiEsimDeleteRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*ESIMsAPIService) EsimHistory 

func (a *ESIMsAPIService) EsimHistory(ctx context.Context) ApiEsimHistoryRequest

EsimHistory View eSIM history 

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

func (*ESIMsAPIService) EsimHistoryExecute 

func (a *ESIMsAPIService) EsimHistoryExecute(r ApiEsimHistoryRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*ESIMsAPIService) EsimLabelUpdate 

func (a *ESIMsAPIService) EsimLabelUpdate(ctx context.Context) ApiEsimLabelUpdateRequest

EsimLabelUpdate Update eSIM label

Set or clear the label of one of your eSIMs. The label is returned as `label` by **View eSIM history**, so you can use it to tell your eSIMs apart.

A label can be up to 30 characters long and may only contain letters, numbers and spaces. Leave `label` out, or send it empty, to remove the label. 

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

func (*ESIMsAPIService) EsimLabelUpdateExecute 

func (a *ESIMsAPIService) EsimLabelUpdateExecute(r ApiEsimLabelUpdateRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*ESIMsAPIService) EsimPlans 

func (a *ESIMsAPIService) EsimPlans(ctx context.Context) ApiEsimPlansRequest

EsimPlans View eSIM plans per country 

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

func (*ESIMsAPIService) EsimPlansExecute 

func (a *ESIMsAPIService) EsimPlansExecute(r ApiEsimPlansRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*ESIMsAPIService) EsimPricing 

func (a *ESIMsAPIService) EsimPricing(ctx context.Context) ApiEsimPricingRequest

EsimPricing View eSIM countries 

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

func (*ESIMsAPIService) EsimPricingExecute 

func (a *ESIMsAPIService) EsimPricingExecute(r ApiEsimPricingRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*ESIMsAPIService) EsimProfile 

func (a *ESIMsAPIService) EsimProfile(ctx context.Context) ApiEsimProfileRequest

EsimProfile View eSIM profile 

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

func (*ESIMsAPIService) EsimProfileExecute 

func (a *ESIMsAPIService) EsimProfileExecute(r ApiEsimProfileRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*ESIMsAPIService) EsimPurchase 

func (a *ESIMsAPIService) EsimPurchase(ctx context.Context) ApiEsimPurchaseRequest

EsimPurchase Purchase eSIM 

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

func (*ESIMsAPIService) EsimPurchaseExecute 

func (a *ESIMsAPIService) EsimPurchaseExecute(r ApiEsimPurchaseRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*ESIMsAPIService) EsimTopup 

func (a *ESIMsAPIService) EsimTopup(ctx context.Context) ApiEsimTopupRequest

EsimTopup Top up eSIM 

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

func (*ESIMsAPIService) EsimTopupExecute 

func (a *ESIMsAPIService) EsimTopupExecute(r ApiEsimTopupRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*ESIMsAPIService) EsimTopupPlans 

func (a *ESIMsAPIService) EsimTopupPlans(ctx context.Context) ApiEsimTopupPlansRequest

EsimTopupPlans Top Up Plans 

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

func (*ESIMsAPIService) EsimTopupPlansExecute 

func (a *ESIMsAPIService) EsimTopupPlansExecute(r ApiEsimTopupPlansRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

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 InformationAPI 

type InformationAPI interface {

	/*
		CountryRetrieveAll Country list

		This API endpoint is used to retrieve the full country list for SMSPool requests. It sends an HTTP GET request to the URL `https://api.smspool.net/country/retrieve_all`.

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

	// CountryRetrieveAllExecute executes the request
	//  @return interface{}
	CountryRetrieveAllExecute(r ApiCountryRetrieveAllRequest) (interface{}, *http.Response, error)

	/*
		PoolRetrieveAll Pool list

		This API endpoint is used to retrieve a list of our active pools for SMSPool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/pool/retrieve_all`.

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

	// PoolRetrieveAllExecute executes the request
	//  @return interface{}
	PoolRetrieveAllExecute(r ApiPoolRetrieveAllRequest) (interface{}, *http.Response, error)

	/*
		PoolRetrieveValid Suggested Pools

		This API endpoint is used to retrieve suggested pools for SMSPool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/pool/retrieve_valid`.

	Please use either the service ID, or the service name as service param.

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

	// PoolRetrieveValidExecute executes the request
	//  @return interface{}
	PoolRetrieveValidExecute(r ApiPoolRetrieveValidRequest) (interface{}, *http.Response, error)

	/*
		RequestBalance Balance

		This HTTP POST request is used to retrieve the balance for a specific SMSPool. The request is sent to the URL `https://api.smspool.net/request/balance`.

	### Request Parameters

	This request require the \`key\` param which is your API key

	### Response

	The response to this request will have a status code of 200 if the request is successful. The response body will be in JSON format and will include a `balance` field. However, the last execution of this request returned an empty string for the `balance` field.

	Please note that the actual value of the `balance` field may vary depending on the user and its configuration.

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

	// RequestBalanceExecute executes the request
	//  @return interface{}
	RequestBalanceExecute(r ApiRequestBalanceRequest) (interface{}, *http.Response, error)

	/*
		RequestSuccessRate Retrieve country success rates per service

		This API endpoint is used to retrieve success per country for SMSPool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/request/success_rate`.

	Please use either the service ID, or the service name as service param.

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

	// RequestSuccessRateExecute executes the request
	//  @return interface{}
	RequestSuccessRateExecute(r ApiRequestSuccessRateRequest) (interface{}, *http.Response, error)

	/*
		RequestSuggestedCountries Suggested Countries

		This API endpoint is used to retrieve suggested countries for SMS pool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/request/suggested_countries`.

	Please use either the service ID, or the service name as service param.

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

	// RequestSuggestedCountriesExecute executes the request
	//  @return interface{}
	RequestSuggestedCountriesExecute(r ApiRequestSuggestedCountriesRequest) (interface{}, *http.Response, error)

	/*
		ServiceRetrieveAll Service list

		This API endpoint is used to retrieve the full service list for SMSPool requests. It sends an HTTP GET request to the URL `https://api.smspool.net/service/retrieve_all`.

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

	// ServiceRetrieveAllExecute executes the request
	//  @return interface{}
	ServiceRetrieveAllExecute(r ApiServiceRetrieveAllRequest) (interface{}, *http.Response, error)
}

type InformationAPIService 

type InformationAPIService service

InformationAPIService InformationAPI service

func (*InformationAPIService) CountryRetrieveAll 

func (a *InformationAPIService) CountryRetrieveAll(ctx context.Context) ApiCountryRetrieveAllRequest

CountryRetrieveAll Country list

This API endpoint is used to retrieve the full country list for SMSPool requests. It sends an HTTP GET request to the URL `https://api.smspool.net/country/retrieve_all`. 

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

func (*InformationAPIService) CountryRetrieveAllExecute 

func (a *InformationAPIService) CountryRetrieveAllExecute(r ApiCountryRetrieveAllRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*InformationAPIService) PoolRetrieveAll 

func (a *InformationAPIService) PoolRetrieveAll(ctx context.Context) ApiPoolRetrieveAllRequest

PoolRetrieveAll Pool list

This API endpoint is used to retrieve a list of our active pools for SMSPool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/pool/retrieve_all`. 

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

func (*InformationAPIService) PoolRetrieveAllExecute 

func (a *InformationAPIService) PoolRetrieveAllExecute(r ApiPoolRetrieveAllRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*InformationAPIService) PoolRetrieveValid 

func (a *InformationAPIService) PoolRetrieveValid(ctx context.Context) ApiPoolRetrieveValidRequest

PoolRetrieveValid Suggested Pools

This API endpoint is used to retrieve suggested pools for SMSPool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/pool/retrieve_valid`.

Please use either the service ID, or the service name as service param. 

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

func (*InformationAPIService) PoolRetrieveValidExecute 

func (a *InformationAPIService) PoolRetrieveValidExecute(r ApiPoolRetrieveValidRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*InformationAPIService) RequestBalance 

func (a *InformationAPIService) RequestBalance(ctx context.Context) ApiRequestBalanceRequest

RequestBalance Balance

This HTTP POST request is used to retrieve the balance for a specific SMSPool. The request is sent to the URL `https://api.smspool.net/request/balance`.

### Request Parameters

This request require the \`key\` param which is your API key

### Response

The response to this request will have a status code of 200 if the request is successful. The response body will be in JSON format and will include a `balance` field. However, the last execution of this request returned an empty string for the `balance` field.

Please note that the actual value of the `balance` field may vary depending on the user and its configuration. 

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

func (*InformationAPIService) RequestBalanceExecute 

func (a *InformationAPIService) RequestBalanceExecute(r ApiRequestBalanceRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*InformationAPIService) RequestSuccessRate 

func (a *InformationAPIService) RequestSuccessRate(ctx context.Context) ApiRequestSuccessRateRequest

RequestSuccessRate Retrieve country success rates per service

This API endpoint is used to retrieve success per country for SMSPool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/request/success_rate`.

Please use either the service ID, or the service name as service param. 

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

func (*InformationAPIService) RequestSuccessRateExecute 

func (a *InformationAPIService) RequestSuccessRateExecute(r ApiRequestSuccessRateRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*InformationAPIService) RequestSuggestedCountries 

func (a *InformationAPIService) RequestSuggestedCountries(ctx context.Context) ApiRequestSuggestedCountriesRequest

RequestSuggestedCountries Suggested Countries

This API endpoint is used to retrieve suggested countries for SMS pool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/request/suggested_countries`.

Please use either the service ID, or the service name as service param. 

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

func (*InformationAPIService) RequestSuggestedCountriesExecute 

func (a *InformationAPIService) RequestSuggestedCountriesExecute(r ApiRequestSuggestedCountriesRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*InformationAPIService) ServiceRetrieveAll 

func (a *InformationAPIService) ServiceRetrieveAll(ctx context.Context) ApiServiceRetrieveAllRequest

ServiceRetrieveAll Service list

This API endpoint is used to retrieve the full service list for SMSPool requests. It sends an HTTP GET request to the URL `https://api.smspool.net/service/retrieve_all`. 

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

func (*InformationAPIService) ServiceRetrieveAllExecute 

func (a *InformationAPIService) ServiceRetrieveAllExecute(r ApiServiceRetrieveAllRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

type MappedNullable 

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

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 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 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 PreordersAPI 

type PreordersAPI interface {

	/*
		PreorderCancel Cancel

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

	// PreorderCancelExecute executes the request
	//  @return interface{}
	PreorderCancelExecute(r ApiPreorderCancelRequest) (interface{}, *http.Response, error)

	/*
		PreorderCheck Check

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

	// PreorderCheckExecute executes the request
	//  @return interface{}
	PreorderCheckExecute(r ApiPreorderCheckRequest) (interface{}, *http.Response, error)

	/*
		PreorderCreate Create

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

	// PreorderCreateExecute executes the request
	//  @return interface{}
	PreorderCreateExecute(r ApiPreorderCreateRequest) (interface{}, *http.Response, error)

	/*
		PreorderPrice Price

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

	// PreorderPriceExecute executes the request
	//  @return interface{}
	PreorderPriceExecute(r ApiPreorderPriceRequest) (interface{}, *http.Response, error)

	/*
		PreorderRetrieve Retrieve

		This API endpoint allows you to retrieve preorders from the SMS Pool system. It is an HTTP POST request sent to the URL `https://api.smspool.net/preorder/retrieve`.

	### Request Parameters

	This endpoint requires the \`key\` parameter which is your API key.

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

	// PreorderRetrieveExecute executes the request
	//  @return interface{}
	PreorderRetrieveExecute(r ApiPreorderRetrieveRequest) (interface{}, *http.Response, error)
}

type PreordersAPIService 

type PreordersAPIService service

PreordersAPIService PreordersAPI service

func (*PreordersAPIService) PreorderCancel 

func (a *PreordersAPIService) PreorderCancel(ctx context.Context) ApiPreorderCancelRequest

PreorderCancel Cancel 

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

func (*PreordersAPIService) PreorderCancelExecute 

func (a *PreordersAPIService) PreorderCancelExecute(r ApiPreorderCancelRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*PreordersAPIService) PreorderCheck 

func (a *PreordersAPIService) PreorderCheck(ctx context.Context) ApiPreorderCheckRequest

PreorderCheck Check 

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

func (*PreordersAPIService) PreorderCheckExecute 

func (a *PreordersAPIService) PreorderCheckExecute(r ApiPreorderCheckRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*PreordersAPIService) PreorderCreate 

func (a *PreordersAPIService) PreorderCreate(ctx context.Context) ApiPreorderCreateRequest

PreorderCreate Create 

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

func (*PreordersAPIService) PreorderCreateExecute 

func (a *PreordersAPIService) PreorderCreateExecute(r ApiPreorderCreateRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*PreordersAPIService) PreorderPrice 

func (a *PreordersAPIService) PreorderPrice(ctx context.Context) ApiPreorderPriceRequest

PreorderPrice Price 

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

func (*PreordersAPIService) PreorderPriceExecute 

func (a *PreordersAPIService) PreorderPriceExecute(r ApiPreorderPriceRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*PreordersAPIService) PreorderRetrieve 

func (a *PreordersAPIService) PreorderRetrieve(ctx context.Context) ApiPreorderRetrieveRequest

PreorderRetrieve Retrieve

This API endpoint allows you to retrieve preorders from the SMS Pool system. It is an HTTP POST request sent to the URL `https://api.smspool.net/preorder/retrieve`.

### Request Parameters

This endpoint requires the \`key\` parameter which is your API key. 

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

func (*PreordersAPIService) PreorderRetrieveExecute 

func (a *PreordersAPIService) PreorderRetrieveExecute(r ApiPreorderRetrieveRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

type PricingAPI 

type PricingAPI interface {

	/*
		RequestPrice Retrieve specific price & Success Rate

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

	// RequestPriceExecute executes the request
	//  @return interface{}
	RequestPriceExecute(r ApiRequestPriceRequest) (interface{}, *http.Response, error)

	/*
		RequestPricing Retrieve all pricing

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

	// RequestPricingExecute executes the request
	//  @return interface{}
	RequestPricingExecute(r ApiRequestPricingRequest) (interface{}, *http.Response, error)
}

type PricingAPIService 

type PricingAPIService service

PricingAPIService PricingAPI service

func (*PricingAPIService) RequestPrice 

func (a *PricingAPIService) RequestPrice(ctx context.Context) ApiRequestPriceRequest

RequestPrice Retrieve specific price & Success Rate 

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

func (*PricingAPIService) RequestPriceExecute 

func (a *PricingAPIService) RequestPriceExecute(r ApiRequestPriceRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*PricingAPIService) RequestPricing 

func (a *PricingAPIService) RequestPricing(ctx context.Context) ApiRequestPricingRequest

RequestPricing Retrieve all pricing 

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

func (*PricingAPIService) RequestPricingExecute 

func (a *PricingAPIService) RequestPricingExecute(r ApiRequestPricingRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

type RentalAPI 

type RentalAPI interface {

	/*
		PurchaseRental Order Rental

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

	// PurchaseRentalExecute executes the request
	//  @return interface{}
	PurchaseRentalExecute(r ApiPurchaseRentalRequest) (interface{}, *http.Response, error)

	/*
		RentalAutoExtend Enable Auto Extend Rental

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

	// RentalAutoExtendExecute executes the request
	//  @return interface{}
	RentalAutoExtendExecute(r ApiRentalAutoExtendRequest) (interface{}, *http.Response, error)

	/*
		RentalExtend Extend Rental

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

	// RentalExtendExecute executes the request
	//  @return interface{}
	RentalExtendExecute(r ApiRentalExtendRequest) (interface{}, *http.Response, error)

	/*
		RentalHistory Rental History

		Retrieve a history of all your rental actions.

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

	// RentalHistoryExecute executes the request
	//  @return interface{}
	RentalHistoryExecute(r ApiRentalHistoryRequest) (interface{}, *http.Response, error)

	/*
		RentalInfo Retrieve Rental Info

		Retrieve rental information

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

	// RentalInfoExecute executes the request
	//  @return interface{}
	RentalInfoExecute(r ApiRentalInfoRequest) (interface{}, *http.Response, error)

	/*
		RentalRefund Refund Rental

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

	// RentalRefundExecute executes the request
	//  @return interface{}
	RentalRefundExecute(r ApiRentalRefundRequest) (interface{}, *http.Response, error)

	/*
		RentalReset Reset Rental

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

	// RentalResetExecute executes the request
	//  @return interface{}
	RentalResetExecute(r ApiRentalResetRequest) (interface{}, *http.Response, error)

	/*
		RentalRetrieve Retrieve Active Rentals

		Retrieve a history of all your rental actions.

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

	// RentalRetrieveExecute executes the request
	//  @return interface{}
	RentalRetrieveExecute(r ApiRentalRetrieveRequest) (interface{}, *http.Response, error)

	/*
		RentalRetrieveAll Retrieve Rental IDs

		Retrieve available rental products. Each listing includes `is_refundable` (`0` or `1`), `refund_within` (hours after purchase a refund is allowed; `0` when not refundable), and `refund_min_days` (minimum duration that is eligible for a refund; `0` when there is no duration floor or the rental is never refundable). Refunds also require that no messages have been received.

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

	// RentalRetrieveAllExecute executes the request
	//  @return interface{}
	RentalRetrieveAllExecute(r ApiRentalRetrieveAllRequest) (interface{}, *http.Response, error)

	/*
		RentalRetrieveHistory Retrieve your rentals

		List every rental on your account that was not refunded, including expired ones. For the actions taken on your rentals (activations, extensions, refunds) use **Rental History** instead.

	- `rental`: the rental ID from **Retrieve Rental IDs**
	- `rental_code`: use it with the other rental endpoints, such as **Retrieve Rental Messages**
	- `expiration_date`: Unix timestamp
	- `source`: the pool the number comes from
	- `state`: the US state of the number, or `Unknown`

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

	// RentalRetrieveHistoryExecute executes the request
	//  @return interface{}
	RentalRetrieveHistoryExecute(r ApiRentalRetrieveHistoryRequest) (interface{}, *http.Response, error)

	/*
		RentalRetrieveMessages Retrieve Rental Messages

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

	// RentalRetrieveMessagesExecute executes the request
	//  @return interface{}
	RentalRetrieveMessagesExecute(r ApiRentalRetrieveMessagesRequest) (interface{}, *http.Response, error)

	/*
		RentalRetrievePricing Retrieve Rental Pricing

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

	// RentalRetrievePricingExecute executes the request
	//  @return interface{}
	RentalRetrievePricingExecute(r ApiRentalRetrievePricingRequest) (interface{}, *http.Response, error)

	/*
		RentalRetrieveServices Retrieve Rental Services

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

	// RentalRetrieveServicesExecute executes the request
	//  @return interface{}
	RentalRetrieveServicesExecute(r ApiRentalRetrieveServicesRequest) (interface{}, *http.Response, error)

	/*
		RentalRetrieveStatus Retrieve Rental Status

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

	// RentalRetrieveStatusExecute executes the request
	//  @return interface{}
	RentalRetrieveStatusExecute(r ApiRentalRetrieveStatusRequest) (interface{}, *http.Response, error)

	/*
		RentalServicePrice Retrieve rental service price

		Some rentals are bound to a single service. This returns the price of a rental for that service, with the custom pricing on your account applied.

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

	// RentalServicePriceExecute executes the request
	//  @return interface{}
	RentalServicePriceExecute(r ApiRentalServicePriceRequest) (interface{}, *http.Response, error)

	/*
		RentalStock Retrieve Rental Stock

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

	// RentalStockExecute executes the request
	//  @return interface{}
	RentalStockExecute(r ApiRentalStockRequest) (interface{}, *http.Response, error)
}

type RentalAPIService 

type RentalAPIService service

RentalAPIService RentalAPI service

func (*RentalAPIService) PurchaseRental 

func (a *RentalAPIService) PurchaseRental(ctx context.Context) ApiPurchaseRentalRequest

PurchaseRental Order Rental 

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

func (*RentalAPIService) PurchaseRentalExecute 

func (a *RentalAPIService) PurchaseRentalExecute(r ApiPurchaseRentalRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalAutoExtend 

func (a *RentalAPIService) RentalAutoExtend(ctx context.Context) ApiRentalAutoExtendRequest

RentalAutoExtend Enable Auto Extend Rental 

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

func (*RentalAPIService) RentalAutoExtendExecute 

func (a *RentalAPIService) RentalAutoExtendExecute(r ApiRentalAutoExtendRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalExtend 

func (a *RentalAPIService) RentalExtend(ctx context.Context) ApiRentalExtendRequest

RentalExtend Extend Rental 

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

func (*RentalAPIService) RentalExtendExecute 

func (a *RentalAPIService) RentalExtendExecute(r ApiRentalExtendRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalHistory 

func (a *RentalAPIService) RentalHistory(ctx context.Context) ApiRentalHistoryRequest

RentalHistory Rental History

Retrieve a history of all your rental actions. 

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

func (*RentalAPIService) RentalHistoryExecute 

func (a *RentalAPIService) RentalHistoryExecute(r ApiRentalHistoryRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalInfo 

func (a *RentalAPIService) RentalInfo(ctx context.Context) ApiRentalInfoRequest

RentalInfo Retrieve Rental Info

Retrieve rental information 

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

func (*RentalAPIService) RentalInfoExecute 

func (a *RentalAPIService) RentalInfoExecute(r ApiRentalInfoRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalRefund 

func (a *RentalAPIService) RentalRefund(ctx context.Context) ApiRentalRefundRequest

RentalRefund Refund Rental 

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

func (*RentalAPIService) RentalRefundExecute 

func (a *RentalAPIService) RentalRefundExecute(r ApiRentalRefundRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalReset 

func (a *RentalAPIService) RentalReset(ctx context.Context) ApiRentalResetRequest

RentalReset Reset Rental 

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

func (*RentalAPIService) RentalResetExecute 

func (a *RentalAPIService) RentalResetExecute(r ApiRentalResetRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalRetrieve 

func (a *RentalAPIService) RentalRetrieve(ctx context.Context) ApiRentalRetrieveRequest

RentalRetrieve Retrieve Active Rentals

Retrieve a history of all your rental actions. 

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

func (*RentalAPIService) RentalRetrieveAll 

func (a *RentalAPIService) RentalRetrieveAll(ctx context.Context) ApiRentalRetrieveAllRequest

RentalRetrieveAll Retrieve Rental IDs

Retrieve available rental products. Each listing includes `is_refundable` (`0` or `1`), `refund_within` (hours after purchase a refund is allowed; `0` when not refundable), and `refund_min_days` (minimum duration that is eligible for a refund; `0` when there is no duration floor or the rental is never refundable). Refunds also require that no messages have been received. 

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

func (*RentalAPIService) RentalRetrieveAllExecute 

func (a *RentalAPIService) RentalRetrieveAllExecute(r ApiRentalRetrieveAllRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalRetrieveExecute 

func (a *RentalAPIService) RentalRetrieveExecute(r ApiRentalRetrieveRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalRetrieveHistory 

func (a *RentalAPIService) RentalRetrieveHistory(ctx context.Context) ApiRentalRetrieveHistoryRequest

RentalRetrieveHistory Retrieve your rentals

List every rental on your account that was not refunded, including expired ones. For the actions taken on your rentals (activations, extensions, refunds) use **Rental History** instead.

- `rental`: the rental ID from **Retrieve Rental IDs** - `rental_code`: use it with the other rental endpoints, such as **Retrieve Rental Messages** - `expiration_date`: Unix timestamp - `source`: the pool the number comes from - `state`: the US state of the number, or `Unknown` 

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

func (*RentalAPIService) RentalRetrieveHistoryExecute 

func (a *RentalAPIService) RentalRetrieveHistoryExecute(r ApiRentalRetrieveHistoryRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalRetrieveMessages 

func (a *RentalAPIService) RentalRetrieveMessages(ctx context.Context) ApiRentalRetrieveMessagesRequest

RentalRetrieveMessages Retrieve Rental Messages 

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

func (*RentalAPIService) RentalRetrieveMessagesExecute 

func (a *RentalAPIService) RentalRetrieveMessagesExecute(r ApiRentalRetrieveMessagesRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalRetrievePricing 

func (a *RentalAPIService) RentalRetrievePricing(ctx context.Context) ApiRentalRetrievePricingRequest

RentalRetrievePricing Retrieve Rental Pricing 

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

func (*RentalAPIService) RentalRetrievePricingExecute 

func (a *RentalAPIService) RentalRetrievePricingExecute(r ApiRentalRetrievePricingRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalRetrieveServices 

func (a *RentalAPIService) RentalRetrieveServices(ctx context.Context) ApiRentalRetrieveServicesRequest

RentalRetrieveServices Retrieve Rental Services 

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

func (*RentalAPIService) RentalRetrieveServicesExecute 

func (a *RentalAPIService) RentalRetrieveServicesExecute(r ApiRentalRetrieveServicesRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalRetrieveStatus 

func (a *RentalAPIService) RentalRetrieveStatus(ctx context.Context) ApiRentalRetrieveStatusRequest

RentalRetrieveStatus Retrieve Rental Status 

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

func (*RentalAPIService) RentalRetrieveStatusExecute 

func (a *RentalAPIService) RentalRetrieveStatusExecute(r ApiRentalRetrieveStatusRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalServicePrice 

func (a *RentalAPIService) RentalServicePrice(ctx context.Context) ApiRentalServicePriceRequest

RentalServicePrice Retrieve rental service price

Some rentals are bound to a single service. This returns the price of a rental for that service, with the custom pricing on your account applied. 

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

func (*RentalAPIService) RentalServicePriceExecute 

func (a *RentalAPIService) RentalServicePriceExecute(r ApiRentalServicePriceRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*RentalAPIService) RentalStock 

func (a *RentalAPIService) RentalStock(ctx context.Context) ApiRentalStockRequest

RentalStock Retrieve Rental Stock 

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

func (*RentalAPIService) RentalStockExecute 

func (a *RentalAPIService) RentalStockExecute(r ApiRentalStockRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

type SMSAPI 

type SMSAPI interface {

	/*
		PurchaseSms Order SMS

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

	// PurchaseSmsExecute executes the request
	//  @return interface{}
	PurchaseSmsExecute(r ApiPurchaseSmsRequest) (interface{}, *http.Response, error)

	/*
		RequestActive Active orders

		The recommended endpoint to retrieve your current active orders, this will display all your orders at the same time. We recommend using this endpoint to iterate through your active orders to retrieve your SMS messages.

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

	// RequestActiveExecute executes the request
	//  @return interface{}
	RequestActiveExecute(r ApiRequestActiveRequest) (interface{}, *http.Response, error)

	/*
		RequestArchive Archive all orders

		This API endpoint is used to archive a request in the SMS Pool system. The HTTP POST request should be sent to `https://api.smspool.net/request/archive`.

	### Request Parameters

	The \`key\` parameter is required for this endpoint, this is your API key.

	### Response

	The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:

	- `success` (integer): A flag indicating the success of the request. A value of 0 indicates failure.
	- `message` (string): An optional message providing additional information about the request. In this case, the message is empty.


	Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation.

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

	// RequestArchiveExecute executes the request
	//  @return interface{}
	RequestArchiveExecute(r ApiRequestArchiveRequest) (interface{}, *http.Response, error)

	/*
		RequestAreacodes Request available areacodes

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

	// RequestAreacodesExecute executes the request
	//  @return interface{}
	RequestAreacodesExecute(r ApiRequestAreacodesRequest) (interface{}, *http.Response, error)

	/*
		RequestHistory Order History

		This API endpoint is used to retrieve the history of SMS requests. It is an HTTP POST request that should be made to the following URL: `https://api.smspool.net/request/history`.

	The request requires the \`key\` parameter which is your API key.

	The response returned by the API is a JSON array. Each element in the array represents a historical SMS request and contains the following properties:

	- `cost`: The cost of the SMS request.
	- `order_code`: The order code associated with the SMS request.
	- `phonenumber`: The phone number to which the SMS was sent.
	- `code`: The code associated with the SMS request.
	- `full_code`: The full code associated with the SMS request.
	- `short_name`: The short name associated with the SMS request.
	- `service`: The service associated with the SMS request.
	- `status`: The status of the SMS request.
	- `pool`: The pool associated with the SMS request.
	- `timestamp`: The timestamp of the SMS request.
	- `completed_on`: The completion date of the SMS request.
	- `expiry`: The expiry time of the SMS request.
	- `time_left`: The time left for the SMS request to expire.


	Please note that the values for the properties are not provided in the response example, so they may be empty or null.

	The last execution of this API request returned a response with a status code of 200, indicating a successful execution. The response body contained an array of SMS request history objects.

	Please refer to the API documentation for more details on how to use this endpoint and interpret the response.

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

	// RequestHistoryExecute executes the request
	//  @return interface{}
	RequestHistoryExecute(r ApiRequestHistoryRequest) (interface{}, *http.Response, error)

	/*
		SmsActivate Activate SMS

		This endpoint will forcefully activate an SMS to set it available for future resends, please keep in mind that these orders are NOT eligible for a refund after activating them.

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

	// SmsActivateExecute executes the request
	//  @return interface{}
	SmsActivateExecute(r ApiSmsActivateRequest) (interface{}, *http.Response, error)

	/*
		SmsAllStock One-time stock for all services

		This API endpoint is used to retrieve one-time SMS stock in the SMSPool system. The HTTP POST request should be sent to `https://api.smspool.net/sms/stock`.

	### Request Parameters

	The \`key\` parameter is required for this endpoint, this is your API key.

	### Response

	The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:

	- `success` (integer): A flag indicating the success of the request. A value of 0 indicates failure.

	- `message` (string): An optional message providing additional information about the request. In this case, the message is empty.


	Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation.

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

	// SmsAllStockExecute executes the request
	//  @return interface{}
	SmsAllStockExecute(r ApiSmsAllStockRequest) (interface{}, *http.Response, error)

	/*
		SmsCancel Cancel SMS

		# Cancel your SMS order

	## Responses

	| **Success** | {"success":1} |
	| **Fail** | {"success":0} |

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

	// SmsCancelExecute executes the request
	//  @return interface{}
	SmsCancelExecute(r ApiSmsCancelRequest) (interface{}, *http.Response, error)

	/*
		SmsCancelAll Cancel All SMS

		# Cancel your SMS order

	## Responses

	| **Success** | {"success":1} |
	| **Fail** | {"success":0} |

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

	// SmsCancelAllExecute executes the request
	//  @return interface{}
	SmsCancelAllExecute(r ApiSmsCancelAllRequest) (interface{}, *http.Response, error)

	/*
		SmsCheck Check SMS

		You may run into ratelimits while using this endpoint for high rate requests, we recommend using /request/active instead as it will list all your orders at the same time.

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

	// SmsCheckExecute executes the request
	//  @return interface{}
	SmsCheckExecute(r ApiSmsCheckRequest) (interface{}, *http.Response, error)

	/*
		SmsCheckResend Check Resend

		Check if the order can be resent or not.

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

	// SmsCheckResendExecute executes the request
	//  @return interface{}
	SmsCheckResendExecute(r ApiSmsCheckResendRequest) (interface{}, *http.Response, error)

	/*
		SmsClearCache Clear SMS Cache

		# Clear your previous SMS cache to allocate previous numbers again

	## Responses

	| **Success** | {"success":1} |
	| **Fail** | {"success":0} |

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

	// SmsClearCacheExecute executes the request
	//  @return interface{}
	SmsClearCacheExecute(r ApiSmsClearCacheRequest) (interface{}, *http.Response, error)

	/*
		SmsMissed Missed SMS

		Some messages arrive on a number from your one-time orders but cannot finish the order, such as Ticketmaster and Seated codes or Hark reward payouts. This returns those messages, the same ones the Missed SMS tool on the website shows. Only numbers from pool Foxtrot are covered.

	The newest messages come first. `url`, `code` and `email` hold the first link, code and email address found in the message, or an empty string.

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

	// SmsMissedExecute executes the request
	//  @return interface{}
	SmsMissedExecute(r ApiSmsMissedRequest) (interface{}, *http.Response, error)

	/*
		SmsReactivate Reactivate SMS

		This endpoint will reactivate an order, please keep in mind that these orders are NOT eligible for a refund after activating them.

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

	// SmsReactivateExecute executes the request
	//  @return interface{}
	SmsReactivateExecute(r ApiSmsReactivateRequest) (interface{}, *http.Response, error)

	/*
		SmsResend Resend

		# Resend

	Resend the order. Keep in mind that some pools will have a charge per resend. You can see whether the resend will have a charge using the "Check Resend" endpoint

	## Responses

	| **Success** | {"success":1,"message":"Number has been requested again","resend":0} |
	| **Fail** | {"success":0,"message":"Phonenumber could not be requested again, try later again.","resend":0} |

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

	// SmsResendExecute executes the request
	//  @return interface{}
	SmsResendExecute(r ApiSmsResendRequest) (interface{}, *http.Response, error)

	/*
		SmsStock One-time SMS stock

		This API endpoint is used to retrieve one-time SMS stock in the SMSPool system. The HTTP POST request should be sent to `https://api.smspool.net/sms/stock`.

	### Request Parameters

	The \`key\` parameter is required for this endpoint, this is your API key.

	### Response

	The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:

	- `success` (integer): A flag indicating the success of the request. A value of 0 indicates failure.

	- `message` (string): An optional message providing additional information about the request. In this case, the message is empty.


	Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation.

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

	// SmsStockExecute executes the request
	//  @return interface{}
	SmsStockExecute(r ApiSmsStockRequest) (interface{}, *http.Response, error)

	/*
		SmsUnarchive Unarchive order

		Move an archived order back to your active orders, so it shows up in **Active orders** and on your dashboard again. Use **Archive all orders** to archive them.

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

	// SmsUnarchiveExecute executes the request
	//  @return interface{}
	SmsUnarchiveExecute(r ApiSmsUnarchiveRequest) (interface{}, *http.Response, error)
}

type SMSAPIService 

type SMSAPIService service

SMSAPIService SMSAPI service

func (*SMSAPIService) PurchaseSms 

func (a *SMSAPIService) PurchaseSms(ctx context.Context) ApiPurchaseSmsRequest

PurchaseSms Order SMS 

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

func (*SMSAPIService) PurchaseSmsExecute 

func (a *SMSAPIService) PurchaseSmsExecute(r ApiPurchaseSmsRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) RequestActive 

func (a *SMSAPIService) RequestActive(ctx context.Context) ApiRequestActiveRequest

RequestActive Active orders

The recommended endpoint to retrieve your current active orders, this will display all your orders at the same time. We recommend using this endpoint to iterate through your active orders to retrieve your SMS messages. 

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

func (*SMSAPIService) RequestActiveExecute 

func (a *SMSAPIService) RequestActiveExecute(r ApiRequestActiveRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) RequestArchive 

func (a *SMSAPIService) RequestArchive(ctx context.Context) ApiRequestArchiveRequest

RequestArchive Archive all orders

This API endpoint is used to archive a request in the SMS Pool system. The HTTP POST request should be sent to `https://api.smspool.net/request/archive`.

### Request Parameters

The \`key\` parameter is required for this endpoint, this is your API key.

### Response

The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:

- `success` (integer): A flag indicating the success of the request. A value of 0 indicates failure. - `message` (string): An optional message providing additional information about the request. In this case, the message is empty.

Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation. 

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

func (*SMSAPIService) RequestArchiveExecute 

func (a *SMSAPIService) RequestArchiveExecute(r ApiRequestArchiveRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) RequestAreacodes 

func (a *SMSAPIService) RequestAreacodes(ctx context.Context) ApiRequestAreacodesRequest

RequestAreacodes Request available areacodes 

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

func (*SMSAPIService) RequestAreacodesExecute 

func (a *SMSAPIService) RequestAreacodesExecute(r ApiRequestAreacodesRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) RequestHistory 

func (a *SMSAPIService) RequestHistory(ctx context.Context) ApiRequestHistoryRequest

RequestHistory Order History

This API endpoint is used to retrieve the history of SMS requests. It is an HTTP POST request that should be made to the following URL: `https://api.smspool.net/request/history`.

The request requires the \`key\` parameter which is your API key.

The response returned by the API is a JSON array. Each element in the array represents a historical SMS request and contains the following properties:

- `cost`: The cost of the SMS request. - `order_code`: The order code associated with the SMS request. - `phonenumber`: The phone number to which the SMS was sent. - `code`: The code associated with the SMS request. - `full_code`: The full code associated with the SMS request. - `short_name`: The short name associated with the SMS request. - `service`: The service associated with the SMS request. - `status`: The status of the SMS request. - `pool`: The pool associated with the SMS request. - `timestamp`: The timestamp of the SMS request. - `completed_on`: The completion date of the SMS request. - `expiry`: The expiry time of the SMS request. - `time_left`: The time left for the SMS request to expire.

Please note that the values for the properties are not provided in the response example, so they may be empty or null.

The last execution of this API request returned a response with a status code of 200, indicating a successful execution. The response body contained an array of SMS request history objects.

Please refer to the API documentation for more details on how to use this endpoint and interpret the response. 

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

func (*SMSAPIService) RequestHistoryExecute 

func (a *SMSAPIService) RequestHistoryExecute(r ApiRequestHistoryRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsActivate 

func (a *SMSAPIService) SmsActivate(ctx context.Context) ApiSmsActivateRequest

SmsActivate Activate SMS

This endpoint will forcefully activate an SMS to set it available for future resends, please keep in mind that these orders are NOT eligible for a refund after activating them. 

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

func (*SMSAPIService) SmsActivateExecute 

func (a *SMSAPIService) SmsActivateExecute(r ApiSmsActivateRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsAllStock 

func (a *SMSAPIService) SmsAllStock(ctx context.Context) ApiSmsAllStockRequest

SmsAllStock One-time stock for all services

This API endpoint is used to retrieve one-time SMS stock in the SMSPool system. The HTTP POST request should be sent to `https://api.smspool.net/sms/stock`.

### Request Parameters

The \`key\` parameter is required for this endpoint, this is your API key.

### Response

The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:

- `success` (integer): A flag indicating the success of the request. A value of 0 indicates failure.

- `message` (string): An optional message providing additional information about the request. In this case, the message is empty.

Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation. 

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

func (*SMSAPIService) SmsAllStockExecute 

func (a *SMSAPIService) SmsAllStockExecute(r ApiSmsAllStockRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsCancel 

func (a *SMSAPIService) SmsCancel(ctx context.Context) ApiSmsCancelRequest

SmsCancel Cancel SMS

Cancel your SMS order

## Responses

| **Success** | {"success":1} | | **Fail** | {"success":0} | 

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

func (*SMSAPIService) SmsCancelAll 

func (a *SMSAPIService) SmsCancelAll(ctx context.Context) ApiSmsCancelAllRequest

SmsCancelAll Cancel All SMS

Cancel your SMS order

## Responses

| **Success** | {"success":1} | | **Fail** | {"success":0} | 

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

func (*SMSAPIService) SmsCancelAllExecute 

func (a *SMSAPIService) SmsCancelAllExecute(r ApiSmsCancelAllRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsCancelExecute 

func (a *SMSAPIService) SmsCancelExecute(r ApiSmsCancelRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsCheck 

func (a *SMSAPIService) SmsCheck(ctx context.Context) ApiSmsCheckRequest

SmsCheck Check SMS

You may run into ratelimits while using this endpoint for high rate requests, we recommend using /request/active instead as it will list all your orders at the same time. 

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

func (*SMSAPIService) SmsCheckExecute 

func (a *SMSAPIService) SmsCheckExecute(r ApiSmsCheckRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsCheckResend 

func (a *SMSAPIService) SmsCheckResend(ctx context.Context) ApiSmsCheckResendRequest

SmsCheckResend Check Resend

Check if the order can be resent or not. 

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

func (*SMSAPIService) SmsCheckResendExecute 

func (a *SMSAPIService) SmsCheckResendExecute(r ApiSmsCheckResendRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsClearCache 

func (a *SMSAPIService) SmsClearCache(ctx context.Context) ApiSmsClearCacheRequest

SmsClearCache Clear SMS Cache

Clear your previous SMS cache to allocate previous numbers again

## Responses

| **Success** | {"success":1} | | **Fail** | {"success":0} | 

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

func (*SMSAPIService) SmsClearCacheExecute 

func (a *SMSAPIService) SmsClearCacheExecute(r ApiSmsClearCacheRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsMissed 

func (a *SMSAPIService) SmsMissed(ctx context.Context) ApiSmsMissedRequest

SmsMissed Missed SMS

Some messages arrive on a number from your one-time orders but cannot finish the order, such as Ticketmaster and Seated codes or Hark reward payouts. This returns those messages, the same ones the Missed SMS tool on the website shows. Only numbers from pool Foxtrot are covered.

The newest messages come first. `url`, `code` and `email` hold the first link, code and email address found in the message, or an empty string. 

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

func (*SMSAPIService) SmsMissedExecute 

func (a *SMSAPIService) SmsMissedExecute(r ApiSmsMissedRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsReactivate 

func (a *SMSAPIService) SmsReactivate(ctx context.Context) ApiSmsReactivateRequest

SmsReactivate Reactivate SMS

This endpoint will reactivate an order, please keep in mind that these orders are NOT eligible for a refund after activating them. 

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

func (*SMSAPIService) SmsReactivateExecute 

func (a *SMSAPIService) SmsReactivateExecute(r ApiSmsReactivateRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsResend 

func (a *SMSAPIService) SmsResend(ctx context.Context) ApiSmsResendRequest

SmsResend Resend

Resend

Resend the order. Keep in mind that some pools will have a charge per resend. You can see whether the resend will have a charge using the "Check Resend" endpoint

## Responses

| **Success** | {"success":1,"message":"Number has been requested again","resend":0} | | **Fail** | {"success":0,"message":"Phonenumber could not be requested again, try later again.","resend":0} | 

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

func (*SMSAPIService) SmsResendExecute 

func (a *SMSAPIService) SmsResendExecute(r ApiSmsResendRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsStock 

func (a *SMSAPIService) SmsStock(ctx context.Context) ApiSmsStockRequest

SmsStock One-time SMS stock

This API endpoint is used to retrieve one-time SMS stock in the SMSPool system. The HTTP POST request should be sent to `https://api.smspool.net/sms/stock`.

### Request Parameters

The \`key\` parameter is required for this endpoint, this is your API key.

### Response

The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:

- `success` (integer): A flag indicating the success of the request. A value of 0 indicates failure.

- `message` (string): An optional message providing additional information about the request. In this case, the message is empty.

Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation. 

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

func (*SMSAPIService) SmsStockExecute 

func (a *SMSAPIService) SmsStockExecute(r ApiSmsStockRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*SMSAPIService) SmsUnarchive 

func (a *SMSAPIService) SmsUnarchive(ctx context.Context) ApiSmsUnarchiveRequest

SmsUnarchive Unarchive order

Move an archived order back to your active orders, so it shows up in **Active orders** and on your dashboard again. Use **Archive all orders** to archive them. 

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

func (*SMSAPIService) SmsUnarchiveExecute 

func (a *SMSAPIService) SmsUnarchiveExecute(r ApiSmsUnarchiveRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

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 VoucherAPI 

type VoucherAPI interface {

	/*
		VoucherBulkGenerate Bulk generate vouchers

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

	// VoucherBulkGenerateExecute executes the request
	//  @return interface{}
	VoucherBulkGenerateExecute(r ApiVoucherBulkGenerateRequest) (interface{}, *http.Response, error)

	/*
		VoucherDelete Delete voucher

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

	// VoucherDeleteExecute executes the request
	//  @return interface{}
	VoucherDeleteExecute(r ApiVoucherDeleteRequest) (interface{}, *http.Response, error)

	/*
		VoucherGenerate Generate voucher

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

	// VoucherGenerateExecute executes the request
	//  @return interface{}
	VoucherGenerateExecute(r ApiVoucherGenerateRequest) (interface{}, *http.Response, error)

	/*
		VoucherRetrieve Retrieve vouchers

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

	// VoucherRetrieveExecute executes the request
	//  @return interface{}
	VoucherRetrieveExecute(r ApiVoucherRetrieveRequest) (interface{}, *http.Response, error)
}

type VoucherAPIService 

type VoucherAPIService service

VoucherAPIService VoucherAPI service

func (*VoucherAPIService) VoucherBulkGenerate 

func (a *VoucherAPIService) VoucherBulkGenerate(ctx context.Context) ApiVoucherBulkGenerateRequest

VoucherBulkGenerate Bulk generate vouchers 

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

func (*VoucherAPIService) VoucherBulkGenerateExecute 

func (a *VoucherAPIService) VoucherBulkGenerateExecute(r ApiVoucherBulkGenerateRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*VoucherAPIService) VoucherDelete 

func (a *VoucherAPIService) VoucherDelete(ctx context.Context) ApiVoucherDeleteRequest

VoucherDelete Delete voucher 

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

func (*VoucherAPIService) VoucherDeleteExecute 

func (a *VoucherAPIService) VoucherDeleteExecute(r ApiVoucherDeleteRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*VoucherAPIService) VoucherGenerate 

func (a *VoucherAPIService) VoucherGenerate(ctx context.Context) ApiVoucherGenerateRequest

VoucherGenerate Generate voucher 

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

func (*VoucherAPIService) VoucherGenerateExecute 

func (a *VoucherAPIService) VoucherGenerateExecute(r ApiVoucherGenerateRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

func (*VoucherAPIService) VoucherRetrieve 

func (a *VoucherAPIService) VoucherRetrieve(ctx context.Context) ApiVoucherRetrieveRequest

VoucherRetrieve Retrieve vouchers 

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

func (*VoucherAPIService) VoucherRetrieveExecute 

func (a *VoucherAPIService) VoucherRetrieveExecute(r ApiVoucherRetrieveRequest) (interface{}, *http.Response, error)

Execute executes the request 

@return interface{}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.