openapi

package
v0.9.0 Latest Latest
Warning

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

 Go to latest Published: Jun 2, 2021 License: MIT Imports: 6 Imported by: 1

README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.16.1
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

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

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://supersim.twilio.com

Class Method HTTP request Description
DefaultApi CreateCommand Post /v1/Commands
DefaultApi CreateFleet Post /v1/Fleets
DefaultApi CreateNetworkAccessProfile Post /v1/NetworkAccessProfiles
DefaultApi CreateNetworkAccessProfileNetwork Post /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks
DefaultApi CreateSim Post /v1/Sims
DefaultApi CreateSmsCommand Post /v1/SmsCommands
DefaultApi DeleteNetworkAccessProfileNetwork Delete /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}
DefaultApi FetchCommand Get /v1/Commands/{Sid}
DefaultApi FetchFleet Get /v1/Fleets/{Sid}
DefaultApi FetchNetwork Get /v1/Networks/{Sid}
DefaultApi FetchNetworkAccessProfile Get /v1/NetworkAccessProfiles/{Sid}
DefaultApi FetchNetworkAccessProfileNetwork Get /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}
DefaultApi FetchSim Get /v1/Sims/{Sid}
DefaultApi FetchSmsCommand Get /v1/SmsCommands/{Sid}
DefaultApi ListCommand Get /v1/Commands
DefaultApi ListFleet Get /v1/Fleets
DefaultApi ListNetwork Get /v1/Networks
DefaultApi ListNetworkAccessProfile Get /v1/NetworkAccessProfiles
DefaultApi ListNetworkAccessProfileNetwork Get /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks
DefaultApi ListSim Get /v1/Sims
DefaultApi ListSmsCommand Get /v1/SmsCommands
DefaultApi ListUsageRecord Get /v1/UsageRecords
DefaultApi UpdateFleet Post /v1/Fleets/{Sid}
DefaultApi UpdateNetworkAccessProfile Post /v1/NetworkAccessProfiles/{Sid}
DefaultApi UpdateSim Post /v1/Sims/{Sid}

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

support@twilio.com

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateCommandParams 

type CreateCommandParams struct {
	// The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.
	CallbackMethod *string `json:"CallbackMethod,omitempty"`
	// The URL we should call using the `callback_method` after we have sent the command.
	CallbackUrl *string `json:"CallbackUrl,omitempty"`
	// The message body of the command.
	Command *string `json:"Command,omitempty"`
	// The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource) to send the Command to.
	Sim *string `json:"Sim,omitempty"`
}

Optional parameters for the method 'CreateCommand'

func (*CreateCommandParams) SetCallbackMethod 

func (params *CreateCommandParams) SetCallbackMethod(CallbackMethod string) *CreateCommandParams

func (*CreateCommandParams) SetCallbackUrl 

func (params *CreateCommandParams) SetCallbackUrl(CallbackUrl string) *CreateCommandParams

func (*CreateCommandParams) SetCommand 

func (params *CreateCommandParams) SetCommand(Command string) *CreateCommandParams

func (*CreateCommandParams) SetSim 

func (params *CreateCommandParams) SetSim(Sim string) *CreateCommandParams

type CreateFleetParams 

type CreateFleetParams struct {
	// Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to `true`.
	CommandsEnabled *bool `json:"CommandsEnabled,omitempty"`
	// A string representing the HTTP method to use when making a request to `commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
	CommandsMethod *string `json:"CommandsMethod,omitempty"`
	// The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
	CommandsUrl *string `json:"CommandsUrl,omitempty"`
	// Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to `true`.
	DataEnabled *bool `json:"DataEnabled,omitempty"`
	// The total data usage (download and upload combined) in Megabytes that each Sim resource assigned to the Fleet resource can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000).
	DataLimit *int32 `json:"DataLimit,omitempty"`
	// The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to.
	NetworkAccessProfile *string `json:"NetworkAccessProfile,omitempty"`
	// Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to `true`.
	SmsCommandsEnabled *bool `json:"SmsCommandsEnabled,omitempty"`
	// A string representing the HTTP method to use when making a request to `sms_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
	SmsCommandsMethod *string `json:"SmsCommandsMethod,omitempty"`
	// The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
	SmsCommandsUrl *string `json:"SmsCommandsUrl,omitempty"`
	// An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'CreateFleet'

func (*CreateFleetParams) SetCommandsEnabled 

func (params *CreateFleetParams) SetCommandsEnabled(CommandsEnabled bool) *CreateFleetParams

func (*CreateFleetParams) SetCommandsMethod 

func (params *CreateFleetParams) SetCommandsMethod(CommandsMethod string) *CreateFleetParams

func (*CreateFleetParams) SetCommandsUrl 

func (params *CreateFleetParams) SetCommandsUrl(CommandsUrl string) *CreateFleetParams

func (*CreateFleetParams) SetDataEnabled 

func (params *CreateFleetParams) SetDataEnabled(DataEnabled bool) *CreateFleetParams

func (*CreateFleetParams) SetDataLimit 

func (params *CreateFleetParams) SetDataLimit(DataLimit int32) *CreateFleetParams

func (*CreateFleetParams) SetNetworkAccessProfile 

func (params *CreateFleetParams) SetNetworkAccessProfile(NetworkAccessProfile string) *CreateFleetParams

func (*CreateFleetParams) SetSmsCommandsEnabled 

func (params *CreateFleetParams) SetSmsCommandsEnabled(SmsCommandsEnabled bool) *CreateFleetParams

func (*CreateFleetParams) SetSmsCommandsMethod 

func (params *CreateFleetParams) SetSmsCommandsMethod(SmsCommandsMethod string) *CreateFleetParams

func (*CreateFleetParams) SetSmsCommandsUrl 

func (params *CreateFleetParams) SetSmsCommandsUrl(SmsCommandsUrl string) *CreateFleetParams

func (*CreateFleetParams) SetUniqueName 

func (params *CreateFleetParams) SetUniqueName(UniqueName string) *CreateFleetParams

type CreateNetworkAccessProfileNetworkParams 

type CreateNetworkAccessProfileNetworkParams struct {
	// The SID of the Network resource to be added to the Network Access Profile resource.
	Network *string `json:"Network,omitempty"`
}

Optional parameters for the method 'CreateNetworkAccessProfileNetwork'

func (*CreateNetworkAccessProfileNetworkParams) SetNetwork 

func (params *CreateNetworkAccessProfileNetworkParams) SetNetwork(Network string) *CreateNetworkAccessProfileNetworkParams

type CreateNetworkAccessProfileParams 

type CreateNetworkAccessProfileParams struct {
	// List of Network SIDs that this Network Access Profile will allow connections to.
	Networks *[]string `json:"Networks,omitempty"`
	// An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'CreateNetworkAccessProfile'

func (*CreateNetworkAccessProfileParams) SetNetworks 

func (params *CreateNetworkAccessProfileParams) SetNetworks(Networks []string) *CreateNetworkAccessProfileParams

func (*CreateNetworkAccessProfileParams) SetUniqueName 

func (params *CreateNetworkAccessProfileParams) SetUniqueName(UniqueName string) *CreateNetworkAccessProfileParams

type CreateSimParams 

type CreateSimParams struct {
	// The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) of the Super SIM to be added to your Account.
	Iccid *string `json:"Iccid,omitempty"`
	// The 10-digit code required to claim the Super SIM for your Account.
	RegistrationCode *string `json:"RegistrationCode,omitempty"`
}

Optional parameters for the method 'CreateSim'

func (*CreateSimParams) SetIccid 

func (params *CreateSimParams) SetIccid(Iccid string) *CreateSimParams

func (*CreateSimParams) SetRegistrationCode 

func (params *CreateSimParams) SetRegistrationCode(RegistrationCode string) *CreateSimParams

type CreateSmsCommandParams 

type CreateSmsCommandParams struct {
	// The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.
	CallbackMethod *string `json:"CallbackMethod,omitempty"`
	// The URL we should call using the `callback_method` after we have sent the command.
	CallbackUrl *string `json:"CallbackUrl,omitempty"`
	// The message body of the SMS Command.
	Payload *string `json:"Payload,omitempty"`
	// The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource) to send the SMS Command to.
	Sim *string `json:"Sim,omitempty"`
}

Optional parameters for the method 'CreateSmsCommand'

func (*CreateSmsCommandParams) SetCallbackMethod 

func (params *CreateSmsCommandParams) SetCallbackMethod(CallbackMethod string) *CreateSmsCommandParams

func (*CreateSmsCommandParams) SetCallbackUrl 

func (params *CreateSmsCommandParams) SetCallbackUrl(CallbackUrl string) *CreateSmsCommandParams

func (*CreateSmsCommandParams) SetPayload 

func (params *CreateSmsCommandParams) SetPayload(Payload string) *CreateSmsCommandParams

func (*CreateSmsCommandParams) SetSim 

func (params *CreateSmsCommandParams) SetSim(Sim string) *CreateSmsCommandParams

type DefaultApiService 

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

func NewDefaultApiService 

func NewDefaultApiService(requestHandler *twilio.RequestHandler) *DefaultApiService

func NewDefaultApiServiceWithClient added in v0.9.0 

func NewDefaultApiServiceWithClient(client twilio.BaseClient) *DefaultApiService

func (*DefaultApiService) CreateCommand 

func (c *DefaultApiService) CreateCommand(params *CreateCommandParams) (*SupersimV1Command, error)

Send a Command to a Sim.

func (*DefaultApiService) CreateFleet 

func (c *DefaultApiService) CreateFleet(params *CreateFleetParams) (*SupersimV1Fleet, error)

Create a Fleet

func (*DefaultApiService) CreateNetworkAccessProfile 

func (c *DefaultApiService) CreateNetworkAccessProfile(params *CreateNetworkAccessProfileParams) (*SupersimV1NetworkAccessProfile, error)

Create a new Network Access Profile

func (*DefaultApiService) CreateNetworkAccessProfileNetwork 

func (c *DefaultApiService) CreateNetworkAccessProfileNetwork(NetworkAccessProfileSid string, params *CreateNetworkAccessProfileNetworkParams) (*SupersimV1NetworkAccessProfileNetworkAccessProfileNetwork, error)

Add a Network resource to the Network Access Profile resource.

func (*DefaultApiService) CreateSim 

func (c *DefaultApiService) CreateSim(params *CreateSimParams) (*SupersimV1Sim, error)

Register a Super SIM to your Account

func (*DefaultApiService) CreateSmsCommand 

func (c *DefaultApiService) CreateSmsCommand(params *CreateSmsCommandParams) (*SupersimV1SmsCommand, error)

Send SMS Command to a Sim.

func (*DefaultApiService) DeleteNetworkAccessProfileNetwork 

func (c *DefaultApiService) DeleteNetworkAccessProfileNetwork(NetworkAccessProfileSid string, Sid string) error

Remove a Network resource from the Network Access Profile resource's.

func (*DefaultApiService) FetchCommand 

func (c *DefaultApiService) FetchCommand(Sid string) (*SupersimV1Command, error)

Fetch a Command instance from your account.

func (*DefaultApiService) FetchFleet 

func (c *DefaultApiService) FetchFleet(Sid string) (*SupersimV1Fleet, error)

Fetch a Fleet instance from your account.

func (*DefaultApiService) FetchNetwork 

func (c *DefaultApiService) FetchNetwork(Sid string) (*SupersimV1Network, error)

Fetch a Network resource.

func (*DefaultApiService) FetchNetworkAccessProfile 

func (c *DefaultApiService) FetchNetworkAccessProfile(Sid string) (*SupersimV1NetworkAccessProfile, error)

Fetch a Network Access Profile instance from your account.

func (*DefaultApiService) FetchNetworkAccessProfileNetwork 

func (c *DefaultApiService) FetchNetworkAccessProfileNetwork(NetworkAccessProfileSid string, Sid string) (*SupersimV1NetworkAccessProfileNetworkAccessProfileNetwork, error)

Fetch a Network Access Profile resource's Network resource.

func (*DefaultApiService) FetchSim 

func (c *DefaultApiService) FetchSim(Sid string) (*SupersimV1Sim, error)

Fetch a Super SIM instance from your account.

func (*DefaultApiService) FetchSmsCommand 

func (c *DefaultApiService) FetchSmsCommand(Sid string) (*SupersimV1SmsCommand, error)

Fetch SMS Command instance from your account.

func (*DefaultApiService) ListCommand 

func (c *DefaultApiService) ListCommand(params *ListCommandParams) (*ListCommandResponse, error)

Retrieve a list of Commands from your account.

func (*DefaultApiService) ListFleet 

func (c *DefaultApiService) ListFleet(params *ListFleetParams) (*ListFleetResponse, error)

Retrieve a list of Fleets from your account.

func (*DefaultApiService) ListNetwork 

func (c *DefaultApiService) ListNetwork(params *ListNetworkParams) (*ListNetworkResponse, error)

Retrieve a list of Network resources.

func (*DefaultApiService) ListNetworkAccessProfile 

func (c *DefaultApiService) ListNetworkAccessProfile(params *ListNetworkAccessProfileParams) (*ListNetworkAccessProfileResponse, error)

Retrieve a list of Network Access Profiles from your account.

func (*DefaultApiService) ListNetworkAccessProfileNetwork 

func (c *DefaultApiService) ListNetworkAccessProfileNetwork(NetworkAccessProfileSid string, params *ListNetworkAccessProfileNetworkParams) (*ListNetworkAccessProfileNetworkResponse, error)

Retrieve a list of Network Access Profile resource's Network resource.

func (*DefaultApiService) ListSim 

func (c *DefaultApiService) ListSim(params *ListSimParams) (*ListSimResponse, error)

Retrieve a list of Super SIMs from your account.

func (*DefaultApiService) ListSmsCommand 

func (c *DefaultApiService) ListSmsCommand(params *ListSmsCommandParams) (*ListSmsCommandResponse, error)

Retrieve a list of SMS Commands from your account.

func (*DefaultApiService) ListUsageRecord 

func (c *DefaultApiService) ListUsageRecord(params *ListUsageRecordParams) (*ListUsageRecordResponse, error)

List UsageRecords

func (*DefaultApiService) UpdateFleet 

func (c *DefaultApiService) UpdateFleet(Sid string, params *UpdateFleetParams) (*SupersimV1Fleet, error)

Updates the given properties of a Super SIM Fleet instance from your account.

func (*DefaultApiService) UpdateNetworkAccessProfile 

func (c *DefaultApiService) UpdateNetworkAccessProfile(Sid string, params *UpdateNetworkAccessProfileParams) (*SupersimV1NetworkAccessProfile, error)

Updates the given properties of a Network Access Profile in your account.

func (*DefaultApiService) UpdateSim 

func (c *DefaultApiService) UpdateSim(Sid string, params *UpdateSimParams) (*SupersimV1Sim, error)

Updates the given properties of a Super SIM instance from your account.

type ListCommandParams 

type ListCommandParams struct {
	// The SID or unique name of the Sim that Command was sent to or from.
	Sim *string `json:"Sim,omitempty"`
	// The status of the Command. Can be: `queued`, `sent`, `delivered`, `received` or `failed`. See the [Command Status Values](https://www.twilio.com/docs/wireless/api/command-resource#status-values) for a description of each.
	Status *string `json:"Status,omitempty"`
	// The direction of the Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
	Direction *string `json:"Direction,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListCommand'

func (*ListCommandParams) SetDirection 

func (params *ListCommandParams) SetDirection(Direction string) *ListCommandParams

func (*ListCommandParams) SetPageSize 

func (params *ListCommandParams) SetPageSize(PageSize int32) *ListCommandParams

func (*ListCommandParams) SetSim 

func (params *ListCommandParams) SetSim(Sim string) *ListCommandParams

func (*ListCommandParams) SetStatus 

func (params *ListCommandParams) SetStatus(Status string) *ListCommandParams

type ListCommandResponse 

type ListCommandResponse struct {
	Commands []SupersimV1Command     `json:"commands,omitempty"`
	Meta     ListCommandResponseMeta `json:"meta,omitempty"`
}

ListCommandResponse struct for ListCommandResponse

type ListCommandResponseMeta 

type ListCommandResponseMeta struct {
	FirstPageUrl    string `json:"first_page_url,omitempty"`
	Key             string `json:"key,omitempty"`
	NextPageUrl     string `json:"next_page_url,omitempty"`
	Page            int32  `json:"page,omitempty"`
	PageSize        int32  `json:"page_size,omitempty"`
	PreviousPageUrl string `json:"previous_page_url,omitempty"`
	Url             string `json:"url,omitempty"`
}

ListCommandResponseMeta struct for ListCommandResponseMeta

type ListFleetParams 

type ListFleetParams struct {
	// The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.
	NetworkAccessProfile *string `json:"NetworkAccessProfile,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListFleet'

func (*ListFleetParams) SetNetworkAccessProfile 

func (params *ListFleetParams) SetNetworkAccessProfile(NetworkAccessProfile string) *ListFleetParams

func (*ListFleetParams) SetPageSize 

func (params *ListFleetParams) SetPageSize(PageSize int32) *ListFleetParams

type ListFleetResponse 

type ListFleetResponse struct {
	Fleets []SupersimV1Fleet       `json:"fleets,omitempty"`
	Meta   ListCommandResponseMeta `json:"meta,omitempty"`
}

ListFleetResponse struct for ListFleetResponse

type ListNetworkAccessProfileNetworkParams 

type ListNetworkAccessProfileNetworkParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListNetworkAccessProfileNetwork'

func (*ListNetworkAccessProfileNetworkParams) SetPageSize 

func (params *ListNetworkAccessProfileNetworkParams) SetPageSize(PageSize int32) *ListNetworkAccessProfileNetworkParams

type ListNetworkAccessProfileNetworkResponse 

type ListNetworkAccessProfileNetworkResponse struct {
	Meta     ListCommandResponseMeta                                     `json:"meta,omitempty"`
	Networks []SupersimV1NetworkAccessProfileNetworkAccessProfileNetwork `json:"networks,omitempty"`
}

ListNetworkAccessProfileNetworkResponse struct for ListNetworkAccessProfileNetworkResponse

type ListNetworkAccessProfileParams 

type ListNetworkAccessProfileParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListNetworkAccessProfile'

func (*ListNetworkAccessProfileParams) SetPageSize 

func (params *ListNetworkAccessProfileParams) SetPageSize(PageSize int32) *ListNetworkAccessProfileParams

type ListNetworkAccessProfileResponse 

type ListNetworkAccessProfileResponse struct {
	Meta                  ListCommandResponseMeta          `json:"meta,omitempty"`
	NetworkAccessProfiles []SupersimV1NetworkAccessProfile `json:"network_access_profiles,omitempty"`
}

ListNetworkAccessProfileResponse struct for ListNetworkAccessProfileResponse

type ListNetworkParams 

type ListNetworkParams struct {
	// The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resources to read.
	IsoCountry *string `json:"IsoCountry,omitempty"`
	// The 'mobile country code' of a country. Network resources with this `mcc` in their `identifiers` will be read.
	Mcc *string `json:"Mcc,omitempty"`
	// The 'mobile network code' of a mobile operator network. Network resources with this `mnc` in their `identifiers` will be read.
	Mnc *string `json:"Mnc,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListNetwork'

func (*ListNetworkParams) SetIsoCountry 

func (params *ListNetworkParams) SetIsoCountry(IsoCountry string) *ListNetworkParams

func (*ListNetworkParams) SetMcc 

func (params *ListNetworkParams) SetMcc(Mcc string) *ListNetworkParams

func (*ListNetworkParams) SetMnc 

func (params *ListNetworkParams) SetMnc(Mnc string) *ListNetworkParams

func (*ListNetworkParams) SetPageSize 

func (params *ListNetworkParams) SetPageSize(PageSize int32) *ListNetworkParams

type ListNetworkResponse 

type ListNetworkResponse struct {
	Meta     ListCommandResponseMeta `json:"meta,omitempty"`
	Networks []SupersimV1Network     `json:"networks,omitempty"`
}

ListNetworkResponse struct for ListNetworkResponse

type ListSimParams 

type ListSimParams struct {
	// The status of the Sim resources to read. Can be `new`, `ready`, `active`, `inactive`, or `scheduled`.
	Status *string `json:"Status,omitempty"`
	// The SID or unique name of the Fleet to which a list of Sims are assigned.
	Fleet *string `json:"Fleet,omitempty"`
	// The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.
	Iccid *string `json:"Iccid,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListSim'

func (*ListSimParams) SetFleet 

func (params *ListSimParams) SetFleet(Fleet string) *ListSimParams

func (*ListSimParams) SetIccid 

func (params *ListSimParams) SetIccid(Iccid string) *ListSimParams

func (*ListSimParams) SetPageSize 

func (params *ListSimParams) SetPageSize(PageSize int32) *ListSimParams

func (*ListSimParams) SetStatus 

func (params *ListSimParams) SetStatus(Status string) *ListSimParams

type ListSimResponse 

type ListSimResponse struct {
	Meta ListCommandResponseMeta `json:"meta,omitempty"`
	Sims []SupersimV1Sim         `json:"sims,omitempty"`
}

ListSimResponse struct for ListSimResponse

type ListSmsCommandParams 

type ListSmsCommandParams struct {
	// The SID or unique name of the Sim resource that SMS Command was sent to or from.
	Sim *string `json:"Sim,omitempty"`
	// The status of the SMS Command. Can be: `queued`, `sent`, `delivered`, `received` or `failed`. See the [SMS Command Status Values](https://www.twilio.com/docs/wireless/api/smscommand-resource#status-values) for a description of each.
	Status *string `json:"Status,omitempty"`
	// The direction of the SMS Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
	Direction *string `json:"Direction,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListSmsCommand'

func (*ListSmsCommandParams) SetDirection 

func (params *ListSmsCommandParams) SetDirection(Direction string) *ListSmsCommandParams

func (*ListSmsCommandParams) SetPageSize 

func (params *ListSmsCommandParams) SetPageSize(PageSize int32) *ListSmsCommandParams

func (*ListSmsCommandParams) SetSim 

func (params *ListSmsCommandParams) SetSim(Sim string) *ListSmsCommandParams

func (*ListSmsCommandParams) SetStatus 

func (params *ListSmsCommandParams) SetStatus(Status string) *ListSmsCommandParams

type ListSmsCommandResponse 

type ListSmsCommandResponse struct {
	Meta        ListCommandResponseMeta `json:"meta,omitempty"`
	SmsCommands []SupersimV1SmsCommand  `json:"sms_commands,omitempty"`
}

ListSmsCommandResponse struct for ListSmsCommandResponse

type ListUsageRecordParams 

type ListUsageRecordParams struct {
	// SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
	Sim *string `json:"Sim,omitempty"`
	// SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
	Fleet *string `json:"Fleet,omitempty"`
	// SID of a Network resource. Only show UsageRecords representing usage on this network.
	Network *string `json:"Network,omitempty"`
	// Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
	IsoCountry *string `json:"IsoCountry,omitempty"`
	// Dimension over which to aggregate usage records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not aggregate across any of these dimensions, UsageRecords will be aggregated into the time buckets described by the `Granularity` parameter.
	Group *string `json:"Group,omitempty"`
	// Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.
	Granularity *string `json:"Granularity,omitempty"`
	// Only include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.
	StartTime *time.Time `json:"StartTime,omitempty"`
	// Only include usage that occurred before this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.
	EndTime *time.Time `json:"EndTime,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListUsageRecord'

func (*ListUsageRecordParams) SetEndTime 

func (params *ListUsageRecordParams) SetEndTime(EndTime time.Time) *ListUsageRecordParams

func (*ListUsageRecordParams) SetFleet 

func (params *ListUsageRecordParams) SetFleet(Fleet string) *ListUsageRecordParams

func (*ListUsageRecordParams) SetGranularity 

func (params *ListUsageRecordParams) SetGranularity(Granularity string) *ListUsageRecordParams

func (*ListUsageRecordParams) SetGroup 

func (params *ListUsageRecordParams) SetGroup(Group string) *ListUsageRecordParams

func (*ListUsageRecordParams) SetIsoCountry 

func (params *ListUsageRecordParams) SetIsoCountry(IsoCountry string) *ListUsageRecordParams

func (*ListUsageRecordParams) SetNetwork 

func (params *ListUsageRecordParams) SetNetwork(Network string) *ListUsageRecordParams

func (*ListUsageRecordParams) SetPageSize 

func (params *ListUsageRecordParams) SetPageSize(PageSize int32) *ListUsageRecordParams

func (*ListUsageRecordParams) SetSim 

func (params *ListUsageRecordParams) SetSim(Sim string) *ListUsageRecordParams

func (*ListUsageRecordParams) SetStartTime 

func (params *ListUsageRecordParams) SetStartTime(StartTime time.Time) *ListUsageRecordParams

type ListUsageRecordResponse 

type ListUsageRecordResponse struct {
	Meta         ListCommandResponseMeta `json:"meta,omitempty"`
	UsageRecords []SupersimV1UsageRecord `json:"usage_records,omitempty"`
}

ListUsageRecordResponse struct for ListUsageRecordResponse

type SupersimV1Command 

type SupersimV1Command struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The message body of the command sent to or from the SIM
	Command *string `json:"command,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The direction of the Command
	Direction *string `json:"direction,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the SIM that this Command was sent to or from
	SimSid *string `json:"sim_sid,omitempty"`
	// The status of the Command
	Status *string `json:"status,omitempty"`
	// The absolute URL of the Command resource
	Url *string `json:"url,omitempty"`
}

SupersimV1Command struct for SupersimV1Command

type SupersimV1Fleet 

type SupersimV1Fleet struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands
	CommandsEnabled *bool `json:"commands_enabled,omitempty"`
	// A string representing the HTTP method to use when making a request to `commands_url`
	CommandsMethod *string `json:"commands_method,omitempty"`
	// The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the Commands number
	CommandsUrl *string `json:"commands_url,omitempty"`
	// Defines whether SIMs in the Fleet are capable of using data connectivity
	DataEnabled *bool `json:"data_enabled,omitempty"`
	// The total data usage (download and upload combined) in Megabytes that each Sim resource assigned to the Fleet resource can consume
	DataLimit *int32 `json:"data_limit,omitempty"`
	// The model by which a SIM is metered and billed
	DataMetering *string `json:"data_metering,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The SID of the Network Access Profile of the Fleet
	NetworkAccessProfileSid *string `json:"network_access_profile_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands
	SmsCommandsEnabled *bool `json:"sms_commands_enabled,omitempty"`
	// A string representing the HTTP method to use when making a request to `sms_commands_url`
	SmsCommandsMethod *string `json:"sms_commands_method,omitempty"`
	// The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number
	SmsCommandsUrl *string `json:"sms_commands_url,omitempty"`
	// An application-defined string that uniquely identifies the resource
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the Fleet resource
	Url *string `json:"url,omitempty"`
}

SupersimV1Fleet struct for SupersimV1Fleet

type SupersimV1Network 

type SupersimV1Network struct {
	// A human readable identifier of this resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The MCC/MNCs included in the Network resource
	Identifiers *[]map[string]interface{} `json:"identifiers,omitempty"`
	// The ISO country code of the Network resource
	IsoCountry *string `json:"iso_country,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Network resource
	Url *string `json:"url,omitempty"`
}

SupersimV1Network struct for SupersimV1Network

type SupersimV1NetworkAccessProfile 

type SupersimV1NetworkAccessProfile struct {
	// The SID of the Account that the Network Access Profile belongs to
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time              `json:"date_updated,omitempty"`
	Links       *map[string]interface{} `json:"links,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the resource
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the resource
	Url *string `json:"url,omitempty"`
}

SupersimV1NetworkAccessProfile struct for SupersimV1NetworkAccessProfile

type SupersimV1NetworkAccessProfileNetworkAccessProfileNetwork 

type SupersimV1NetworkAccessProfileNetworkAccessProfileNetwork struct {
	// A human readable identifier of this resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The MCC/MNCs included in the resource
	Identifiers *[]map[string]interface{} `json:"identifiers,omitempty"`
	// The ISO country code of the Network resource
	IsoCountry *string `json:"iso_country,omitempty"`
	// The unique string that identifies the Network Access Profile resource
	NetworkAccessProfileSid *string `json:"network_access_profile_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the resource
	Url *string `json:"url,omitempty"`
}

SupersimV1NetworkAccessProfileNetworkAccessProfileNetwork struct for SupersimV1NetworkAccessProfileNetworkAccessProfileNetwork

type SupersimV1Sim 

type SupersimV1Sim struct {
	// The SID of the Account that the Super SIM belongs to
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The unique ID of the Fleet configured for this SIM
	FleetSid *string `json:"fleet_sid,omitempty"`
	// The ICCID associated with the SIM
	Iccid *string `json:"iccid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The status of the Super SIM
	Status *string `json:"status,omitempty"`
	// An application-defined string that uniquely identifies the resource
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the Sim Resource
	Url *string `json:"url,omitempty"`
}

SupersimV1Sim struct for SupersimV1Sim

type SupersimV1SmsCommand 

type SupersimV1SmsCommand struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The direction of the SMS Command
	Direction *string `json:"direction,omitempty"`
	// The message body of the SMS Command sent to or from the SIM
	Payload *string `json:"payload,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the SIM that this SMS Command was sent to or from
	SimSid *string `json:"sim_sid,omitempty"`
	// The status of the SMS Command
	Status *string `json:"status,omitempty"`
	// The absolute URL of the SMS Command resource
	Url *string `json:"url,omitempty"`
}

SupersimV1SmsCommand struct for SupersimV1SmsCommand

type SupersimV1UsageRecord 

type SupersimV1UsageRecord struct {
	// The SID of the Account that incurred the usage.
	AccountSid *string `json:"account_sid,omitempty"`
	// Total data downloaded in bytes, aggregated by the query parameters.
	DataDownload *int32 `json:"data_download,omitempty"`
	// Total of data_upload and data_download.
	DataTotal *int32 `json:"data_total,omitempty"`
	// Total data uploaded in bytes, aggregated by the query parameters.
	DataUpload *int32 `json:"data_upload,omitempty"`
	// SID of the Fleet resource on which the usage occurred.
	FleetSid *string `json:"fleet_sid,omitempty"`
	// Alpha-2 ISO Country Code of the country the usage occurred in.
	IsoCountry *string `json:"iso_country,omitempty"`
	// SID of the Network resource on which the usage occurred.
	NetworkSid *string `json:"network_sid,omitempty"`
	// The time period for which the usage is reported.
	Period *map[string]interface{} `json:"period,omitempty"`
	// SID of a Sim resource to which the UsageRecord belongs.
	SimSid *string `json:"sim_sid,omitempty"`
}

SupersimV1UsageRecord struct for SupersimV1UsageRecord

type UpdateFleetParams 

type UpdateFleetParams struct {
	// A string representing the HTTP method to use when making a request to `commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
	CommandsMethod *string `json:"CommandsMethod,omitempty"`
	// The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
	CommandsUrl *string `json:"CommandsUrl,omitempty"`
	// The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to.
	NetworkAccessProfile *string `json:"NetworkAccessProfile,omitempty"`
	// A string representing the HTTP method to use when making a request to `sms_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
	SmsCommandsMethod *string `json:"SmsCommandsMethod,omitempty"`
	// The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
	SmsCommandsUrl *string `json:"SmsCommandsUrl,omitempty"`
	// An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'UpdateFleet'

func (*UpdateFleetParams) SetCommandsMethod 

func (params *UpdateFleetParams) SetCommandsMethod(CommandsMethod string) *UpdateFleetParams

func (*UpdateFleetParams) SetCommandsUrl 

func (params *UpdateFleetParams) SetCommandsUrl(CommandsUrl string) *UpdateFleetParams

func (*UpdateFleetParams) SetNetworkAccessProfile 

func (params *UpdateFleetParams) SetNetworkAccessProfile(NetworkAccessProfile string) *UpdateFleetParams

func (*UpdateFleetParams) SetSmsCommandsMethod 

func (params *UpdateFleetParams) SetSmsCommandsMethod(SmsCommandsMethod string) *UpdateFleetParams

func (*UpdateFleetParams) SetSmsCommandsUrl 

func (params *UpdateFleetParams) SetSmsCommandsUrl(SmsCommandsUrl string) *UpdateFleetParams

func (*UpdateFleetParams) SetUniqueName 

func (params *UpdateFleetParams) SetUniqueName(UniqueName string) *UpdateFleetParams

type UpdateNetworkAccessProfileParams 

type UpdateNetworkAccessProfileParams struct {
	// The new unique name of the Network Access Profile.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'UpdateNetworkAccessProfile'

func (*UpdateNetworkAccessProfileParams) SetUniqueName 

func (params *UpdateNetworkAccessProfileParams) SetUniqueName(UniqueName string) *UpdateNetworkAccessProfileParams

type UpdateSimParams 

type UpdateSimParams struct {
	// The SID of the Account to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a Subaccount of the requesting Account. Only valid when the Sim resource's status is new.
	AccountSid *string `json:"AccountSid,omitempty"`
	// The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.
	CallbackMethod *string `json:"CallbackMethod,omitempty"`
	// The URL we should call using the `callback_method` after an asynchronous update has finished.
	CallbackUrl *string `json:"CallbackUrl,omitempty"`
	// The SID or unique name of the Fleet to which the SIM resource should be assigned.
	Fleet *string `json:"Fleet,omitempty"`
	// The new status of the resource. Can be: `ready`, `active`, or `inactive`. See the [Super SIM Status Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values) for more info.
	Status *string `json:"Status,omitempty"`
	// An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'UpdateSim'

func (*UpdateSimParams) SetAccountSid 

func (params *UpdateSimParams) SetAccountSid(AccountSid string) *UpdateSimParams

func (*UpdateSimParams) SetCallbackMethod 

func (params *UpdateSimParams) SetCallbackMethod(CallbackMethod string) *UpdateSimParams

func (*UpdateSimParams) SetCallbackUrl 

func (params *UpdateSimParams) SetCallbackUrl(CallbackUrl string) *UpdateSimParams

func (*UpdateSimParams) SetFleet 

func (params *UpdateSimParams) SetFleet(Fleet string) *UpdateSimParams

func (*UpdateSimParams) SetStatus 

func (params *UpdateSimParams) SetStatus(Status string) *UpdateSimParams

func (*UpdateSimParams) SetUniqueName 

func (params *UpdateSimParams) SetUniqueName(UniqueName string) *UpdateSimParams

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.