openapi

package
v0.0.0-...-e041b52 Latest Latest
Warning

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

Go to latest
Published: Jan 20, 2024 License: MIT Imports: 6 Imported by: 0

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.52.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
ESimProfilesApi CreateEsimProfile Post /v1/ESimProfiles
ESimProfilesApi FetchEsimProfile Get /v1/ESimProfiles/{Sid}
ESimProfilesApi ListEsimProfile Get /v1/ESimProfiles
FleetsApi CreateFleet Post /v1/Fleets
FleetsApi FetchFleet Get /v1/Fleets/{Sid}
FleetsApi ListFleet Get /v1/Fleets
FleetsApi UpdateFleet Post /v1/Fleets/{Sid}
IpCommandsApi CreateIpCommand Post /v1/IpCommands
IpCommandsApi FetchIpCommand Get /v1/IpCommands/{Sid}
IpCommandsApi ListIpCommand Get /v1/IpCommands
NetworkAccessProfilesApi CreateNetworkAccessProfile Post /v1/NetworkAccessProfiles
NetworkAccessProfilesApi FetchNetworkAccessProfile Get /v1/NetworkAccessProfiles/{Sid}
NetworkAccessProfilesApi ListNetworkAccessProfile Get /v1/NetworkAccessProfiles
NetworkAccessProfilesApi UpdateNetworkAccessProfile Post /v1/NetworkAccessProfiles/{Sid}
NetworkAccessProfilesNetworksApi CreateNetworkAccessProfileNetwork Post /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks
NetworkAccessProfilesNetworksApi DeleteNetworkAccessProfileNetwork Delete /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}
NetworkAccessProfilesNetworksApi FetchNetworkAccessProfileNetwork Get /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}
NetworkAccessProfilesNetworksApi ListNetworkAccessProfileNetwork Get /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks
NetworksApi FetchNetwork Get /v1/Networks/{Sid}
NetworksApi ListNetwork Get /v1/Networks
SettingsUpdatesApi ListSettingsUpdate Get /v1/SettingsUpdates
SimsApi CreateSim Post /v1/Sims
SimsApi FetchSim Get /v1/Sims/{Sid}
SimsApi ListSim Get /v1/Sims
SimsApi UpdateSim Post /v1/Sims/{Sid}
SimsBillingPeriodsApi ListBillingPeriod Get /v1/Sims/{SimSid}/BillingPeriods
SimsIpAddressesApi ListSimIpAddress Get /v1/Sims/{SimSid}/IpAddresses
SmsCommandsApi CreateSmsCommand Post /v1/SmsCommands
SmsCommandsApi FetchSmsCommand Get /v1/SmsCommands/{Sid}
SmsCommandsApi ListSmsCommand Get /v1/SmsCommands
UsageRecordsApi ListUsageRecord Get /v1/UsageRecords

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)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService

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

func NewApiService

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateEsimProfile

func (c *ApiService) CreateEsimProfile(params *CreateEsimProfileParams) (*SupersimV1EsimProfile, error)

Order an eSIM Profile.

func (*ApiService) CreateFleet

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

Create a Fleet

func (*ApiService) CreateIpCommand

func (c *ApiService) CreateIpCommand(params *CreateIpCommandParams) (*SupersimV1IpCommand, error)

Send an IP Command to a Super SIM.

func (*ApiService) CreateNetworkAccessProfile

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

Create a new Network Access Profile

func (*ApiService) CreateNetworkAccessProfileNetwork

func (c *ApiService) CreateNetworkAccessProfileNetwork(NetworkAccessProfileSid string, params *CreateNetworkAccessProfileNetworkParams) (*SupersimV1NetworkAccessProfileNetwork, error)

Add a Network resource to the Network Access Profile resource.

func (*ApiService) CreateSim

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

Register a Super SIM to your Account

func (*ApiService) CreateSmsCommand

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

Send SMS Command to a Sim.

func (*ApiService) DeleteNetworkAccessProfileNetwork

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

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

func (*ApiService) FetchEsimProfile

func (c *ApiService) FetchEsimProfile(Sid string) (*SupersimV1EsimProfile, error)

Fetch an eSIM Profile.

func (*ApiService) FetchFleet

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

Fetch a Fleet instance from your account.

func (*ApiService) FetchIpCommand

func (c *ApiService) FetchIpCommand(Sid string) (*SupersimV1IpCommand, error)

Fetch IP Command instance from your account.

func (*ApiService) FetchNetwork

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

Fetch a Network resource.

func (*ApiService) FetchNetworkAccessProfile

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

Fetch a Network Access Profile instance from your account.

func (*ApiService) FetchNetworkAccessProfileNetwork

func (c *ApiService) FetchNetworkAccessProfileNetwork(NetworkAccessProfileSid string, Sid string) (*SupersimV1NetworkAccessProfileNetwork, error)

Fetch a Network Access Profile resource's Network resource.

func (*ApiService) FetchSim

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

Fetch a Super SIM instance from your account.

func (*ApiService) FetchSmsCommand

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

Fetch SMS Command instance from your account.

func (*ApiService) ListBillingPeriod

func (c *ApiService) ListBillingPeriod(SimSid string, params *ListBillingPeriodParams) ([]SupersimV1BillingPeriod, error)

Lists BillingPeriod records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListEsimProfile

func (c *ApiService) ListEsimProfile(params *ListEsimProfileParams) ([]SupersimV1EsimProfile, error)

Lists EsimProfile records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListFleet

func (c *ApiService) ListFleet(params *ListFleetParams) ([]SupersimV1Fleet, error)

Lists Fleet records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListIpCommand

func (c *ApiService) ListIpCommand(params *ListIpCommandParams) ([]SupersimV1IpCommand, error)

Lists IpCommand records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListNetwork

func (c *ApiService) ListNetwork(params *ListNetworkParams) ([]SupersimV1Network, error)

Lists Network records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListNetworkAccessProfile

func (c *ApiService) ListNetworkAccessProfile(params *ListNetworkAccessProfileParams) ([]SupersimV1NetworkAccessProfile, error)

Lists NetworkAccessProfile records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListNetworkAccessProfileNetwork

func (c *ApiService) ListNetworkAccessProfileNetwork(NetworkAccessProfileSid string, params *ListNetworkAccessProfileNetworkParams) ([]SupersimV1NetworkAccessProfileNetwork, error)

Lists NetworkAccessProfileNetwork records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSettingsUpdate

func (c *ApiService) ListSettingsUpdate(params *ListSettingsUpdateParams) ([]SupersimV1SettingsUpdate, error)

Lists SettingsUpdate records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSim

func (c *ApiService) ListSim(params *ListSimParams) ([]SupersimV1Sim, error)

Lists Sim records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSimIpAddress

func (c *ApiService) ListSimIpAddress(SimSid string, params *ListSimIpAddressParams) ([]SupersimV1SimIpAddress, error)

Lists SimIpAddress records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSmsCommand

func (c *ApiService) ListSmsCommand(params *ListSmsCommandParams) ([]SupersimV1SmsCommand, error)

Lists SmsCommand records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListUsageRecord

func (c *ApiService) ListUsageRecord(params *ListUsageRecordParams) ([]SupersimV1UsageRecord, error)

Lists UsageRecord records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageBillingPeriod

func (c *ApiService) PageBillingPeriod(SimSid string, params *ListBillingPeriodParams, pageToken, pageNumber string) (*ListBillingPeriodResponse, error)

Retrieve a single page of BillingPeriod records from the API. Request is executed immediately.

func (*ApiService) PageEsimProfile

func (c *ApiService) PageEsimProfile(params *ListEsimProfileParams, pageToken, pageNumber string) (*ListEsimProfileResponse, error)

Retrieve a single page of EsimProfile records from the API. Request is executed immediately.

func (*ApiService) PageFleet

func (c *ApiService) PageFleet(params *ListFleetParams, pageToken, pageNumber string) (*ListFleetResponse, error)

Retrieve a single page of Fleet records from the API. Request is executed immediately.

func (*ApiService) PageIpCommand

func (c *ApiService) PageIpCommand(params *ListIpCommandParams, pageToken, pageNumber string) (*ListIpCommandResponse, error)

Retrieve a single page of IpCommand records from the API. Request is executed immediately.

func (*ApiService) PageNetwork

func (c *ApiService) PageNetwork(params *ListNetworkParams, pageToken, pageNumber string) (*ListNetworkResponse, error)

Retrieve a single page of Network records from the API. Request is executed immediately.

func (*ApiService) PageNetworkAccessProfile

func (c *ApiService) PageNetworkAccessProfile(params *ListNetworkAccessProfileParams, pageToken, pageNumber string) (*ListNetworkAccessProfileResponse, error)

Retrieve a single page of NetworkAccessProfile records from the API. Request is executed immediately.

func (*ApiService) PageNetworkAccessProfileNetwork

func (c *ApiService) PageNetworkAccessProfileNetwork(NetworkAccessProfileSid string, params *ListNetworkAccessProfileNetworkParams, pageToken, pageNumber string) (*ListNetworkAccessProfileNetworkResponse, error)

Retrieve a single page of NetworkAccessProfileNetwork records from the API. Request is executed immediately.

func (*ApiService) PageSettingsUpdate

func (c *ApiService) PageSettingsUpdate(params *ListSettingsUpdateParams, pageToken, pageNumber string) (*ListSettingsUpdateResponse, error)

Retrieve a single page of SettingsUpdate records from the API. Request is executed immediately.

func (*ApiService) PageSim

func (c *ApiService) PageSim(params *ListSimParams, pageToken, pageNumber string) (*ListSimResponse, error)

Retrieve a single page of Sim records from the API. Request is executed immediately.

func (*ApiService) PageSimIpAddress

func (c *ApiService) PageSimIpAddress(SimSid string, params *ListSimIpAddressParams, pageToken, pageNumber string) (*ListSimIpAddressResponse, error)

Retrieve a single page of SimIpAddress records from the API. Request is executed immediately.

func (*ApiService) PageSmsCommand

func (c *ApiService) PageSmsCommand(params *ListSmsCommandParams, pageToken, pageNumber string) (*ListSmsCommandResponse, error)

Retrieve a single page of SmsCommand records from the API. Request is executed immediately.

func (*ApiService) PageUsageRecord

func (c *ApiService) PageUsageRecord(params *ListUsageRecordParams, pageToken, pageNumber string) (*ListUsageRecordResponse, error)

Retrieve a single page of UsageRecord records from the API. Request is executed immediately.

func (*ApiService) StreamBillingPeriod

func (c *ApiService) StreamBillingPeriod(SimSid string, params *ListBillingPeriodParams) (chan SupersimV1BillingPeriod, chan error)

Streams BillingPeriod records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamEsimProfile

func (c *ApiService) StreamEsimProfile(params *ListEsimProfileParams) (chan SupersimV1EsimProfile, chan error)

Streams EsimProfile records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamFleet

func (c *ApiService) StreamFleet(params *ListFleetParams) (chan SupersimV1Fleet, chan error)

Streams Fleet records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamIpCommand

func (c *ApiService) StreamIpCommand(params *ListIpCommandParams) (chan SupersimV1IpCommand, chan error)

Streams IpCommand records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamNetwork

func (c *ApiService) StreamNetwork(params *ListNetworkParams) (chan SupersimV1Network, chan error)

Streams Network records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamNetworkAccessProfile

func (c *ApiService) StreamNetworkAccessProfile(params *ListNetworkAccessProfileParams) (chan SupersimV1NetworkAccessProfile, chan error)

Streams NetworkAccessProfile records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamNetworkAccessProfileNetwork

func (c *ApiService) StreamNetworkAccessProfileNetwork(NetworkAccessProfileSid string, params *ListNetworkAccessProfileNetworkParams) (chan SupersimV1NetworkAccessProfileNetwork, chan error)

Streams NetworkAccessProfileNetwork records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSettingsUpdate

func (c *ApiService) StreamSettingsUpdate(params *ListSettingsUpdateParams) (chan SupersimV1SettingsUpdate, chan error)

Streams SettingsUpdate records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSim

func (c *ApiService) StreamSim(params *ListSimParams) (chan SupersimV1Sim, chan error)

Streams Sim records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSimIpAddress

func (c *ApiService) StreamSimIpAddress(SimSid string, params *ListSimIpAddressParams) (chan SupersimV1SimIpAddress, chan error)

Streams SimIpAddress records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSmsCommand

func (c *ApiService) StreamSmsCommand(params *ListSmsCommandParams) (chan SupersimV1SmsCommand, chan error)

Streams SmsCommand records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamUsageRecord

func (c *ApiService) StreamUsageRecord(params *ListUsageRecordParams) (chan SupersimV1UsageRecord, chan error)

Streams UsageRecord records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateFleet

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

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

func (*ApiService) UpdateNetworkAccessProfile

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

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

func (*ApiService) UpdateSim

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

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

type CreateEsimProfileParams

type CreateEsimProfileParams struct {
	// The URL we should call using the `callback_method` when the status of the eSIM Profile changes. At this stage of the eSIM Profile pilot, the a request to the URL will only be called when the ESimProfile resource changes from `reserving` to `available`.
	CallbackUrl *string `json:"CallbackUrl,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"`
	// When set to `true`, a value for `Eid` does not need to be provided. Instead, when the eSIM profile is reserved, a matching ID will be generated and returned via the `matching_id` property. This identifies the specific eSIM profile that can be used by any capable device to claim and download the profile.
	GenerateMatchingId *bool `json:"GenerateMatchingId,omitempty"`
	// Identifier of the eUICC that will claim the eSIM Profile.
	Eid *string `json:"Eid,omitempty"`
}

Optional parameters for the method 'CreateEsimProfile'

func (*CreateEsimProfileParams) SetCallbackMethod

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

func (*CreateEsimProfileParams) SetCallbackUrl

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

func (*CreateEsimProfileParams) SetEid

func (*CreateEsimProfileParams) SetGenerateMatchingId

func (params *CreateEsimProfileParams) SetGenerateMatchingId(GenerateMatchingId bool) *CreateEsimProfileParams

type CreateFleetParams

type CreateFleetParams struct {
	// 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"`
	// 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"`
	// 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 Super SIM assigned to the Fleet 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 *int `json:"DataLimit,omitempty"`
	// The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
	IpCommandsUrl *string `json:"IpCommandsUrl,omitempty"`
	// A string representing the HTTP method to use when making a request to `ip_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
	IpCommandsMethod *string `json:"IpCommandsMethod,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"`
	// 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"`
	// 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"`
}

Optional parameters for the method 'CreateFleet'

func (*CreateFleetParams) SetDataEnabled

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

func (*CreateFleetParams) SetDataLimit

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

func (*CreateFleetParams) SetIpCommandsMethod

func (params *CreateFleetParams) SetIpCommandsMethod(IpCommandsMethod string) *CreateFleetParams

func (*CreateFleetParams) SetIpCommandsUrl

func (params *CreateFleetParams) SetIpCommandsUrl(IpCommandsUrl string) *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 CreateIpCommandParams

type CreateIpCommandParams struct {
	// The `sid` or `unique_name` of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) to send the IP Command to.
	Sim *string `json:"Sim,omitempty"`
	// The data that will be sent to the device. The payload cannot exceed 1300 bytes. If the PayloadType is set to text, the payload is encoded in UTF-8. If PayloadType is set to binary, the payload is encoded in Base64.
	Payload *string `json:"Payload,omitempty"`
	// The device port to which the IP Command will be sent.
	DevicePort *int `json:"DevicePort,omitempty"`
	//
	PayloadType *string `json:"PayloadType,omitempty"`
	// The URL we should call using the `callback_method` after we have sent the IP Command.
	CallbackUrl *string `json:"CallbackUrl,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"`
}

Optional parameters for the method 'CreateIpCommand'

func (*CreateIpCommandParams) SetCallbackMethod

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

func (*CreateIpCommandParams) SetCallbackUrl

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

func (*CreateIpCommandParams) SetDevicePort

func (params *CreateIpCommandParams) SetDevicePort(DevicePort int) *CreateIpCommandParams

func (*CreateIpCommandParams) SetPayload

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

func (*CreateIpCommandParams) SetPayloadType

func (params *CreateIpCommandParams) SetPayloadType(PayloadType string) *CreateIpCommandParams

func (*CreateIpCommandParams) SetSim

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

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

type CreateNetworkAccessProfileParams

type CreateNetworkAccessProfileParams struct {
	// 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"`
	// List of Network SIDs that this Network Access Profile will allow connections to.
	Networks *[]string `json:"Networks,omitempty"`
}

Optional parameters for the method 'CreateNetworkAccessProfile'

func (*CreateNetworkAccessProfileParams) SetNetworks

func (*CreateNetworkAccessProfileParams) SetUniqueName

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 `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) to send the SMS Command to.
	Sim *string `json:"Sim,omitempty"`
	// The message body of the SMS Command.
	Payload *string `json:"Payload,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 we have sent the command.
	CallbackUrl *string `json:"CallbackUrl,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

type ListBillingPeriodParams

type ListBillingPeriodParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListBillingPeriod'

func (*ListBillingPeriodParams) SetLimit

func (params *ListBillingPeriodParams) SetLimit(Limit int) *ListBillingPeriodParams

func (*ListBillingPeriodParams) SetPageSize

func (params *ListBillingPeriodParams) SetPageSize(PageSize int) *ListBillingPeriodParams

type ListBillingPeriodResponse

type ListBillingPeriodResponse struct {
	BillingPeriods []SupersimV1BillingPeriod     `json:"billing_periods,omitempty"`
	Meta           ListBillingPeriodResponseMeta `json:"meta,omitempty"`
}

ListBillingPeriodResponse struct for ListBillingPeriodResponse

type ListBillingPeriodResponseMeta

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

ListBillingPeriodResponseMeta struct for ListBillingPeriodResponseMeta

type ListEsimProfileParams

type ListEsimProfileParams struct {
	// List the eSIM Profiles that have been associated with an EId.
	Eid *string `json:"Eid,omitempty"`
	// Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
	SimSid *string `json:"SimSid,omitempty"`
	// List the eSIM Profiles that are in a given status.
	Status *string `json:"Status,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListEsimProfile'

func (*ListEsimProfileParams) SetEid

func (params *ListEsimProfileParams) SetEid(Eid string) *ListEsimProfileParams

func (*ListEsimProfileParams) SetLimit

func (params *ListEsimProfileParams) SetLimit(Limit int) *ListEsimProfileParams

func (*ListEsimProfileParams) SetPageSize

func (params *ListEsimProfileParams) SetPageSize(PageSize int) *ListEsimProfileParams

func (*ListEsimProfileParams) SetSimSid

func (params *ListEsimProfileParams) SetSimSid(SimSid string) *ListEsimProfileParams

func (*ListEsimProfileParams) SetStatus

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

type ListEsimProfileResponse

type ListEsimProfileResponse struct {
	EsimProfiles []SupersimV1EsimProfile       `json:"esim_profiles,omitempty"`
	Meta         ListBillingPeriodResponseMeta `json:"meta,omitempty"`
}

ListEsimProfileResponse struct for ListEsimProfileResponse

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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListFleet'

func (*ListFleetParams) SetLimit

func (params *ListFleetParams) SetLimit(Limit int) *ListFleetParams

func (*ListFleetParams) SetNetworkAccessProfile

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

func (*ListFleetParams) SetPageSize

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

type ListFleetResponse

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

ListFleetResponse struct for ListFleetResponse

type ListIpCommandParams

type ListIpCommandParams struct {
	// The SID or unique name of the Sim resource that IP Command was sent to or from.
	Sim *string `json:"Sim,omitempty"`
	// The ICCID of the Sim resource that IP Command was sent to or from.
	SimIccid *string `json:"SimIccid,omitempty"`
	// The status of the IP Command. Can be: `queued`, `sent`, `received` or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/iot/supersim/api/ipcommand-resource#status-values) for a description of each.
	Status *string `json:"Status,omitempty"`
	// The direction of the IP 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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListIpCommand'

func (*ListIpCommandParams) SetDirection

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

func (*ListIpCommandParams) SetLimit

func (params *ListIpCommandParams) SetLimit(Limit int) *ListIpCommandParams

func (*ListIpCommandParams) SetPageSize

func (params *ListIpCommandParams) SetPageSize(PageSize int) *ListIpCommandParams

func (*ListIpCommandParams) SetSim

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

func (*ListIpCommandParams) SetSimIccid

func (params *ListIpCommandParams) SetSimIccid(SimIccid string) *ListIpCommandParams

func (*ListIpCommandParams) SetStatus

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

type ListIpCommandResponse

type ListIpCommandResponse struct {
	IpCommands []SupersimV1IpCommand         `json:"ip_commands,omitempty"`
	Meta       ListBillingPeriodResponseMeta `json:"meta,omitempty"`
}

ListIpCommandResponse struct for ListIpCommandResponse

type ListNetworkAccessProfileNetworkParams

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

Optional parameters for the method 'ListNetworkAccessProfileNetwork'

func (*ListNetworkAccessProfileNetworkParams) SetLimit

func (*ListNetworkAccessProfileNetworkParams) SetPageSize

type ListNetworkAccessProfileNetworkResponse

type ListNetworkAccessProfileNetworkResponse struct {
	Networks []SupersimV1NetworkAccessProfileNetwork `json:"networks,omitempty"`
	Meta     ListBillingPeriodResponseMeta           `json:"meta,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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListNetworkAccessProfile'

func (*ListNetworkAccessProfileParams) SetLimit

func (*ListNetworkAccessProfileParams) SetPageSize

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

type ListNetworkAccessProfileResponse

type ListNetworkAccessProfileResponse struct {
	NetworkAccessProfiles []SupersimV1NetworkAccessProfile `json:"network_access_profiles,omitempty"`
	Meta                  ListBillingPeriodResponseMeta    `json:"meta,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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListNetwork'

func (*ListNetworkParams) SetIsoCountry

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

func (*ListNetworkParams) SetLimit

func (params *ListNetworkParams) SetLimit(Limit int) *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 int) *ListNetworkParams

type ListNetworkResponse

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

ListNetworkResponse struct for ListNetworkResponse

type ListSettingsUpdateParams

type ListSettingsUpdateParams struct {
	// Filter the Settings Updates by a Super SIM's SID or UniqueName.
	Sim *string `json:"Sim,omitempty"`
	// Filter the Settings Updates by status. Can be `scheduled`, `in-progress`, `successful`, or `failed`.
	Status *string `json:"Status,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSettingsUpdate'

func (*ListSettingsUpdateParams) SetLimit

func (params *ListSettingsUpdateParams) SetLimit(Limit int) *ListSettingsUpdateParams

func (*ListSettingsUpdateParams) SetPageSize

func (params *ListSettingsUpdateParams) SetPageSize(PageSize int) *ListSettingsUpdateParams

func (*ListSettingsUpdateParams) SetSim

func (*ListSettingsUpdateParams) SetStatus

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

type ListSettingsUpdateResponse

type ListSettingsUpdateResponse struct {
	SettingsUpdates []SupersimV1SettingsUpdate    `json:"settings_updates,omitempty"`
	Meta            ListBillingPeriodResponseMeta `json:"meta,omitempty"`
}

ListSettingsUpdateResponse struct for ListSettingsUpdateResponse

type ListSimIpAddressParams

type ListSimIpAddressParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSimIpAddress'

func (*ListSimIpAddressParams) SetLimit

func (params *ListSimIpAddressParams) SetLimit(Limit int) *ListSimIpAddressParams

func (*ListSimIpAddressParams) SetPageSize

func (params *ListSimIpAddressParams) SetPageSize(PageSize int) *ListSimIpAddressParams

type ListSimIpAddressResponse

type ListSimIpAddressResponse struct {
	IpAddresses []SupersimV1SimIpAddress      `json:"ip_addresses,omitempty"`
	Meta        ListBillingPeriodResponseMeta `json:"meta,omitempty"`
}

ListSimIpAddressResponse struct for ListSimIpAddressResponse

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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,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) SetLimit

func (params *ListSimParams) SetLimit(Limit int) *ListSimParams

func (*ListSimParams) SetPageSize

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

func (*ListSimParams) SetStatus

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

type ListSimResponse

type ListSimResponse struct {
	Sims []SupersimV1Sim               `json:"sims,omitempty"`
	Meta ListBillingPeriodResponseMeta `json:"meta,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/iot/supersim/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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSmsCommand'

func (*ListSmsCommandParams) SetDirection

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

func (*ListSmsCommandParams) SetLimit

func (params *ListSmsCommandParams) SetLimit(Limit int) *ListSmsCommandParams

func (*ListSmsCommandParams) SetPageSize

func (params *ListSmsCommandParams) SetPageSize(PageSize int) *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 {
	SmsCommands []SupersimV1SmsCommand        `json:"sms_commands,omitempty"`
	Meta        ListBillingPeriodResponseMeta `json:"meta,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 (exclusive), 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 *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,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) SetLimit

func (params *ListUsageRecordParams) SetLimit(Limit int) *ListUsageRecordParams

func (*ListUsageRecordParams) SetNetwork

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

func (*ListUsageRecordParams) SetPageSize

func (params *ListUsageRecordParams) SetPageSize(PageSize int) *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 {
	UsageRecords []SupersimV1UsageRecord       `json:"usage_records,omitempty"`
	Meta         ListBillingPeriodResponseMeta `json:"meta,omitempty"`
}

ListUsageRecordResponse struct for ListUsageRecordResponse

type SupersimV1BillingPeriod

type SupersimV1BillingPeriod struct {
	// The SID of the Billing Period.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) the Super SIM belongs to.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the Super SIM the Billing Period belongs to.
	SimSid *string `json:"sim_sid,omitempty"`
	// The start time of the Billing Period specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	StartTime *time.Time `json:"start_time,omitempty"`
	// The end time of the Billing Period specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	EndTime    *time.Time `json:"end_time,omitempty"`
	PeriodType *string    `json:"period_type,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
}

SupersimV1BillingPeriod struct for SupersimV1BillingPeriod

type SupersimV1EsimProfile

type SupersimV1EsimProfile struct {
	// The unique string that we created to identify the eSIM Profile resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the eSIM Profile resource belongs.
	AccountSid *string `json:"account_sid,omitempty"`
	// The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource.
	Iccid *string `json:"iccid,omitempty"`
	// The SID of the [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource that this eSIM Profile controls.
	SimSid *string `json:"sim_sid,omitempty"`
	Status *string `json:"status,omitempty"`
	// Identifier of the eUICC that can claim the eSIM Profile.
	Eid *string `json:"eid,omitempty"`
	// Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status `available`.
	SmdpPlusAddress *string `json:"smdp_plus_address,omitempty"`
	// Unique identifier of the eSIM profile that can be used to identify and download the eSIM profile from the SM-DP+ server. Populated if `generate_matching_id` is set to `true` when creating the eSIM profile reservation.
	MatchingId *string `json:"matching_id,omitempty"`
	// Combined machine-readable activation code for acquiring an eSIM Profile with the Activation Code download method. Can be used in a QR code to download an eSIM profile.
	ActivationCode *string `json:"activation_code,omitempty"`
	// Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state.
	ErrorCode *string `json:"error_code,omitempty"`
	// Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state.
	ErrorMessage *string `json:"error_message,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the eSIM Profile resource.
	Url *string `json:"url,omitempty"`
}

SupersimV1EsimProfile struct for SupersimV1EsimProfile

type SupersimV1Fleet

type SupersimV1Fleet struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Fleet resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique string that we created to identify the Fleet resource.
	Sid *string `json:"sid,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:"unique_name,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Fleet resource.
	Url *string `json:"url,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:"data_enabled,omitempty"`
	// The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 250MB.
	DataLimit    *int    `json:"data_limit,omitempty"`
	DataMetering *string `json:"data_metering,omitempty"`
	// Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to `false`.
	SmsCommandsEnabled *bool `json:"sms_commands_enabled,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:"sms_commands_url,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:"sms_commands_method,omitempty"`
	// The SID of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.
	NetworkAccessProfileSid *string `json:"network_access_profile_sid,omitempty"`
	// The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
	IpCommandsUrl *string `json:"ip_commands_url,omitempty"`
	// A string representing the HTTP method to use when making a request to `ip_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
	IpCommandsMethod *string `json:"ip_commands_method,omitempty"`
}

SupersimV1Fleet struct for SupersimV1Fleet

type SupersimV1IpCommand

type SupersimV1IpCommand struct {
	// The unique string that we created to identify the IP Command resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IP Command resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) that this IP Command was sent to or from.
	SimSid *string `json:"sim_sid,omitempty"`
	// The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) that this IP Command was sent to or from.
	SimIccid  *string `json:"sim_iccid,omitempty"`
	Status    *string `json:"status,omitempty"`
	Direction *string `json:"direction,omitempty"`
	// The IP address of the device that the IP Command was sent to or received from. For an IP Command sent to a Super SIM, `device_ip` starts out as `null`, and once the IP Command is “sent”, the `device_ip` will be filled out. An IP Command sent from a Super SIM have its `device_ip` always set.
	DeviceIp *string `json:"device_ip,omitempty"`
	// For an IP Command sent to a Super SIM, it would be the destination port of the IP message. For an IP Command sent from a Super SIM, it would be the source port of the IP message.
	DevicePort  *int    `json:"device_port,omitempty"`
	PayloadType *string `json:"payload_type,omitempty"`
	// The payload that is carried in the IP/UDP message. The payload can be encoded in either text or binary format. For text payload, UTF-8 encoding must be used.  For an IP Command sent to a Super SIM, the payload is appended to the IP/UDP message “as is”. The payload should not exceed 1300 bytes.  For an IP Command sent from a Super SIM, the payload from the received IP/UDP message is extracted and sent in binary encoding. For an IP Command sent from a Super SIM, the payload should not exceed 1300 bytes. If it is larger than 1300 bytes, there might be fragmentation on the upstream and the message may appear truncated.
	Payload *string `json:"payload,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the IP Command resource.
	Url *string `json:"url,omitempty"`
}

SupersimV1IpCommand struct for SupersimV1IpCommand

type SupersimV1Network

type SupersimV1Network struct {
	// The unique string that we created to identify the Network resource.
	Sid *string `json:"sid,omitempty"`
	// A human readable identifier of this resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The absolute URL of the Network resource.
	Url *string `json:"url,omitempty"`
	// The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resource.
	IsoCountry *string `json:"iso_country,omitempty"`
	// Array of objects identifying the [MCC-MNCs](https://en.wikipedia.org/wiki/Mobile_country_code) that are included in the Network resource.
	Identifiers *[]interface{} `json:"identifiers,omitempty"`
}

SupersimV1Network struct for SupersimV1Network

type SupersimV1NetworkAccessProfile

type SupersimV1NetworkAccessProfile struct {
	// The unique string that identifies the Network Access Profile resource.
	Sid *string `json:"sid,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:"unique_name,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Network Access Profile belongs to.
	AccountSid *string `json:"account_sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Network Access Profile resource.
	Url   *string                 `json:"url,omitempty"`
	Links *map[string]interface{} `json:"links,omitempty"`
}

SupersimV1NetworkAccessProfile struct for SupersimV1NetworkAccessProfile

type SupersimV1NetworkAccessProfileNetwork

type SupersimV1NetworkAccessProfileNetwork struct {
	// The unique string that identifies the Network resource.
	Sid *string `json:"sid,omitempty"`
	// The unique string that identifies the Network resource's Network Access Profile resource.
	NetworkAccessProfileSid *string `json:"network_access_profile_sid,omitempty"`
	// A human readable identifier of the Network this resource refers to.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resource.
	IsoCountry *string `json:"iso_country,omitempty"`
	// Array of objects identifying the [MCC-MNCs](https://en.wikipedia.org/wiki/Mobile_country_code) that are included in the Network resource.
	Identifiers *[]interface{} `json:"identifiers,omitempty"`
	// The absolute URL of the Network resource.
	Url *string `json:"url,omitempty"`
}

SupersimV1NetworkAccessProfileNetwork struct for SupersimV1NetworkAccessProfileNetwork

type SupersimV1SettingsUpdate

type SupersimV1SettingsUpdate struct {
	// The unique identifier of this Settings Update.
	Sid *string `json:"sid,omitempty"`
	// The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM.
	Iccid *string `json:"iccid,omitempty"`
	// The SID of the Super SIM to which this Settings Update was applied.
	SimSid *string `json:"sim_sid,omitempty"`
	Status *string `json:"status,omitempty"`
	// Array containing the different Settings Packages that will be applied to the SIM after the update completes. Each object within the array indicates the name and the version of the Settings Package that will be on the SIM if the update is successful.
	Packages *[]interface{} `json:"packages,omitempty"`
	// The time, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, when the update successfully completed and the new settings were applied to the SIM.
	DateCompleted *time.Time `json:"date_completed,omitempty"`
	// The date that this Settings Update was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date that this Settings Update was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
}

SupersimV1SettingsUpdate struct for SupersimV1SettingsUpdate

type SupersimV1Sim

type SupersimV1Sim struct {
	// The unique string that identifies the Sim resource.
	Sid *string `json:"sid,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:"unique_name,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Super SIM belongs to.
	AccountSid *string `json:"account_sid,omitempty"`
	// The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM.
	Iccid  *string `json:"iccid,omitempty"`
	Status *string `json:"status,omitempty"`
	// The unique ID of the Fleet configured for this SIM.
	FleetSid *string `json:"fleet_sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Sim Resource.
	Url   *string                 `json:"url,omitempty"`
	Links *map[string]interface{} `json:"links,omitempty"`
}

SupersimV1Sim struct for SupersimV1Sim

type SupersimV1SimIpAddress

type SupersimV1SimIpAddress struct {
	// IP address assigned to the given Super SIM
	IpAddress        *string `json:"ip_address,omitempty"`
	IpAddressVersion *string `json:"ip_address_version,omitempty"`
}

SupersimV1SimIpAddress struct for SupersimV1SimIpAddress

type SupersimV1SmsCommand

type SupersimV1SmsCommand struct {
	// The unique string that we created to identify the SMS Command resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SMS Command resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) that this SMS Command was sent to or from.
	SimSid *string `json:"sim_sid,omitempty"`
	// The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters.
	Payload   *string `json:"payload,omitempty"`
	Status    *string `json:"status,omitempty"`
	Direction *string `json:"direction,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,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](https://www.twilio.com/docs/iam/api/account) that incurred the usage.
	AccountSid *string `json:"account_sid,omitempty"`
	// SID of a Sim resource to which the UsageRecord belongs. Value will only be present when either a value for the `Sim` query parameter is provided or when UsageRecords are grouped by `sim`. Otherwise, the value will be `null`.
	SimSid *string `json:"sim_sid,omitempty"`
	// SID of the Network resource the usage occurred on. Value will only be present when either a value for the `Network` query parameter is provided or when UsageRecords are grouped by `network`. Otherwise, the value will be `null`.
	NetworkSid *string `json:"network_sid,omitempty"`
	// SID of the Fleet resource the usage occurred on. Value will only be present when either a value for the `Fleet` query parameter is provided or when UsageRecords are grouped by `fleet`. Otherwise, the value will be `null`.
	FleetSid *string `json:"fleet_sid,omitempty"`
	// Alpha-2 ISO Country Code that the usage occurred in. Value will only be present when either a value for the `IsoCountry` query parameter is provided or when UsageRecords are grouped by `isoCountry`. Otherwise, the value will be `null`.
	IsoCountry *string `json:"iso_country,omitempty"`
	// The time period for which the usage is reported. The period is represented as a pair of `start_time` and `end_time` timestamps specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	Period *interface{} `json:"period,omitempty"`
	// Total data uploaded in bytes, aggregated by the query parameters.
	DataUpload *int64 `json:"data_upload,omitempty"`
	// Total data downloaded in bytes, aggregated by the query parameters.
	DataDownload *int64 `json:"data_download,omitempty"`
	// Total of data_upload and data_download.
	DataTotal *int64 `json:"data_total,omitempty"`
	// Total amount in the `billed_unit` that was charged for the data uploaded or downloaded. Will return 0 for usage prior to February 1, 2022. Value may be 0 despite `data_total` being greater than 0 if the data usage is still being processed by Twilio's billing system. Refer to [Data Usage Processing](https://www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) for more details.
	DataTotalBilled *float32 `json:"data_total_billed,omitempty"`
	// The currency in which the billed amounts are measured, specified in the 3 letter ISO 4127 format (e.g. `USD`, `EUR`, `JPY`). This can be null when data_toal_billed is 0 and we do not yet have billing information for the corresponding data usage. Refer to [Data Usage Processing](https://www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) for more details.
	BilledUnit *string `json:"billed_unit,omitempty"`
}

SupersimV1UsageRecord struct for SupersimV1UsageRecord

func (*SupersimV1UsageRecord) UnmarshalJSON

func (response *SupersimV1UsageRecord) UnmarshalJSON(bytes []byte) (err error)

type UpdateFleetParams

type UpdateFleetParams struct {
	// 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"`
	// 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"`
	// The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
	IpCommandsUrl *string `json:"IpCommandsUrl,omitempty"`
	// A string representing the HTTP method to use when making a request to `ip_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
	IpCommandsMethod *string `json:"IpCommandsMethod,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"`
	// 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 total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet 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 *int `json:"DataLimit,omitempty"`
}

Optional parameters for the method 'UpdateFleet'

func (*UpdateFleetParams) SetDataLimit

func (params *UpdateFleetParams) SetDataLimit(DataLimit int) *UpdateFleetParams

func (*UpdateFleetParams) SetIpCommandsMethod

func (params *UpdateFleetParams) SetIpCommandsMethod(IpCommandsMethod string) *UpdateFleetParams

func (*UpdateFleetParams) SetIpCommandsUrl

func (params *UpdateFleetParams) SetIpCommandsUrl(IpCommandsUrl 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

type UpdateSimParams

type UpdateSimParams struct {
	// 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"`
	//
	Status *string `json:"Status,omitempty"`
	// The SID or unique name of the Fleet to which the SIM resource should be assigned.
	Fleet *string `json:"Fleet,omitempty"`
	// The URL we should call using the `callback_method` after an asynchronous update has finished.
	CallbackUrl *string `json:"CallbackUrl,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 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"`
}

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

Jump to

Keyboard shortcuts

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