spanclient

type APIClient struct {
	CollectionsApi *CollectionsApiService

	DatadumpApi *DatadumpApiService

	DevicesApi *DevicesApiService

	FotaApi *FotaApiService

	OutputsApi *OutputsApiService

	SystemApi *SystemApiService
	// contains filtered or unexported fields
}

type APIKey struct {
	Key    string
	Prefix string
}

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

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

type CoApMetadata struct {
	Code string `json:"code,omitempty"`
	Path string `json:"path,omitempty"`
}

type Collection struct {
	// The ID of the collection. This is assigned by the backend.
	CollectionId string `json:"collectionId,omitempty"`
	// The team ID that owns the collection. This field is required. When you create new collections the default is to use your private team ID.
	TeamId    string             `json:"teamId,omitempty"`
	FieldMask FieldMask          `json:"fieldMask,omitempty"`
	Firmware  CollectionFirmware `json:"firmware,omitempty"`
	// Tags for the collection. Tags are metadata fields that you can assign to the collection.
	Tags map[string]string `json:"tags,omitempty"`
}

type CollectionFirmware struct {
	// The current firmware is the firmware that the devices are currently using.
	CurrentFirmwareId string `json:"currentFirmwareId,omitempty"`
	// The target firmware is set to the desired firmware image for the devices in this collection. If the management is set to \"device\" this will only be used if the target firmware isn't set on the device itself.
	TargetFirmwareId string                               `json:"targetFirmwareId,omitempty"`
	Management       CollectionFirmwareFirmwareManagement `json:"management,omitempty"`
}

type CollectionFirmwareFirmwareManagement string

type CollectionsApiService service

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

type CreateFirmwareRequest struct {
	CollectionId string            `json:"collectionId,omitempty"`
	Image        string            `json:"image,omitempty"`
	Version      string            `json:"version,omitempty"`
	Filename     string            `json:"filename,omitempty"`
	Tags         map[string]string `json:"tags,omitempty"`
}

type DataDumpResponse struct {
	Collections []DumpedCollection `json:"collections,omitempty"`
}

type DataStream interface {
	Recv() (OutputDataMessage, error)
	Close() error
}

type DatadumpApiService service

type Device struct {
	// The device ID is assigned by the backend.
	DeviceId     string `json:"deviceId,omitempty"`
	CollectionId string `json:"collectionId,omitempty"`
	// The IMSI is the unique ID for the (e|nu|whatever)SIM card on your device. This is the primary identifier for your device on the network.
	Imsi string `json:"imsi,omitempty"`
	// The IMEI number is the unique ID for your hardware as seen by the network. Obviously you might have a completely different view on things.
	Imei string `json:"imei,omitempty"`
	// Tags are metadata for the device that you can set. These are just strings.
	Tags     map[string]string `json:"tags,omitempty"`
	Network  NetworkMetadata   `json:"network,omitempty"`
	Firmware FirmwareMetadata  `json:"firmware,omitempty"`
}

type DevicesApiService service

type DumpedCollection struct {
	Collection Collection     `json:"collection,omitempty"`
	Devices    []DumpedDevice `json:"devices,omitempty"`
	Outputs    []Output       `json:"outputs,omitempty"`
}

type DumpedDevice struct {
	Device Device `json:"device,omitempty"`
}

type FieldMask struct {
	Imsi     bool `json:"imsi,omitempty"`
	Imei     bool `json:"imei,omitempty"`
	Msisdn   bool `json:"msisdn,omitempty"`
	Location bool `json:"location,omitempty"`
}

type Firmware struct {
	ImageId string `json:"imageId,omitempty"`
	// Make sure that the firmware image reports this version. If the version reported by this image is different the FOTA process won't be reported as successful since the device will report a version different from this.
	Version string `json:"version,omitempty"`
	// This is just for internal house keeping, making it potentially easier to identify the firmware image.
	Filename string `json:"filename,omitempty"`
	// To ensure each image is unique the SHA-256 hash for all images in a collection must be unqique
	Sha256 string `json:"sha256,omitempty"`
	Length int32  `json:"length,omitempty"`
	// Collection ID for the collection owning the firmware image.
	CollectionId string `json:"collectionId,omitempty"`
	Created      string `json:"created,omitempty"`
	// Tags for firmware image.
	Tags map[string]string `json:"tags,omitempty"`
}

type FirmwareMetadata struct {
	CurrentFirmwareId string `json:"currentFirmwareId,omitempty"`
	TargetFirmwareId  string `json:"targetFirmwareId,omitempty"`
	// Last reported firmware version.
	FirmwareVersion string `json:"firmwareVersion,omitempty"`
	SerialNumber    string `json:"serialNumber,omitempty"`
	ModelNumber     string `json:"modelNumber,omitempty"`
	Manufacturer    string `json:"manufacturer,omitempty"`
	// State of the firmware.
	State        string `json:"state,omitempty"`
	StateMessage string `json:"stateMessage,omitempty"`
}

type FirmwareUsageResponse struct {
	ImageId  string   `json:"imageId,omitempty"`
	Targeted []string `json:"targeted,omitempty"`
	Current  []string `json:"current,omitempty"`
}

type FotaApiService service

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

type ListCollectionDataOpts struct {
	Limit  optional.Int32
	Start  optional.String
	End    optional.String
	Offset optional.String
}

type ListCollectionResponse struct {
	Collections []Collection `json:"collections,omitempty"`
}

type ListDataResponse struct {
	Data []OutputDataMessage `json:"data,omitempty"`
}

type ListDeviceDataOpts struct {
	Limit  optional.Int32
	Start  optional.String
	End    optional.String
	Offset optional.String
}

type ListDevicesResponse struct {
	Devices []Device `json:"devices,omitempty"`
}

type ListFirmwareResponse struct {
	Images []Firmware `json:"images,omitempty"`
}

type ListOutputResponse struct {
	CollectionId string   `json:"collectionId,omitempty"`
	Outputs      []Output `json:"outputs,omitempty"`
}

type MessageSendResult struct {
	DeviceId string `json:"deviceId,omitempty"`
	Message  string `json:"message,omitempty"`
}

type MultiSendMessageResponse struct {
	Errors []MessageSendResult `json:"errors,omitempty"`
	Sent   int32               `json:"sent,omitempty"`
	Failed int32               `json:"failed,omitempty"`
}

type NetworkMetadata struct {
	// Allocated IP address.
	AllocatedIp string `json:"allocatedIp,omitempty"`
	AllocatedAt string `json:"allocatedAt,omitempty"`
	// Cell ID for device. This might not be set, depending on the provider in use.
	CellId string `json:"cellId,omitempty"`
}

type Output struct {
	OutputId     string            `json:"outputId,omitempty"`
	CollectionId string            `json:"collectionId,omitempty"`
	Type         OutputType        `json:"type,omitempty"`
	Config       OutputConfig      `json:"config,omitempty"`
	Enabled      bool              `json:"enabled,omitempty"`
	Tags         map[string]string `json:"tags,omitempty"`
}

type OutputConfig struct {
	Url               string `json:"url,omitempty"`
	BasicAuthUser     string `json:"basicAuthUser,omitempty"`
	BasicAuthPass     string `json:"basicAuthPass,omitempty"`
	CustomHeaderName  string `json:"customHeaderName,omitempty"`
	CustomHeaderValue string `json:"customHeaderValue,omitempty"`
	Host              string `json:"host,omitempty"`
	Port              int32  `json:"port,omitempty"`
	Key               string `json:"key,omitempty"`
	EventName         string `json:"eventName,omitempty"`
	AsIsPayload       bool   `json:"asIsPayload,omitempty"`
	Endpoint          string `json:"endpoint,omitempty"`
	// MQTT configuration: Disable certificate checks. Default is off.
	DisableCertCheck bool   `json:"disableCertCheck,omitempty"`
	Username         string `json:"username,omitempty"`
	Password         string `json:"password,omitempty"`
	ClientId         string `json:"clientId,omitempty"`
	TopicName        string `json:"topicName,omitempty"`
}

type OutputDataMessage struct {
	Type    OutputDataMessageOutputMessageType `json:"type,omitempty"`
	Device  Device                             `json:"device,omitempty"`
	Payload string                             `json:"payload,omitempty"`
	// Received time for message. Value is ms since epoch.
	Received     string       `json:"received,omitempty"`
	Transport    string       `json:"transport,omitempty"`
	UdpMetaData  UdpMetadata  `json:"udpMetaData,omitempty"`
	CoapMetaData CoApMetadata `json:"coapMetaData,omitempty"`
	MessageId    string       `json:"messageId,omitempty"`
}

type OutputDataMessageOutputMessageType string

type OutputLogEntry struct {
	Time     string `json:"time,omitempty"`
	Message  string `json:"message,omitempty"`
	Repeated int32  `json:"repeated,omitempty"`
}

type OutputLogs struct {
	Logs []OutputLogEntry `json:"logs,omitempty"`
}

type OutputStatus struct {
	CollectionId string `json:"collectionId,omitempty"`
	OutputId     string `json:"outputId,omitempty"`
	Enabled      bool   `json:"enabled,omitempty"`
	ErrorCount   int32  `json:"errorCount,omitempty"`
	Forwarded    int32  `json:"forwarded,omitempty"`
	Received     int32  `json:"received,omitempty"`
	Retransmits  int32  `json:"retransmits,omitempty"`
}

type OutputType string

type OutputsApiService service

type ProtobufAny struct {
	// A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted).  In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:  * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][]   value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the   URL, or have them precompiled into a binary to avoid any   lookup. Therefore, binary compatibility needs to be preserved   on changes to types. (Use versioned type names to manage   breaking changes.)  Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.  Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
	TypeUrl string `json:"typeUrl,omitempty"`
	// Must be a valid serialized protocol buffer of the above specified type.
	Value string `json:"value,omitempty"`
}

type RuntimeError struct {
	Error   string        `json:"error,omitempty"`
	Code    int32         `json:"code,omitempty"`
	Message string        `json:"message,omitempty"`
	Details []ProtobufAny `json:"details,omitempty"`
}

type RuntimeStreamError struct {
	GrpcCode   int32         `json:"grpcCode,omitempty"`
	HttpCode   int32         `json:"httpCode,omitempty"`
	Message    string        `json:"message,omitempty"`
	HttpStatus string        `json:"httpStatus,omitempty"`
	Details    []ProtobufAny `json:"details,omitempty"`
}

type SendMessageRequest struct {
	CollectionId string `json:"collectionId,omitempty"`
	DeviceId     string `json:"deviceId,omitempty"`
	Port         int32  `json:"port,omitempty"`
	Payload      string `json:"payload,omitempty"`
	// Valid transports are \"udp\", \"coap\", \"coap-pull\", \"udp-pull\", \"coap-push\", \"udp-push\". \"udp\" is equivalent to \"udp-push\" and \"coap\" is equivalent to \"coap-push\". Push messages are sent unsolicited to the device wheil pull messages are sent whenever the device wither sends data upstream (for UDP) or does a CoAP request to the CoAP service in span.
	Transport string `json:"transport,omitempty"`
	CoapPath  string `json:"coapPath,omitempty"`
}

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

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

type SystemApiService service

type SystemInfoResponse struct {
	Version          string    `json:"version,omitempty"`
	BuildDate        string    `json:"buildDate,omitempty"`
	ReleaseName      string    `json:"releaseName,omitempty"`
	DefaultFieldMask FieldMask `json:"defaultFieldMask,omitempty"`
	ForcedFieldMask  FieldMask `json:"forcedFieldMask,omitempty"`
}

type UdpMetadata struct {
	LocalPort  int32 `json:"localPort,omitempty"`
	RemotePort int32 `json:"remotePort,omitempty"`
}

type UpdateDeviceRequest struct {
	ExistingCollectionId string `json:"existingCollectionId,omitempty"`
	DeviceId             string `json:"deviceId,omitempty"`
	// The collection id for the device. This field is optional and can be omitted if the collection id isn't changed. When changing to a new collection you must be an owner of the other collection, ie an administrator of the team that owns the new collection.
	CollectionId string `json:"collectionId,omitempty"`
	// The IMSI is the unique ID for the (e|nu|whatever)SIM card on your device. This is the primary identifier for your device on the network.
	Imsi string `json:"imsi,omitempty"`
	// The IMEI number is the unique ID for your hardware as seen by the network. Obviously you might have a completely different view on things.
	Imei string `json:"imei,omitempty"`
	// Tags are metadata for the device that you can set. These are just strings.
	Tags     map[string]string `json:"tags,omitempty"`
	Firmware FirmwareMetadata  `json:"firmware,omitempty"`
}