TelstraMessaging

package module
v3.4.13 Latest Latest
Warning

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

 Go to latest Published: Mar 27, 2024 License: MIT Imports: 21 Imported by: 0

README

Go API client for TelstraMessaging V3

Send and receive SMS & MMS programmatically, leveraging Australia's leading mobile network. With Telstra's Messaging API, we take out the complexity to allow seamless messaging integration into your app, with just a few lines of code. Our REST API is enterprise grade, allowing you to communicate with engaging SMS & MMS messaging in your web and mobile apps in near real-time on a global scale.

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/telstra/MessagingAPI-SDK-Go/v3

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

import TelstraMessaging "github.com/telstra/MessagingAPI-SDK-Go/v3"

To use a proxy, set the environment variable HTTP_PROXY:

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

Documentation for API Endpoints

All URIs are relative to https://products.api.telstra.com/messaging/v3

Class Method HTTP request Description
AuthenticationAPI AuthToken Post /oauth/token Generate an access token
FreeTrialNumbersAPI CreateTrialNumbers Post /free-trial-numbers create free trial number list
FreeTrialNumbersAPI GetTrialNumbers Get /free-trial-numbers get all free trial numbers
HealthCheckAPI HealthCheck Get /health-check health check
LogsAPI GetLogs Get /logs get logs
MessagesAPI DeleteMessageById Delete /messages/{messageId} delete a message
MessagesAPI GetMessageById Get /messages/{messageId} fetch a specific message
MessagesAPI GetMessages Get /messages fetch all sent/received messages
MessagesAPI SendMessages Post /messages send messages
MessagesAPI UpdateMessageById Put /messages/{messageId} update a message
MessagesAPI UpdateMessageTags Patch /messages/{messageId} update message tags
ReportsAPI GetReport Get /reports/{reportId} fetch a specific report
ReportsAPI GetReports Get /reports fetch all reports
ReportsAPI MessagesReport Post /reports/messages submit a request for a messages report
VirtualNumbersAPI AssignNumber Post /virtual-numbers assign a virtual number
VirtualNumbersAPI DeleteNumber Delete /virtual-numbers/{virtual-number} delete a virtual number
VirtualNumbersAPI GetNumbers Get /virtual-numbers fetch all virtual numbers
VirtualNumbersAPI GetRecipientOptouts Get /virtual-numbers/{virtual-number}/optouts Get recipient optouts list
VirtualNumbersAPI GetVirtualNumber Get /virtual-numbers/{virtual-number} fetch a virtual number
VirtualNumbersAPI UpdateNumber Put /virtual-numbers/{virtual-number} update a virtual number

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer_auth
  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • free-trial-numbers:read: read information for free trial numbers
    • free-trial-numbers:write: write information for free trial numbers
    • messages:read: read information for messages
    • messages:write: write information for messages
    • reports:read: read information for reports
    • reports:write: write information for reports
    • virtual-numbers:read: read information for virtual-numbers
    • virtual-numbers:write: write information for virtual numbers

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

Documentation for Authorization

Authentication schemes defined for the API:

bearer_auth
  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • free-trial-numbers:read: read information for free trial numbers
    • free-trial-numbers:write: write information for free trial numbers
    • messages:read: read information for messages
    • messages:write: write information for messages
    • reports:read: read information for reports
    • reports:write: write information for reports
    • virtual-numbers:read: read information for virtual-numbers
    • virtual-numbers:write: write information for virtual numbers
import (
	"context"
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"

authApi := apiClient.AuthenticationAPI.AuthToken(context.Background(), clientId, clientSecret)
oauthResult, resp, err := authApi.AuthToken()

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

Free Trial

Telstra offers a free trial for the messaging API to help you evaluate whether it meets your needs. There are some restrictions that apply compared to the full API, including a maximum number of messages that can be sent and requiring the registration of a limited number of destinations before a message can be sent to that destination. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#FreeTrial.

Registering Free Trial Numbers

ℹ Only required for the free trial accounts

Register destinations for the free trial. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#RegisteraFreeTrialNumber.

The function freeTrialNumbers.create can be used to register destinations.

It takes an object with following properties as argument:

  • freeTrialNumbers: A list of destinations, expected to be phone numbers of the form 04XXXXXXXX.

It returns the list of phone numbers that have been registered.

For example:


import (
	"context"
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)

trialNumbers := []string{"0400000001", "0400000002"}
createTrialNumbersRequestFreeTrialNumbers := msg_sdk.ArrayOfStringAsCreateTrialNumbersRequestFreeTrialNumbers(&trialNumbers)
createTrialNumbersRequest := msg_sdk.NewCreateTrialNumbersRequest(createTrialNumbersRequestFreeTrialNumbers)

trialNumbersApi := apiClient.FreeTrialNumbersAPI.CreateTrialNumbers(context.Background(), authorization)
resp, httpRes, err := trialNumbersApi.CreateTrialNumbers(*createTrialNumbersRequest)
Fetch all Free Trial Numbers

ℹ Only required for the free trial

Fetch the Free Trial Number(s) currently assigned to your account. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#FetchyourFreeTrialNumbers.

The function freeTrialNumbers.getAll can be used to retrieve registered destinations.

It takes no arguments.

It returns the list of phone numbers that have been registered.

For example:


import (
	"context"
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

trialNumbersApi := apiClient.FreeTrialNumbersAPI.GetTrialNumbers(context.Background(), authorization)
resp, httpRes, err := trialNumbersApi.GetTrialNumbers()

Virtual Number

Gives you a dedicated mobile number tied to an application which enables you to receive replies from your customers. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#VirtualNumbers.

Assign Virtual Number

When a recipient receives your message, you can choose whether they'll see a Virtual Number or senderName (paid plans only) in the from field. If you want to use a Virtual Number, use this function to assign one. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#AssignaVirtualNumber.

The function virtualNumbers.assign can be used to create a subscription.

It takes a object with following properties as argument:

  • replyCallbackUrl (optional): The URL that replies to the Virtual Number will be posted to.
  • tags (optional): Create your own tags and use them to fetch, sort and report on your Virtual Numbers through our other endpoints. You can assign up to 10 tags per number.

It returns an object with the following properties:

  • virtualNumber: The Virtual Number assigned to your account.
  • lastUse: The last time the Virtual Number was used to send a message.
  • replyCallbackUrl: The URL that replies to the Virtual Number will be posted to.
  • tags: Any customisable tags assigned to the Virtual Number.

For example:


import (
	"context"
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	
	
tags := []string{
	"reprehenderit",
	"Excepteur non labore",
	"labore in consequat culpa",
	"qui voluptate",
	"n",
	"incididunt aliqua tempor",
	"incididunt dolor Lorem",
	"adipisicing aliquip elit eiusm",
	"consequat id sunt enim",
	"co",
}

assignNumberRequest := msg_sdk.NewAssignNumberRequest()
assignNumberRequest.SetReplyCallbackUrl("http://www.example.com")
assignNumberRequest.SetTags(tags)

vnApi := apiClient.VirtualNumbersAPI.AssignNumber(context.Background(), authorization)
resp, httpRes, err := vnApi.AssignNumber(*assignNumberRequest)
Fetch a Virtual Number

Fetch the tags, replyCallbackUrl and lastUse date for a Virtual Number. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#FetchaVirtualNumber.

The function virtualNumbers.get can be used to get the details of a Virtual Number.

It takes the following arguments:

  • virtualNumber: The Virtual Number assigned to your account.

It returns an object with the following properties:

  • virtualNumber: The Virtual Number assigned to your account.
  • lastUse: The last time the Virtual Number was used to send a message.
  • replyCallbackUrl: The URL that replies to the Virtual Number will be posted to.
  • tags: Any customisable tags assigned to the Virtual Number.

For example:


import (
	"context"
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

vnApi := apiClient.VirtualNumbersAPI.GetVirtualNumber(context.Background(), virtualNumber, authorization)
resp, httpRes, err := vnApi.GetVirtualNumber()
Fetch all Virtual Numbers

Fetch all Virtual Numbers currently assigned to your account. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#FetchallVirtualNumbers.

The function virtualNumbers.getAll can be used to get the all virtual numbers associated to your account.

It takes an object with following prperties as argument:

  • limit (optional): Tell us how many results you want us to return, up to a maximum of 50.
  • offset (optional): Use the offset to navigate between the response results. An offset of 0 will display the first page of results, and so on.
  • filter (optional): Filter your Virtual Numbers by tag or by number.

It returns an object with the following properties:

  • virtualNumbers: A list of Virtual Numbers assigned to your account.
  • paging: Paging information.

For example:


import (
	"context"
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	
	
vnApi := apiClient.VirtualNumbersAPI.GetNumbers(context.Background(), authorization)
resp, httpRes, err := vnApi.GetNumbers()
Update a Virtual Number

Update a virtual number attributes. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#UpdateaVirtualNumber.

The function virtualNumbers.update can be used to update a virtual number.

It takes an object with following properties as argument:

  • virtualNumber: The Virtual Number assigned to your account.
  • updateData (optional):
    • reply_callback_url (optional): The URL that replies to the Virtual Number will be posted to.
    • tags (optional): Create your own tags and use them to fetch, sort and report on your Virtual Numbers through our other endpoints. You can assign up to 10 tags per number.

It returns an object with the following properties:

  • virtualNumber: The Virtual Number assigned to your account.
  • lastUse: The last time the Virtual Number was used to send a message.
  • replyCallbackUrl: The URL that replies to the Virtual Number will be posted to.
  • tags: Any customisable tags assigned to the Virtual Number.

For example:


import (
	"context"
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

updateNumberRequest := msg_sdk.NewUpdateNumberRequest()
updateNumberRequest.SetReplyCallbackUrl("http://www.example.com")
tags := []string{
	"minim qui",
	"commodo",
	"nostrud laborum minim",
	"nulla proident ut voluptat",
	"et consectetur dolor",
	"est amet cillum",
	"exercitation",
	"non occaecat cupidatat Duis",
	"adipisicing",
	"ea aliqua incididunt",
}
updateNumberRequest.SetTags(tags)

vnApi := apiClient.VirtualNumbersAPI.UpdateNumber(context.Background(), virtualNumber, authorization)
resp, httpRes, err := vnApi.UpdateNumber(*updateNumberRequest)
Delete Virtual Number

Delete the a virtual number. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#DeleteaVirtualNumber.

The function virtualNumbers.get can be used to unassign a Virtual Number.

It takes the following arguments:

  • virtualNumber: The Virtual Number assigned to your account.

It returns nothing.

For example:


import (
	"context"
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

vnApi := apiClient.VirtualNumbersAPI.DeleteNumber(context.Background(), virtualNumber, authorization)
httpRes, err := vnApi.DeleteNumber()
Fetch all Recipient Optouts list

Fetch any mobile number(s) that have opted out of receiving messages from a Virtual Number assigned to your account. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Fetchallrecipientoptoutslist.

The function telstra.messaging.virtual_number.get_optouts can be used to get the list of mobile numbers that have opted out of receiving messages from a virtual number associated to your account. It takes the following arguments:

  • virtual_number: The Virtual Number assigned to your account.
  • limit: Tell us how many results you want us to return, up to a maximum of 50.
  • offset: Use the offset to navigate between the response results. An offset of 0 will display the first page of results, and so on.

Raises telstra.messaging.exceptions.VirtualNumbersError if anything goes wrong.

It returns an object with the following properties:

  • recipient_optouts: A list of recipient optouts.
  • paging: Paging information.

For example:


import (
	"context"
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

vnApi := apiClient.VirtualNumbersAPI.GetRecipientOptouts(context.Background(), virtualNumber, authorization)
resp, httpRes, err := vnApi.GetRecipientOptouts()

Message

Send and receive messages. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Messages.

Send Message

Send a message to a mobile number, or to multiple mobile numbers. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#SendanSMSorMMS.

The function messages.send can be used to send a message.

It takes an object with following properties as argument:

  • to: The destination address, expected to be a phone number of the form +614XXXXXXXX or 04XXXXXXXX.
  • from: This will be either one of your Virtual Numbers or your senderName.
  • messageContent (Either one of messageContent or multimedia is required): The content of the message.
  • multimedia (Either one of messageContent or multimedia is required): MMS multimedia content.
  • retryTimeout (optional): How many minutes you asked the server to keep trying to send the message.
  • scheduleSend (optional): The time (in Central Standard Time) the message is scheduled to send.
  • deliveryNotification (optional): If set to true, you will receive a notification to the statusCallbackUrl when your SMS or MMS is delivered (paid feature).
  • statusCallbackUrl (optional): The URL the API will call when the status of the message changes.
  • tags (optional): Any customisable tags assigned to the message.

The type TMultimediacan be used to build an mms payload. It has following properties:

  • type: The content type of the attachment, for example <TMultimediaContentType.IMAGE_GIF>.
  • fileName (optional): Optional field, for example image.png.
  • payload: The payload of an mms encoded as base64.

It returns an object with the following properties:

  • messageId: Use this UUID with our other endpoints to fetch, update or delete the message.
  • status: The status will be either queued, sent, delivered or expired.
  • to: The recipient's mobile number(s).
  • from: This will be either one of your Virtual Numbers or your senderName.
  • messageContent: The content of the message.
  • multimedia: The multimedia content of the message (MMS only).
  • retryTimeout: How many minutes you asked the server to keep trying to send the message.
  • scheduleSend: The time (in Central Standard Time) a message is scheduled to send.
  • deliveryNotification: If set to true, you will receive a notification to the statusCallbackUrl when your SMS or MMS is delivered (paid feature).
  • statusCallbackUrl: The URL the API will call when the status of the message changes.
  • tags: Any customisable tags assigned to the message.

For example:


import (
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

sendMessagesSlice := []string{"0400000001", "0400000002"}
sendMessagesRequestTo := msg_sdk.SendMessagesRequestTo{
	ArrayOfString: &sendMessagesSlice,
	String:        new(string),
}

sendMessagesFrom := "0428180739"
sendMessagesRequest := msg_sdk.NewSendMessagesRequest(sendMessagesRequestTo, sendMessagesFrom)
setMessageContent := "Hello customer, this is from CBA to confirme your offer!"
sendMessagesRequest.SetMessageContent(setMessageContent)
sendMessagesRequest.SetDeliveryNotification(false)
sendMessagesRequest.SetRetryTimeout(10)
sendMessagesRequest.SetStatusCallbackUrl("http://www.example.com")

tags := []string{
	"ip",
	"deserunt exercitation",
	"id mollit magna proident ipsum",
	"consequat proident",
	"u",
	"nulla ve",
	"deserunt proident",
	"deserunt nulla id esse",
	"laboris velit",
	"pr",
}

sendMessagesRequest.SetScheduleSend(time.Now().AddDate(0, 0, 5).UTC())

sendMessagesRequest.SetTags(tags)

messagesApi := apiClient.MessagesAPI.SendMessages(context.Background(), authorization)
resp, httpRes, err := messagesApi.SendMessages(*sendMessagesRequest)
Get a Message

Use the messageId to fetch a message that's been sent from/to your account within the last 30 days. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Fetchamessage.

The function messages.get can be used to retrieve the a message.

It takes the following arguments:

  • messageId: Unique identifier for the message.

It returns an object with the following properties:

  • messageId: Use this UUID with our other endpoints to fetch, update or delete the message.
  • status: The status will be either queued, sent, delivered or expired.
  • createTimestamp: The time you submitted the message to the queue for sending.
  • sentTimestamp: The time the message was sent from the server.
  • receivedTimestamp: The time the message was received by the recipient's device.
  • to: The recipient's mobile number(s).
  • from: This will be either one of your Virtual Numbers or your senderName.
  • messageContent: The content of the message.
  • multimedia: The multimedia content of the message (MMS only).
  • direction: Direction of the message (outgoing or incoming).
  • retryTimeout: How many minutes you asked the server to keep trying to send the message.
  • scheduleSend: The time (in Central Standard Time) the message is scheduled to send.
  • deliveryNotification: If set to true, you will receive a notification to the statusCallbackUrl when your SMS or MMS is delivered (paid feature).
  • statusCallbackUrl: The URL the API will call when the status of the message changes.
  • queuePriority: The priority assigned to the message.
  • tags: Any customisable tags assigned to the message.

For example:


import (
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

messagesApi := apiClient.MessagesAPI.GetMessageById(context.Background(), messageId, authorization)
resp, httpRes, err := messagesApi.GetMessageById()
Get all Messages

Fetch messages that have been sent from/to your account in the last 30 days. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Fetchallsent/receivedmessages.

The function messages.getAll can be used to fetch all messages.

It takes an object with following properties as argument:

  • limit (optional): Tell us how many results you want us to return, up to a maximum of 50.
  • offset (optional): Use the offset to navigate between the response results. An offset of 0 will display the first page of results, and so on.
  • filter (optional): Filter your Virtual Numbers by tag or by number.

It returns an object with the following properties:

  • messages: List of all messages.
  • paging: Paging information.

For example:


import (
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

messagesApi := apiClient.MessagesAPI.GetMessages(context.Background(), authorization)
reverse := true
messagesApi.Reverse(reverse)
startTime := time.Now().AddDate(0, 0, -5).UTC()
messagesApi.StartTime(startTime)
endTime := time.Now().AddDate(0, 0, -1).UTC()
messagesApi.EndTime(endTime)

resp, httpRes, err := messagesApi.GetMessages()
Update a Message

Update a message that's scheduled for sending, you can change any of the below parameters, as long as the message hasn't been sent yet. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Updateamessage.

The function messages.send can be used to send a message.

It takes an object with following properties as argument:

  • messageId: Use this UUID with our other endpoints to fetch, update or delete the message.
  • to: The destination address, expected to be a phone number of the form +614XXXXXXXX or 04XXXXXXXX.
  • from: This will be either one of your Virtual Numbers or your senderName.
  • messageContent (Either one of messageContent or multimedia is required): The content of the message.
  • multimedia (Either one of messageContent or multimedia is required): MMS multimedia content.
  • retryTimeout (optional): How many minutes you asked the server to keep trying to send the message.
  • scheduleSend (optional): The time (in Central Standard Time) the message is scheduled to send.
  • deliveryNotification (optional): If set to true, you will receive a notification to the statusCallbackUrl when your SMS or MMS is delivered (paid feature).
  • statusCallbackUrl (optional): The URL the API will call when the status of the message changes.
  • tags (optional): Any customisable tags assigned to the message.

The type TMultimediacan be used to build an mms payload. It has following properties:

  • type: The content type of the attachment, for example <TMultimediaContentType.IMAGE_GIF>.
  • fileName (optional): Optional field, for example image.png.
  • payload: The payload of an mms encoded as base64.

The dataclass telstra.messaging.message.Multimedia can be used to build a mms payload. It takes the following arguments:

  • type: The content type of the attachment, for example image/png.
  • filename (optional): Optional field, for example image.png.
  • payload: The payload of an mms encoded as base64.

It returns an object with the following properties:

  • messageId: Use this UUID with our other endpoints to fetch, update or delete the message.
  • status: The status will be either queued, sent, delivered or expired.
  • to: The recipient's mobile number(s).
  • from: This will be either one of your Virtual Numbers or your senderName.
  • messageContent: The content of the message.
  • multimedia: The multimedia content of the message (MMS only).
  • retryTimeout: How many minutes you asked the server to keep trying to send the message.
  • scheduleSend: The time (in Central Standard Time) a message is scheduled to send.
  • deliveryNotification: If set to true, you will receive a notification to the statusCallbackUrl when your SMS or MMS is delivered (paid feature).
  • statusCallbackUrl: The URL the API will call when the status of the message changes.
  • tags: Any customisable tags assigned to the message.

For example:


import (
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)	
	
configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

updateMessageByIdRequest := msg_sdk.NewUpdateMessageByIdRequest("0400000001", "0428180739")

setMessageContent := "Ut veniam in ipsum exercitation"
updateMessageByIdRequest.SetMessageContent(setMessageContent)
updateMessageByIdRequest.SetDeliveryNotification(false)
updateMessageByIdRequest.SetRetryTimeout(10)
updateMessageByIdRequest.SetStatusCallbackUrl("http://www.example.com")

tags := []string{
	"ip",
	"deserunt exercitation",
	"id mollit magna proident ipsum",
	"consequat proident",
	"u",
	"nulla ve",
	"deserunt proident",
	"deserunt nulla id esse",
	"laboris velit",
	"pr",
}
updateMessageByIdRequest.SetTags(tags)

messagesApi := apiClient.MessagesAPI.UpdateMessageById(context.Background(), messageId, authorization)
resp, httpRes, err := messagesApi.UpdateMessageById(*updateMessageByIdRequest)
Update Message Tags

Update message tags, you can update them even after your message has been delivered. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Updatemessagetags.

The function messages.updateTags can be used to update message tags.

It takes the following arguments:

  • messageId: Unique identifier for the message.
  • tags (optional): Any customisable tags assigned to the message.

It returns nothing.

For example:


import (
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

tags := []string{"marketing", "SMS"}
updateMessageTagsRequest := msg_sdk.NewUpdateMessageTagsRequest(tags)

messagesApi := apiClient.MessagesAPI.UpdateMessageTags(context.Background(), messageId, authorization)
httpRes, err := messagesApi.UpdateMessageTags(*updateMessageTagsRequest)
Delete a Message

Delete a scheduled message, but hasn't yet sent. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Deleteamessage.

The function messages.delete can be used to delete a message.

It takes the following arguments:

  • messageId: Unique identifier for the message.

It returns nothing.

For example:


import (
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

messagesApi := apiClient.MessagesAPI.DeleteMessageById(context.Background(), messageId, authorization)
httpRes, err := messagesApi.DeleteMessageById()

Reports

Create and fetch reports. For more information, please see here: https://dev.telstra.com/content/messaging-api-v3#tag/reports.

Request a Messages Report

Request a CSV report of messages (both incoming and outgoing) that have been sent to/from your account within the last three months. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Submitarequestforamessagesreport.

The function reports.create can be used to create a report.

It takes the following arguments:

  • startDate: Set the time period you want to generate a report for by typing the start date (inclusive) here. Note that we only retain data for three months, so please ensure your startDate is not more than three months old. Use ISO format(yyyy-mm-dd), e.g. "2019-08-24".
  • endDate: Type the end date (inclusive) of your reporting period here. Your endDate must be a date in the past, and less than three months from your startDate. Use ISO format(yyyy-mm-dd), e.g. "2019-08-24".
  • reportCallbackUrl (optional): The callbackUrl where notification is sent when report is ready for download.
  • filter (optional): Filter report messages by: tag - use one of the tags assigned to your message(s) number - either the Virtual Number used to send the message, or the Recipient Number the message was sent to.

It returns an object with the following properties:

  • reportId: Use this UUID with our other endpoints to fetch the report.
  • reportCallbackUrl: If you provided a reportCallbackUrl in your request, it will be returned here.
  • reportStatus: The status of the report. It will be either:
    • queued – the report is in the queue for generation.
    • completed – the report is ready for download.
    • failed – the report failed to generate, please try again.

For example:


import (
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

now := time.Now()
threeDaysAgo := now.AddDate(0, 0, -3)
oneDayAgo := now.AddDate(0, 0, -1)
threeDaysAgoFormatted := threeDaysAgo.Format("2006-01-02")
oneDayAgoFormatted := oneDayAgo.Format("2006-01-02")
messageReportRequest := msg_sdk.NewMessagesReportRequest(threeDaysAgoFormatted, oneDayAgoFormatted)

reportsApi := apiClient.ReportsAPI.MessagesReport(context.Background(), authorization)
resp, httpRes, err := reportsApi.MessagesReport(*messageReportRequest)
Fetch a specific report

Use the report_id to fetch a download link for a report generated. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#FetchaReport.

The function reports.get can be used to retrieve the a report download link. It takes the following arguments:

  • reportId: Unique identifier for the report.

It returns an object with the following properties:

  • reportId: Use this UUID with our other endpoints to fetch the report.
  • reportStatus: The status of the report.
  • reportUrl: Download link to download the CSV file.

For example:


import (
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

reportId := "c22d2050-eb37-11ee-ad5e-3d9263246ccb"
reportsApi := apiClient.ReportsAPI.GetReport(context.Background(), reportId, authorization)
resp, httpRes, err := reportsApi.GetReport()
Fetch all reports

Fetch details of all reports recently generated for your account. Use it to check the status of a report, plus fetch the report ID, status, report type and expiry date. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Fetchallreports.

The function reports.getAll can be used to fetch all reports.

It doesn't take any arguments.

It returns a list of objects with the following properties:

  • reportId: Use this UUID with our other endpoints to fetch the report.
  • reportStatus: The status of the report.
  • reportType: The type of report generated.
  • reportExpiry: The expiry date of your report. After this date, you will be unable to download your report.

For example:


import (
	"context"
	"fmt"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)	

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

reportsApi := apiClient.ReportsAPI.GetReports(context.Background(), authorization)
resp, httpRes, err := reportsApi.GetReports()

Health Check

Get operational status of the messaging service

Check the operational status of the messaging service. For more information, please see here: https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#HealthCheck.

The function healthCheck.get can be used to get the status.

It takes no arguments.

It returns an object with following properties:

  • status: Denotes the status of the services Up/Down.

For example:


import (
	"context"
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"
	msg_sdk "github.com/telstra/MessagingAPI-SDK-Go/v3"
)

configuration := msg_sdk.NewConfiguration()
apiClient := msg_sdk.NewAPIClient(configuration)

clientId := "YOUR CLIENT ID"
clientSecret := "YOUR CLIENT SECRET"
authorization, _ := msg_sdk.GetAuthorization(apiClient, clientId, clientSecret)	

healthCheckApi := apiClient.HealthCheckAPI.HealthCheck(context.Background(), authorization)
resp, httpRes, err := healthCheckApi.HealthCheck()

Documentation

Overview

Messaging API v3.4.3

Request params for the Telstra Messaging API

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// 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 GetAuthorization added in v3.4.9 

func GetAuthorization(apiClient *APIClient, clientId string, clientSecret string) (string, error)

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 {
	AuthenticationAPI *AuthenticationAPIService

	FreeTrialNumbersAPI *FreeTrialNumbersAPIService

	HealthCheckAPI *HealthCheckAPIService

	LogsAPI *LogsAPIService

	MessagesAPI *MessagesAPIService

	ReportsAPI *ReportsAPIService

	VirtualNumbersAPI *VirtualNumbersAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the Messaging API v3.4.3 API v3.1.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

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 ApiAssignNumberRequest 

type ApiAssignNumberRequest struct {
	ApiService *VirtualNumbersAPIService
	// contains filtered or unexported fields
}

func (ApiAssignNumberRequest) Accept 

func (r ApiAssignNumberRequest) Accept(accept string) ApiAssignNumberRequest

func (ApiAssignNumberRequest) AcceptCharset 

func (r ApiAssignNumberRequest) AcceptCharset(acceptCharset string) ApiAssignNumberRequest

func (ApiAssignNumberRequest) AssignNumber added in v3.4.8 

func (r ApiAssignNumberRequest) AssignNumber(assignNumberRequest AssignNumberRequest) (*VirtualNumber, *http.Response, error)

func (ApiAssignNumberRequest) AssignNumberRequest 

func (r ApiAssignNumberRequest) AssignNumberRequest(assignNumberRequest AssignNumberRequest) ApiAssignNumberRequest

func (ApiAssignNumberRequest) Authorization 

func (r ApiAssignNumberRequest) Authorization(authorization string) ApiAssignNumberRequest

func (ApiAssignNumberRequest) ContentLanguage 

func (r ApiAssignNumberRequest) ContentLanguage(contentLanguage string) ApiAssignNumberRequest

func (ApiAssignNumberRequest) ContentType 

func (r ApiAssignNumberRequest) ContentType(contentType string) ApiAssignNumberRequest

func (ApiAssignNumberRequest) Execute 

func (r ApiAssignNumberRequest) Execute() (*VirtualNumber, *http.Response, error)

func (ApiAssignNumberRequest) TelstraApiVersion 

func (r ApiAssignNumberRequest) TelstraApiVersion(telstraApiVersion string) ApiAssignNumberRequest

type ApiAuthTokenRequest 

type ApiAuthTokenRequest struct {
	ApiService *AuthenticationAPIService
	// contains filtered or unexported fields
}

func (ApiAuthTokenRequest) AuthToken added in v3.4.8 

func (r ApiAuthTokenRequest) AuthToken() (*OAuth, *http.Response, error)

func (ApiAuthTokenRequest) ClientId 

func (r ApiAuthTokenRequest) ClientId(clientId string) ApiAuthTokenRequest

Copy and paste your &#x60;client_id&#x60; here. Find it in your [dashboard](https://dev.telstra.com).

func (ApiAuthTokenRequest) ClientSecret 

func (r ApiAuthTokenRequest) ClientSecret(clientSecret string) ApiAuthTokenRequest

Copy and paste your &#x60;client_secret&#x60; here. Find it in your [dashboard](https://dev.telstra.com).

func (ApiAuthTokenRequest) Execute 

func (r ApiAuthTokenRequest) Execute() (*OAuth, *http.Response, error)

func (ApiAuthTokenRequest) GrantType 

func (r ApiAuthTokenRequest) GrantType(grantType string) ApiAuthTokenRequest

Ensure the &#x60;grant_type&#x60; is **client_credentials**.

func (ApiAuthTokenRequest) Scope 

func (r ApiAuthTokenRequest) Scope(scope string) ApiAuthTokenRequest

Ensure the &#x60;scope&#x60; is **verification:read**.

type ApiCreateTrialNumbersRequest 

type ApiCreateTrialNumbersRequest struct {
	ApiService *FreeTrialNumbersAPIService
	// contains filtered or unexported fields
}

func (ApiCreateTrialNumbersRequest) Accept 

func (r ApiCreateTrialNumbersRequest) Accept(accept string) ApiCreateTrialNumbersRequest

func (ApiCreateTrialNumbersRequest) AcceptCharset 

func (r ApiCreateTrialNumbersRequest) AcceptCharset(acceptCharset string) ApiCreateTrialNumbersRequest

func (ApiCreateTrialNumbersRequest) Authorization 

func (r ApiCreateTrialNumbersRequest) Authorization(authorization string) ApiCreateTrialNumbersRequest

func (ApiCreateTrialNumbersRequest) ContentLanguage 

func (r ApiCreateTrialNumbersRequest) ContentLanguage(contentLanguage string) ApiCreateTrialNumbersRequest

func (ApiCreateTrialNumbersRequest) ContentType 

func (r ApiCreateTrialNumbersRequest) ContentType(contentType string) ApiCreateTrialNumbersRequest

func (ApiCreateTrialNumbersRequest) CreateTrialNumbers added in v3.4.8 

func (r ApiCreateTrialNumbersRequest) CreateTrialNumbers(createTrialNumbersRequest CreateTrialNumbersRequest) (*FreeTrialNumbers, *http.Response, error)

func (ApiCreateTrialNumbersRequest) CreateTrialNumbersRequest 

func (r ApiCreateTrialNumbersRequest) CreateTrialNumbersRequest(createTrialNumbersRequest CreateTrialNumbersRequest) ApiCreateTrialNumbersRequest

func (ApiCreateTrialNumbersRequest) Execute 

func (r ApiCreateTrialNumbersRequest) Execute() (*FreeTrialNumbers, *http.Response, error)

func (ApiCreateTrialNumbersRequest) TelstraApiVersion 

func (r ApiCreateTrialNumbersRequest) TelstraApiVersion(telstraApiVersion string) ApiCreateTrialNumbersRequest

type ApiDeleteMessageByIdRequest 

type ApiDeleteMessageByIdRequest struct {
	ApiService *MessagesAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteMessageByIdRequest) Accept 

func (r ApiDeleteMessageByIdRequest) Accept(accept string) ApiDeleteMessageByIdRequest

func (ApiDeleteMessageByIdRequest) AcceptCharset 

func (r ApiDeleteMessageByIdRequest) AcceptCharset(acceptCharset string) ApiDeleteMessageByIdRequest

func (ApiDeleteMessageByIdRequest) Authorization 

func (r ApiDeleteMessageByIdRequest) Authorization(authorization string) ApiDeleteMessageByIdRequest

func (ApiDeleteMessageByIdRequest) ContentLanguage 

func (r ApiDeleteMessageByIdRequest) ContentLanguage(contentLanguage string) ApiDeleteMessageByIdRequest

func (ApiDeleteMessageByIdRequest) ContentType 

func (r ApiDeleteMessageByIdRequest) ContentType(contentType string) ApiDeleteMessageByIdRequest

func (ApiDeleteMessageByIdRequest) DeleteMessageById added in v3.4.8 

func (r ApiDeleteMessageByIdRequest) DeleteMessageById() (*http.Response, error)

func (ApiDeleteMessageByIdRequest) Execute 

func (r ApiDeleteMessageByIdRequest) Execute() (*http.Response, error)

func (ApiDeleteMessageByIdRequest) TelstraApiVersion 

func (r ApiDeleteMessageByIdRequest) TelstraApiVersion(telstraApiVersion string) ApiDeleteMessageByIdRequest

type ApiDeleteNumberRequest 

type ApiDeleteNumberRequest struct {
	ApiService *VirtualNumbersAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteNumberRequest) Accept 

func (r ApiDeleteNumberRequest) Accept(accept string) ApiDeleteNumberRequest

func (ApiDeleteNumberRequest) AcceptCharset 

func (r ApiDeleteNumberRequest) AcceptCharset(acceptCharset string) ApiDeleteNumberRequest

func (ApiDeleteNumberRequest) Authorization 

func (r ApiDeleteNumberRequest) Authorization(authorization string) ApiDeleteNumberRequest

func (ApiDeleteNumberRequest) ContentLanguage 

func (r ApiDeleteNumberRequest) ContentLanguage(contentLanguage string) ApiDeleteNumberRequest

func (ApiDeleteNumberRequest) ContentType 

func (r ApiDeleteNumberRequest) ContentType(contentType string) ApiDeleteNumberRequest

func (ApiDeleteNumberRequest) DeleteNumber added in v3.4.8 

func (r ApiDeleteNumberRequest) DeleteNumber() (*http.Response, error)

func (ApiDeleteNumberRequest) Execute 

func (r ApiDeleteNumberRequest) Execute() (*http.Response, error)

func (ApiDeleteNumberRequest) TelstraApiVersion 

func (r ApiDeleteNumberRequest) TelstraApiVersion(telstraApiVersion string) ApiDeleteNumberRequest

type ApiGetLogsRequest 

type ApiGetLogsRequest struct {
	ApiService *LogsAPIService
	// contains filtered or unexported fields
}

func (ApiGetLogsRequest) Accept 

func (r ApiGetLogsRequest) Accept(accept string) ApiGetLogsRequest

func (ApiGetLogsRequest) AcceptCharset 

func (r ApiGetLogsRequest) AcceptCharset(acceptCharset string) ApiGetLogsRequest

func (ApiGetLogsRequest) Authorization 

func (r ApiGetLogsRequest) Authorization(authorization string) ApiGetLogsRequest

func (ApiGetLogsRequest) ContentLanguage 

func (r ApiGetLogsRequest) ContentLanguage(contentLanguage string) ApiGetLogsRequest

func (ApiGetLogsRequest) ContentType 

func (r ApiGetLogsRequest) ContentType(contentType string) ApiGetLogsRequest

func (ApiGetLogsRequest) EndDate 

func (r ApiGetLogsRequest) EndDate(endDate time.Time) ApiGetLogsRequest

Fetch logs for calls made until a specific time and date. Default value is current time and date

func (ApiGetLogsRequest) Execute 

func (r ApiGetLogsRequest) Execute() (*GetLogs200Response, *http.Response, error)

func (ApiGetLogsRequest) LogsFilter 

func (r ApiGetLogsRequest) LogsFilter(logsFilter string) ApiGetLogsRequest

Filter your logs by: * date - rather than searching within a time range, you can choose to return logs for a specific date instead. Use string &lt;date-time&gt; format. * resource – return logs for a specific resource, e.g. POST /messages.

func (ApiGetLogsRequest) StartDate 

func (r ApiGetLogsRequest) StartDate(startDate time.Time) ApiGetLogsRequest

Fetch logs for calls made from a specific time and date. Default value is events logged within the last week.

func (ApiGetLogsRequest) TelstraApiVersion 

func (r ApiGetLogsRequest) TelstraApiVersion(telstraApiVersion string) ApiGetLogsRequest

type ApiGetMessageByIdRequest 

type ApiGetMessageByIdRequest struct {
	ApiService *MessagesAPIService
	// contains filtered or unexported fields
}

func (ApiGetMessageByIdRequest) Accept 

func (r ApiGetMessageByIdRequest) Accept(accept string) ApiGetMessageByIdRequest

func (ApiGetMessageByIdRequest) AcceptCharset 

func (r ApiGetMessageByIdRequest) AcceptCharset(acceptCharset string) ApiGetMessageByIdRequest

func (ApiGetMessageByIdRequest) Authorization 

func (r ApiGetMessageByIdRequest) Authorization(authorization string) ApiGetMessageByIdRequest

func (ApiGetMessageByIdRequest) ContentLanguage 

func (r ApiGetMessageByIdRequest) ContentLanguage(contentLanguage string) ApiGetMessageByIdRequest

func (ApiGetMessageByIdRequest) ContentType 

func (r ApiGetMessageByIdRequest) ContentType(contentType string) ApiGetMessageByIdRequest

func (ApiGetMessageByIdRequest) Execute 

func (r ApiGetMessageByIdRequest) Execute() (*MessageGet, *http.Response, error)

func (ApiGetMessageByIdRequest) GetMessageById added in v3.4.8 

func (r ApiGetMessageByIdRequest) GetMessageById() (*MessageGet, *http.Response, error)

func (ApiGetMessageByIdRequest) TelstraApiVersion 

func (r ApiGetMessageByIdRequest) TelstraApiVersion(telstraApiVersion string) ApiGetMessageByIdRequest

type ApiGetMessagesRequest 

type ApiGetMessagesRequest struct {
	ApiService *MessagesAPIService
	// contains filtered or unexported fields
}

func (ApiGetMessagesRequest) Accept 

func (r ApiGetMessagesRequest) Accept(accept string) ApiGetMessagesRequest

func (ApiGetMessagesRequest) AcceptCharset 

func (r ApiGetMessagesRequest) AcceptCharset(acceptCharset string) ApiGetMessagesRequest

func (ApiGetMessagesRequest) Authorization 

func (r ApiGetMessagesRequest) Authorization(authorization string) ApiGetMessagesRequest

func (ApiGetMessagesRequest) ContentLanguage 

func (r ApiGetMessagesRequest) ContentLanguage(contentLanguage string) ApiGetMessagesRequest

func (ApiGetMessagesRequest) ContentType 

func (r ApiGetMessagesRequest) ContentType(contentType string) ApiGetMessagesRequest

func (ApiGetMessagesRequest) Direction 

func (r ApiGetMessagesRequest) Direction(direction string) ApiGetMessagesRequest

Filter your messages by direction: * **outgoing** – messages sent from your account. * **incoming** – messages sent to your account.

func (ApiGetMessagesRequest) EndTime 

func (r ApiGetMessagesRequest) EndTime(endTime time.Time) ApiGetMessagesRequest

By Default messages from last 30 days will be fetched. Use this parameter to fetch the messages till the time you want. Set the time in London Greenwich Mean Time (adjusting for any time difference) and use ISO format, e.g. \&quot;2024-01-24T16:39:00Z\&quot;. You can set a time from last 30 days and endTime should be after startTime (if set). If you specify a timestamp outside of this limit, the API will return a FIELD_INVALID error.

func (ApiGetMessagesRequest) Execute 

func (r ApiGetMessagesRequest) Execute() (*GetMessages200Response, *http.Response, error)

func (ApiGetMessagesRequest) Filter 

func (r ApiGetMessagesRequest) Filter(filter string) ApiGetMessagesRequest

Filter your messages by: * tag - use one of the tags assigned to your message(s) * number - either the Virtual Number used to send the message, or the Recipient Number the message was sent to.

func (ApiGetMessagesRequest) GetMessages added in v3.4.8 

func (r ApiGetMessagesRequest) GetMessages() (*GetMessages200Response, *http.Response, error)

func (ApiGetMessagesRequest) Limit 

func (r ApiGetMessagesRequest) Limit(limit int32) ApiGetMessagesRequest

Tell us how many results you want us to return, up to a maximum of 50.

func (ApiGetMessagesRequest) Offset 

func (r ApiGetMessagesRequest) Offset(offset int32) ApiGetMessagesRequest

Use the offset to navigate between the response results. An offset of 0 will display the first page of results, and so on.

func (ApiGetMessagesRequest) Reverse 

func (r ApiGetMessagesRequest) Reverse(reverse bool) ApiGetMessagesRequest

If set to **true** the results will be returned in reverse order. Recent messages will be returned first. By default, the results will be returned in the order they were sent/received.

func (ApiGetMessagesRequest) StartTime 

func (r ApiGetMessagesRequest) StartTime(startTime time.Time) ApiGetMessagesRequest

By Default messages from last 30 days will be fetched.Use this parameter to fetch the messages from the time you want. Set the time in London Greenwich Mean Time (adjusting for any time difference) and use ISO format, e.g. \&quot;2024-01-24T15:39:00Z\&quot;. You can set a time from last 30 days. If you specify a timestamp outside of this limit, the API will return a FIELD_INVALID error. If startTime alone set, messages from this time till current time will be fetched.

func (ApiGetMessagesRequest) Status 

func (r ApiGetMessagesRequest) Status(status string) ApiGetMessagesRequest

Filter your messages by one of the statuses below: * **queued** – messages queued for sending or still in transit. * **sent** – messages that have been sent from the server. * **delivered** – messages successful delivered to the recipient&#39;s device. Note that we will only be able to return this status if you set deliveryNotification to **true** (paid feature). * **expired** – message that couldn&#39;t be sent within the **retryTimeout** timeframe.

func (ApiGetMessagesRequest) TelstraApiVersion 

func (r ApiGetMessagesRequest) TelstraApiVersion(telstraApiVersion string) ApiGetMessagesRequest

type ApiGetNumbersRequest 

type ApiGetNumbersRequest struct {
	ApiService *VirtualNumbersAPIService
	// contains filtered or unexported fields
}

func (ApiGetNumbersRequest) Accept 

func (r ApiGetNumbersRequest) Accept(accept string) ApiGetNumbersRequest

func (ApiGetNumbersRequest) AcceptCharset 

func (r ApiGetNumbersRequest) AcceptCharset(acceptCharset string) ApiGetNumbersRequest

func (ApiGetNumbersRequest) Authorization 

func (r ApiGetNumbersRequest) Authorization(authorization string) ApiGetNumbersRequest

func (ApiGetNumbersRequest) ContentLanguage 

func (r ApiGetNumbersRequest) ContentLanguage(contentLanguage string) ApiGetNumbersRequest

func (ApiGetNumbersRequest) ContentType 

func (r ApiGetNumbersRequest) ContentType(contentType string) ApiGetNumbersRequest

func (ApiGetNumbersRequest) Execute 

func (r ApiGetNumbersRequest) Execute() (*GetNumbers200Response, *http.Response, error)

func (ApiGetNumbersRequest) Filter 

func (r ApiGetNumbersRequest) Filter(filter string) ApiGetNumbersRequest

Filter your Virtual Numbers by tag or by number.

func (ApiGetNumbersRequest) GetNumbers added in v3.4.8 

func (r ApiGetNumbersRequest) GetNumbers() (*GetNumbers200Response, *http.Response, error)

func (ApiGetNumbersRequest) Limit 

func (r ApiGetNumbersRequest) Limit(limit int32) ApiGetNumbersRequest

Tell us how many results you want us to return, up to a maximum of 50.

func (ApiGetNumbersRequest) Offset 

func (r ApiGetNumbersRequest) Offset(offset int32) ApiGetNumbersRequest

Use the offset to navigate between the response results. An offset of 0 will display the first page of results, and so on.

func (ApiGetNumbersRequest) TelstraApiVersion 

func (r ApiGetNumbersRequest) TelstraApiVersion(telstraApiVersion string) ApiGetNumbersRequest

type ApiGetRecipientOptoutsRequest 

type ApiGetRecipientOptoutsRequest struct {
	ApiService *VirtualNumbersAPIService
	// contains filtered or unexported fields
}

func (ApiGetRecipientOptoutsRequest) Accept 

func (r ApiGetRecipientOptoutsRequest) Accept(accept string) ApiGetRecipientOptoutsRequest

func (ApiGetRecipientOptoutsRequest) AcceptCharset 

func (r ApiGetRecipientOptoutsRequest) AcceptCharset(acceptCharset string) ApiGetRecipientOptoutsRequest

func (ApiGetRecipientOptoutsRequest) Authorization 

func (r ApiGetRecipientOptoutsRequest) Authorization(authorization string) ApiGetRecipientOptoutsRequest

func (ApiGetRecipientOptoutsRequest) ContentLanguage 

func (r ApiGetRecipientOptoutsRequest) ContentLanguage(contentLanguage string) ApiGetRecipientOptoutsRequest

func (ApiGetRecipientOptoutsRequest) ContentType 

func (r ApiGetRecipientOptoutsRequest) ContentType(contentType string) ApiGetRecipientOptoutsRequest

func (ApiGetRecipientOptoutsRequest) Execute 

func (r ApiGetRecipientOptoutsRequest) Execute() (*GetRecipientOptouts200Response, *http.Response, error)

func (ApiGetRecipientOptoutsRequest) GetRecipientOptouts added in v3.4.8 

func (r ApiGetRecipientOptoutsRequest) GetRecipientOptouts() (*GetRecipientOptouts200Response, *http.Response, error)

func (ApiGetRecipientOptoutsRequest) Limit 

func (r ApiGetRecipientOptoutsRequest) Limit(limit int32) ApiGetRecipientOptoutsRequest

Tell us how many results you want us to return, up to a maximum of 50.

func (ApiGetRecipientOptoutsRequest) Offset 

func (r ApiGetRecipientOptoutsRequest) Offset(offset int32) ApiGetRecipientOptoutsRequest

Use the offset to navigate between the response results. An offset of 0 will display the first page of results, and so on.

func (ApiGetRecipientOptoutsRequest) TelstraApiVersion 

func (r ApiGetRecipientOptoutsRequest) TelstraApiVersion(telstraApiVersion string) ApiGetRecipientOptoutsRequest

type ApiGetReportRequest 

type ApiGetReportRequest struct {
	ApiService *ReportsAPIService
	// contains filtered or unexported fields
}

func (ApiGetReportRequest) Accept 

func (r ApiGetReportRequest) Accept(accept string) ApiGetReportRequest

func (ApiGetReportRequest) AcceptCharset 

func (r ApiGetReportRequest) AcceptCharset(acceptCharset string) ApiGetReportRequest

func (ApiGetReportRequest) Authorization 

func (r ApiGetReportRequest) Authorization(authorization string) ApiGetReportRequest

func (ApiGetReportRequest) ContentLanguage 

func (r ApiGetReportRequest) ContentLanguage(contentLanguage string) ApiGetReportRequest

func (ApiGetReportRequest) ContentType 

func (r ApiGetReportRequest) ContentType(contentType string) ApiGetReportRequest

func (ApiGetReportRequest) Execute 

func (r ApiGetReportRequest) Execute() (*GetReport200Response, *http.Response, error)

func (ApiGetReportRequest) GetReport added in v3.4.8 

func (r ApiGetReportRequest) GetReport() (*GetReport200Response, *http.Response, error)

func (ApiGetReportRequest) TelstraApiVersion 

func (r ApiGetReportRequest) TelstraApiVersion(telstraApiVersion string) ApiGetReportRequest

type ApiGetReportsRequest 

type ApiGetReportsRequest struct {
	ApiService *ReportsAPIService
	// contains filtered or unexported fields
}

func (ApiGetReportsRequest) Accept 

func (r ApiGetReportsRequest) Accept(accept string) ApiGetReportsRequest

func (ApiGetReportsRequest) AcceptCharset 

func (r ApiGetReportsRequest) AcceptCharset(acceptCharset string) ApiGetReportsRequest

func (ApiGetReportsRequest) Authorization 

func (r ApiGetReportsRequest) Authorization(authorization string) ApiGetReportsRequest

func (ApiGetReportsRequest) ContentLanguage 

func (r ApiGetReportsRequest) ContentLanguage(contentLanguage string) ApiGetReportsRequest

func (ApiGetReportsRequest) ContentType 

func (r ApiGetReportsRequest) ContentType(contentType string) ApiGetReportsRequest

func (ApiGetReportsRequest) Execute 

func (r ApiGetReportsRequest) Execute() (*GetReports200Response, *http.Response, error)

func (ApiGetReportsRequest) GetReports added in v3.4.8 

func (r ApiGetReportsRequest) GetReports() (*GetReports200Response, *http.Response, error)

func (ApiGetReportsRequest) TelstraApiVersion 

func (r ApiGetReportsRequest) TelstraApiVersion(telstraApiVersion string) ApiGetReportsRequest

type ApiGetTrialNumbersRequest 

type ApiGetTrialNumbersRequest struct {
	ApiService *FreeTrialNumbersAPIService
	// contains filtered or unexported fields
}

func (ApiGetTrialNumbersRequest) Accept 

func (r ApiGetTrialNumbersRequest) Accept(accept string) ApiGetTrialNumbersRequest

func (ApiGetTrialNumbersRequest) AcceptCharset 

func (r ApiGetTrialNumbersRequest) AcceptCharset(acceptCharset string) ApiGetTrialNumbersRequest

func (ApiGetTrialNumbersRequest) Authorization 

func (r ApiGetTrialNumbersRequest) Authorization(authorization string) ApiGetTrialNumbersRequest

func (ApiGetTrialNumbersRequest) ContentLanguage 

func (r ApiGetTrialNumbersRequest) ContentLanguage(contentLanguage string) ApiGetTrialNumbersRequest

func (ApiGetTrialNumbersRequest) ContentType 

func (r ApiGetTrialNumbersRequest) ContentType(contentType string) ApiGetTrialNumbersRequest

func (ApiGetTrialNumbersRequest) Execute 

func (r ApiGetTrialNumbersRequest) Execute() (*FreeTrialNumbers, *http.Response, error)

func (ApiGetTrialNumbersRequest) GetTrialNumbers added in v3.4.8 

func (r ApiGetTrialNumbersRequest) GetTrialNumbers() (*FreeTrialNumbers, *http.Response, error)

func (ApiGetTrialNumbersRequest) TelstraApiVersion 

func (r ApiGetTrialNumbersRequest) TelstraApiVersion(telstraApiVersion string) ApiGetTrialNumbersRequest

type ApiGetVirtualNumberRequest 

type ApiGetVirtualNumberRequest struct {
	ApiService *VirtualNumbersAPIService
	// contains filtered or unexported fields
}

func (ApiGetVirtualNumberRequest) Accept 

func (r ApiGetVirtualNumberRequest) Accept(accept string) ApiGetVirtualNumberRequest

func (ApiGetVirtualNumberRequest) AcceptCharset 

func (r ApiGetVirtualNumberRequest) AcceptCharset(acceptCharset string) ApiGetVirtualNumberRequest

func (ApiGetVirtualNumberRequest) Authorization 

func (r ApiGetVirtualNumberRequest) Authorization(authorization string) ApiGetVirtualNumberRequest

func (ApiGetVirtualNumberRequest) ContentLanguage 

func (r ApiGetVirtualNumberRequest) ContentLanguage(contentLanguage string) ApiGetVirtualNumberRequest

func (ApiGetVirtualNumberRequest) ContentType 

func (r ApiGetVirtualNumberRequest) ContentType(contentType string) ApiGetVirtualNumberRequest

func (ApiGetVirtualNumberRequest) Execute 

func (r ApiGetVirtualNumberRequest) Execute() (*VirtualNumber, *http.Response, error)

func (ApiGetVirtualNumberRequest) GetVirtualNumber added in v3.4.8 

func (r ApiGetVirtualNumberRequest) GetVirtualNumber() (*VirtualNumber, *http.Response, error)

func (ApiGetVirtualNumberRequest) TelstraApiVersion 

func (r ApiGetVirtualNumberRequest) TelstraApiVersion(telstraApiVersion string) ApiGetVirtualNumberRequest

type ApiHealthCheckRequest 

type ApiHealthCheckRequest struct {
	ApiService *HealthCheckAPIService
	// contains filtered or unexported fields
}

func (ApiHealthCheckRequest) Authorization 

func (r ApiHealthCheckRequest) Authorization(authorization string) ApiHealthCheckRequest

func (ApiHealthCheckRequest) Execute 

func (r ApiHealthCheckRequest) Execute() (*HealthCheck200Response, *http.Response, error)

func (ApiHealthCheckRequest) HealthCheck added in v3.4.8 

func (r ApiHealthCheckRequest) HealthCheck() (*HealthCheck200Response, *http.Response, error)

func (ApiHealthCheckRequest) TelstraApiVersion 

func (r ApiHealthCheckRequest) TelstraApiVersion(telstraApiVersion string) ApiHealthCheckRequest

type ApiMessagesReportRequest 

type ApiMessagesReportRequest struct {
	ApiService *ReportsAPIService
	// contains filtered or unexported fields
}

func (ApiMessagesReportRequest) Accept 

func (r ApiMessagesReportRequest) Accept(accept string) ApiMessagesReportRequest

func (ApiMessagesReportRequest) AcceptCharset 

func (r ApiMessagesReportRequest) AcceptCharset(acceptCharset string) ApiMessagesReportRequest

func (ApiMessagesReportRequest) Authorization 

func (r ApiMessagesReportRequest) Authorization(authorization string) ApiMessagesReportRequest

func (ApiMessagesReportRequest) ContentLanguage 

func (r ApiMessagesReportRequest) ContentLanguage(contentLanguage string) ApiMessagesReportRequest

func (ApiMessagesReportRequest) ContentType 

func (r ApiMessagesReportRequest) ContentType(contentType string) ApiMessagesReportRequest

func (ApiMessagesReportRequest) Execute 

func (r ApiMessagesReportRequest) Execute() (*MessagesReport201Response, *http.Response, error)

func (ApiMessagesReportRequest) MessagesReport added in v3.4.8 

func (r ApiMessagesReportRequest) MessagesReport(messagesReportRequest MessagesReportRequest) (*MessagesReport201Response, *http.Response, error)

func (ApiMessagesReportRequest) MessagesReportRequest 

func (r ApiMessagesReportRequest) MessagesReportRequest(messagesReportRequest MessagesReportRequest) ApiMessagesReportRequest

func (ApiMessagesReportRequest) TelstraApiVersion 

func (r ApiMessagesReportRequest) TelstraApiVersion(telstraApiVersion string) ApiMessagesReportRequest

type ApiSendMessagesRequest 

type ApiSendMessagesRequest struct {
	ApiService *MessagesAPIService
	// contains filtered or unexported fields
}

func (ApiSendMessagesRequest) Accept 

func (r ApiSendMessagesRequest) Accept(accept string) ApiSendMessagesRequest

func (ApiSendMessagesRequest) AcceptCharset 

func (r ApiSendMessagesRequest) AcceptCharset(acceptCharset string) ApiSendMessagesRequest

func (ApiSendMessagesRequest) Authorization 

func (r ApiSendMessagesRequest) Authorization(authorization string) ApiSendMessagesRequest

func (ApiSendMessagesRequest) ContentLanguage 

func (r ApiSendMessagesRequest) ContentLanguage(contentLanguage string) ApiSendMessagesRequest

func (ApiSendMessagesRequest) ContentType 

func (r ApiSendMessagesRequest) ContentType(contentType string) ApiSendMessagesRequest

func (ApiSendMessagesRequest) Execute 

func (r ApiSendMessagesRequest) Execute() (*MessageSent, *http.Response, error)

func (ApiSendMessagesRequest) SendMessages added in v3.4.8 

func (r ApiSendMessagesRequest) SendMessages(sendMessagesRequest SendMessagesRequest) (*MessageSent, *http.Response, error)

func (ApiSendMessagesRequest) SendMessagesRequest 

func (r ApiSendMessagesRequest) SendMessagesRequest(sendMessagesRequest SendMessagesRequest) ApiSendMessagesRequest

func (ApiSendMessagesRequest) TelstraApiVersion 

func (r ApiSendMessagesRequest) TelstraApiVersion(telstraApiVersion string) ApiSendMessagesRequest

type ApiUpdateMessageByIdRequest 

type ApiUpdateMessageByIdRequest struct {
	ApiService *MessagesAPIService
	// contains filtered or unexported fields
}

func (ApiUpdateMessageByIdRequest) Accept 

func (r ApiUpdateMessageByIdRequest) Accept(accept string) ApiUpdateMessageByIdRequest

func (ApiUpdateMessageByIdRequest) AcceptCharset 

func (r ApiUpdateMessageByIdRequest) AcceptCharset(acceptCharset string) ApiUpdateMessageByIdRequest

func (ApiUpdateMessageByIdRequest) Authorization 

func (r ApiUpdateMessageByIdRequest) Authorization(authorization string) ApiUpdateMessageByIdRequest

func (ApiUpdateMessageByIdRequest) ContentLanguage 

func (r ApiUpdateMessageByIdRequest) ContentLanguage(contentLanguage string) ApiUpdateMessageByIdRequest

func (ApiUpdateMessageByIdRequest) ContentType 

func (r ApiUpdateMessageByIdRequest) ContentType(contentType string) ApiUpdateMessageByIdRequest

func (ApiUpdateMessageByIdRequest) Execute 

func (r ApiUpdateMessageByIdRequest) Execute() (*MessageUpdate, *http.Response, error)

func (ApiUpdateMessageByIdRequest) TelstraApiVersion 

func (r ApiUpdateMessageByIdRequest) TelstraApiVersion(telstraApiVersion string) ApiUpdateMessageByIdRequest

func (ApiUpdateMessageByIdRequest) UpdateMessageById added in v3.4.8 

func (r ApiUpdateMessageByIdRequest) UpdateMessageById(updateMessageByIdRequest UpdateMessageByIdRequest) (*MessageUpdate, *http.Response, error)

func (ApiUpdateMessageByIdRequest) UpdateMessageByIdRequest 

func (r ApiUpdateMessageByIdRequest) UpdateMessageByIdRequest(updateMessageByIdRequest UpdateMessageByIdRequest) ApiUpdateMessageByIdRequest

type ApiUpdateMessageTagsRequest 

type ApiUpdateMessageTagsRequest struct {
	ApiService *MessagesAPIService
	// contains filtered or unexported fields
}

func (ApiUpdateMessageTagsRequest) Accept 

func (r ApiUpdateMessageTagsRequest) Accept(accept string) ApiUpdateMessageTagsRequest

func (ApiUpdateMessageTagsRequest) AcceptCharset 

func (r ApiUpdateMessageTagsRequest) AcceptCharset(acceptCharset string) ApiUpdateMessageTagsRequest

func (ApiUpdateMessageTagsRequest) Authorization 

func (r ApiUpdateMessageTagsRequest) Authorization(authorization string) ApiUpdateMessageTagsRequest

func (ApiUpdateMessageTagsRequest) ContentLanguage 

func (r ApiUpdateMessageTagsRequest) ContentLanguage(contentLanguage string) ApiUpdateMessageTagsRequest

func (ApiUpdateMessageTagsRequest) ContentType 

func (r ApiUpdateMessageTagsRequest) ContentType(contentType string) ApiUpdateMessageTagsRequest

func (ApiUpdateMessageTagsRequest) Execute 

func (r ApiUpdateMessageTagsRequest) Execute() (*http.Response, error)

func (ApiUpdateMessageTagsRequest) TelstraApiVersion 

func (r ApiUpdateMessageTagsRequest) TelstraApiVersion(telstraApiVersion string) ApiUpdateMessageTagsRequest

func (ApiUpdateMessageTagsRequest) UpdateMessageTags added in v3.4.8 

func (r ApiUpdateMessageTagsRequest) UpdateMessageTags(updateMessageTagsRequest UpdateMessageTagsRequest) (*http.Response, error)

func (ApiUpdateMessageTagsRequest) UpdateMessageTagsRequest 

func (r ApiUpdateMessageTagsRequest) UpdateMessageTagsRequest(updateMessageTagsRequest UpdateMessageTagsRequest) ApiUpdateMessageTagsRequest

type ApiUpdateNumberRequest 

type ApiUpdateNumberRequest struct {
	ApiService *VirtualNumbersAPIService
	// contains filtered or unexported fields
}

func (ApiUpdateNumberRequest) Accept 

func (r ApiUpdateNumberRequest) Accept(accept string) ApiUpdateNumberRequest

func (ApiUpdateNumberRequest) AcceptCharset 

func (r ApiUpdateNumberRequest) AcceptCharset(acceptCharset string) ApiUpdateNumberRequest

func (ApiUpdateNumberRequest) Authorization 

func (r ApiUpdateNumberRequest) Authorization(authorization string) ApiUpdateNumberRequest

func (ApiUpdateNumberRequest) ContentLanguage 

func (r ApiUpdateNumberRequest) ContentLanguage(contentLanguage string) ApiUpdateNumberRequest

func (ApiUpdateNumberRequest) ContentType 

func (r ApiUpdateNumberRequest) ContentType(contentType string) ApiUpdateNumberRequest

func (ApiUpdateNumberRequest) Execute 

func (r ApiUpdateNumberRequest) Execute() (*VirtualNumber, *http.Response, error)

func (ApiUpdateNumberRequest) TelstraApiVersion 

func (r ApiUpdateNumberRequest) TelstraApiVersion(telstraApiVersion string) ApiUpdateNumberRequest

func (ApiUpdateNumberRequest) UpdateNumber added in v3.4.8 

func (r ApiUpdateNumberRequest) UpdateNumber(updateNumberRequest UpdateNumberRequest) (*VirtualNumber, *http.Response, error)

func (ApiUpdateNumberRequest) UpdateNumberRequest 

func (r ApiUpdateNumberRequest) UpdateNumberRequest(updateNumberRequest UpdateNumberRequest) ApiUpdateNumberRequest

type AssignNumberRequest 

type AssignNumberRequest struct {
	// Tell us the URL that replies to the Virtual Number should be sent to.  Sample callback response:  <pre><code class=\"language-sh\">{   \"to\":\"0476543210\",    \"from\":\"0401234567\",    \"timestamp\":\"2022-11-10T05:06:42.823Z\",    \"messageId\":\"75f263c0-60b5-11ed-8456-71ae4c63550d\",    \"messageContent\":\"Hi, example message\",    \"multimedia\": {      \"fileName:\"image.jpeg\"      \"type:\"image/jpeg\"      \"payload\":\"base64 payload\"   } }</code></pre>
	ReplyCallbackUrl *string `json:"replyCallbackUrl,omitempty"`
	// Create your own tags and use them to fetch, sort and report on your Virtual Numbers through our other endpoints. You can assign up to 10 tags per number.
	Tags []string `json:"tags,omitempty"`
}

AssignNumberRequest struct for AssignNumberRequest

func NewAssignNumberRequest 

func NewAssignNumberRequest() *AssignNumberRequest

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

func NewAssignNumberRequestWithDefaults 

func NewAssignNumberRequestWithDefaults() *AssignNumberRequest

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

func (*AssignNumberRequest) GetReplyCallbackUrl 

func (o *AssignNumberRequest) GetReplyCallbackUrl() string

GetReplyCallbackUrl returns the ReplyCallbackUrl field value if set, zero value otherwise.

func (*AssignNumberRequest) GetReplyCallbackUrlOk 

func (o *AssignNumberRequest) GetReplyCallbackUrlOk() (*string, bool)

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

func (*AssignNumberRequest) GetTags 

func (o *AssignNumberRequest) GetTags() []string

GetTags returns the Tags field value if set, zero value otherwise.

func (*AssignNumberRequest) GetTagsOk 

func (o *AssignNumberRequest) GetTagsOk() ([]string, bool)

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

func (*AssignNumberRequest) HasReplyCallbackUrl 

func (o *AssignNumberRequest) HasReplyCallbackUrl() bool

HasReplyCallbackUrl returns a boolean if a field has been set.

func (*AssignNumberRequest) HasTags 

func (o *AssignNumberRequest) HasTags() bool

HasTags returns a boolean if a field has been set.

func (AssignNumberRequest) MarshalJSON 

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

func (*AssignNumberRequest) SetReplyCallbackUrl 

func (o *AssignNumberRequest) SetReplyCallbackUrl(v string)

SetReplyCallbackUrl gets a reference to the given string and assigns it to the ReplyCallbackUrl field.

func (*AssignNumberRequest) SetTags 

func (o *AssignNumberRequest) SetTags(v []string)

SetTags gets a reference to the given []string and assigns it to the Tags field.

func (AssignNumberRequest) ToMap 

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

type AuthToken400Response 

type AuthToken400Response struct {
	// Unique code of the error
	Error string `json:"error"`
	// Description of the error
	ErrorDescription *string `json:"error_description,omitempty"`
}

AuthToken400Response OAuth Error Responses

func NewAuthToken400Response 

func NewAuthToken400Response(error_ string) *AuthToken400Response

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

func NewAuthToken400ResponseWithDefaults 

func NewAuthToken400ResponseWithDefaults() *AuthToken400Response

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

func (*AuthToken400Response) GetError 

func (o *AuthToken400Response) GetError() string

GetError returns the Error field value

func (*AuthToken400Response) GetErrorDescription 

func (o *AuthToken400Response) GetErrorDescription() string

GetErrorDescription returns the ErrorDescription field value if set, zero value otherwise.

func (*AuthToken400Response) GetErrorDescriptionOk 

func (o *AuthToken400Response) GetErrorDescriptionOk() (*string, bool)

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

func (*AuthToken400Response) GetErrorOk 

func (o *AuthToken400Response) GetErrorOk() (*string, bool)

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

func (*AuthToken400Response) HasErrorDescription 

func (o *AuthToken400Response) HasErrorDescription() bool

HasErrorDescription returns a boolean if a field has been set.

func (AuthToken400Response) MarshalJSON 

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

func (*AuthToken400Response) SetError 

func (o *AuthToken400Response) SetError(v string)

SetError sets field value

func (*AuthToken400Response) SetErrorDescription 

func (o *AuthToken400Response) SetErrorDescription(v string)

SetErrorDescription gets a reference to the given string and assigns it to the ErrorDescription field.

func (AuthToken400Response) ToMap 

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

type AuthenticationAPIService 

type AuthenticationAPIService service

AuthenticationAPIService AuthenticationAPI service

func (*AuthenticationAPIService) AuthToken 

func (a *AuthenticationAPIService) AuthToken(ctx context.Context, clientId string, clientSecret string) ApiAuthTokenRequest

AuthToken Generate an access token

An OAuth 2.0 access token is required to access the API features. To create a token, use the unique `client_id` and `client_secret` you received when you registered for the API. You can find these credentials [here](https://dev.telstra.com). Note that your access token will expire in 1 hour. 

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

func (*AuthenticationAPIService) AuthTokenExecute 

func (a *AuthenticationAPIService) AuthTokenExecute(r ApiAuthTokenRequest) (*OAuth, *http.Response, error)

Execute executes the request 

@return OAuth

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

type CreateTrialNumbersRequest struct {
	FreeTrialNumbers CreateTrialNumbersRequestFreeTrialNumbers `json:"freeTrialNumbers"`
}

CreateTrialNumbersRequest struct for CreateTrialNumbersRequest

func NewCreateTrialNumbersRequest 

func NewCreateTrialNumbersRequest(freeTrialNumbers CreateTrialNumbersRequestFreeTrialNumbers) *CreateTrialNumbersRequest

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

func NewCreateTrialNumbersRequestWithDefaults 

func NewCreateTrialNumbersRequestWithDefaults() *CreateTrialNumbersRequest

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

func (*CreateTrialNumbersRequest) GetFreeTrialNumbers 

func (o *CreateTrialNumbersRequest) GetFreeTrialNumbers() CreateTrialNumbersRequestFreeTrialNumbers

GetFreeTrialNumbers returns the FreeTrialNumbers field value

func (*CreateTrialNumbersRequest) GetFreeTrialNumbersOk 

func (o *CreateTrialNumbersRequest) GetFreeTrialNumbersOk() (*CreateTrialNumbersRequestFreeTrialNumbers, bool)

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

func (CreateTrialNumbersRequest) MarshalJSON 

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

func (*CreateTrialNumbersRequest) SetFreeTrialNumbers 

func (o *CreateTrialNumbersRequest) SetFreeTrialNumbers(v CreateTrialNumbersRequestFreeTrialNumbers)

SetFreeTrialNumbers sets field value

func (CreateTrialNumbersRequest) ToMap 

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

type CreateTrialNumbersRequestFreeTrialNumbers 

type CreateTrialNumbersRequestFreeTrialNumbers struct {
	ArrayOfString *[]string
	String        *string
}

CreateTrialNumbersRequestFreeTrialNumbers - These are the mobile numbers you want to message during your Free Trial. Write Australian numbers in national format (e.g. \"0412345678\"). Use a string for a single recipient, and an array of strings for multiple recipients, (e.g. [\"0412345678\", \"0487654321\"]).

func ArrayOfStringAsCreateTrialNumbersRequestFreeTrialNumbers 

func ArrayOfStringAsCreateTrialNumbersRequestFreeTrialNumbers(v *[]string) CreateTrialNumbersRequestFreeTrialNumbers

[]stringAsCreateTrialNumbersRequestFreeTrialNumbers is a convenience function that returns []string wrapped in CreateTrialNumbersRequestFreeTrialNumbers

func StringAsCreateTrialNumbersRequestFreeTrialNumbers 

func StringAsCreateTrialNumbersRequestFreeTrialNumbers(v *string) CreateTrialNumbersRequestFreeTrialNumbers

stringAsCreateTrialNumbersRequestFreeTrialNumbers is a convenience function that returns string wrapped in CreateTrialNumbersRequestFreeTrialNumbers

func (*CreateTrialNumbersRequestFreeTrialNumbers) GetActualInstance 

func (obj *CreateTrialNumbersRequestFreeTrialNumbers) GetActualInstance() interface{}

Get the actual instance

func (CreateTrialNumbersRequestFreeTrialNumbers) MarshalJSON 

func (src CreateTrialNumbersRequestFreeTrialNumbers) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*CreateTrialNumbersRequestFreeTrialNumbers) UnmarshalJSON 

func (dst *CreateTrialNumbersRequestFreeTrialNumbers) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct

type Error 

type Error struct {
	// Unique code of the error
	Code string `json:"code"`
	// The reason for the error
	Issue string `json:"issue"`
	// Suggest practical actions for this particular issue.
	SuggestedAction string `json:"suggested_action"`
	// The field that caused the error
	Field *string `json:"field,omitempty"`
	// The value of the field that caused the error
	Value *string `json:"value,omitempty"`
	// The location of the field that caused the error.
	Location *string `json:"location,omitempty"`
	// URI for detailed information related to this error for the developer.
	Link *string `json:"link,omitempty"`
}

Error struct for Error

func NewError 

func NewError(code string, issue string, suggestedAction string) *Error

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

func NewErrorWithDefaults 

func NewErrorWithDefaults() *Error

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

func (*Error) GetCode 

func (o *Error) GetCode() string

GetCode returns the Code field value

func (*Error) GetCodeOk 

func (o *Error) GetCodeOk() (*string, bool)

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

func (*Error) GetField 

func (o *Error) GetField() string

GetField returns the Field field value if set, zero value otherwise.

func (*Error) GetFieldOk 

func (o *Error) GetFieldOk() (*string, bool)

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

func (*Error) GetIssue 

func (o *Error) GetIssue() string

GetIssue returns the Issue field value

func (*Error) GetIssueOk 

func (o *Error) GetIssueOk() (*string, bool)

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

func (o *Error) GetLink() string

GetLink returns the Link field value if set, zero value otherwise.

func (*Error) GetLinkOk 

func (o *Error) GetLinkOk() (*string, bool)

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

func (*Error) GetLocation 

func (o *Error) GetLocation() string

GetLocation returns the Location field value if set, zero value otherwise.

func (*Error) GetLocationOk 

func (o *Error) GetLocationOk() (*string, bool)

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

func (*Error) GetSuggestedAction 

func (o *Error) GetSuggestedAction() string

GetSuggestedAction returns the SuggestedAction field value

func (*Error) GetSuggestedActionOk 

func (o *Error) GetSuggestedActionOk() (*string, bool)

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

func (*Error) GetValue 

func (o *Error) GetValue() string

GetValue returns the Value field value if set, zero value otherwise.

func (*Error) GetValueOk 

func (o *Error) GetValueOk() (*string, bool)

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

func (*Error) HasField 

func (o *Error) HasField() bool

HasField returns a boolean if a field has been set. 

func (o *Error) HasLink() bool

HasLink returns a boolean if a field has been set.

func (*Error) HasLocation 

func (o *Error) HasLocation() bool

HasLocation returns a boolean if a field has been set.

func (*Error) HasValue 

func (o *Error) HasValue() bool

HasValue returns a boolean if a field has been set.

func (Error) MarshalJSON 

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

func (*Error) SetCode 

func (o *Error) SetCode(v string)

SetCode sets field value

func (*Error) SetField 

func (o *Error) SetField(v string)

SetField gets a reference to the given string and assigns it to the Field field.

func (*Error) SetIssue 

func (o *Error) SetIssue(v string)

SetIssue sets field value 

func (o *Error) SetLink(v string)

SetLink gets a reference to the given string and assigns it to the Link field.

func (*Error) SetLocation 

func (o *Error) SetLocation(v string)

SetLocation gets a reference to the given string and assigns it to the Location field.

func (*Error) SetSuggestedAction 

func (o *Error) SetSuggestedAction(v string)

SetSuggestedAction sets field value

func (*Error) SetValue 

func (o *Error) SetValue(v string)

SetValue gets a reference to the given string and assigns it to the Value field.

func (Error) ToMap 

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

type Errors 

type Errors struct {
	Errors []Error `json:"errors,omitempty"`
}

Errors struct for Errors

func NewErrors 

func NewErrors() *Errors

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

func NewErrorsWithDefaults 

func NewErrorsWithDefaults() *Errors

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

func (*Errors) GetErrors 

func (o *Errors) GetErrors() []Error

GetErrors returns the Errors field value if set, zero value otherwise.

func (*Errors) GetErrorsOk 

func (o *Errors) GetErrorsOk() ([]Error, bool)

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

func (*Errors) HasErrors 

func (o *Errors) HasErrors() bool

HasErrors returns a boolean if a field has been set.

func (Errors) MarshalJSON 

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

func (*Errors) SetErrors 

func (o *Errors) SetErrors(v []Error)

SetErrors gets a reference to the given []Error and assigns it to the Errors field.

func (Errors) ToMap 

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

type FreeTrialNumbers 

type FreeTrialNumbers struct {
	// The recipient number(s) registered to your Free Trial Numbers List. These are the mobile numbers that you can message during the Free Trial.
	FreeTrialNumbers []string `json:"freeTrialNumbers"`
}

FreeTrialNumbers struct for FreeTrialNumbers

func NewFreeTrialNumbers 

func NewFreeTrialNumbers(freeTrialNumbers []string) *FreeTrialNumbers

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

func NewFreeTrialNumbersWithDefaults 

func NewFreeTrialNumbersWithDefaults() *FreeTrialNumbers

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

func (*FreeTrialNumbers) GetFreeTrialNumbers 

func (o *FreeTrialNumbers) GetFreeTrialNumbers() []string

GetFreeTrialNumbers returns the FreeTrialNumbers field value

func (*FreeTrialNumbers) GetFreeTrialNumbersOk 

func (o *FreeTrialNumbers) GetFreeTrialNumbersOk() ([]string, bool)

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

func (FreeTrialNumbers) MarshalJSON 

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

func (*FreeTrialNumbers) SetFreeTrialNumbers 

func (o *FreeTrialNumbers) SetFreeTrialNumbers(v []string)

SetFreeTrialNumbers sets field value

func (FreeTrialNumbers) ToMap 

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

type FreeTrialNumbersAPIService 

type FreeTrialNumbersAPIService service

FreeTrialNumbersAPIService FreeTrialNumbersAPI service

func (*FreeTrialNumbersAPIService) CreateTrialNumbers 

func (a *FreeTrialNumbersAPIService) CreateTrialNumbers(ctx context.Context, authorization string) ApiCreateTrialNumbersRequest

CreateTrialNumbers create free trial number list

Your Free Trial Numbers are the 10 recipient mobile numbers that you can message during the Free Trial. The first five numbers you send an SMS/MMS to will automatically be added to your Free Trial Numbers list. After that, you can use this endpoint to register another five. Alternatively, you can use this endpoint to register all 10 numbers.

Use this endpoint to register a Free Trial Number to your account. To test out all the features that the trial has to offer, we recommend registering your own mobile number to your Free Trial Numbers list.

Note that you can only message mobile numbers that have been added to your Free Trial list and once registered, a Free Trial Number cannot be removed or replaced. 

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

func (*FreeTrialNumbersAPIService) CreateTrialNumbersExecute 

func (a *FreeTrialNumbersAPIService) CreateTrialNumbersExecute(r ApiCreateTrialNumbersRequest) (*FreeTrialNumbers, *http.Response, error)

Execute executes the request 

@return FreeTrialNumbers

func (*FreeTrialNumbersAPIService) GetTrialNumbers 

func (a *FreeTrialNumbersAPIService) GetTrialNumbers(ctx context.Context, authorization string) ApiGetTrialNumbersRequest

GetTrialNumbers get all free trial numbers

Use this endpoint to fetch the Free Trial Number(s) currently assigned to your account. These are the mobile numbers that you can message during the Free Trial.

If you're using a paid plan, there's no limit to the number of recipients that you can message, so you don't need to register Free Trial Numbers. 

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

func (*FreeTrialNumbersAPIService) GetTrialNumbersExecute 

func (a *FreeTrialNumbersAPIService) GetTrialNumbersExecute(r ApiGetTrialNumbersRequest) (*FreeTrialNumbers, *http.Response, error)

Execute executes the request 

@return FreeTrialNumbers

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 GetLogs200Response 

type GetLogs200Response struct {
	Logs []Log `json:"logs,omitempty"`
}

GetLogs200Response struct for GetLogs200Response

func NewGetLogs200Response 

func NewGetLogs200Response() *GetLogs200Response

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

func NewGetLogs200ResponseWithDefaults 

func NewGetLogs200ResponseWithDefaults() *GetLogs200Response

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

func (*GetLogs200Response) GetLogs 

func (o *GetLogs200Response) GetLogs() []Log

GetLogs returns the Logs field value if set, zero value otherwise.

func (*GetLogs200Response) GetLogsOk 

func (o *GetLogs200Response) GetLogsOk() ([]Log, bool)

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

func (*GetLogs200Response) HasLogs 

func (o *GetLogs200Response) HasLogs() bool

HasLogs returns a boolean if a field has been set.

func (GetLogs200Response) MarshalJSON 

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

func (*GetLogs200Response) SetLogs 

func (o *GetLogs200Response) SetLogs(v []Log)

SetLogs gets a reference to the given []Log and assigns it to the Logs field.

func (GetLogs200Response) ToMap 

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

type GetMessages200Response 

type GetMessages200Response struct {
	// The paginated results of your request. To fetch the next set of results, send another request and provide the succeeding offset value.
	Messages []MessageGet                  `json:"messages,omitempty"`
	Paging   *GetMessages200ResponsePaging `json:"paging,omitempty"`
}

GetMessages200Response struct for GetMessages200Response

func NewGetMessages200Response 

func NewGetMessages200Response() *GetMessages200Response

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

func NewGetMessages200ResponseWithDefaults 

func NewGetMessages200ResponseWithDefaults() *GetMessages200Response

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

func (*GetMessages200Response) GetMessages 

func (o *GetMessages200Response) GetMessages() []MessageGet

GetMessages returns the Messages field value if set, zero value otherwise.

func (*GetMessages200Response) GetMessagesOk 

func (o *GetMessages200Response) GetMessagesOk() ([]MessageGet, bool)

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

func (*GetMessages200Response) GetPaging 

func (o *GetMessages200Response) GetPaging() GetMessages200ResponsePaging

GetPaging returns the Paging field value if set, zero value otherwise.

func (*GetMessages200Response) GetPagingOk 

func (o *GetMessages200Response) GetPagingOk() (*GetMessages200ResponsePaging, bool)

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

func (*GetMessages200Response) HasMessages 

func (o *GetMessages200Response) HasMessages() bool

HasMessages returns a boolean if a field has been set.

func (*GetMessages200Response) HasPaging 

func (o *GetMessages200Response) HasPaging() bool

HasPaging returns a boolean if a field has been set.

func (GetMessages200Response) MarshalJSON 

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

func (*GetMessages200Response) SetMessages 

func (o *GetMessages200Response) SetMessages(v []MessageGet)

SetMessages gets a reference to the given []MessageGet and assigns it to the Messages field.

func (*GetMessages200Response) SetPaging 

func (o *GetMessages200Response) SetPaging(v GetMessages200ResponsePaging)

SetPaging gets a reference to the given GetMessages200ResponsePaging and assigns it to the Paging field.

func (GetMessages200Response) ToMap 

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

type GetMessages200ResponsePaging 

type GetMessages200ResponsePaging struct {
	// The next page of results.
	NextPage *string `json:"nextPage,omitempty"`
	// The previous page of results.
	PreviousPage *string `json:"previousPage,omitempty"`
	// The last page of results.
	LastPage *string `json:"lastPage,omitempty"`
	// The total number of pages.
	TotalCount *float32 `json:"totalCount,omitempty"`
}

GetMessages200ResponsePaging struct for GetMessages200ResponsePaging

func NewGetMessages200ResponsePaging 

func NewGetMessages200ResponsePaging() *GetMessages200ResponsePaging

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

func NewGetMessages200ResponsePagingWithDefaults 

func NewGetMessages200ResponsePagingWithDefaults() *GetMessages200ResponsePaging

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

func (*GetMessages200ResponsePaging) GetLastPage 

func (o *GetMessages200ResponsePaging) GetLastPage() string

GetLastPage returns the LastPage field value if set, zero value otherwise.

func (*GetMessages200ResponsePaging) GetLastPageOk 

func (o *GetMessages200ResponsePaging) GetLastPageOk() (*string, bool)

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

func (*GetMessages200ResponsePaging) GetNextPage 

func (o *GetMessages200ResponsePaging) GetNextPage() string

GetNextPage returns the NextPage field value if set, zero value otherwise.

func (*GetMessages200ResponsePaging) GetNextPageOk 

func (o *GetMessages200ResponsePaging) GetNextPageOk() (*string, bool)

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

func (*GetMessages200ResponsePaging) GetPreviousPage 

func (o *GetMessages200ResponsePaging) GetPreviousPage() string

GetPreviousPage returns the PreviousPage field value if set, zero value otherwise.

func (*GetMessages200ResponsePaging) GetPreviousPageOk 

func (o *GetMessages200ResponsePaging) GetPreviousPageOk() (*string, bool)

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

func (*GetMessages200ResponsePaging) GetTotalCount 

func (o *GetMessages200ResponsePaging) GetTotalCount() float32

GetTotalCount returns the TotalCount field value if set, zero value otherwise.

func (*GetMessages200ResponsePaging) GetTotalCountOk 

func (o *GetMessages200ResponsePaging) GetTotalCountOk() (*float32, bool)

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

func (*GetMessages200ResponsePaging) HasLastPage 

func (o *GetMessages200ResponsePaging) HasLastPage() bool

HasLastPage returns a boolean if a field has been set.

func (*GetMessages200ResponsePaging) HasNextPage 

func (o *GetMessages200ResponsePaging) HasNextPage() bool

HasNextPage returns a boolean if a field has been set.

func (*GetMessages200ResponsePaging) HasPreviousPage 

func (o *GetMessages200ResponsePaging) HasPreviousPage() bool

HasPreviousPage returns a boolean if a field has been set.

func (*GetMessages200ResponsePaging) HasTotalCount 

func (o *GetMessages200ResponsePaging) HasTotalCount() bool

HasTotalCount returns a boolean if a field has been set.

func (GetMessages200ResponsePaging) MarshalJSON 

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

func (*GetMessages200ResponsePaging) SetLastPage 

func (o *GetMessages200ResponsePaging) SetLastPage(v string)

SetLastPage gets a reference to the given string and assigns it to the LastPage field.

func (*GetMessages200ResponsePaging) SetNextPage 

func (o *GetMessages200ResponsePaging) SetNextPage(v string)

SetNextPage gets a reference to the given string and assigns it to the NextPage field.

func (*GetMessages200ResponsePaging) SetPreviousPage 

func (o *GetMessages200ResponsePaging) SetPreviousPage(v string)

SetPreviousPage gets a reference to the given string and assigns it to the PreviousPage field.

func (*GetMessages200ResponsePaging) SetTotalCount 

func (o *GetMessages200ResponsePaging) SetTotalCount(v float32)

SetTotalCount gets a reference to the given float32 and assigns it to the TotalCount field.

func (GetMessages200ResponsePaging) ToMap 

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

type GetNumbers200Response 

type GetNumbers200Response struct {
	// The paginated results of your request. To fetch the next set of results, send another request and provide the succeeding offset value.
	VirtualNumbers []VirtualNumber               `json:"virtualNumbers,omitempty"`
	Paging         *GetMessages200ResponsePaging `json:"paging,omitempty"`
}

GetNumbers200Response struct for GetNumbers200Response

func NewGetNumbers200Response 

func NewGetNumbers200Response() *GetNumbers200Response

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

func NewGetNumbers200ResponseWithDefaults 

func NewGetNumbers200ResponseWithDefaults() *GetNumbers200Response

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

func (*GetNumbers200Response) GetPaging 

func (o *GetNumbers200Response) GetPaging() GetMessages200ResponsePaging

GetPaging returns the Paging field value if set, zero value otherwise.

func (*GetNumbers200Response) GetPagingOk 

func (o *GetNumbers200Response) GetPagingOk() (*GetMessages200ResponsePaging, bool)

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

func (*GetNumbers200Response) GetVirtualNumbers 

func (o *GetNumbers200Response) GetVirtualNumbers() []VirtualNumber

GetVirtualNumbers returns the VirtualNumbers field value if set, zero value otherwise.

func (*GetNumbers200Response) GetVirtualNumbersOk 

func (o *GetNumbers200Response) GetVirtualNumbersOk() ([]VirtualNumber, bool)

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

func (*GetNumbers200Response) HasPaging 

func (o *GetNumbers200Response) HasPaging() bool

HasPaging returns a boolean if a field has been set.

func (*GetNumbers200Response) HasVirtualNumbers 

func (o *GetNumbers200Response) HasVirtualNumbers() bool

HasVirtualNumbers returns a boolean if a field has been set.

func (GetNumbers200Response) MarshalJSON 

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

func (*GetNumbers200Response) SetPaging 

func (o *GetNumbers200Response) SetPaging(v GetMessages200ResponsePaging)

SetPaging gets a reference to the given Object and assigns it to the Paging field.

func (*GetNumbers200Response) SetVirtualNumbers 

func (o *GetNumbers200Response) SetVirtualNumbers(v []VirtualNumber)

SetVirtualNumbers gets a reference to the given []VirtualNumber and assigns it to the VirtualNumbers field.

func (GetNumbers200Response) ToMap 

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

type GetRecipientOptouts200Response 

type GetRecipientOptouts200Response struct {
	// The paginated results of your request. To fetch the next set of results, send another request and provide the succeeding offset value.
	RecipientOptouts []RecipientOptout             `json:"recipientOptouts,omitempty"`
	Paging           *GetMessages200ResponsePaging `json:"paging,omitempty"`
}

GetRecipientOptouts200Response struct for GetRecipientOptouts200Response

func NewGetRecipientOptouts200Response 

func NewGetRecipientOptouts200Response() *GetRecipientOptouts200Response

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

func NewGetRecipientOptouts200ResponseWithDefaults 

func NewGetRecipientOptouts200ResponseWithDefaults() *GetRecipientOptouts200Response

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

func (*GetRecipientOptouts200Response) GetPaging 

func (o *GetRecipientOptouts200Response) GetPaging() GetMessages200ResponsePaging

GetPaging returns the Paging field value if set, zero value otherwise.

func (*GetRecipientOptouts200Response) GetPagingOk 

func (o *GetRecipientOptouts200Response) GetPagingOk() (*GetMessages200ResponsePaging, bool)

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

func (*GetRecipientOptouts200Response) GetRecipientOptouts 

func (o *GetRecipientOptouts200Response) GetRecipientOptouts() []RecipientOptout

GetRecipientOptouts returns the RecipientOptouts field value if set, zero value otherwise.

func (*GetRecipientOptouts200Response) GetRecipientOptoutsOk 

func (o *GetRecipientOptouts200Response) GetRecipientOptoutsOk() ([]RecipientOptout, bool)

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

func (*GetRecipientOptouts200Response) HasPaging 

func (o *GetRecipientOptouts200Response) HasPaging() bool

HasPaging returns a boolean if a field has been set.

func (*GetRecipientOptouts200Response) HasRecipientOptouts 

func (o *GetRecipientOptouts200Response) HasRecipientOptouts() bool

HasRecipientOptouts returns a boolean if a field has been set.

func (GetRecipientOptouts200Response) MarshalJSON 

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

func (*GetRecipientOptouts200Response) SetPaging 

func (o *GetRecipientOptouts200Response) SetPaging(v GetMessages200ResponsePaging)

SetPaging gets a reference to the given Object and assigns it to the Paging field.

func (*GetRecipientOptouts200Response) SetRecipientOptouts 

func (o *GetRecipientOptouts200Response) SetRecipientOptouts(v []RecipientOptout)

SetRecipientOptouts gets a reference to the given []RecipientOptout and assigns it to the RecipientOptouts field.

func (GetRecipientOptouts200Response) ToMap 

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

type GetReport200Response 

type GetReport200Response struct {
	// The UUID assigned to your report.
	ReportId *string `json:"reportId,omitempty"`
	// The status of the report. It will be either:        * **queued** – the report is in the queue for generation.        * **completed** – the report is ready for download.        * **failed** – the report failed to generate. Please try again.
	ReportStatus *string `json:"reportStatus,omitempty"`
	// Use this link to download your CSV file.
	ReportUrl *string `json:"reportUrl,omitempty"`
}

GetReport200Response struct for GetReport200Response

func NewGetReport200Response 

func NewGetReport200Response() *GetReport200Response

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

func NewGetReport200ResponseWithDefaults 

func NewGetReport200ResponseWithDefaults() *GetReport200Response

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

func (*GetReport200Response) GetReportId 

func (o *GetReport200Response) GetReportId() string

GetReportId returns the ReportId field value if set, zero value otherwise.

func (*GetReport200Response) GetReportIdOk 

func (o *GetReport200Response) GetReportIdOk() (*string, bool)

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

func (*GetReport200Response) GetReportStatus 

func (o *GetReport200Response) GetReportStatus() string

GetReportStatus returns the ReportStatus field value if set, zero value otherwise.

func (*GetReport200Response) GetReportStatusOk 

func (o *GetReport200Response) GetReportStatusOk() (*string, bool)

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

func (*GetReport200Response) GetReportUrl 

func (o *GetReport200Response) GetReportUrl() string

GetReportUrl returns the ReportUrl field value if set, zero value otherwise.

func (*GetReport200Response) GetReportUrlOk 

func (o *GetReport200Response) GetReportUrlOk() (*string, bool)

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

func (*GetReport200Response) HasReportId 

func (o *GetReport200Response) HasReportId() bool

HasReportId returns a boolean if a field has been set.

func (*GetReport200Response) HasReportStatus 

func (o *GetReport200Response) HasReportStatus() bool

HasReportStatus returns a boolean if a field has been set.

func (*GetReport200Response) HasReportUrl 

func (o *GetReport200Response) HasReportUrl() bool

HasReportUrl returns a boolean if a field has been set.

func (GetReport200Response) MarshalJSON 

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

func (*GetReport200Response) SetReportId 

func (o *GetReport200Response) SetReportId(v string)

SetReportId gets a reference to the given string and assigns it to the ReportId field.

func (*GetReport200Response) SetReportStatus 

func (o *GetReport200Response) SetReportStatus(v string)

SetReportStatus gets a reference to the given string and assigns it to the ReportStatus field.

func (*GetReport200Response) SetReportUrl 

func (o *GetReport200Response) SetReportUrl(v string)

SetReportUrl gets a reference to the given string and assigns it to the ReportUrl field.

func (GetReport200Response) ToMap 

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

type GetReports200Response 

type GetReports200Response struct {
	Reports []GetReports200ResponseReportsInner `json:"reports,omitempty"`
}

GetReports200Response struct for GetReports200Response

func NewGetReports200Response 

func NewGetReports200Response() *GetReports200Response

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

func NewGetReports200ResponseWithDefaults 

func NewGetReports200ResponseWithDefaults() *GetReports200Response

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

func (*GetReports200Response) GetReports 

func (o *GetReports200Response) GetReports() []GetReports200ResponseReportsInner

GetReports returns the Reports field value if set, zero value otherwise.

func (*GetReports200Response) GetReportsOk 

func (o *GetReports200Response) GetReportsOk() ([]GetReports200ResponseReportsInner, bool)

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

func (*GetReports200Response) HasReports 

func (o *GetReports200Response) HasReports() bool

HasReports returns a boolean if a field has been set.

func (GetReports200Response) MarshalJSON 

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

func (*GetReports200Response) SetReports 

func (o *GetReports200Response) SetReports(v []GetReports200ResponseReportsInner)

SetReports gets a reference to the given []GetReports200ResponseReportsInner and assigns it to the Reports field.

func (GetReports200Response) ToMap 

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

type GetReports200ResponseReportsInner 

type GetReports200ResponseReportsInner struct {
	// Use this UUID to fetch your report with the GET /reports/{reportId} endpoint.
	ReportId *string `json:"reportId,omitempty"`
	// The status of the report. It will be either:        * **queued** – the report is in the queue for generation.        * **completed** – the report is ready for download.        * **failed** – the report failed to generate. Please try again.
	ReportStatus *string `json:"reportStatus,omitempty"`
	// The type of report generated.
	ReportType *string `json:"reportType,omitempty"`
	// The expiry date of your report. After this date, you will be unable to download your report.
	ReportExpiry *string `json:"reportExpiry,omitempty"`
}

GetReports200ResponseReportsInner struct for GetReports200ResponseReportsInner

func NewGetReports200ResponseReportsInner 

func NewGetReports200ResponseReportsInner() *GetReports200ResponseReportsInner

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

func NewGetReports200ResponseReportsInnerWithDefaults 

func NewGetReports200ResponseReportsInnerWithDefaults() *GetReports200ResponseReportsInner

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

func (*GetReports200ResponseReportsInner) GetReportExpiry 

func (o *GetReports200ResponseReportsInner) GetReportExpiry() string

GetReportExpiry returns the ReportExpiry field value if set, zero value otherwise.

func (*GetReports200ResponseReportsInner) GetReportExpiryOk 

func (o *GetReports200ResponseReportsInner) GetReportExpiryOk() (*string, bool)

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

func (*GetReports200ResponseReportsInner) GetReportId 

func (o *GetReports200ResponseReportsInner) GetReportId() string

GetReportId returns the ReportId field value if set, zero value otherwise.

func (*GetReports200ResponseReportsInner) GetReportIdOk 

func (o *GetReports200ResponseReportsInner) GetReportIdOk() (*string, bool)

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

func (*GetReports200ResponseReportsInner) GetReportStatus 

func (o *GetReports200ResponseReportsInner) GetReportStatus() string

GetReportStatus returns the ReportStatus field value if set, zero value otherwise.

func (*GetReports200ResponseReportsInner) GetReportStatusOk 

func (o *GetReports200ResponseReportsInner) GetReportStatusOk() (*string, bool)

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

func (*GetReports200ResponseReportsInner) GetReportType 

func (o *GetReports200ResponseReportsInner) GetReportType() string

GetReportType returns the ReportType field value if set, zero value otherwise.

func (*GetReports200ResponseReportsInner) GetReportTypeOk 

func (o *GetReports200ResponseReportsInner) GetReportTypeOk() (*string, bool)

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

func (*GetReports200ResponseReportsInner) HasReportExpiry 

func (o *GetReports200ResponseReportsInner) HasReportExpiry() bool

HasReportExpiry returns a boolean if a field has been set.

func (*GetReports200ResponseReportsInner) HasReportId 

func (o *GetReports200ResponseReportsInner) HasReportId() bool

HasReportId returns a boolean if a field has been set.

func (*GetReports200ResponseReportsInner) HasReportStatus 

func (o *GetReports200ResponseReportsInner) HasReportStatus() bool

HasReportStatus returns a boolean if a field has been set.

func (*GetReports200ResponseReportsInner) HasReportType 

func (o *GetReports200ResponseReportsInner) HasReportType() bool

HasReportType returns a boolean if a field has been set.

func (GetReports200ResponseReportsInner) MarshalJSON 

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

func (*GetReports200ResponseReportsInner) SetReportExpiry 

func (o *GetReports200ResponseReportsInner) SetReportExpiry(v string)

SetReportExpiry gets a reference to the given string and assigns it to the ReportExpiry field.

func (*GetReports200ResponseReportsInner) SetReportId 

func (o *GetReports200ResponseReportsInner) SetReportId(v string)

SetReportId gets a reference to the given string and assigns it to the ReportId field.

func (*GetReports200ResponseReportsInner) SetReportStatus 

func (o *GetReports200ResponseReportsInner) SetReportStatus(v string)

SetReportStatus gets a reference to the given string and assigns it to the ReportStatus field.

func (*GetReports200ResponseReportsInner) SetReportType 

func (o *GetReports200ResponseReportsInner) SetReportType(v string)

SetReportType gets a reference to the given string and assigns it to the ReportType field.

func (GetReports200ResponseReportsInner) ToMap 

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

type HealthCheck200Response 

type HealthCheck200Response struct {
	Status *string `json:"status,omitempty"`
}

HealthCheck200Response struct for HealthCheck200Response

func NewHealthCheck200Response 

func NewHealthCheck200Response() *HealthCheck200Response

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

func NewHealthCheck200ResponseWithDefaults 

func NewHealthCheck200ResponseWithDefaults() *HealthCheck200Response

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

func (*HealthCheck200Response) GetStatus 

func (o *HealthCheck200Response) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*HealthCheck200Response) GetStatusOk 

func (o *HealthCheck200Response) GetStatusOk() (*string, bool)

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

func (*HealthCheck200Response) HasStatus 

func (o *HealthCheck200Response) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (HealthCheck200Response) MarshalJSON 

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

func (*HealthCheck200Response) SetStatus 

func (o *HealthCheck200Response) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (HealthCheck200Response) ToMap 

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

type HealthCheckAPIService 

type HealthCheckAPIService service

HealthCheckAPIService HealthCheckAPI service

func (*HealthCheckAPIService) HealthCheck 

func (a *HealthCheckAPIService) HealthCheck(ctx context.Context, authorization string) ApiHealthCheckRequest

HealthCheck health check

Use this endpoint to check the operational status of the messaging service. A 200 OK response means the service is up. If you receive a 504 response, the service is temporarily down. Check the [API Live Status page] (https://dev.telstra.com/api/status) to see if there's an active incident. 

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

func (*HealthCheckAPIService) HealthCheckExecute 

func (a *HealthCheckAPIService) HealthCheckExecute(r ApiHealthCheckRequest) (*HealthCheck200Response, *http.Response, error)

Execute executes the request 

@return HealthCheck200Response

type Log 

type Log struct {
	Timestamp  *time.Time `json:"timestamp,omitempty"`
	Value      *string    `json:"value,omitempty"`
	StatusCode *int32     `json:"statusCode,omitempty"`
}

Log struct for Log

func NewLog 

func NewLog() *Log

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

func NewLogWithDefaults 

func NewLogWithDefaults() *Log

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

func (*Log) GetStatusCode 

func (o *Log) GetStatusCode() int32

GetStatusCode returns the StatusCode field value if set, zero value otherwise.

func (*Log) GetStatusCodeOk 

func (o *Log) GetStatusCodeOk() (*int32, bool)

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

func (*Log) GetTimestamp 

func (o *Log) GetTimestamp() time.Time

GetTimestamp returns the Timestamp field value if set, zero value otherwise.

func (*Log) GetTimestampOk 

func (o *Log) GetTimestampOk() (*time.Time, bool)

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

func (*Log) GetValue 

func (o *Log) GetValue() string

GetValue returns the Value field value if set, zero value otherwise.

func (*Log) GetValueOk 

func (o *Log) GetValueOk() (*string, bool)

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

func (*Log) HasStatusCode 

func (o *Log) HasStatusCode() bool

HasStatusCode returns a boolean if a field has been set.

func (*Log) HasTimestamp 

func (o *Log) HasTimestamp() bool

HasTimestamp returns a boolean if a field has been set.

func (*Log) HasValue 

func (o *Log) HasValue() bool

HasValue returns a boolean if a field has been set.

func (Log) MarshalJSON 

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

func (*Log) SetStatusCode 

func (o *Log) SetStatusCode(v int32)

SetStatusCode gets a reference to the given int32 and assigns it to the StatusCode field.

func (*Log) SetTimestamp 

func (o *Log) SetTimestamp(v time.Time)

SetTimestamp gets a reference to the given time.Time and assigns it to the Timestamp field.

func (*Log) SetValue 

func (o *Log) SetValue(v string)

SetValue gets a reference to the given string and assigns it to the Value field.

func (Log) ToMap 

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

type LogsAPIService 

type LogsAPIService service

LogsAPIService LogsAPI service

func (*LogsAPIService) GetLogs 

func (a *LogsAPIService) GetLogs(ctx context.Context) ApiGetLogsRequest

GetLogs get logs

Fetch a log of events made from your account. Get details of the last 50 calls (default), display results for a specific timeframe, or filter your logs by date or by resource. 

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

func (*LogsAPIService) GetLogsExecute 

func (a *LogsAPIService) GetLogsExecute(r ApiGetLogsRequest) (*GetLogs200Response, *http.Response, error)

Execute executes the request 

@return GetLogs200Response

type MappedNullable 

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

type MessageGet 

type MessageGet struct {
	// Use this UUID with our other endpoints to fetch, update or delete the message.
	MessageId *string `json:"messageId,omitempty"`
	// The status will be either queued, sent, delivered, expired or undeliverable.
	Status *string `json:"status,omitempty"`
	// The time you submitted the message to the queue for sending.
	CreateTimestamp *time.Time `json:"createTimestamp,omitempty"`
	// The time the message was sent from the server.
	SentTimestamp *time.Time `json:"sentTimestamp,omitempty"`
	// The time the message was received by the recipient's device.
	ReceivedTimestamp *time.Time `json:"receivedTimestamp,omitempty"`
	// The recipient's mobile number.
	To *string `json:"to,omitempty"`
	// This will be either one of your Virtual Numbers or your senderName.
	From *string `json:"from,omitempty"`
	// The content of the message.
	MessageContent *string `json:"messageContent,omitempty"`
	// The multimedia content of the message (MMS only). It will include:
	Multimedia []MultimediaGet `json:"multimedia,omitempty"`
	// * **outgoing** – messages sent from your account. * **incoming** – messages sent to your account.
	Direction *string `json:"direction,omitempty"`
	// How many minutes you asked the server to keep trying to send the message.
	RetryTimeout *int32 `json:"retryTimeout,omitempty"`
	// The time the message is scheduled to send.
	ScheduleSend *time.Time `json:"scheduleSend,omitempty"`
	// If set to **true**, you will receive a notification to the statusCallbackUrl when your message is delivered (paid feature).
	DeliveryNotification *bool `json:"deliveryNotification,omitempty"`
	// The URL the API will call when the status of the message changes.
	StatusCallbackUrl *string `json:"statusCallbackUrl,omitempty"`
	// The priority assigned to the message.
	QueuePriority *int32 `json:"queuePriority,omitempty"`
	// Any customisable tags assigned to the message.
	Tags []string `json:"tags,omitempty"`
}

MessageGet struct for MessageGet

func NewMessageGet 

func NewMessageGet() *MessageGet

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

func NewMessageGetWithDefaults 

func NewMessageGetWithDefaults() *MessageGet

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

func (*MessageGet) GetCreateTimestamp 

func (o *MessageGet) GetCreateTimestamp() time.Time

GetCreateTimestamp returns the CreateTimestamp field value if set, zero value otherwise.

func (*MessageGet) GetCreateTimestampOk 

func (o *MessageGet) GetCreateTimestampOk() (*time.Time, bool)

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

func (*MessageGet) GetDeliveryNotification 

func (o *MessageGet) GetDeliveryNotification() bool

GetDeliveryNotification returns the DeliveryNotification field value if set, zero value otherwise.

func (*MessageGet) GetDeliveryNotificationOk 

func (o *MessageGet) GetDeliveryNotificationOk() (*bool, bool)

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

func (*MessageGet) GetDirection 

func (o *MessageGet) GetDirection() string

GetDirection returns the Direction field value if set, zero value otherwise.

func (*MessageGet) GetDirectionOk 

func (o *MessageGet) GetDirectionOk() (*string, bool)

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

func (*MessageGet) GetFrom 

func (o *MessageGet) GetFrom() string

GetFrom returns the From field value if set, zero value otherwise.

func (*MessageGet) GetFromOk 

func (o *MessageGet) GetFromOk() (*string, bool)

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

func (*MessageGet) GetMessageContent 

func (o *MessageGet) GetMessageContent() string

GetMessageContent returns the MessageContent field value if set, zero value otherwise.

func (*MessageGet) GetMessageContentOk 

func (o *MessageGet) GetMessageContentOk() (*string, bool)

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

func (*MessageGet) GetMessageId 

func (o *MessageGet) GetMessageId() string

GetMessageId returns the MessageId field value if set, zero value otherwise.

func (*MessageGet) GetMessageIdOk 

func (o *MessageGet) GetMessageIdOk() (*string, bool)

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

func (*MessageGet) GetMultimedia 

func (o *MessageGet) GetMultimedia() []MultimediaGet

GetMultimedia returns the Multimedia field value if set, zero value otherwise.

func (*MessageGet) GetMultimediaOk 

func (o *MessageGet) GetMultimediaOk() ([]MultimediaGet, bool)

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

func (*MessageGet) GetQueuePriority 

func (o *MessageGet) GetQueuePriority() int32

GetQueuePriority returns the QueuePriority field value if set, zero value otherwise.

func (*MessageGet) GetQueuePriorityOk 

func (o *MessageGet) GetQueuePriorityOk() (*int32, bool)

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

func (*MessageGet) GetReceivedTimestamp 

func (o *MessageGet) GetReceivedTimestamp() time.Time

GetReceivedTimestamp returns the ReceivedTimestamp field value if set, zero value otherwise.

func (*MessageGet) GetReceivedTimestampOk 

func (o *MessageGet) GetReceivedTimestampOk() (*time.Time, bool)

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

func (*MessageGet) GetRetryTimeout 

func (o *MessageGet) GetRetryTimeout() int32

GetRetryTimeout returns the RetryTimeout field value if set, zero value otherwise.

func (*MessageGet) GetRetryTimeoutOk 

func (o *MessageGet) GetRetryTimeoutOk() (*int32, bool)

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

func (*MessageGet) GetScheduleSend 

func (o *MessageGet) GetScheduleSend() time.Time

GetScheduleSend returns the ScheduleSend field value if set, zero value otherwise.

func (*MessageGet) GetScheduleSendOk 

func (o *MessageGet) GetScheduleSendOk() (*time.Time, bool)

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

func (*MessageGet) GetSentTimestamp 

func (o *MessageGet) GetSentTimestamp() time.Time

GetSentTimestamp returns the SentTimestamp field value if set, zero value otherwise.

func (*MessageGet) GetSentTimestampOk 

func (o *MessageGet) GetSentTimestampOk() (*time.Time, bool)

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

func (*MessageGet) GetStatus 

func (o *MessageGet) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*MessageGet) GetStatusCallbackUrl 

func (o *MessageGet) GetStatusCallbackUrl() string

GetStatusCallbackUrl returns the StatusCallbackUrl field value if set, zero value otherwise.

func (*MessageGet) GetStatusCallbackUrlOk 

func (o *MessageGet) GetStatusCallbackUrlOk() (*string, bool)

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

func (*MessageGet) GetStatusOk 

func (o *MessageGet) GetStatusOk() (*string, bool)

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

func (*MessageGet) GetTags 

func (o *MessageGet) GetTags() []string

GetTags returns the Tags field value if set, zero value otherwise.

func (*MessageGet) GetTagsOk 

func (o *MessageGet) GetTagsOk() ([]string, bool)

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

func (*MessageGet) GetTo 

func (o *MessageGet) GetTo() string

GetTo returns the To field value if set, zero value otherwise.

func (*MessageGet) GetToOk 

func (o *MessageGet) GetToOk() (*string, bool)

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

func (*MessageGet) HasCreateTimestamp 

func (o *MessageGet) HasCreateTimestamp() bool

HasCreateTimestamp returns a boolean if a field has been set.

func (*MessageGet) HasDeliveryNotification 

func (o *MessageGet) HasDeliveryNotification() bool

HasDeliveryNotification returns a boolean if a field has been set.

func (*MessageGet) HasDirection 

func (o *MessageGet) HasDirection() bool

HasDirection returns a boolean if a field has been set.

func (*MessageGet) HasFrom 

func (o *MessageGet) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*MessageGet) HasMessageContent 

func (o *MessageGet) HasMessageContent() bool

HasMessageContent returns a boolean if a field has been set.

func (*MessageGet) HasMessageId 

func (o *MessageGet) HasMessageId() bool

HasMessageId returns a boolean if a field has been set.

func (*MessageGet) HasMultimedia 

func (o *MessageGet) HasMultimedia() bool

HasMultimedia returns a boolean if a field has been set.

func (*MessageGet) HasQueuePriority 

func (o *MessageGet) HasQueuePriority() bool

HasQueuePriority returns a boolean if a field has been set.

func (*MessageGet) HasReceivedTimestamp 

func (o *MessageGet) HasReceivedTimestamp() bool

HasReceivedTimestamp returns a boolean if a field has been set.

func (*MessageGet) HasRetryTimeout 

func (o *MessageGet) HasRetryTimeout() bool

HasRetryTimeout returns a boolean if a field has been set.

func (*MessageGet) HasScheduleSend 

func (o *MessageGet) HasScheduleSend() bool

HasScheduleSend returns a boolean if a field has been set.

func (*MessageGet) HasSentTimestamp 

func (o *MessageGet) HasSentTimestamp() bool

HasSentTimestamp returns a boolean if a field has been set.

func (*MessageGet) HasStatus 

func (o *MessageGet) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*MessageGet) HasStatusCallbackUrl 

func (o *MessageGet) HasStatusCallbackUrl() bool

HasStatusCallbackUrl returns a boolean if a field has been set.

func (*MessageGet) HasTags 

func (o *MessageGet) HasTags() bool

HasTags returns a boolean if a field has been set.

func (*MessageGet) HasTo 

func (o *MessageGet) HasTo() bool

HasTo returns a boolean if a field has been set.

func (MessageGet) MarshalJSON 

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

func (*MessageGet) SetCreateTimestamp 

func (o *MessageGet) SetCreateTimestamp(v time.Time)

SetCreateTimestamp gets a reference to the given time.Time and assigns it to the CreateTimestamp field.

func (*MessageGet) SetDeliveryNotification 

func (o *MessageGet) SetDeliveryNotification(v bool)

SetDeliveryNotification gets a reference to the given bool and assigns it to the DeliveryNotification field.

func (*MessageGet) SetDirection 

func (o *MessageGet) SetDirection(v string)

SetDirection gets a reference to the given string and assigns it to the Direction field.

func (*MessageGet) SetFrom 

func (o *MessageGet) SetFrom(v string)

SetFrom gets a reference to the given string and assigns it to the From field.

func (*MessageGet) SetMessageContent 

func (o *MessageGet) SetMessageContent(v string)

SetMessageContent gets a reference to the given string and assigns it to the MessageContent field.

func (*MessageGet) SetMessageId 

func (o *MessageGet) SetMessageId(v string)

SetMessageId gets a reference to the given string and assigns it to the MessageId field.

func (*MessageGet) SetMultimedia 

func (o *MessageGet) SetMultimedia(v []MultimediaGet)

SetMultimedia gets a reference to the given []MultimediaGet and assigns it to the Multimedia field.

func (*MessageGet) SetQueuePriority 

func (o *MessageGet) SetQueuePriority(v int32)

SetQueuePriority gets a reference to the given int32 and assigns it to the QueuePriority field.

func (*MessageGet) SetReceivedTimestamp 

func (o *MessageGet) SetReceivedTimestamp(v time.Time)

SetReceivedTimestamp gets a reference to the given time.Time and assigns it to the ReceivedTimestamp field.

func (*MessageGet) SetRetryTimeout 

func (o *MessageGet) SetRetryTimeout(v int32)

SetRetryTimeout gets a reference to the given int32 and assigns it to the RetryTimeout field.

func (*MessageGet) SetScheduleSend 

func (o *MessageGet) SetScheduleSend(v time.Time)

SetScheduleSend gets a reference to the given time.Time and assigns it to the ScheduleSend field.

func (*MessageGet) SetSentTimestamp 

func (o *MessageGet) SetSentTimestamp(v time.Time)

SetSentTimestamp gets a reference to the given time.Time and assigns it to the SentTimestamp field.

func (*MessageGet) SetStatus 

func (o *MessageGet) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*MessageGet) SetStatusCallbackUrl 

func (o *MessageGet) SetStatusCallbackUrl(v string)

SetStatusCallbackUrl gets a reference to the given string and assigns it to the StatusCallbackUrl field.

func (*MessageGet) SetTags 

func (o *MessageGet) SetTags(v []string)

SetTags gets a reference to the given []string and assigns it to the Tags field.

func (*MessageGet) SetTo 

func (o *MessageGet) SetTo(v string)

SetTo gets a reference to the given string and assigns it to the To field.

func (MessageGet) ToMap 

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

type MessageSent 

type MessageSent struct {
	MessageId *MessageSentMessageId `json:"messageId,omitempty"`
	// The status will be either queued, sent, delivered, expired or undeliverable.
	Status *string        `json:"status,omitempty"`
	To     *MessageSentTo `json:"to,omitempty"`
	// This will be either one of your Virtual Numbers or your senderName.
	From *string `json:"from,omitempty"`
	// The content of the message.
	MessageContent *string `json:"messageContent,omitempty"`
	// The multimedia content of the message (MMS only). It will include:
	Multimedia []MultimediaGet `json:"multimedia,omitempty"`
	// How many minutes you asked the server to keep trying to send the message.
	RetryTimeout *int32 `json:"retryTimeout,omitempty"`
	// The time (in Central Standard Time) the message is scheduled to send.
	ScheduleSend *time.Time `json:"scheduleSend,omitempty"`
	// If set to **true**, you will receive a notification to the statusCallbackUrl when your SMS is delivered (paid feature).
	DeliveryNotification *bool `json:"deliveryNotification,omitempty"`
	// The URL the API will call when the status of the message changes.
	StatusCallbackUrl *string `json:"statusCallbackUrl,omitempty"`
	// Any customisable tags assigned to the message.
	Tags []string `json:"tags,omitempty"`
}

MessageSent struct for MessageSent

func NewMessageSent 

func NewMessageSent() *MessageSent

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

func NewMessageSentWithDefaults 

func NewMessageSentWithDefaults() *MessageSent

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

func (*MessageSent) GetDeliveryNotification 

func (o *MessageSent) GetDeliveryNotification() bool

GetDeliveryNotification returns the DeliveryNotification field value if set, zero value otherwise.

func (*MessageSent) GetDeliveryNotificationOk 

func (o *MessageSent) GetDeliveryNotificationOk() (*bool, bool)

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

func (*MessageSent) GetFrom 

func (o *MessageSent) GetFrom() string

GetFrom returns the From field value if set, zero value otherwise.

func (*MessageSent) GetFromOk 

func (o *MessageSent) GetFromOk() (*string, bool)

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

func (*MessageSent) GetMessageContent 

func (o *MessageSent) GetMessageContent() string

GetMessageContent returns the MessageContent field value if set, zero value otherwise.

func (*MessageSent) GetMessageContentOk 

func (o *MessageSent) GetMessageContentOk() (*string, bool)

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

func (*MessageSent) GetMessageId 

func (o *MessageSent) GetMessageId() MessageSentMessageId

GetMessageId returns the MessageId field value if set, zero value otherwise.

func (*MessageSent) GetMessageIdOk 

func (o *MessageSent) GetMessageIdOk() (*MessageSentMessageId, bool)

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

func (*MessageSent) GetMultimedia 

func (o *MessageSent) GetMultimedia() []MultimediaGet

GetMultimedia returns the Multimedia field value if set, zero value otherwise.

func (*MessageSent) GetMultimediaOk 

func (o *MessageSent) GetMultimediaOk() ([]MultimediaGet, bool)

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

func (*MessageSent) GetRetryTimeout 

func (o *MessageSent) GetRetryTimeout() int32

GetRetryTimeout returns the RetryTimeout field value if set, zero value otherwise.

func (*MessageSent) GetRetryTimeoutOk 

func (o *MessageSent) GetRetryTimeoutOk() (*int32, bool)

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

func (*MessageSent) GetScheduleSend 

func (o *MessageSent) GetScheduleSend() time.Time

GetScheduleSend returns the ScheduleSend field value if set, zero value otherwise.

func (*MessageSent) GetScheduleSendOk 

func (o *MessageSent) GetScheduleSendOk() (*time.Time, bool)

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

func (*MessageSent) GetStatus 

func (o *MessageSent) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*MessageSent) GetStatusCallbackUrl 

func (o *MessageSent) GetStatusCallbackUrl() string

GetStatusCallbackUrl returns the StatusCallbackUrl field value if set, zero value otherwise.

func (*MessageSent) GetStatusCallbackUrlOk 

func (o *MessageSent) GetStatusCallbackUrlOk() (*string, bool)

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

func (*MessageSent) GetStatusOk 

func (o *MessageSent) GetStatusOk() (*string, bool)

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

func (*MessageSent) GetTags 

func (o *MessageSent) GetTags() []string

GetTags returns the Tags field value if set, zero value otherwise.

func (*MessageSent) GetTagsOk 

func (o *MessageSent) GetTagsOk() ([]string, bool)

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

func (*MessageSent) GetTo 

func (o *MessageSent) GetTo() MessageSentTo

GetTo returns the To field value if set, zero value otherwise.

func (*MessageSent) GetToOk 

func (o *MessageSent) GetToOk() (*MessageSentTo, bool)

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

func (*MessageSent) HasDeliveryNotification 

func (o *MessageSent) HasDeliveryNotification() bool

HasDeliveryNotification returns a boolean if a field has been set.

func (*MessageSent) HasFrom 

func (o *MessageSent) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*MessageSent) HasMessageContent 

func (o *MessageSent) HasMessageContent() bool

HasMessageContent returns a boolean if a field has been set.

func (*MessageSent) HasMessageId 

func (o *MessageSent) HasMessageId() bool

HasMessageId returns a boolean if a field has been set.

func (*MessageSent) HasMultimedia 

func (o *MessageSent) HasMultimedia() bool

HasMultimedia returns a boolean if a field has been set.

func (*MessageSent) HasRetryTimeout 

func (o *MessageSent) HasRetryTimeout() bool

HasRetryTimeout returns a boolean if a field has been set.

func (*MessageSent) HasScheduleSend 

func (o *MessageSent) HasScheduleSend() bool

HasScheduleSend returns a boolean if a field has been set.

func (*MessageSent) HasStatus 

func (o *MessageSent) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*MessageSent) HasStatusCallbackUrl 

func (o *MessageSent) HasStatusCallbackUrl() bool

HasStatusCallbackUrl returns a boolean if a field has been set.

func (*MessageSent) HasTags 

func (o *MessageSent) HasTags() bool

HasTags returns a boolean if a field has been set.

func (*MessageSent) HasTo 

func (o *MessageSent) HasTo() bool

HasTo returns a boolean if a field has been set.

func (MessageSent) MarshalJSON 

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

func (*MessageSent) SetDeliveryNotification 

func (o *MessageSent) SetDeliveryNotification(v bool)

SetDeliveryNotification gets a reference to the given bool and assigns it to the DeliveryNotification field.

func (*MessageSent) SetFrom 

func (o *MessageSent) SetFrom(v string)

SetFrom gets a reference to the given string and assigns it to the From field.

func (*MessageSent) SetMessageContent 

func (o *MessageSent) SetMessageContent(v string)

SetMessageContent gets a reference to the given string and assigns it to the MessageContent field.

func (*MessageSent) SetMessageId 

func (o *MessageSent) SetMessageId(v MessageSentMessageId)

SetMessageId gets a reference to the given MessageSentMessageId and assigns it to the MessageId field.

func (*MessageSent) SetMultimedia 

func (o *MessageSent) SetMultimedia(v []MultimediaGet)

SetMultimedia gets a reference to the given []MultimediaGet and assigns it to the Multimedia field.

func (*MessageSent) SetRetryTimeout 

func (o *MessageSent) SetRetryTimeout(v int32)

SetRetryTimeout gets a reference to the given int32 and assigns it to the RetryTimeout field.

func (*MessageSent) SetScheduleSend 

func (o *MessageSent) SetScheduleSend(v time.Time)

SetScheduleSend gets a reference to the given time.Time and assigns it to the ScheduleSend field.

func (*MessageSent) SetStatus 

func (o *MessageSent) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*MessageSent) SetStatusCallbackUrl 

func (o *MessageSent) SetStatusCallbackUrl(v string)

SetStatusCallbackUrl gets a reference to the given string and assigns it to the StatusCallbackUrl field.

func (*MessageSent) SetTags 

func (o *MessageSent) SetTags(v []string)

SetTags gets a reference to the given []string and assigns it to the Tags field.

func (*MessageSent) SetTo 

func (o *MessageSent) SetTo(v MessageSentTo)

SetTo gets a reference to the given MessageSentTo and assigns it to the To field.

func (MessageSent) ToMap 

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

type MessageSentMessageId 

type MessageSentMessageId struct {
	ArrayOfString *[]string
	String        *string
}

MessageSentMessageId - Use this UUID with our other endpoints to fetch, update or delete the message.

func ArrayOfStringAsMessageSentMessageId 

func ArrayOfStringAsMessageSentMessageId(v *[]string) MessageSentMessageId

[]stringAsMessageSentMessageId is a convenience function that returns []string wrapped in MessageSentMessageId

func StringAsMessageSentMessageId 

func StringAsMessageSentMessageId(v *string) MessageSentMessageId

stringAsMessageSentMessageId is a convenience function that returns string wrapped in MessageSentMessageId

func (*MessageSentMessageId) GetActualInstance 

func (obj *MessageSentMessageId) GetActualInstance() interface{}

Get the actual instance

func (MessageSentMessageId) MarshalJSON 

func (src MessageSentMessageId) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*MessageSentMessageId) UnmarshalJSON 

func (dst *MessageSentMessageId) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct

type MessageSentTo 

type MessageSentTo struct {
	ArrayOfString *[]string
	String        *string
}

MessageSentTo - The recipient's mobile number(s).

func ArrayOfStringAsMessageSentTo 

func ArrayOfStringAsMessageSentTo(v *[]string) MessageSentTo

[]stringAsMessageSentTo is a convenience function that returns []string wrapped in MessageSentTo

func StringAsMessageSentTo 

func StringAsMessageSentTo(v *string) MessageSentTo

stringAsMessageSentTo is a convenience function that returns string wrapped in MessageSentTo

func (*MessageSentTo) GetActualInstance 

func (obj *MessageSentTo) GetActualInstance() interface{}

Get the actual instance

func (MessageSentTo) MarshalJSON 

func (src MessageSentTo) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*MessageSentTo) UnmarshalJSON 

func (dst *MessageSentTo) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct

type MessageUpdate 

type MessageUpdate struct {
	// Use this UUID with our other endpoints to fetch, update or delete the message.
	MessageId *string `json:"messageId,omitempty"`
	// The status will be either queued, sent, delivered, expired or undeliverable.
	Status *string `json:"status,omitempty"`
	// The recipient's mobile number.
	To *string `json:"to,omitempty"`
	// This will be either one of your Virtual Numbers or your senderName.
	From *string `json:"from,omitempty"`
	// The content of the message.
	MessageContent *string `json:"messageContent,omitempty"`
	// The multimedia content of the message (MMS only). It will include:
	Multimedia []MultimediaGet `json:"multimedia,omitempty"`
	// How many minutes you asked the server to keep trying to send the message.
	RetryTimeout *int32 `json:"retryTimeout,omitempty"`
	// The time the message is scheduled to send.
	ScheduleSend *time.Time `json:"scheduleSend,omitempty"`
	// If set to **true**, you will receive a notification to the statusCallbackUrl when your message is delivered (paid feature).
	DeliveryNotification *bool `json:"deliveryNotification,omitempty"`
	// The URL the API will call when the status of the message changes.
	StatusCallbackUrl *string `json:"statusCallbackUrl,omitempty"`
	// The priority assigned to the message.
	QueuePriority *int32 `json:"queuePriority,omitempty"`
	// Any customisable tags assigned to the message.
	Tags []string `json:"tags,omitempty"`
}

MessageUpdate struct for MessageUpdate

func NewMessageUpdate 

func NewMessageUpdate() *MessageUpdate

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

func NewMessageUpdateWithDefaults 

func NewMessageUpdateWithDefaults() *MessageUpdate

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

func (*MessageUpdate) GetDeliveryNotification 

func (o *MessageUpdate) GetDeliveryNotification() bool

GetDeliveryNotification returns the DeliveryNotification field value if set, zero value otherwise.

func (*MessageUpdate) GetDeliveryNotificationOk 

func (o *MessageUpdate) GetDeliveryNotificationOk() (*bool, bool)

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

func (*MessageUpdate) GetFrom 

func (o *MessageUpdate) GetFrom() string

GetFrom returns the From field value if set, zero value otherwise.

func (*MessageUpdate) GetFromOk 

func (o *MessageUpdate) GetFromOk() (*string, bool)

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

func (*MessageUpdate) GetMessageContent 

func (o *MessageUpdate) GetMessageContent() string

GetMessageContent returns the MessageContent field value if set, zero value otherwise.

func (*MessageUpdate) GetMessageContentOk 

func (o *MessageUpdate) GetMessageContentOk() (*string, bool)

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

func (*MessageUpdate) GetMessageId 

func (o *MessageUpdate) GetMessageId() string

GetMessageId returns the MessageId field value if set, zero value otherwise.

func (*MessageUpdate) GetMessageIdOk 

func (o *MessageUpdate) GetMessageIdOk() (*string, bool)

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

func (*MessageUpdate) GetMultimedia 

func (o *MessageUpdate) GetMultimedia() []MultimediaGet

GetMultimedia returns the Multimedia field value if set, zero value otherwise.

func (*MessageUpdate) GetMultimediaOk 

func (o *MessageUpdate) GetMultimediaOk() ([]MultimediaGet, bool)

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

func (*MessageUpdate) GetQueuePriority 

func (o *MessageUpdate) GetQueuePriority() int32

GetQueuePriority returns the QueuePriority field value if set, zero value otherwise.

func (*MessageUpdate) GetQueuePriorityOk 

func (o *MessageUpdate) GetQueuePriorityOk() (*int32, bool)

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

func (*MessageUpdate) GetRetryTimeout 

func (o *MessageUpdate) GetRetryTimeout() int32

GetRetryTimeout returns the RetryTimeout field value if set, zero value otherwise.

func (*MessageUpdate) GetRetryTimeoutOk 

func (o *MessageUpdate) GetRetryTimeoutOk() (*int32, bool)

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

func (*MessageUpdate) GetScheduleSend 

func (o *MessageUpdate) GetScheduleSend() time.Time

GetScheduleSend returns the ScheduleSend field value if set, zero value otherwise.

func (*MessageUpdate) GetScheduleSendOk 

func (o *MessageUpdate) GetScheduleSendOk() (*time.Time, bool)

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

func (*MessageUpdate) GetStatus 

func (o *MessageUpdate) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*MessageUpdate) GetStatusCallbackUrl 

func (o *MessageUpdate) GetStatusCallbackUrl() string

GetStatusCallbackUrl returns the StatusCallbackUrl field value if set, zero value otherwise.

func (*MessageUpdate) GetStatusCallbackUrlOk 

func (o *MessageUpdate) GetStatusCallbackUrlOk() (*string, bool)

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

func (*MessageUpdate) GetStatusOk 

func (o *MessageUpdate) GetStatusOk() (*string, bool)

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

func (*MessageUpdate) GetTags 

func (o *MessageUpdate) GetTags() []string

GetTags returns the Tags field value if set, zero value otherwise.

func (*MessageUpdate) GetTagsOk 

func (o *MessageUpdate) GetTagsOk() ([]string, bool)

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

func (*MessageUpdate) GetTo 

func (o *MessageUpdate) GetTo() string

GetTo returns the To field value if set, zero value otherwise.

func (*MessageUpdate) GetToOk 

func (o *MessageUpdate) GetToOk() (*string, bool)

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

func (*MessageUpdate) HasDeliveryNotification 

func (o *MessageUpdate) HasDeliveryNotification() bool

HasDeliveryNotification returns a boolean if a field has been set.

func (*MessageUpdate) HasFrom 

func (o *MessageUpdate) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*MessageUpdate) HasMessageContent 

func (o *MessageUpdate) HasMessageContent() bool

HasMessageContent returns a boolean if a field has been set.

func (*MessageUpdate) HasMessageId 

func (o *MessageUpdate) HasMessageId() bool

HasMessageId returns a boolean if a field has been set.

func (*MessageUpdate) HasMultimedia 

func (o *MessageUpdate) HasMultimedia() bool

HasMultimedia returns a boolean if a field has been set.

func (*MessageUpdate) HasQueuePriority 

func (o *MessageUpdate) HasQueuePriority() bool

HasQueuePriority returns a boolean if a field has been set.

func (*MessageUpdate) HasRetryTimeout 

func (o *MessageUpdate) HasRetryTimeout() bool

HasRetryTimeout returns a boolean if a field has been set.

func (*MessageUpdate) HasScheduleSend 

func (o *MessageUpdate) HasScheduleSend() bool

HasScheduleSend returns a boolean if a field has been set.

func (*MessageUpdate) HasStatus 

func (o *MessageUpdate) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*MessageUpdate) HasStatusCallbackUrl 

func (o *MessageUpdate) HasStatusCallbackUrl() bool

HasStatusCallbackUrl returns a boolean if a field has been set.

func (*MessageUpdate) HasTags 

func (o *MessageUpdate) HasTags() bool

HasTags returns a boolean if a field has been set.

func (*MessageUpdate) HasTo 

func (o *MessageUpdate) HasTo() bool

HasTo returns a boolean if a field has been set.

func (MessageUpdate) MarshalJSON 

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

func (*MessageUpdate) SetDeliveryNotification 

func (o *MessageUpdate) SetDeliveryNotification(v bool)

SetDeliveryNotification gets a reference to the given bool and assigns it to the DeliveryNotification field.

func (*MessageUpdate) SetFrom 

func (o *MessageUpdate) SetFrom(v string)

SetFrom gets a reference to the given string and assigns it to the From field.

func (*MessageUpdate) SetMessageContent 

func (o *MessageUpdate) SetMessageContent(v string)

SetMessageContent gets a reference to the given string and assigns it to the MessageContent field.

func (*MessageUpdate) SetMessageId 

func (o *MessageUpdate) SetMessageId(v string)

SetMessageId gets a reference to the given string and assigns it to the MessageId field.

func (*MessageUpdate) SetMultimedia 

func (o *MessageUpdate) SetMultimedia(v []MultimediaGet)

SetMultimedia gets a reference to the given []MultimediaGet and assigns it to the Multimedia field.

func (*MessageUpdate) SetQueuePriority 

func (o *MessageUpdate) SetQueuePriority(v int32)

SetQueuePriority gets a reference to the given int32 and assigns it to the QueuePriority field.

func (*MessageUpdate) SetRetryTimeout 

func (o *MessageUpdate) SetRetryTimeout(v int32)

SetRetryTimeout gets a reference to the given int32 and assigns it to the RetryTimeout field.

func (*MessageUpdate) SetScheduleSend 

func (o *MessageUpdate) SetScheduleSend(v time.Time)

SetScheduleSend gets a reference to the given time.Time and assigns it to the ScheduleSend field.

func (*MessageUpdate) SetStatus 

func (o *MessageUpdate) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*MessageUpdate) SetStatusCallbackUrl 

func (o *MessageUpdate) SetStatusCallbackUrl(v string)

SetStatusCallbackUrl gets a reference to the given string and assigns it to the StatusCallbackUrl field.

func (*MessageUpdate) SetTags 

func (o *MessageUpdate) SetTags(v []string)

SetTags gets a reference to the given []string and assigns it to the Tags field.

func (*MessageUpdate) SetTo 

func (o *MessageUpdate) SetTo(v string)

SetTo gets a reference to the given string and assigns it to the To field.

func (MessageUpdate) ToMap 

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

type MessagesAPIService 

type MessagesAPIService service

MessagesAPIService MessagesAPI service

func (*MessagesAPIService) DeleteMessageById 

func (a *MessagesAPIService) DeleteMessageById(ctx context.Context, messageId string, authorization string) ApiDeleteMessageByIdRequest

DeleteMessageById delete a message

Use this endpoint to delete a message that's been scheduled for sending, but hasn't yet sent. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param messageId When you sent the original message, this is the UUID that was returned in the call response. Use this ID to fetch, update or delete a message with the appropriate endpoints.
@return ApiDeleteMessageByIdRequest

func (*MessagesAPIService) DeleteMessageByIdExecute 

func (a *MessagesAPIService) DeleteMessageByIdExecute(r ApiDeleteMessageByIdRequest) (*http.Response, error)

Execute executes the request

func (*MessagesAPIService) GetMessageById 

func (a *MessagesAPIService) GetMessageById(ctx context.Context, messageId string, authorization string) ApiGetMessageByIdRequest

GetMessageById fetch a specific message

Use the **messageId** to fetch a message that's been sent from/to your account within the last 30 days. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param messageId When you sent the original message, this is the UUID that was returned in the response. Use this ID to fetch, update or delete a message with the appropriate endpoints.   Incoming messages are also assigned a messageId. Use this ID with GET/ messages/{messageId} to fetch the message later.
@return ApiGetMessageByIdRequest

func (*MessagesAPIService) GetMessageByIdExecute 

func (a *MessagesAPIService) GetMessageByIdExecute(r ApiGetMessageByIdRequest) (*MessageGet, *http.Response, error)

Execute executes the request 

@return MessageGet

func (*MessagesAPIService) GetMessages 

func (a *MessagesAPIService) GetMessages(ctx context.Context, authorization string) ApiGetMessagesRequest

GetMessages fetch all sent/received messages

Fetch messages that have been sent from/to your account in the last 30 days. 

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

func (*MessagesAPIService) GetMessagesExecute 

func (a *MessagesAPIService) GetMessagesExecute(r ApiGetMessagesRequest) (*GetMessages200Response, *http.Response, error)

Execute executes the request 

@return GetMessages200Response

func (*MessagesAPIService) SendMessages 

func (a *MessagesAPIService) SendMessages(ctx context.Context, authorization string) ApiSendMessagesRequest

SendMessages send messages

Send an SMS/MMS to a mobile number, or to multiple mobile numbers.

Free Trial users can message to up to 10 unique recipient numbers for free. The first five recipients will be automatically added to your Free Trial Numbers list. Need more? Just use the POST /free-trial-numbers call to add another five. 

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

func (*MessagesAPIService) SendMessagesExecute 

func (a *MessagesAPIService) SendMessagesExecute(r ApiSendMessagesRequest) (*MessageSent, *http.Response, error)

Execute executes the request 

@return MessageSent

func (*MessagesAPIService) UpdateMessageById 

func (a *MessagesAPIService) UpdateMessageById(ctx context.Context, messageId string, authorization string) ApiUpdateMessageByIdRequest

UpdateMessageById update a message

Need to update a message that's scheduled for sending? You can change any of the below parameters, as long as the message hasn't been sent yet. This request body will override the original POST/ messages call. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param messageId When you sent the original message, this is the UUID that was returned in the call response. Use this ID to fetch, update or delete a message with the appropriate endpoints.
@return ApiUpdateMessageByIdRequest

func (*MessagesAPIService) UpdateMessageByIdExecute 

func (a *MessagesAPIService) UpdateMessageByIdExecute(r ApiUpdateMessageByIdRequest) (*MessageUpdate, *http.Response, error)

Execute executes the request 

@return MessageUpdate

func (*MessagesAPIService) UpdateMessageTags 

func (a *MessagesAPIService) UpdateMessageTags(ctx context.Context, messageId string, authorization string) ApiUpdateMessageTagsRequest

UpdateMessageTags update message tags

Use the **messageId** to update the tag(s) assigned to a message. You can use this endpoint any time, even after your message has been delivered. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param messageId When you sent the original message, this is the UUID that was returned in the call response. Use this ID to fetch, update or delete a message with the appropriate endpoints.
@return ApiUpdateMessageTagsRequest

func (*MessagesAPIService) UpdateMessageTagsExecute 

func (a *MessagesAPIService) UpdateMessageTagsExecute(r ApiUpdateMessageTagsRequest) (*http.Response, error)

Execute executes the request

type MessagesReport201Response 

type MessagesReport201Response struct {
	// When your report is ready for download, you can use this UUID to fetch it with the GET /reports/{reportId} endpoint.
	ReportId *string `json:"reportId,omitempty"`
	// If you provided a reportCallbackUrl in your request, it will be returned here.
	ReportCallbackUrl *string `json:"reportCallbackUrl,omitempty"`
	// The status of the report. It will be either:        * **queued** – the report is in the queue for generation.        * **completed** – the report is ready for download.        * **failed** – the report failed to generate. Please try again.
	ReportStatus *string `json:"reportStatus,omitempty"`
}

MessagesReport201Response struct for MessagesReport201Response

func NewMessagesReport201Response 

func NewMessagesReport201Response() *MessagesReport201Response

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

func NewMessagesReport201ResponseWithDefaults 

func NewMessagesReport201ResponseWithDefaults() *MessagesReport201Response

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

func (*MessagesReport201Response) GetReportCallbackUrl 

func (o *MessagesReport201Response) GetReportCallbackUrl() string

GetReportCallbackUrl returns the ReportCallbackUrl field value if set, zero value otherwise.

func (*MessagesReport201Response) GetReportCallbackUrlOk 

func (o *MessagesReport201Response) GetReportCallbackUrlOk() (*string, bool)

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

func (*MessagesReport201Response) GetReportId 

func (o *MessagesReport201Response) GetReportId() string

GetReportId returns the ReportId field value if set, zero value otherwise.

func (*MessagesReport201Response) GetReportIdOk 

func (o *MessagesReport201Response) GetReportIdOk() (*string, bool)

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

func (*MessagesReport201Response) GetReportStatus 

func (o *MessagesReport201Response) GetReportStatus() string

GetReportStatus returns the ReportStatus field value if set, zero value otherwise.

func (*MessagesReport201Response) GetReportStatusOk 

func (o *MessagesReport201Response) GetReportStatusOk() (*string, bool)

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

func (*MessagesReport201Response) HasReportCallbackUrl 

func (o *MessagesReport201Response) HasReportCallbackUrl() bool

HasReportCallbackUrl returns a boolean if a field has been set.

func (*MessagesReport201Response) HasReportId 

func (o *MessagesReport201Response) HasReportId() bool

HasReportId returns a boolean if a field has been set.

func (*MessagesReport201Response) HasReportStatus 

func (o *MessagesReport201Response) HasReportStatus() bool

HasReportStatus returns a boolean if a field has been set.

func (MessagesReport201Response) MarshalJSON 

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

func (*MessagesReport201Response) SetReportCallbackUrl 

func (o *MessagesReport201Response) SetReportCallbackUrl(v string)

SetReportCallbackUrl gets a reference to the given string and assigns it to the ReportCallbackUrl field.

func (*MessagesReport201Response) SetReportId 

func (o *MessagesReport201Response) SetReportId(v string)

SetReportId gets a reference to the given string and assigns it to the ReportId field.

func (*MessagesReport201Response) SetReportStatus 

func (o *MessagesReport201Response) SetReportStatus(v string)

SetReportStatus gets a reference to the given string and assigns it to the ReportStatus field.

func (MessagesReport201Response) ToMap 

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

type MessagesReportRequest 

type MessagesReportRequest struct {
	// Set the time period you want to generate a report for by typing the start date (inclusive) here.  Note that we only retain data for three months, so please ensure your startDate is not more than three months old.  Use ISO format(yyyy-mm-dd), e.g. 2019-08-24.
	StartDate string `json:"startDate"`
	// Type the end date (inclusive) of your reporting period here.  Your endDate must be a date in the past, and less than three months from your startDate. Use ISO format(yyyy-mm-dd).
	EndDate string `json:"endDate"`
	// Tell us the callbackUrl you want us to notify when your report is ready for download.  Sample callback response:  <pre><code class=\"language-sh\">{   \"reportId\":\"1520b774-46b0-4415-a05f-7bcb1c032c59\",   \"reportStatus\":\"completed\",   \"timestamp\":\"2022-11-10T05:06:42.823Z\" }</code></pre>
	ReportCallbackUrl *string `json:"reportCallbackUrl,omitempty"`
	// Filter your messages report by:   * tag - use one of the tags assigned to your message(s)   * number - either the Virtual Number used to send the message, or the Recipient Number the message was sent to.
	Filter *string `json:"filter,omitempty"`
}

MessagesReportRequest struct for MessagesReportRequest

func NewMessagesReportRequest 

func NewMessagesReportRequest(startDate string, endDate string) *MessagesReportRequest

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

func NewMessagesReportRequestWithDefaults 

func NewMessagesReportRequestWithDefaults() *MessagesReportRequest

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

func (*MessagesReportRequest) GetEndDate 

func (o *MessagesReportRequest) GetEndDate() string

GetEndDate returns the EndDate field value

func (*MessagesReportRequest) GetEndDateOk 

func (o *MessagesReportRequest) GetEndDateOk() (*string, bool)

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

func (*MessagesReportRequest) GetFilter 

func (o *MessagesReportRequest) GetFilter() string

GetFilter returns the Filter field value if set, zero value otherwise.

func (*MessagesReportRequest) GetFilterOk 

func (o *MessagesReportRequest) GetFilterOk() (*string, bool)

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

func (*MessagesReportRequest) GetReportCallbackUrl 

func (o *MessagesReportRequest) GetReportCallbackUrl() string

GetReportCallbackUrl returns the ReportCallbackUrl field value if set, zero value otherwise.

func (*MessagesReportRequest) GetReportCallbackUrlOk 

func (o *MessagesReportRequest) GetReportCallbackUrlOk() (*string, bool)

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

func (*MessagesReportRequest) GetStartDate 

func (o *MessagesReportRequest) GetStartDate() string

GetStartDate returns the StartDate field value

func (*MessagesReportRequest) GetStartDateOk 

func (o *MessagesReportRequest) GetStartDateOk() (*string, bool)

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

func (*MessagesReportRequest) HasFilter 

func (o *MessagesReportRequest) HasFilter() bool

HasFilter returns a boolean if a field has been set.

func (*MessagesReportRequest) HasReportCallbackUrl 

func (o *MessagesReportRequest) HasReportCallbackUrl() bool

HasReportCallbackUrl returns a boolean if a field has been set.

func (MessagesReportRequest) MarshalJSON 

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

func (*MessagesReportRequest) SetEndDate 

func (o *MessagesReportRequest) SetEndDate(v string)

SetEndDate sets field value

func (*MessagesReportRequest) SetFilter 

func (o *MessagesReportRequest) SetFilter(v string)

SetFilter gets a reference to the given string and assigns it to the Filter field.

func (*MessagesReportRequest) SetReportCallbackUrl 

func (o *MessagesReportRequest) SetReportCallbackUrl(v string)

SetReportCallbackUrl gets a reference to the given string and assigns it to the ReportCallbackUrl field.

func (*MessagesReportRequest) SetStartDate 

func (o *MessagesReportRequest) SetStartDate(v string)

SetStartDate sets field value

func (MessagesReportRequest) ToMap 

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

type Multimedia 

type Multimedia struct {
	// the type of multimedia content file you're sending (image, audio or video) followed by the file type. Use the format \"multimedia type/file type\", e.g. \"image/PNG\" or \"audio/MP3\". Supported file types:JPEG, BMP, GIF87a, GIF89a, PNG, MP3, WAV, MPEG, MPG, MP4, 3GP and US-ASCII.
	Type string `json:"type"`
	// The name of the multimedia file.
	FileName string `json:"fileName"`
	// The base64 encoded content. You can use [this online tool](https://elmah.io/tools/base64-image-encoder/) to encode an image, or [Base64 Guru](https://base64.guru/) to encode a video or audio file.
	Payload string `json:"payload"`
}

Multimedia struct for Multimedia

func NewMultimedia 

func NewMultimedia(type_ string, fileName string, payload string) *Multimedia

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

func NewMultimediaWithDefaults 

func NewMultimediaWithDefaults() *Multimedia

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

func (*Multimedia) GetFileName 

func (o *Multimedia) GetFileName() string

GetFileName returns the FileName field value

func (*Multimedia) GetFileNameOk 

func (o *Multimedia) GetFileNameOk() (*string, bool)

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

func (*Multimedia) GetPayload 

func (o *Multimedia) GetPayload() string

GetPayload returns the Payload field value

func (*Multimedia) GetPayloadOk 

func (o *Multimedia) GetPayloadOk() (*string, bool)

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

func (*Multimedia) GetType 

func (o *Multimedia) GetType() string

GetType returns the Type field value

func (*Multimedia) GetTypeOk 

func (o *Multimedia) GetTypeOk() (*string, bool)

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

func (Multimedia) MarshalJSON 

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

func (*Multimedia) SetFileName 

func (o *Multimedia) SetFileName(v string)

SetFileName sets field value

func (*Multimedia) SetPayload 

func (o *Multimedia) SetPayload(v string)

SetPayload sets field value

func (*Multimedia) SetType 

func (o *Multimedia) SetType(v string)

SetType sets field value

func (Multimedia) ToMap 

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

type MultimediaGet 

type MultimediaGet struct {
	// The type of multimedia content (image, audio or video) followed by the type (e.g. jpeg, png, text).
	Type string `json:"type"`
	// The name of the multimedia file.
	FileName string `json:"fileName"`
}

MultimediaGet struct for MultimediaGet

func NewMultimediaGet 

func NewMultimediaGet(type_ string, fileName string) *MultimediaGet

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

func NewMultimediaGetWithDefaults 

func NewMultimediaGetWithDefaults() *MultimediaGet

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

func (*MultimediaGet) GetFileName 

func (o *MultimediaGet) GetFileName() string

GetFileName returns the FileName field value

func (*MultimediaGet) GetFileNameOk 

func (o *MultimediaGet) GetFileNameOk() (*string, bool)

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

func (*MultimediaGet) GetType 

func (o *MultimediaGet) GetType() string

GetType returns the Type field value

func (*MultimediaGet) GetTypeOk 

func (o *MultimediaGet) GetTypeOk() (*string, bool)

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

func (MultimediaGet) MarshalJSON 

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

func (*MultimediaGet) SetFileName 

func (o *MultimediaGet) SetFileName(v string)

SetFileName sets field value

func (*MultimediaGet) SetType 

func (o *MultimediaGet) SetType(v string)

SetType sets field value

func (MultimediaGet) ToMap 

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

type NullableAssignNumberRequest 

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

func NewNullableAssignNumberRequest 

func NewNullableAssignNumberRequest(val *AssignNumberRequest) *NullableAssignNumberRequest

func (NullableAssignNumberRequest) Get 

func (v NullableAssignNumberRequest) Get() *AssignNumberRequest

func (NullableAssignNumberRequest) IsSet 

func (v NullableAssignNumberRequest) IsSet() bool

func (NullableAssignNumberRequest) MarshalJSON 

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

func (*NullableAssignNumberRequest) Set 

func (v *NullableAssignNumberRequest) Set(val *AssignNumberRequest)

func (*NullableAssignNumberRequest) UnmarshalJSON 

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

func (*NullableAssignNumberRequest) Unset 

func (v *NullableAssignNumberRequest) Unset()

type NullableAuthToken400Response 

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

func NewNullableAuthToken400Response 

func NewNullableAuthToken400Response(val *AuthToken400Response) *NullableAuthToken400Response

func (NullableAuthToken400Response) Get 

func (v NullableAuthToken400Response) Get() *AuthToken400Response

func (NullableAuthToken400Response) IsSet 

func (v NullableAuthToken400Response) IsSet() bool

func (NullableAuthToken400Response) MarshalJSON 

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

func (*NullableAuthToken400Response) Set 

func (v *NullableAuthToken400Response) Set(val *AuthToken400Response)

func (*NullableAuthToken400Response) UnmarshalJSON 

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

func (*NullableAuthToken400Response) Unset 

func (v *NullableAuthToken400Response) Unset()

type NullableBool 

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

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

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

func (*NullableBool) Set 

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

func (*NullableBool) UnmarshalJSON 

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

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableCreateTrialNumbersRequest 

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

func NewNullableCreateTrialNumbersRequest 

func NewNullableCreateTrialNumbersRequest(val *CreateTrialNumbersRequest) *NullableCreateTrialNumbersRequest

func (NullableCreateTrialNumbersRequest) Get 

func (v NullableCreateTrialNumbersRequest) Get() *CreateTrialNumbersRequest

func (NullableCreateTrialNumbersRequest) IsSet 

func (v NullableCreateTrialNumbersRequest) IsSet() bool

func (NullableCreateTrialNumbersRequest) MarshalJSON 

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

func (*NullableCreateTrialNumbersRequest) Set 

func (v *NullableCreateTrialNumbersRequest) Set(val *CreateTrialNumbersRequest)

func (*NullableCreateTrialNumbersRequest) UnmarshalJSON 

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

func (*NullableCreateTrialNumbersRequest) Unset 

func (v *NullableCreateTrialNumbersRequest) Unset()

type NullableCreateTrialNumbersRequestFreeTrialNumbers 

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

func NewNullableCreateTrialNumbersRequestFreeTrialNumbers 

func NewNullableCreateTrialNumbersRequestFreeTrialNumbers(val *CreateTrialNumbersRequestFreeTrialNumbers) *NullableCreateTrialNumbersRequestFreeTrialNumbers

func (NullableCreateTrialNumbersRequestFreeTrialNumbers) Get 

func (v NullableCreateTrialNumbersRequestFreeTrialNumbers) Get() *CreateTrialNumbersRequestFreeTrialNumbers

func (NullableCreateTrialNumbersRequestFreeTrialNumbers) IsSet 

func (v NullableCreateTrialNumbersRequestFreeTrialNumbers) IsSet() bool

func (NullableCreateTrialNumbersRequestFreeTrialNumbers) MarshalJSON 

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

func (*NullableCreateTrialNumbersRequestFreeTrialNumbers) Set 

func (v *NullableCreateTrialNumbersRequestFreeTrialNumbers) Set(val *CreateTrialNumbersRequestFreeTrialNumbers)

func (*NullableCreateTrialNumbersRequestFreeTrialNumbers) UnmarshalJSON 

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

func (*NullableCreateTrialNumbersRequestFreeTrialNumbers) Unset 

func (v *NullableCreateTrialNumbersRequestFreeTrialNumbers) Unset()

type NullableError 

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

func NewNullableError 

func NewNullableError(val *Error) *NullableError

func (NullableError) Get 

func (v NullableError) Get() *Error

func (NullableError) IsSet 

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON 

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

func (*NullableError) Set 

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON 

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

func (*NullableError) Unset 

func (v *NullableError) Unset()

type NullableErrors 

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

func NewNullableErrors 

func NewNullableErrors(val *Errors) *NullableErrors

func (NullableErrors) Get 

func (v NullableErrors) Get() *Errors

func (NullableErrors) IsSet 

func (v NullableErrors) IsSet() bool

func (NullableErrors) MarshalJSON 

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

func (*NullableErrors) Set 

func (v *NullableErrors) Set(val *Errors)

func (*NullableErrors) UnmarshalJSON 

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

func (*NullableErrors) Unset 

func (v *NullableErrors) 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 NullableFreeTrialNumbers 

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

func NewNullableFreeTrialNumbers 

func NewNullableFreeTrialNumbers(val *FreeTrialNumbers) *NullableFreeTrialNumbers

func (NullableFreeTrialNumbers) Get 

func (v NullableFreeTrialNumbers) Get() *FreeTrialNumbers

func (NullableFreeTrialNumbers) IsSet 

func (v NullableFreeTrialNumbers) IsSet() bool

func (NullableFreeTrialNumbers) MarshalJSON 

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

func (*NullableFreeTrialNumbers) Set 

func (v *NullableFreeTrialNumbers) Set(val *FreeTrialNumbers)

func (*NullableFreeTrialNumbers) UnmarshalJSON 

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

func (*NullableFreeTrialNumbers) Unset 

func (v *NullableFreeTrialNumbers) Unset()

type NullableGetLogs200Response 

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

func NewNullableGetLogs200Response 

func NewNullableGetLogs200Response(val *GetLogs200Response) *NullableGetLogs200Response

func (NullableGetLogs200Response) Get 

func (v NullableGetLogs200Response) Get() *GetLogs200Response

func (NullableGetLogs200Response) IsSet 

func (v NullableGetLogs200Response) IsSet() bool

func (NullableGetLogs200Response) MarshalJSON 

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

func (*NullableGetLogs200Response) Set 

func (v *NullableGetLogs200Response) Set(val *GetLogs200Response)

func (*NullableGetLogs200Response) UnmarshalJSON 

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

func (*NullableGetLogs200Response) Unset 

func (v *NullableGetLogs200Response) Unset()

type NullableGetMessages200Response 

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

func NewNullableGetMessages200Response 

func NewNullableGetMessages200Response(val *GetMessages200Response) *NullableGetMessages200Response

func (NullableGetMessages200Response) Get 

func (v NullableGetMessages200Response) Get() *GetMessages200Response

func (NullableGetMessages200Response) IsSet 

func (v NullableGetMessages200Response) IsSet() bool

func (NullableGetMessages200Response) MarshalJSON 

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

func (*NullableGetMessages200Response) Set 

func (v *NullableGetMessages200Response) Set(val *GetMessages200Response)

func (*NullableGetMessages200Response) UnmarshalJSON 

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

func (*NullableGetMessages200Response) Unset 

func (v *NullableGetMessages200Response) Unset()

type NullableGetMessages200ResponsePaging 

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

func NewNullableGetMessages200ResponsePaging 

func NewNullableGetMessages200ResponsePaging(val *GetMessages200ResponsePaging) *NullableGetMessages200ResponsePaging

func (NullableGetMessages200ResponsePaging) Get 

func (v NullableGetMessages200ResponsePaging) Get() *GetMessages200ResponsePaging

func (NullableGetMessages200ResponsePaging) IsSet 

func (v NullableGetMessages200ResponsePaging) IsSet() bool

func (NullableGetMessages200ResponsePaging) MarshalJSON 

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

func (*NullableGetMessages200ResponsePaging) Set 

func (v *NullableGetMessages200ResponsePaging) Set(val *GetMessages200ResponsePaging)

func (*NullableGetMessages200ResponsePaging) UnmarshalJSON 

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

func (*NullableGetMessages200ResponsePaging) Unset 

func (v *NullableGetMessages200ResponsePaging) Unset()

type NullableGetNumbers200Response 

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

func NewNullableGetNumbers200Response 

func NewNullableGetNumbers200Response(val *GetNumbers200Response) *NullableGetNumbers200Response

func (NullableGetNumbers200Response) Get 

func (v NullableGetNumbers200Response) Get() *GetNumbers200Response

func (NullableGetNumbers200Response) IsSet 

func (v NullableGetNumbers200Response) IsSet() bool

func (NullableGetNumbers200Response) MarshalJSON 

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

func (*NullableGetNumbers200Response) Set 

func (v *NullableGetNumbers200Response) Set(val *GetNumbers200Response)

func (*NullableGetNumbers200Response) UnmarshalJSON 

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

func (*NullableGetNumbers200Response) Unset 

func (v *NullableGetNumbers200Response) Unset()

type NullableGetRecipientOptouts200Response 

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

func NewNullableGetRecipientOptouts200Response 

func NewNullableGetRecipientOptouts200Response(val *GetRecipientOptouts200Response) *NullableGetRecipientOptouts200Response

func (NullableGetRecipientOptouts200Response) Get 

func (v NullableGetRecipientOptouts200Response) Get() *GetRecipientOptouts200Response

func (NullableGetRecipientOptouts200Response) IsSet 

func (v NullableGetRecipientOptouts200Response) IsSet() bool

func (NullableGetRecipientOptouts200Response) MarshalJSON 

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

func (*NullableGetRecipientOptouts200Response) Set 

func (v *NullableGetRecipientOptouts200Response) Set(val *GetRecipientOptouts200Response)

func (*NullableGetRecipientOptouts200Response) UnmarshalJSON 

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

func (*NullableGetRecipientOptouts200Response) Unset 

func (v *NullableGetRecipientOptouts200Response) Unset()

type NullableGetReport200Response 

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

func NewNullableGetReport200Response 

func NewNullableGetReport200Response(val *GetReport200Response) *NullableGetReport200Response

func (NullableGetReport200Response) Get 

func (v NullableGetReport200Response) Get() *GetReport200Response

func (NullableGetReport200Response) IsSet 

func (v NullableGetReport200Response) IsSet() bool

func (NullableGetReport200Response) MarshalJSON 

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

func (*NullableGetReport200Response) Set 

func (v *NullableGetReport200Response) Set(val *GetReport200Response)

func (*NullableGetReport200Response) UnmarshalJSON 

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

func (*NullableGetReport200Response) Unset 

func (v *NullableGetReport200Response) Unset()

type NullableGetReports200Response 

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

func NewNullableGetReports200Response 

func NewNullableGetReports200Response(val *GetReports200Response) *NullableGetReports200Response

func (NullableGetReports200Response) Get 

func (v NullableGetReports200Response) Get() *GetReports200Response

func (NullableGetReports200Response) IsSet 

func (v NullableGetReports200Response) IsSet() bool

func (NullableGetReports200Response) MarshalJSON 

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

func (*NullableGetReports200Response) Set 

func (v *NullableGetReports200Response) Set(val *GetReports200Response)

func (*NullableGetReports200Response) UnmarshalJSON 

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

func (*NullableGetReports200Response) Unset 

func (v *NullableGetReports200Response) Unset()

type NullableGetReports200ResponseReportsInner 

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

func NewNullableGetReports200ResponseReportsInner 

func NewNullableGetReports200ResponseReportsInner(val *GetReports200ResponseReportsInner) *NullableGetReports200ResponseReportsInner

func (NullableGetReports200ResponseReportsInner) Get 

func (v NullableGetReports200ResponseReportsInner) Get() *GetReports200ResponseReportsInner

func (NullableGetReports200ResponseReportsInner) IsSet 

func (v NullableGetReports200ResponseReportsInner) IsSet() bool

func (NullableGetReports200ResponseReportsInner) MarshalJSON 

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

func (*NullableGetReports200ResponseReportsInner) Set 

func (v *NullableGetReports200ResponseReportsInner) Set(val *GetReports200ResponseReportsInner)

func (*NullableGetReports200ResponseReportsInner) UnmarshalJSON 

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

func (*NullableGetReports200ResponseReportsInner) Unset 

func (v *NullableGetReports200ResponseReportsInner) Unset()

type NullableHealthCheck200Response 

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

func NewNullableHealthCheck200Response 

func NewNullableHealthCheck200Response(val *HealthCheck200Response) *NullableHealthCheck200Response

func (NullableHealthCheck200Response) Get 

func (v NullableHealthCheck200Response) Get() *HealthCheck200Response

func (NullableHealthCheck200Response) IsSet 

func (v NullableHealthCheck200Response) IsSet() bool

func (NullableHealthCheck200Response) MarshalJSON 

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

func (*NullableHealthCheck200Response) Set 

func (v *NullableHealthCheck200Response) Set(val *HealthCheck200Response)

func (*NullableHealthCheck200Response) UnmarshalJSON 

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

func (*NullableHealthCheck200Response) Unset 

func (v *NullableHealthCheck200Response) 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 NullableLog 

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

func NewNullableLog 

func NewNullableLog(val *Log) *NullableLog

func (NullableLog) Get 

func (v NullableLog) Get() *Log

func (NullableLog) IsSet 

func (v NullableLog) IsSet() bool

func (NullableLog) MarshalJSON 

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

func (*NullableLog) Set 

func (v *NullableLog) Set(val *Log)

func (*NullableLog) UnmarshalJSON 

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

func (*NullableLog) Unset 

func (v *NullableLog) Unset()

type NullableMessageGet 

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

func NewNullableMessageGet 

func NewNullableMessageGet(val *MessageGet) *NullableMessageGet

func (NullableMessageGet) Get 

func (v NullableMessageGet) Get() *MessageGet

func (NullableMessageGet) IsSet 

func (v NullableMessageGet) IsSet() bool

func (NullableMessageGet) MarshalJSON 

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

func (*NullableMessageGet) Set 

func (v *NullableMessageGet) Set(val *MessageGet)

func (*NullableMessageGet) UnmarshalJSON 

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

func (*NullableMessageGet) Unset 

func (v *NullableMessageGet) Unset()

type NullableMessageSent 

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

func NewNullableMessageSent 

func NewNullableMessageSent(val *MessageSent) *NullableMessageSent

func (NullableMessageSent) Get 

func (v NullableMessageSent) Get() *MessageSent

func (NullableMessageSent) IsSet 

func (v NullableMessageSent) IsSet() bool

func (NullableMessageSent) MarshalJSON 

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

func (*NullableMessageSent) Set 

func (v *NullableMessageSent) Set(val *MessageSent)

func (*NullableMessageSent) UnmarshalJSON 

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

func (*NullableMessageSent) Unset 

func (v *NullableMessageSent) Unset()

type NullableMessageSentMessageId 

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

func NewNullableMessageSentMessageId 

func NewNullableMessageSentMessageId(val *MessageSentMessageId) *NullableMessageSentMessageId

func (NullableMessageSentMessageId) Get 

func (v NullableMessageSentMessageId) Get() *MessageSentMessageId

func (NullableMessageSentMessageId) IsSet 

func (v NullableMessageSentMessageId) IsSet() bool

func (NullableMessageSentMessageId) MarshalJSON 

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

func (*NullableMessageSentMessageId) Set 

func (v *NullableMessageSentMessageId) Set(val *MessageSentMessageId)

func (*NullableMessageSentMessageId) UnmarshalJSON 

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

func (*NullableMessageSentMessageId) Unset 

func (v *NullableMessageSentMessageId) Unset()

type NullableMessageSentTo 

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

func NewNullableMessageSentTo 

func NewNullableMessageSentTo(val *MessageSentTo) *NullableMessageSentTo

func (NullableMessageSentTo) Get 

func (v NullableMessageSentTo) Get() *MessageSentTo

func (NullableMessageSentTo) IsSet 

func (v NullableMessageSentTo) IsSet() bool

func (NullableMessageSentTo) MarshalJSON 

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

func (*NullableMessageSentTo) Set 

func (v *NullableMessageSentTo) Set(val *MessageSentTo)

func (*NullableMessageSentTo) UnmarshalJSON 

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

func (*NullableMessageSentTo) Unset 

func (v *NullableMessageSentTo) Unset()

type NullableMessageUpdate 

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

func NewNullableMessageUpdate 

func NewNullableMessageUpdate(val *MessageUpdate) *NullableMessageUpdate

func (NullableMessageUpdate) Get 

func (v NullableMessageUpdate) Get() *MessageUpdate

func (NullableMessageUpdate) IsSet 

func (v NullableMessageUpdate) IsSet() bool

func (NullableMessageUpdate) MarshalJSON 

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

func (*NullableMessageUpdate) Set 

func (v *NullableMessageUpdate) Set(val *MessageUpdate)

func (*NullableMessageUpdate) UnmarshalJSON 

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

func (*NullableMessageUpdate) Unset 

func (v *NullableMessageUpdate) Unset()

type NullableMessagesReport201Response 

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

func NewNullableMessagesReport201Response 

func NewNullableMessagesReport201Response(val *MessagesReport201Response) *NullableMessagesReport201Response

func (NullableMessagesReport201Response) Get 

func (v NullableMessagesReport201Response) Get() *MessagesReport201Response

func (NullableMessagesReport201Response) IsSet 

func (v NullableMessagesReport201Response) IsSet() bool

func (NullableMessagesReport201Response) MarshalJSON 

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

func (*NullableMessagesReport201Response) Set 

func (v *NullableMessagesReport201Response) Set(val *MessagesReport201Response)

func (*NullableMessagesReport201Response) UnmarshalJSON 

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

func (*NullableMessagesReport201Response) Unset 

func (v *NullableMessagesReport201Response) Unset()

type NullableMessagesReportRequest 

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

func NewNullableMessagesReportRequest 

func NewNullableMessagesReportRequest(val *MessagesReportRequest) *NullableMessagesReportRequest

func (NullableMessagesReportRequest) Get 

func (v NullableMessagesReportRequest) Get() *MessagesReportRequest

func (NullableMessagesReportRequest) IsSet 

func (v NullableMessagesReportRequest) IsSet() bool

func (NullableMessagesReportRequest) MarshalJSON 

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

func (*NullableMessagesReportRequest) Set 

func (v *NullableMessagesReportRequest) Set(val *MessagesReportRequest)

func (*NullableMessagesReportRequest) UnmarshalJSON 

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

func (*NullableMessagesReportRequest) Unset 

func (v *NullableMessagesReportRequest) Unset()

type NullableMultimedia 

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

func NewNullableMultimedia 

func NewNullableMultimedia(val *Multimedia) *NullableMultimedia

func (NullableMultimedia) Get 

func (v NullableMultimedia) Get() *Multimedia

func (NullableMultimedia) IsSet 

func (v NullableMultimedia) IsSet() bool

func (NullableMultimedia) MarshalJSON 

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

func (*NullableMultimedia) Set 

func (v *NullableMultimedia) Set(val *Multimedia)

func (*NullableMultimedia) UnmarshalJSON 

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

func (*NullableMultimedia) Unset 

func (v *NullableMultimedia) Unset()

type NullableMultimediaGet 

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

func NewNullableMultimediaGet 

func NewNullableMultimediaGet(val *MultimediaGet) *NullableMultimediaGet

func (NullableMultimediaGet) Get 

func (v NullableMultimediaGet) Get() *MultimediaGet

func (NullableMultimediaGet) IsSet 

func (v NullableMultimediaGet) IsSet() bool

func (NullableMultimediaGet) MarshalJSON 

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

func (*NullableMultimediaGet) Set 

func (v *NullableMultimediaGet) Set(val *MultimediaGet)

func (*NullableMultimediaGet) UnmarshalJSON 

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

func (*NullableMultimediaGet) Unset 

func (v *NullableMultimediaGet) Unset()

type NullableOAuth 

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

func NewNullableOAuth 

func NewNullableOAuth(val *OAuth) *NullableOAuth

func (NullableOAuth) Get 

func (v NullableOAuth) Get() *OAuth

func (NullableOAuth) IsSet 

func (v NullableOAuth) IsSet() bool

func (NullableOAuth) MarshalJSON 

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

func (*NullableOAuth) Set 

func (v *NullableOAuth) Set(val *OAuth)

func (*NullableOAuth) UnmarshalJSON 

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

func (*NullableOAuth) Unset 

func (v *NullableOAuth) Unset()

type NullableRecipientOptout 

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

func NewNullableRecipientOptout 

func NewNullableRecipientOptout(val *RecipientOptout) *NullableRecipientOptout

func (NullableRecipientOptout) Get 

func (v NullableRecipientOptout) Get() *RecipientOptout

func (NullableRecipientOptout) IsSet 

func (v NullableRecipientOptout) IsSet() bool

func (NullableRecipientOptout) MarshalJSON 

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

func (*NullableRecipientOptout) Set 

func (v *NullableRecipientOptout) Set(val *RecipientOptout)

func (*NullableRecipientOptout) UnmarshalJSON 

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

func (*NullableRecipientOptout) Unset 

func (v *NullableRecipientOptout) Unset()

type NullableSendMessagesRequest 

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

func NewNullableSendMessagesRequest 

func NewNullableSendMessagesRequest(val *SendMessagesRequest) *NullableSendMessagesRequest

func (NullableSendMessagesRequest) Get 

func (v NullableSendMessagesRequest) Get() *SendMessagesRequest

func (NullableSendMessagesRequest) IsSet 

func (v NullableSendMessagesRequest) IsSet() bool

func (NullableSendMessagesRequest) MarshalJSON 

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

func (*NullableSendMessagesRequest) Set 

func (v *NullableSendMessagesRequest) Set(val *SendMessagesRequest)

func (*NullableSendMessagesRequest) UnmarshalJSON 

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

func (*NullableSendMessagesRequest) Unset 

func (v *NullableSendMessagesRequest) Unset()

type NullableSendMessagesRequestTo 

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

func NewNullableSendMessagesRequestTo 

func NewNullableSendMessagesRequestTo(val *SendMessagesRequestTo) *NullableSendMessagesRequestTo

func (NullableSendMessagesRequestTo) Get 

func (v NullableSendMessagesRequestTo) Get() *SendMessagesRequestTo

func (NullableSendMessagesRequestTo) IsSet 

func (v NullableSendMessagesRequestTo) IsSet() bool

func (NullableSendMessagesRequestTo) MarshalJSON 

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

func (*NullableSendMessagesRequestTo) Set 

func (v *NullableSendMessagesRequestTo) Set(val *SendMessagesRequestTo)

func (*NullableSendMessagesRequestTo) UnmarshalJSON 

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

func (*NullableSendMessagesRequestTo) Unset 

func (v *NullableSendMessagesRequestTo) 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 NullableUpdateMessageByIdRequest 

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

func NewNullableUpdateMessageByIdRequest 

func NewNullableUpdateMessageByIdRequest(val *UpdateMessageByIdRequest) *NullableUpdateMessageByIdRequest

func (NullableUpdateMessageByIdRequest) Get 

func (v NullableUpdateMessageByIdRequest) Get() *UpdateMessageByIdRequest

func (NullableUpdateMessageByIdRequest) IsSet 

func (v NullableUpdateMessageByIdRequest) IsSet() bool

func (NullableUpdateMessageByIdRequest) MarshalJSON 

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

func (*NullableUpdateMessageByIdRequest) Set 

func (v *NullableUpdateMessageByIdRequest) Set(val *UpdateMessageByIdRequest)

func (*NullableUpdateMessageByIdRequest) UnmarshalJSON 

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

func (*NullableUpdateMessageByIdRequest) Unset 

func (v *NullableUpdateMessageByIdRequest) Unset()

type NullableUpdateMessageTagsRequest 

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

func NewNullableUpdateMessageTagsRequest 

func NewNullableUpdateMessageTagsRequest(val *UpdateMessageTagsRequest) *NullableUpdateMessageTagsRequest

func (NullableUpdateMessageTagsRequest) Get 

func (v NullableUpdateMessageTagsRequest) Get() *UpdateMessageTagsRequest

func (NullableUpdateMessageTagsRequest) IsSet 

func (v NullableUpdateMessageTagsRequest) IsSet() bool

func (NullableUpdateMessageTagsRequest) MarshalJSON 

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

func (*NullableUpdateMessageTagsRequest) Set 

func (v *NullableUpdateMessageTagsRequest) Set(val *UpdateMessageTagsRequest)

func (*NullableUpdateMessageTagsRequest) UnmarshalJSON 

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

func (*NullableUpdateMessageTagsRequest) Unset 

func (v *NullableUpdateMessageTagsRequest) Unset()

type NullableUpdateNumberRequest 

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

func NewNullableUpdateNumberRequest 

func NewNullableUpdateNumberRequest(val *UpdateNumberRequest) *NullableUpdateNumberRequest

func (NullableUpdateNumberRequest) Get 

func (v NullableUpdateNumberRequest) Get() *UpdateNumberRequest

func (NullableUpdateNumberRequest) IsSet 

func (v NullableUpdateNumberRequest) IsSet() bool

func (NullableUpdateNumberRequest) MarshalJSON 

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

func (*NullableUpdateNumberRequest) Set 

func (v *NullableUpdateNumberRequest) Set(val *UpdateNumberRequest)

func (*NullableUpdateNumberRequest) UnmarshalJSON 

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

func (*NullableUpdateNumberRequest) Unset 

func (v *NullableUpdateNumberRequest) Unset()

type NullableVirtualNumber 

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

func NewNullableVirtualNumber 

func NewNullableVirtualNumber(val *VirtualNumber) *NullableVirtualNumber

func (NullableVirtualNumber) Get 

func (v NullableVirtualNumber) Get() *VirtualNumber

func (NullableVirtualNumber) IsSet 

func (v NullableVirtualNumber) IsSet() bool

func (NullableVirtualNumber) MarshalJSON 

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

func (*NullableVirtualNumber) Set 

func (v *NullableVirtualNumber) Set(val *VirtualNumber)

func (*NullableVirtualNumber) UnmarshalJSON 

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

func (*NullableVirtualNumber) Unset 

func (v *NullableVirtualNumber) Unset()

type OAuth 

type OAuth struct {
	// This is your OAuth 2.0 Authentication Token. It will be valid for one hour.
	AccessToken *string `json:"access_token,omitempty"`
	// This is the Authentication Token type.
	TokenType *string `json:"token_type,omitempty"`
	// This is when your token will expire.
	ExpiresIn *string `json:"expires_in,omitempty"`
}

OAuth struct for OAuth

func NewOAuth 

func NewOAuth() *OAuth

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

func NewOAuthWithDefaults 

func NewOAuthWithDefaults() *OAuth

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

func (*OAuth) GetAccessToken 

func (o *OAuth) GetAccessToken() string

GetAccessToken returns the AccessToken field value if set, zero value otherwise.

func (*OAuth) GetAccessTokenOk 

func (o *OAuth) GetAccessTokenOk() (*string, bool)

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

func (*OAuth) GetExpiresIn 

func (o *OAuth) GetExpiresIn() string

GetExpiresIn returns the ExpiresIn field value if set, zero value otherwise.

func (*OAuth) GetExpiresInOk 

func (o *OAuth) GetExpiresInOk() (*string, bool)

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

func (*OAuth) GetTokenType 

func (o *OAuth) GetTokenType() string

GetTokenType returns the TokenType field value if set, zero value otherwise.

func (*OAuth) GetTokenTypeOk 

func (o *OAuth) GetTokenTypeOk() (*string, bool)

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

func (*OAuth) HasAccessToken 

func (o *OAuth) HasAccessToken() bool

HasAccessToken returns a boolean if a field has been set.

func (*OAuth) HasExpiresIn 

func (o *OAuth) HasExpiresIn() bool

HasExpiresIn returns a boolean if a field has been set.

func (*OAuth) HasTokenType 

func (o *OAuth) HasTokenType() bool

HasTokenType returns a boolean if a field has been set.

func (OAuth) MarshalJSON 

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

func (*OAuth) SetAccessToken 

func (o *OAuth) SetAccessToken(v string)

SetAccessToken gets a reference to the given string and assigns it to the AccessToken field.

func (*OAuth) SetExpiresIn 

func (o *OAuth) SetExpiresIn(v string)

SetExpiresIn gets a reference to the given string and assigns it to the ExpiresIn field.

func (*OAuth) SetTokenType 

func (o *OAuth) SetTokenType(v string)

SetTokenType gets a reference to the given string and assigns it to the TokenType field.

func (OAuth) ToMap 

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

type RecipientOptout 

type RecipientOptout struct {
	// The mobile number that sent the optout request.
	OptoutNumber *string `json:"optoutNumber,omitempty"`
	// The date and time we received the optout request.
	CreateTimestamp *time.Time `json:"createTimestamp,omitempty"`
}

RecipientOptout struct for RecipientOptout

func NewRecipientOptout 

func NewRecipientOptout() *RecipientOptout

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

func NewRecipientOptoutWithDefaults 

func NewRecipientOptoutWithDefaults() *RecipientOptout

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

func (*RecipientOptout) GetCreateTimestamp 

func (o *RecipientOptout) GetCreateTimestamp() time.Time

GetCreateTimestamp returns the CreateTimestamp field value if set, zero value otherwise.

func (*RecipientOptout) GetCreateTimestampOk 

func (o *RecipientOptout) GetCreateTimestampOk() (*time.Time, bool)

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

func (*RecipientOptout) GetOptoutNumber 

func (o *RecipientOptout) GetOptoutNumber() string

GetOptoutNumber returns the OptoutNumber field value if set, zero value otherwise.

func (*RecipientOptout) GetOptoutNumberOk 

func (o *RecipientOptout) GetOptoutNumberOk() (*string, bool)

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

func (*RecipientOptout) HasCreateTimestamp 

func (o *RecipientOptout) HasCreateTimestamp() bool

HasCreateTimestamp returns a boolean if a field has been set.

func (*RecipientOptout) HasOptoutNumber 

func (o *RecipientOptout) HasOptoutNumber() bool

HasOptoutNumber returns a boolean if a field has been set.

func (RecipientOptout) MarshalJSON 

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

func (*RecipientOptout) SetCreateTimestamp 

func (o *RecipientOptout) SetCreateTimestamp(v time.Time)

SetCreateTimestamp gets a reference to the given time.Time and assigns it to the CreateTimestamp field.

func (*RecipientOptout) SetOptoutNumber 

func (o *RecipientOptout) SetOptoutNumber(v string)

SetOptoutNumber gets a reference to the given string and assigns it to the OptoutNumber field.

func (RecipientOptout) ToMap 

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

type ReportsAPIService 

type ReportsAPIService service

ReportsAPIService ReportsAPI service

func (*ReportsAPIService) GetReport 

func (a *ReportsAPIService) GetReport(ctx context.Context, reportId string, authorization string) ApiGetReportRequest

GetReport fetch a specific report

Fetch a download link for a report generated with POST /reports/{reportId} using the **reportId** returned in the response. Once ready, your report will be available for download for one week. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param reportId Use the reportId returned in the POST /reports/{reportType} response.
@return ApiGetReportRequest

func (*ReportsAPIService) GetReportExecute 

func (a *ReportsAPIService) GetReportExecute(r ApiGetReportRequest) (*GetReport200Response, *http.Response, error)

Execute executes the request 

@return GetReport200Response

func (*ReportsAPIService) GetReports 

func (a *ReportsAPIService) GetReports(ctx context.Context, authorization string) ApiGetReportsRequest

GetReports fetch all reports

Fetch details of all reports recently generated for your account. Use it to check the status of a report, plus fetch the report ID, status, report type and expiry date. 

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

func (*ReportsAPIService) GetReportsExecute 

func (a *ReportsAPIService) GetReportsExecute(r ApiGetReportsRequest) (*GetReports200Response, *http.Response, error)

Execute executes the request 

@return GetReports200Response

func (*ReportsAPIService) MessagesReport 

func (a *ReportsAPIService) MessagesReport(ctx context.Context, authorization string) ApiMessagesReportRequest

MessagesReport submit a request for a messages report

Request a CSV report of messages (both incoming and outgoing) that have been sent to/from your account within the last three months. You can request details for a specific timeframe, and filter your messages by tags, recipient number or Virtual Number.

A 201 Created means your report has been queued for generation. Make a note of the reportId returned in the response. You'll need this to check the status of your report and fetch your download link with GET reports/{reportId}. If you supplied a reportCallbackUrl in the request we'll also notify it when your report is ready for download.

Once your report is generated, it will be available for download for one week. The expiry date is returned in the response. 

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

func (*ReportsAPIService) MessagesReportExecute 

func (a *ReportsAPIService) MessagesReportExecute(r ApiMessagesReportRequest) (*MessagesReport201Response, *http.Response, error)

Execute executes the request 

@return MessagesReport201Response

type RequestParams added in v3.4.8 

type RequestParams struct {
	ContentType       string
	Accept            string
	AcceptCharset     string
	ContentLanguage   string
	TelstraApiVersion string
	GrantType         string
	Scope             string
}

func SetRequestParams added in v3.4.9 

func SetRequestParams() *RequestParams

type SendMessagesRequest 

type SendMessagesRequest struct {
	To SendMessagesRequestTo `json:"to"`
	// When the recipient receives your message, you can choose whether they'll see a virtualNumber or senderName (paid plans only) in the **from** field.   * 04xxxxxxxx: Use one of the Virtual Numbers associated with your account. You'll also be able to receive SMS replies to this number.  * senderName: Choose a unique alphanumeric string of up to 11 characters (paid feature).
	From string `json:"from"`
	// Use this field to send an SMS. Your text message goes here.     Note: either messageContent or multimedia are required, or you can use both field if you want to send multimedia with text.
	MessageContent *string `json:"messageContent,omitempty"`
	// Use this field to send an MMS. Add your image, video or audio content here.   Note: either messageContent or multimedia are required, or you can use both field if you want to send multimedia with text.  Include a JSON payload with:  type: the type of multimedia content file you're sending (image, audio or video) followed by the file type. Use the format \"multimedia type/file type\", e.g. \"image/PNG\" or \"audio/MP3\". Supported file types: JPEG, BMP, GIF87a, GIF89a, PNG, MP3, WAV, MPEG, MPG, MP4, 3GP and US-ASCII.  fileName: the name of your multimedia file.  payload: the base64 encoded content. You can use [this online tool](https://elmah.io/tools/base64-image-encoder/) to encode an image, or [Base64 Guru](https://base64.guru/) to encode a video or audio file.
	Multimedia []Multimedia `json:"multimedia,omitempty"`
	// If the message is queued or unable to reach the recipient's device, tell us how many minutes the network should keep trying. Use an integer between 1 and 1440. If you don't set a value, we'll try for 10 minutes.
	RetryTimeout *int32 `json:"retryTimeout,omitempty"`
	// Don't want to send the message right away? Tell us what time you want to add it to the queue for sending instead.  Set the time in London Greenwich Mean Time (adjusting for any time difference) and use ISO format, e.g. \"2019-08-24T15:39:00Z\".  You can schedule a message up to 10 days into the future. If you specify a timestamp outside of this limit, the API will return a FIELD_INVALID error.
	ScheduleSend *time.Time `json:"scheduleSend,omitempty"`
	// To receive a notification when your SMS has been delivered, set this parameter to **true** and make sure you provide a **statusCallbackUrl** (paid feature).
	DeliveryNotification *bool `json:"deliveryNotification,omitempty"`
	// Tell us the URL you want the API to call when the status of your SMS updates.   To receive a status update, this field must be provided and deliveryNotification must be set to **true**.   The status will be either:   * **queued** – the message is in the queue for sending (default). * **sent** – your message has been sent from the server. * **expired** – we weren't able to send the message within the **retryTimeout** timeframe. * **delivered** – the message has successfully reached the recipient's device. Note that we will only be able to return this status if you set **deliveryNotification** to **true** (paid feature). * **undeliverable** – the delivery of your message failed (paid feature).  Sample callback response:  <pre><code class=\"language-sh\">{   \"to\":\"0476543210\",    \"from\":\"0401234567\",     \"timestamp\":\"2022-11-10T05:06:42.823Z\",    \"messageId\":\"1520b774-46b0-4415-a05f-7bcb1c032c59\",    \"status\":\"delivered\"  }</code></pre>
	StatusCallbackUrl *string `json:"statusCallbackUrl,omitempty"`
	// Create your own tags and use them to fetch and sort your messages through our other endpoints. You can assign up to 10 tags per message.
	Tags []string `json:"tags,omitempty"`
}

SendMessagesRequest struct for SendMessagesRequest

func NewSendMessagesRequest 

func NewSendMessagesRequest(to SendMessagesRequestTo, from string) *SendMessagesRequest

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

func NewSendMessagesRequestWithDefaults 

func NewSendMessagesRequestWithDefaults() *SendMessagesRequest

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

func (*SendMessagesRequest) GetDeliveryNotification 

func (o *SendMessagesRequest) GetDeliveryNotification() bool

GetDeliveryNotification returns the DeliveryNotification field value if set, zero value otherwise.

func (*SendMessagesRequest) GetDeliveryNotificationOk 

func (o *SendMessagesRequest) GetDeliveryNotificationOk() (*bool, bool)

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

func (*SendMessagesRequest) GetFrom 

func (o *SendMessagesRequest) GetFrom() string

GetFrom returns the From field value

func (*SendMessagesRequest) GetFromOk 

func (o *SendMessagesRequest) GetFromOk() (*string, bool)

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

func (*SendMessagesRequest) GetMessageContent 

func (o *SendMessagesRequest) GetMessageContent() string

GetMessageContent returns the MessageContent field value if set, zero value otherwise.

func (*SendMessagesRequest) GetMessageContentOk 

func (o *SendMessagesRequest) GetMessageContentOk() (*string, bool)

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

func (*SendMessagesRequest) GetMultimedia 

func (o *SendMessagesRequest) GetMultimedia() []Multimedia

GetMultimedia returns the Multimedia field value if set, zero value otherwise.

func (*SendMessagesRequest) GetMultimediaOk 

func (o *SendMessagesRequest) GetMultimediaOk() ([]Multimedia, bool)

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

func (*SendMessagesRequest) GetRetryTimeout 

func (o *SendMessagesRequest) GetRetryTimeout() int32

GetRetryTimeout returns the RetryTimeout field value if set, zero value otherwise.

func (*SendMessagesRequest) GetRetryTimeoutOk 

func (o *SendMessagesRequest) GetRetryTimeoutOk() (*int32, bool)

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

func (*SendMessagesRequest) GetScheduleSend 

func (o *SendMessagesRequest) GetScheduleSend() time.Time

GetScheduleSend returns the ScheduleSend field value if set, zero value otherwise.

func (*SendMessagesRequest) GetScheduleSendOk 

func (o *SendMessagesRequest) GetScheduleSendOk() (*time.Time, bool)

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

func (*SendMessagesRequest) GetStatusCallbackUrl 

func (o *SendMessagesRequest) GetStatusCallbackUrl() string

GetStatusCallbackUrl returns the StatusCallbackUrl field value if set, zero value otherwise.

func (*SendMessagesRequest) GetStatusCallbackUrlOk 

func (o *SendMessagesRequest) GetStatusCallbackUrlOk() (*string, bool)

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

func (*SendMessagesRequest) GetTags 

func (o *SendMessagesRequest) GetTags() []string

GetTags returns the Tags field value if set, zero value otherwise.

func (*SendMessagesRequest) GetTagsOk 

func (o *SendMessagesRequest) GetTagsOk() ([]string, bool)

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

func (*SendMessagesRequest) GetTo 

func (o *SendMessagesRequest) GetTo() SendMessagesRequestTo

GetTo returns the To field value

func (*SendMessagesRequest) GetToOk 

func (o *SendMessagesRequest) GetToOk() (*SendMessagesRequestTo, bool)

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

func (*SendMessagesRequest) HasDeliveryNotification 

func (o *SendMessagesRequest) HasDeliveryNotification() bool

HasDeliveryNotification returns a boolean if a field has been set.

func (*SendMessagesRequest) HasMessageContent 

func (o *SendMessagesRequest) HasMessageContent() bool

HasMessageContent returns a boolean if a field has been set.

func (*SendMessagesRequest) HasMultimedia 

func (o *SendMessagesRequest) HasMultimedia() bool

HasMultimedia returns a boolean if a field has been set.

func (*SendMessagesRequest) HasRetryTimeout 

func (o *SendMessagesRequest) HasRetryTimeout() bool

HasRetryTimeout returns a boolean if a field has been set.

func (*SendMessagesRequest) HasScheduleSend 

func (o *SendMessagesRequest) HasScheduleSend() bool

HasScheduleSend returns a boolean if a field has been set.

func (*SendMessagesRequest) HasStatusCallbackUrl 

func (o *SendMessagesRequest) HasStatusCallbackUrl() bool

HasStatusCallbackUrl returns a boolean if a field has been set.

func (*SendMessagesRequest) HasTags 

func (o *SendMessagesRequest) HasTags() bool

HasTags returns a boolean if a field has been set.

func (SendMessagesRequest) MarshalJSON 

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

func (*SendMessagesRequest) SetDeliveryNotification 

func (o *SendMessagesRequest) SetDeliveryNotification(v bool)

SetDeliveryNotification gets a reference to the given bool and assigns it to the DeliveryNotification field.

func (*SendMessagesRequest) SetFrom 

func (o *SendMessagesRequest) SetFrom(v string)

SetFrom sets field value

func (*SendMessagesRequest) SetMessageContent 

func (o *SendMessagesRequest) SetMessageContent(v string)

SetMessageContent gets a reference to the given string and assigns it to the MessageContent field.

func (*SendMessagesRequest) SetMultimedia 

func (o *SendMessagesRequest) SetMultimedia(v []Multimedia)

SetMultimedia gets a reference to the given []Multimedia and assigns it to the Multimedia field.

func (*SendMessagesRequest) SetRetryTimeout 

func (o *SendMessagesRequest) SetRetryTimeout(v int32)

SetRetryTimeout gets a reference to the given int32 and assigns it to the RetryTimeout field.

func (*SendMessagesRequest) SetScheduleSend 

func (o *SendMessagesRequest) SetScheduleSend(v time.Time)

SetScheduleSend gets a reference to the given time.Time and assigns it to the ScheduleSend field.

func (*SendMessagesRequest) SetStatusCallbackUrl 

func (o *SendMessagesRequest) SetStatusCallbackUrl(v string)

SetStatusCallbackUrl gets a reference to the given string and assigns it to the StatusCallbackUrl field.

func (*SendMessagesRequest) SetTags 

func (o *SendMessagesRequest) SetTags(v []string)

SetTags gets a reference to the given []string and assigns it to the Tags field.

func (*SendMessagesRequest) SetTo 

func (o *SendMessagesRequest) SetTo(v SendMessagesRequestTo)

SetTo sets field value

func (SendMessagesRequest) ToMap 

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

type SendMessagesRequestTo 

type SendMessagesRequestTo struct {
	ArrayOfString *[]string
	String        *string
}

SendMessagesRequestTo - This is the mobile number you want to send your message to. Write Australian numbers in national format (e.g. 0412345678) and international numbers (paid plans only) in E.164 format (e.g. +441234567890). Use a string for a single recipient, and an array of string of multiple recipients, e.g. \"to\": [\"0412345678\", \"+441234567890\"]. If you're using the Free Trial, you can include up to 5 recipient numbers in the array. If you're using a paid plan, you can bulk send up to 500 messages at once.

func ArrayOfStringAsSendMessagesRequestTo 

func ArrayOfStringAsSendMessagesRequestTo(v *[]string) SendMessagesRequestTo

[]stringAsSendMessagesRequestTo is a convenience function that returns []string wrapped in SendMessagesRequestTo

func StringAsSendMessagesRequestTo 

func StringAsSendMessagesRequestTo(v *string) SendMessagesRequestTo

stringAsSendMessagesRequestTo is a convenience function that returns string wrapped in SendMessagesRequestTo

func (*SendMessagesRequestTo) GetActualInstance 

func (obj *SendMessagesRequestTo) GetActualInstance() interface{}

Get the actual instance

func (SendMessagesRequestTo) MarshalJSON 

func (src SendMessagesRequestTo) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*SendMessagesRequestTo) UnmarshalJSON 

func (dst *SendMessagesRequestTo) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct

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 UpdateMessageByIdRequest 

type UpdateMessageByIdRequest struct {
	// This is the mobile number you want to send your message to. Write Australian numbers in national format (e.g. 0412345678) and international numbers (paid plans only) in E.164 format (e.g. +441234567890).  Use a string for a single recipient, and an array of strings for multiple recipients, e.g. \"to\": [\"0412345678\", \"+441234567890\"]. If you're using the Free Trial, you can include up to 5 recipient numbers in the array. If you're using a paid plan, you can bulk send up to 500 messages at once.
	To string `json:"to"`
	// When the recipient receives your message, you can choose whether they'll see a virtualNumber or senderName (paid plans only) in the **from** field.  * 04xxxxxxxx: Use one of the Virtual Numbers associated with your account. You'll also be able to receive SMS replies to this number. * senderName: Choose a unique alphanumeric string of up to 11 characters (paid feature).
	From string `json:"from"`
	// Use this field to send an SMS. Your text message goes here.   Note: either messageContent or multimedia are required, or you can use both field if you want to send multimedia with text.
	MessageContent *string `json:"messageContent,omitempty"`
	// Use this field to send an MMS. Add your image, video or audio content here.   Note: either messageContent or multimedia are required, or you can use both fields if you want to send multimedia with text.   Include a JSON payload with:  type: the type of multimedia content file you're sending (image, audio or video) followed by the file type. Use the format 'multimedia type/file type', e.g. \"image/PNG\" or \"audio/MP3\". Supported file types: JPEG, BMP, GIF87a, GIF89a, PNG, MP3, WAV, MPEG, MPG, MP4, 3GP and US-ASCII.  fileName: the name of your multimedia file.   payload: the base64 encoded content. You can use [this online tool](https://elmah.io/tools/base64-image-encoder/) to encode an image, or [Base64 Guru](https://base64.guru/) to encode a video or audio file.
	Multimedia []Multimedia `json:"multimedia,omitempty"`
	// If the message is queued or unable to reach the recipient's device, tell us how many minutes the network should keep trying. Use an integer between 1 and 1440. If you don't set a value, we'll try for 10 minutes.
	RetryTimeout *int32 `json:"retryTimeout,omitempty"`
	// Don't want to send the message right away? Tell us what time you want to add it to the queue for sending instead.  Set the time in London Greenwich Mean Time (adjusting for any time difference) and use ISO format, e.g. \"2019-08-24T15:39:00Z\".  You can schedule a message up to 10 days into the future. If you specify a timestamp outside of this limit, the API will return a FIELD_INVALID error.
	ScheduleSend *time.Time `json:"scheduleSend,omitempty"`
	// To receive a notification when your SMS has been delivered, set this parameter to **true** and make sure you provide a **statusCallbackUrl** (paid feature).
	DeliveryNotification *bool `json:"deliveryNotification,omitempty"`
	// Tell us the URL you want the API to call when the status of your SMS updates.   To receive a status update, this field must be provided and deliveryNotification must be set to **true**.   The status will be either:   * **queued** – the message is in the queue for sending (default). * **sent** – your message has been sent from the server. * **expired** – we weren't able to send the message within the **retryTimeout** timeframe. * **delivered** – the message has successfully reached the recipient's device. Note that we will only be able to return this status if you set **deliveryNotification** to **true** (paid feature). * **undeliverable** – the delivery of your message failed (paid feature).  Sample callback response:  <pre><code class=\"language-sh\">{   \"to\":\"0476543210\",    \"from\":\"0401234567\",    \"timestamp\":\"2022-11-10T05:06:42.823Z\",    \"messageId\":\"1520b774-46b0-4415-a05f-7bcb1c032c59\",    \"status\":\"delivered\"  }</code></pre>
	StatusCallbackUrl *string `json:"statusCallbackUrl,omitempty"`
	// Create your own tags and use them to fetch and sort your messages through our other endpoints. You can assign up to 10 tags per message.
	Tags []string `json:"tags,omitempty"`
}

UpdateMessageByIdRequest struct for UpdateMessageByIdRequest

func NewUpdateMessageByIdRequest 

func NewUpdateMessageByIdRequest(to string, from string) *UpdateMessageByIdRequest

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

func NewUpdateMessageByIdRequestWithDefaults 

func NewUpdateMessageByIdRequestWithDefaults() *UpdateMessageByIdRequest

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

func (*UpdateMessageByIdRequest) GetDeliveryNotification 

func (o *UpdateMessageByIdRequest) GetDeliveryNotification() bool

GetDeliveryNotification returns the DeliveryNotification field value if set, zero value otherwise.

func (*UpdateMessageByIdRequest) GetDeliveryNotificationOk 

func (o *UpdateMessageByIdRequest) GetDeliveryNotificationOk() (*bool, bool)

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

func (*UpdateMessageByIdRequest) GetFrom 

func (o *UpdateMessageByIdRequest) GetFrom() string

GetFrom returns the From field value

func (*UpdateMessageByIdRequest) GetFromOk 

func (o *UpdateMessageByIdRequest) GetFromOk() (*string, bool)

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

func (*UpdateMessageByIdRequest) GetMessageContent 

func (o *UpdateMessageByIdRequest) GetMessageContent() string

GetMessageContent returns the MessageContent field value if set, zero value otherwise.

func (*UpdateMessageByIdRequest) GetMessageContentOk 

func (o *UpdateMessageByIdRequest) GetMessageContentOk() (*string, bool)

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

func (*UpdateMessageByIdRequest) GetMultimedia 

func (o *UpdateMessageByIdRequest) GetMultimedia() []Multimedia

GetMultimedia returns the Multimedia field value if set, zero value otherwise.

func (*UpdateMessageByIdRequest) GetMultimediaOk 

func (o *UpdateMessageByIdRequest) GetMultimediaOk() ([]Multimedia, bool)

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

func (*UpdateMessageByIdRequest) GetRetryTimeout 

func (o *UpdateMessageByIdRequest) GetRetryTimeout() int32

GetRetryTimeout returns the RetryTimeout field value if set, zero value otherwise.

func (*UpdateMessageByIdRequest) GetRetryTimeoutOk 

func (o *UpdateMessageByIdRequest) GetRetryTimeoutOk() (*int32, bool)

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

func (*UpdateMessageByIdRequest) GetScheduleSend 

func (o *UpdateMessageByIdRequest) GetScheduleSend() time.Time

GetScheduleSend returns the ScheduleSend field value if set, zero value otherwise.

func (*UpdateMessageByIdRequest) GetScheduleSendOk 

func (o *UpdateMessageByIdRequest) GetScheduleSendOk() (*time.Time, bool)

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

func (*UpdateMessageByIdRequest) GetStatusCallbackUrl 

func (o *UpdateMessageByIdRequest) GetStatusCallbackUrl() string

GetStatusCallbackUrl returns the StatusCallbackUrl field value if set, zero value otherwise.

func (*UpdateMessageByIdRequest) GetStatusCallbackUrlOk 

func (o *UpdateMessageByIdRequest) GetStatusCallbackUrlOk() (*string, bool)

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

func (*UpdateMessageByIdRequest) GetTags 

func (o *UpdateMessageByIdRequest) GetTags() []string

GetTags returns the Tags field value if set, zero value otherwise.

func (*UpdateMessageByIdRequest) GetTagsOk 

func (o *UpdateMessageByIdRequest) GetTagsOk() ([]string, bool)

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

func (*UpdateMessageByIdRequest) GetTo 

func (o *UpdateMessageByIdRequest) GetTo() string

GetTo returns the To field value

func (*UpdateMessageByIdRequest) GetToOk 

func (o *UpdateMessageByIdRequest) GetToOk() (*string, bool)

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

func (*UpdateMessageByIdRequest) HasDeliveryNotification 

func (o *UpdateMessageByIdRequest) HasDeliveryNotification() bool

HasDeliveryNotification returns a boolean if a field has been set.

func (*UpdateMessageByIdRequest) HasMessageContent 

func (o *UpdateMessageByIdRequest) HasMessageContent() bool

HasMessageContent returns a boolean if a field has been set.

func (*UpdateMessageByIdRequest) HasMultimedia 

func (o *UpdateMessageByIdRequest) HasMultimedia() bool

HasMultimedia returns a boolean if a field has been set.

func (*UpdateMessageByIdRequest) HasRetryTimeout 

func (o *UpdateMessageByIdRequest) HasRetryTimeout() bool

HasRetryTimeout returns a boolean if a field has been set.

func (*UpdateMessageByIdRequest) HasScheduleSend 

func (o *UpdateMessageByIdRequest) HasScheduleSend() bool

HasScheduleSend returns a boolean if a field has been set.

func (*UpdateMessageByIdRequest) HasStatusCallbackUrl 

func (o *UpdateMessageByIdRequest) HasStatusCallbackUrl() bool

HasStatusCallbackUrl returns a boolean if a field has been set.

func (*UpdateMessageByIdRequest) HasTags 

func (o *UpdateMessageByIdRequest) HasTags() bool

HasTags returns a boolean if a field has been set.

func (UpdateMessageByIdRequest) MarshalJSON 

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

func (*UpdateMessageByIdRequest) SetDeliveryNotification 

func (o *UpdateMessageByIdRequest) SetDeliveryNotification(v bool)

SetDeliveryNotification gets a reference to the given bool and assigns it to the DeliveryNotification field.

func (*UpdateMessageByIdRequest) SetFrom 

func (o *UpdateMessageByIdRequest) SetFrom(v string)

SetFrom sets field value

func (*UpdateMessageByIdRequest) SetMessageContent 

func (o *UpdateMessageByIdRequest) SetMessageContent(v string)

SetMessageContent gets a reference to the given string and assigns it to the MessageContent field.

func (*UpdateMessageByIdRequest) SetMultimedia 

func (o *UpdateMessageByIdRequest) SetMultimedia(v []Multimedia)

SetMultimedia gets a reference to the given []Multimedia and assigns it to the Multimedia field.

func (*UpdateMessageByIdRequest) SetRetryTimeout 

func (o *UpdateMessageByIdRequest) SetRetryTimeout(v int32)

SetRetryTimeout gets a reference to the given int32 and assigns it to the RetryTimeout field.

func (*UpdateMessageByIdRequest) SetScheduleSend 

func (o *UpdateMessageByIdRequest) SetScheduleSend(v time.Time)

SetScheduleSend gets a reference to the given time.Time and assigns it to the ScheduleSend field.

func (*UpdateMessageByIdRequest) SetStatusCallbackUrl 

func (o *UpdateMessageByIdRequest) SetStatusCallbackUrl(v string)

SetStatusCallbackUrl gets a reference to the given string and assigns it to the StatusCallbackUrl field.

func (*UpdateMessageByIdRequest) SetTags 

func (o *UpdateMessageByIdRequest) SetTags(v []string)

SetTags gets a reference to the given []string and assigns it to the Tags field.

func (*UpdateMessageByIdRequest) SetTo 

func (o *UpdateMessageByIdRequest) SetTo(v string)

SetTo sets field value

func (UpdateMessageByIdRequest) ToMap 

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

type UpdateMessageTagsRequest 

type UpdateMessageTagsRequest struct {
	// Write the updated list of tag(s) here. You can assign up to 10 tags per message.  Note that if you provide an empty array, any pre-existing tags will be wiped.
	Tags []string `json:"tags"`
}

UpdateMessageTagsRequest struct for UpdateMessageTagsRequest

func NewUpdateMessageTagsRequest 

func NewUpdateMessageTagsRequest(tags []string) *UpdateMessageTagsRequest

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

func NewUpdateMessageTagsRequestWithDefaults 

func NewUpdateMessageTagsRequestWithDefaults() *UpdateMessageTagsRequest

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

func (*UpdateMessageTagsRequest) GetTags 

func (o *UpdateMessageTagsRequest) GetTags() []string

GetTags returns the Tags field value

func (*UpdateMessageTagsRequest) GetTagsOk 

func (o *UpdateMessageTagsRequest) GetTagsOk() ([]string, bool)

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

func (UpdateMessageTagsRequest) MarshalJSON 

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

func (*UpdateMessageTagsRequest) SetTags 

func (o *UpdateMessageTagsRequest) SetTags(v []string)

SetTags sets field value

func (UpdateMessageTagsRequest) ToMap 

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

type UpdateNumberRequest 

type UpdateNumberRequest struct {
	// Tell us the URL that replies to the Virtual Number should be sent to.  Note that if you don't include this field, any pre-existing replyCallbackUrl will be wiped.  Sample callback response:  <pre><code class=\"language-sh\">{   \"to\":\"0476543210\",    \"from\":\"0401234567\",    \"timestamp\":\"2022-11-10T05:06:42.823Z\",   \"messageId\":\"75f263c0-60b5-11ed-8456-71ae4c63550d\",    \"messageContent\":\"Hi, example message\",    \"multimedia\": {      \"fileName:\"image.jpeg\"      \"type:\"image/jpeg\"      \"payload\":\"base64 payload\"    } }</code></pre>
	ReplyCallbackUrl *string `json:"replyCallbackUrl,omitempty"`
	// Create your own tags and use them to fetch, sort and report on your Virtual Numbers through our other endpoints. You can assign up to 10 tags per number.   Note that if you don't include this field, any pre-existing tags will be wiped.
	Tags []string `json:"tags,omitempty"`
}

UpdateNumberRequest struct for UpdateNumberRequest

func NewUpdateNumberRequest 

func NewUpdateNumberRequest() *UpdateNumberRequest

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

func NewUpdateNumberRequestWithDefaults 

func NewUpdateNumberRequestWithDefaults() *UpdateNumberRequest

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

func (*UpdateNumberRequest) GetReplyCallbackUrl 

func (o *UpdateNumberRequest) GetReplyCallbackUrl() string

GetReplyCallbackUrl returns the ReplyCallbackUrl field value if set, zero value otherwise.

func (*UpdateNumberRequest) GetReplyCallbackUrlOk 

func (o *UpdateNumberRequest) GetReplyCallbackUrlOk() (*string, bool)

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

func (*UpdateNumberRequest) GetTags 

func (o *UpdateNumberRequest) GetTags() []string

GetTags returns the Tags field value if set, zero value otherwise.

func (*UpdateNumberRequest) GetTagsOk 

func (o *UpdateNumberRequest) GetTagsOk() ([]string, bool)

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

func (*UpdateNumberRequest) HasReplyCallbackUrl 

func (o *UpdateNumberRequest) HasReplyCallbackUrl() bool

HasReplyCallbackUrl returns a boolean if a field has been set.

func (*UpdateNumberRequest) HasTags 

func (o *UpdateNumberRequest) HasTags() bool

HasTags returns a boolean if a field has been set.

func (UpdateNumberRequest) MarshalJSON 

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

func (*UpdateNumberRequest) SetReplyCallbackUrl 

func (o *UpdateNumberRequest) SetReplyCallbackUrl(v string)

SetReplyCallbackUrl gets a reference to the given string and assigns it to the ReplyCallbackUrl field.

func (*UpdateNumberRequest) SetTags 

func (o *UpdateNumberRequest) SetTags(v []string)

SetTags gets a reference to the given []string and assigns it to the Tags field.

func (UpdateNumberRequest) ToMap 

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

type VirtualNumber 

type VirtualNumber struct {
	// The Virtual Number assigned to your account.
	VirtualNumber *string `json:"virtualNumber,omitempty"`
	// The URL that replies to the Virtual Number will be posted to.
	ReplyCallbackUrl *string `json:"replyCallbackUrl,omitempty"`
	// Any customisable tags assigned to the Virtual Number.
	Tags []string `json:"tags,omitempty"`
	// The last time the Virtual Number was used to send a message.
	LastUse *time.Time `json:"lastUse,omitempty"`
}

VirtualNumber struct for VirtualNumber

func NewVirtualNumber 

func NewVirtualNumber() *VirtualNumber

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

func NewVirtualNumberWithDefaults 

func NewVirtualNumberWithDefaults() *VirtualNumber

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

func (*VirtualNumber) GetLastUse 

func (o *VirtualNumber) GetLastUse() time.Time

GetLastUse returns the LastUse field value if set, zero value otherwise.

func (*VirtualNumber) GetLastUseOk 

func (o *VirtualNumber) GetLastUseOk() (*time.Time, bool)

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

func (*VirtualNumber) GetReplyCallbackUrl 

func (o *VirtualNumber) GetReplyCallbackUrl() string

GetReplyCallbackUrl returns the ReplyCallbackUrl field value if set, zero value otherwise.

func (*VirtualNumber) GetReplyCallbackUrlOk 

func (o *VirtualNumber) GetReplyCallbackUrlOk() (*string, bool)

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

func (*VirtualNumber) GetTags 

func (o *VirtualNumber) GetTags() []string

GetTags returns the Tags field value if set, zero value otherwise.

func (*VirtualNumber) GetTagsOk 

func (o *VirtualNumber) GetTagsOk() ([]string, bool)

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

func (*VirtualNumber) GetVirtualNumber 

func (o *VirtualNumber) GetVirtualNumber() string

GetVirtualNumber returns the VirtualNumber field value if set, zero value otherwise.

func (*VirtualNumber) GetVirtualNumberOk 

func (o *VirtualNumber) GetVirtualNumberOk() (*string, bool)

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

func (*VirtualNumber) HasLastUse 

func (o *VirtualNumber) HasLastUse() bool

HasLastUse returns a boolean if a field has been set.

func (*VirtualNumber) HasReplyCallbackUrl 

func (o *VirtualNumber) HasReplyCallbackUrl() bool

HasReplyCallbackUrl returns a boolean if a field has been set.

func (*VirtualNumber) HasTags 

func (o *VirtualNumber) HasTags() bool

HasTags returns a boolean if a field has been set.

func (*VirtualNumber) HasVirtualNumber 

func (o *VirtualNumber) HasVirtualNumber() bool

HasVirtualNumber returns a boolean if a field has been set.

func (VirtualNumber) MarshalJSON 

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

func (*VirtualNumber) SetLastUse 

func (o *VirtualNumber) SetLastUse(v time.Time)

SetLastUse gets a reference to the given time.Time and assigns it to the LastUse field.

func (*VirtualNumber) SetReplyCallbackUrl 

func (o *VirtualNumber) SetReplyCallbackUrl(v string)

SetReplyCallbackUrl gets a reference to the given string and assigns it to the ReplyCallbackUrl field.

func (*VirtualNumber) SetTags 

func (o *VirtualNumber) SetTags(v []string)

SetTags gets a reference to the given []string and assigns it to the Tags field.

func (*VirtualNumber) SetVirtualNumber 

func (o *VirtualNumber) SetVirtualNumber(v string)

SetVirtualNumber gets a reference to the given string and assigns it to the VirtualNumber field.

func (VirtualNumber) ToMap 

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

type VirtualNumbersAPIService 

type VirtualNumbersAPIService service

VirtualNumbersAPIService VirtualNumbersAPI service

func (*VirtualNumbersAPIService) AssignNumber 

func (a *VirtualNumbersAPIService) AssignNumber(ctx context.Context, authorization string) ApiAssignNumberRequest

AssignNumber assign a virtual number

When a recipient receives your message, you can choose whether they'll see a Virtual Number or senderName (paid plans only) in the **from** field. If you want to use a Virtual Number, use this endpoint to assign one. Free Trial users can assign one Virtual Number, and those on a paid plan can assign up to 100.

Virtual Numbers that have not sent a message in 30 days (Free Trial) or sent/received a message in 18 months (paid plans) will be automatically unassigned from your account. You can check the **lastUse** date of your Virtual Number at any time using GET /virtual-numbers/{virtual-number}.

Note that Virtual Numbers used in v2 of the Messaging API cannot be used to send messages in v3. Please assign a new Virtual Number instead. 

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

func (*VirtualNumbersAPIService) AssignNumberExecute 

func (a *VirtualNumbersAPIService) AssignNumberExecute(r ApiAssignNumberRequest) (*VirtualNumber, *http.Response, error)

Execute executes the request 

@return VirtualNumber

func (*VirtualNumbersAPIService) DeleteNumber 

func (a *VirtualNumbersAPIService) DeleteNumber(ctx context.Context, virtualNumber string, authorization string) ApiDeleteNumberRequest

DeleteNumber delete a virtual number

Use **virtual-number** to remove a Virtual Number that's been assigned to your account. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param virtualNumber Write the Virtual Number here, using national format (e.g. 0412345678).
@return ApiDeleteNumberRequest

func (*VirtualNumbersAPIService) DeleteNumberExecute 

func (a *VirtualNumbersAPIService) DeleteNumberExecute(r ApiDeleteNumberRequest) (*http.Response, error)

Execute executes the request

func (*VirtualNumbersAPIService) GetNumbers 

func (a *VirtualNumbersAPIService) GetNumbers(ctx context.Context, authorization string) ApiGetNumbersRequest

GetNumbers fetch all virtual numbers

Use this endpoint to fetch all Virtual Numbers currently assigned to your account. 

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

func (*VirtualNumbersAPIService) GetNumbersExecute 

func (a *VirtualNumbersAPIService) GetNumbersExecute(r ApiGetNumbersRequest) (*GetNumbers200Response, *http.Response, error)

Execute executes the request 

@return GetNumbers200Response

func (*VirtualNumbersAPIService) GetRecipientOptouts 

func (a *VirtualNumbersAPIService) GetRecipientOptouts(ctx context.Context, virtualNumber string, authorization string) ApiGetRecipientOptoutsRequest

GetRecipientOptouts Get recipient optouts list

Use this endpoint to fetch any mobile number(s) that have opted out of receiving messages from a Virtual Number assigned to your account.

Recipients can opt out at any time by sending a message with industry standard keywords such as STOP, STOPALL, UNSUBSCRIBE, QUIT, END and CANCEL. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param virtualNumber Write the Virtual Number here, using national format (e.g. 0412345678).
@return ApiGetRecipientOptoutsRequest

func (*VirtualNumbersAPIService) GetRecipientOptoutsExecute 

func (a *VirtualNumbersAPIService) GetRecipientOptoutsExecute(r ApiGetRecipientOptoutsRequest) (*GetRecipientOptouts200Response, *http.Response, error)

Execute executes the request 

@return GetRecipientOptouts200Response

func (*VirtualNumbersAPIService) GetVirtualNumber 

func (a *VirtualNumbersAPIService) GetVirtualNumber(ctx context.Context, virtualNumber string, authorization string) ApiGetVirtualNumberRequest

GetVirtualNumber fetch a virtual number

Fetch the tags, replyCallbackUrl and lastUse date for a Virtual Number. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param virtualNumber Write the Virtual Number here, using national format (e.g. 0412345678).
@return ApiGetVirtualNumberRequest

func (*VirtualNumbersAPIService) GetVirtualNumberExecute 

func (a *VirtualNumbersAPIService) GetVirtualNumberExecute(r ApiGetVirtualNumberRequest) (*VirtualNumber, *http.Response, error)

Execute executes the request 

@return VirtualNumber

func (*VirtualNumbersAPIService) UpdateNumber 

func (a *VirtualNumbersAPIService) UpdateNumber(ctx context.Context, virtualNumber string, authorization string) ApiUpdateNumberRequest

UpdateNumber update a virtual number

Use **virtual-number** to update the tags and/or replyCallbackUrl of a Virtual Number.

This request body will override the original POST/ virtual-numbers call. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param virtualNumber Write the Virtual Number here, using national format (e.g. 0412345678).
@return ApiUpdateNumberRequest

func (*VirtualNumbersAPIService) UpdateNumberExecute 

func (a *VirtualNumbersAPIService) UpdateNumberExecute(r ApiUpdateNumberRequest) (*VirtualNumber, *http.Response, error)

Execute executes the request 

@return VirtualNumber

Source Files

View all Source files

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.