oapi

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Jun 22, 2024 License: MIT Imports: 14 Imported by: 0

Documentation

Overview

Package oapi provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT.

Package oapi provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT.

Package oapi provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT.

Index

Constants

View Source 
const (
	BearerScopes = "bearer.Scopes"
)

Variables

This section is empty.

Functions

func GetSwagger 

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func NewBeginLoginRequest 

func NewBeginLoginRequest(server string, params *BeginLoginParams, body BeginLoginJSONRequestBody) (*http.Request, error)

NewBeginLoginRequest calls the generic BeginLogin builder with application/json body

func NewBeginLoginRequestWithBody 

func NewBeginLoginRequestWithBody(server string, params *BeginLoginParams, contentType string, body io.Reader) (*http.Request, error)

NewBeginLoginRequestWithBody generates requests for BeginLogin with any type of body

func NewCompleteLoginRequest 

func NewCompleteLoginRequest(server string, params *CompleteLoginParams, body CompleteLoginJSONRequestBody) (*http.Request, error)

NewCompleteLoginRequest calls the generic CompleteLogin builder with application/json body

func NewCompleteLoginRequestWithBody 

func NewCompleteLoginRequestWithBody(server string, params *CompleteLoginParams, contentType string, body io.Reader) (*http.Request, error)

NewCompleteLoginRequestWithBody generates requests for CompleteLogin with any type of body

func NewGetDevicesRequest 

func NewGetDevicesRequest(server string) (*http.Request, error)

NewGetDevicesRequest generates requests for GetDevices

func NewGetIoTInfoRequest 

func NewGetIoTInfoRequest(server string, body GetIoTInfoJSONRequestBody) (*http.Request, error)

NewGetIoTInfoRequest calls the generic GetIoTInfo builder with application/json body

func NewGetIoTInfoRequestWithBody 

func NewGetIoTInfoRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewGetIoTInfoRequestWithBody generates requests for GetIoTInfo with any type of body

func NewGetUserStatusRequest 

func NewGetUserStatusRequest(server string, params *GetUserStatusParams, body GetUserStatusJSONRequestBody) (*http.Request, error)

NewGetUserStatusRequest calls the generic GetUserStatus builder with application/json body

func NewGetUserStatusRequestWithBody 

func NewGetUserStatusRequestWithBody(server string, params *GetUserStatusParams, contentType string, body io.Reader) (*http.Request, error)

NewGetUserStatusRequestWithBody generates requests for GetUserStatus with any type of body

func NewProvisionRequest 

func NewProvisionRequest(server string) (*http.Request, error)

NewProvisionRequest generates requests for Provision

func PathToRawSpec 

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type BeginLoginJSONBody 

type BeginLoginJSONBody struct {
	// Email An email address
	Email openapi_types.Email `json:"email"`
}

BeginLoginJSONBody defines parameters for BeginLogin.

type BeginLoginJSONRequestBody 

type BeginLoginJSONRequestBody BeginLoginJSONBody

BeginLoginJSONRequestBody defines body for BeginLogin for application/json ContentType.

type BeginLoginParams 

type BeginLoginParams struct {
	// Country A 2-digit country code, assumed to be ISO 3166-1 alpha-2
	Country *PathCountry `form:"country,omitempty" json:"country,omitempty"`

	// Culture A locale/language, assumed to be IETF language code
	Culture   *PathCulture `form:"culture,omitempty" json:"culture,omitempty"`
	UserAgent UserAgent    `json:"User-Agent"`
}

BeginLoginParams defines parameters for BeginLogin.

type BeginLoginRequest 

type BeginLoginRequest struct {
	// Email An email address
	Email openapi_types.Email `json:"email"`
}

BeginLoginRequest defines model for BeginLoginRequest.

type BeginLoginResponse 

type BeginLoginResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LoginChallenge
}

func ParseBeginLoginResponse 

func ParseBeginLoginResponse(rsp *http.Response) (*BeginLoginResponse, error)

ParseBeginLoginResponse parses an HTTP response from a BeginLoginWithResponse call

func (BeginLoginResponse) Status 

func (r BeginLoginResponse) Status() string

Status returns HTTPResponse.Status

func (BeginLoginResponse) StatusCode 

func (r BeginLoginResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CapabilityString 

type CapabilityString string

CapabilityString defines model for CapabilityString. 

const (
	AdvanceOscillationDay1 CapabilityString = "AdvanceOscillationDay1"
	ChangeWifi             CapabilityString = "ChangeWifi"
	EnvironmentalData      CapabilityString = "EnvironmentalData"
	ExtendedAQ             CapabilityString = "ExtendedAQ"
	Scheduling             CapabilityString = "Scheduling"
)

Defines values for CapabilityString.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) BeginLogin 

func (c *Client) BeginLogin(ctx context.Context, params *BeginLoginParams, body BeginLoginJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) BeginLoginWithBody 

func (c *Client) BeginLoginWithBody(ctx context.Context, params *BeginLoginParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CompleteLogin 

func (c *Client) CompleteLogin(ctx context.Context, params *CompleteLoginParams, body CompleteLoginJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CompleteLoginWithBody 

func (c *Client) CompleteLoginWithBody(ctx context.Context, params *CompleteLoginParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetDevices 

func (c *Client) GetDevices(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetIoTInfo 

func (c *Client) GetIoTInfo(ctx context.Context, body GetIoTInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetIoTInfoWithBody 

func (c *Client) GetIoTInfoWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetUserStatus 

func (c *Client) GetUserStatus(ctx context.Context, params *GetUserStatusParams, body GetUserStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetUserStatusWithBody 

func (c *Client) GetUserStatusWithBody(ctx context.Context, params *GetUserStatusParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Provision 

func (c *Client) Provision(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// Provision request
	Provision(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIoTInfoWithBody request with any body
	GetIoTInfoWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	GetIoTInfo(ctx context.Context, body GetIoTInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDevices request
	GetDevices(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BeginLoginWithBody request with any body
	BeginLoginWithBody(ctx context.Context, params *BeginLoginParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	BeginLogin(ctx context.Context, params *BeginLoginParams, body BeginLoginJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetUserStatusWithBody request with any body
	GetUserStatusWithBody(ctx context.Context, params *GetUserStatusParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	GetUserStatus(ctx context.Context, params *GetUserStatusParams, body GetUserStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CompleteLoginWithBody request with any body
	CompleteLoginWithBody(ctx context.Context, params *CompleteLoginParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CompleteLogin(ctx context.Context, params *CompleteLoginParams, body CompleteLoginJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) BeginLoginWithBodyWithResponse 

func (c *ClientWithResponses) BeginLoginWithBodyWithResponse(ctx context.Context, params *BeginLoginParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BeginLoginResponse, error)

BeginLoginWithBodyWithResponse request with arbitrary body returning *BeginLoginResponse

func (*ClientWithResponses) BeginLoginWithResponse 

func (c *ClientWithResponses) BeginLoginWithResponse(ctx context.Context, params *BeginLoginParams, body BeginLoginJSONRequestBody, reqEditors ...RequestEditorFn) (*BeginLoginResponse, error)

func (*ClientWithResponses) CompleteLoginWithBodyWithResponse 

func (c *ClientWithResponses) CompleteLoginWithBodyWithResponse(ctx context.Context, params *CompleteLoginParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CompleteLoginResponse, error)

CompleteLoginWithBodyWithResponse request with arbitrary body returning *CompleteLoginResponse

func (*ClientWithResponses) CompleteLoginWithResponse 

func (c *ClientWithResponses) CompleteLoginWithResponse(ctx context.Context, params *CompleteLoginParams, body CompleteLoginJSONRequestBody, reqEditors ...RequestEditorFn) (*CompleteLoginResponse, error)

func (*ClientWithResponses) GetDevicesWithResponse 

func (c *ClientWithResponses) GetDevicesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetDevicesResponse, error)

GetDevicesWithResponse request returning *GetDevicesResponse

func (*ClientWithResponses) GetIoTInfoWithBodyWithResponse 

func (c *ClientWithResponses) GetIoTInfoWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetIoTInfoResponse, error)

GetIoTInfoWithBodyWithResponse request with arbitrary body returning *GetIoTInfoResponse

func (*ClientWithResponses) GetIoTInfoWithResponse 

func (c *ClientWithResponses) GetIoTInfoWithResponse(ctx context.Context, body GetIoTInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*GetIoTInfoResponse, error)

func (*ClientWithResponses) GetUserStatusWithBodyWithResponse 

func (c *ClientWithResponses) GetUserStatusWithBodyWithResponse(ctx context.Context, params *GetUserStatusParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetUserStatusResponse, error)

GetUserStatusWithBodyWithResponse request with arbitrary body returning *GetUserStatusResponse

func (*ClientWithResponses) GetUserStatusWithResponse 

func (c *ClientWithResponses) GetUserStatusWithResponse(ctx context.Context, params *GetUserStatusParams, body GetUserStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*GetUserStatusResponse, error)

func (*ClientWithResponses) ProvisionWithResponse 

func (c *ClientWithResponses) ProvisionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ProvisionResponse, error)

ProvisionWithResponse request returning *ProvisionResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// ProvisionWithResponse request
	ProvisionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ProvisionResponse, error)

	// GetIoTInfoWithBodyWithResponse request with any body
	GetIoTInfoWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetIoTInfoResponse, error)

	GetIoTInfoWithResponse(ctx context.Context, body GetIoTInfoJSONRequestBody, reqEditors ...RequestEditorFn) (*GetIoTInfoResponse, error)

	// GetDevicesWithResponse request
	GetDevicesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetDevicesResponse, error)

	// BeginLoginWithBodyWithResponse request with any body
	BeginLoginWithBodyWithResponse(ctx context.Context, params *BeginLoginParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BeginLoginResponse, error)

	BeginLoginWithResponse(ctx context.Context, params *BeginLoginParams, body BeginLoginJSONRequestBody, reqEditors ...RequestEditorFn) (*BeginLoginResponse, error)

	// GetUserStatusWithBodyWithResponse request with any body
	GetUserStatusWithBodyWithResponse(ctx context.Context, params *GetUserStatusParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetUserStatusResponse, error)

	GetUserStatusWithResponse(ctx context.Context, params *GetUserStatusParams, body GetUserStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*GetUserStatusResponse, error)

	// CompleteLoginWithBodyWithResponse request with any body
	CompleteLoginWithBodyWithResponse(ctx context.Context, params *CompleteLoginParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CompleteLoginResponse, error)

	CompleteLoginWithResponse(ctx context.Context, params *CompleteLoginParams, body CompleteLoginJSONRequestBody, reqEditors ...RequestEditorFn) (*CompleteLoginResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CompleteLoginJSONBody 

type CompleteLoginJSONBody struct {
	ChallengeId openapi_types.UUID  `json:"challengeId"`
	Email       openapi_types.Email `json:"email"`
	OtpCode     string              `json:"otpCode"`
	Password    string              `json:"password"`
}

CompleteLoginJSONBody defines parameters for CompleteLogin.

type CompleteLoginJSONRequestBody 

type CompleteLoginJSONRequestBody CompleteLoginJSONBody

CompleteLoginJSONRequestBody defines body for CompleteLogin for application/json ContentType.

type CompleteLoginParams 

type CompleteLoginParams struct {
	// Country A 2-digit country code, assumed to be ISO 3166-1 alpha-2
	Country *PathCountry `form:"country,omitempty" json:"country,omitempty"`

	// Culture A locale/language, assumed to be IETF language code
	Culture   *PathCulture `form:"culture,omitempty" json:"culture,omitempty"`
	UserAgent UserAgent    `json:"User-Agent"`
}

CompleteLoginParams defines parameters for CompleteLogin.

type CompleteLoginRequest 

type CompleteLoginRequest struct {
	ChallengeId openapi_types.UUID  `json:"challengeId"`
	Email       openapi_types.Email `json:"email"`
	OtpCode     string              `json:"otpCode"`
	Password    string              `json:"password"`
}

CompleteLoginRequest defines model for CompleteLoginRequest.

type CompleteLoginResponse 

type CompleteLoginResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LoginComplete
}

func ParseCompleteLoginResponse 

func ParseCompleteLoginResponse(rsp *http.Response) (*CompleteLoginResponse, error)

ParseCompleteLoginResponse parses an HTTP response from a CompleteLoginWithResponse call

func (CompleteLoginResponse) Status 

func (r CompleteLoginResponse) Status() string

Status returns HTTPResponse.Status

func (CompleteLoginResponse) StatusCode 

func (r CompleteLoginResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ConnectedConfiguration 

type ConnectedConfiguration struct {
	Firmware Firmware `json:"firmware"`
	Mqtt     MQTT     `json:"mqtt"`
}

ConnectedConfiguration defines model for ConnectedConfiguration.

type Device 

type Device struct {
	Category               DeviceCategory           `json:"category"`
	ConnectedConfiguration ConnectedConfiguration   `json:"connectedConfiguration"`
	ConnectionCategory     DeviceConnectionCategory `json:"connectionCategory"`
	Model                  string                   `json:"model"`
	Name                   string                   `json:"name"`
	SerialNumber           string                   `json:"serialNumber"`
	Type                   string                   `json:"type"`
	Variant                *string                  `json:"variant,omitempty"`
}

Device defines model for Device.

type DeviceCategory 

type DeviceCategory string

DeviceCategory defines model for Device.Category. 

const (
	Ec       DeviceCategory = "ec"
	Flrc     DeviceCategory = "flrc"
	Hc       DeviceCategory = "hc"
	Light    DeviceCategory = "light"
	Robot    DeviceCategory = "robot"
	Wearable DeviceCategory = "wearable"
)

Defines values for DeviceCategory.

type DeviceConnectionCategory 

type DeviceConnectionCategory string

DeviceConnectionCategory defines model for Device.ConnectionCategory. 

const (
	LecAndWifi   DeviceConnectionCategory = "lecAndWifi"
	LecOnly      DeviceConnectionCategory = "lecOnly"
	NonConnected DeviceConnectionCategory = "nonConnected"
	WifiOnly     DeviceConnectionCategory = "wifiOnly"
)

Defines values for DeviceConnectionCategory.

type Devices 

type Devices = []Device

Devices defines model for Devices.

type Firmware 

type Firmware struct {
	AutoUpdateEnabled   bool                `json:"autoUpdateEnabled"`
	Capabilities        *[]CapabilityString `json:"capabilities,omitempty"`
	NewVersionAvailable bool                `json:"newVersionAvailable"`
	Version             string              `json:"version"`
}

Firmware defines model for Firmware.

type GetDevicesResponse 

type GetDevicesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Devices
}

func ParseGetDevicesResponse 

func ParseGetDevicesResponse(rsp *http.Response) (*GetDevicesResponse, error)

ParseGetDevicesResponse parses an HTTP response from a GetDevicesWithResponse call

func (GetDevicesResponse) Status 

func (r GetDevicesResponse) Status() string

Status returns HTTPResponse.Status

func (GetDevicesResponse) StatusCode 

func (r GetDevicesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIoTInfoJSONBody 

type GetIoTInfoJSONBody struct {
	// Serial A serial number
	Serial string `json:"Serial"`
}

GetIoTInfoJSONBody defines parameters for GetIoTInfo.

type GetIoTInfoJSONRequestBody 

type GetIoTInfoJSONRequestBody GetIoTInfoJSONBody

GetIoTInfoJSONRequestBody defines body for GetIoTInfo for application/json ContentType.

type GetIoTInfoResponse 

type GetIoTInfoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *IoTData
}

func ParseGetIoTInfoResponse 

func ParseGetIoTInfoResponse(rsp *http.Response) (*GetIoTInfoResponse, error)

ParseGetIoTInfoResponse parses an HTTP response from a GetIoTInfoWithResponse call

func (GetIoTInfoResponse) Status 

func (r GetIoTInfoResponse) Status() string

Status returns HTTPResponse.Status

func (GetIoTInfoResponse) StatusCode 

func (r GetIoTInfoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetUserStatusJSONBody 

type GetUserStatusJSONBody struct {
	// Email An email address
	Email openapi_types.Email `json:"email"`
}

GetUserStatusJSONBody defines parameters for GetUserStatus.

type GetUserStatusJSONRequestBody 

type GetUserStatusJSONRequestBody GetUserStatusJSONBody

GetUserStatusJSONRequestBody defines body for GetUserStatus for application/json ContentType.

type GetUserStatusParams 

type GetUserStatusParams struct {
	// Country A 2-digit country code, assumed to be ISO 3166-1 alpha-2
	Country   *PathCountry `form:"country,omitempty" json:"country,omitempty"`
	UserAgent UserAgent    `json:"User-Agent"`
}

GetUserStatusParams defines parameters for GetUserStatus.

type GetUserStatusResponse 

type GetUserStatusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *UserStatus
}

func ParseGetUserStatusResponse 

func ParseGetUserStatusResponse(rsp *http.Response) (*GetUserStatusResponse, error)

ParseGetUserStatusResponse parses an HTTP response from a GetUserStatusWithResponse call

func (GetUserStatusResponse) Status 

func (r GetUserStatusResponse) Status() string

Status returns HTTPResponse.Status

func (GetUserStatusResponse) StatusCode 

func (r GetUserStatusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type IoTCredentials 

type IoTCredentials struct {
	ClientId             openapi_types.UUID `json:"ClientId"`
	CustomAuthorizerName string             `json:"CustomAuthorizerName"`
	TokenKey             string             `json:"TokenKey"`
	TokenSignature       string             `json:"TokenSignature"`
	TokenValue           openapi_types.UUID `json:"TokenValue"`
}

IoTCredentials defines model for IoTCredentials.

type IoTData 

type IoTData struct {
	Endpoint       string         `json:"Endpoint"`
	IoTCredentials IoTCredentials `json:"IoTCredentials"`
}

IoTData defines model for IoTData.

type IoTDataRequest 

type IoTDataRequest struct {
	// Serial A serial number
	Serial string `json:"Serial"`
}

IoTDataRequest defines model for IoTDataRequest.

type LoginChallenge 

type LoginChallenge struct {
	ChallengeId openapi_types.UUID `json:"challengeId"`
}

LoginChallenge defines model for LoginChallenge.

type LoginComplete 

type LoginComplete = LoginInformation

LoginComplete defines model for LoginComplete.

type LoginInformation 

type LoginInformation struct {
	Account   openapi_types.UUID        `json:"account"`
	Token     string                    `json:"token"`
	TokenType LoginInformationTokenType `json:"tokenType"`
}

LoginInformation defines model for LoginInformation.

type LoginInformationTokenType 

type LoginInformationTokenType string

LoginInformationTokenType defines model for LoginInformation.TokenType. 

const (
	Bearer LoginInformationTokenType = "Bearer"
)

Defines values for LoginInformationTokenType.

type MQTT 

type MQTT struct {
	LocalBrokerCredentials string               `json:"localBrokerCredentials"`
	MqttRootTopicLevel     string               `json:"mqttRootTopicLevel"`
	RemoteBrokerType       MQTTRemoteBrokerType `json:"remoteBrokerType"`
}

MQTT defines model for MQTT.

type MQTTRemoteBrokerType 

type MQTTRemoteBrokerType string

MQTTRemoteBrokerType defines model for MQTT.RemoteBrokerType. 

const (
	Wss MQTTRemoteBrokerType = "wss"
)

Defines values for MQTTRemoteBrokerType.

type PathCountry 

type PathCountry = string

PathCountry defines model for PathCountry.

type PathCulture 

type PathCulture = string

PathCulture defines model for PathCulture.

type Provision 

type Provision = string

Provision defines model for Provision.

type ProvisionResponse 

type ProvisionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Provision
}

func ParseProvisionResponse 

func ParseProvisionResponse(rsp *http.Response) (*ProvisionResponse, error)

ParseProvisionResponse parses an HTTP response from a ProvisionWithResponse call

func (ProvisionResponse) Status 

func (r ProvisionResponse) Status() string

Status returns HTTPResponse.Status

func (ProvisionResponse) StatusCode 

func (r ProvisionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type UserAgent 

type UserAgent = string

UserAgent defines model for UserAgent.

type UserStatus 

type UserStatus struct {
	AccountStatus        UserStatusAccountStatus        `json:"accountStatus"`
	AuthenticationMethod UserStatusAuthenticationMethod `json:"authenticationMethod"`
}

UserStatus defines model for UserStatus.

type UserStatusAccountStatus 

type UserStatusAccountStatus string

UserStatusAccountStatus defines model for UserStatus.AccountStatus. 

const (
	ACTIVE       UserStatusAccountStatus = "ACTIVE"
	UNREGISTERED UserStatusAccountStatus = "UNREGISTERED"
)

Defines values for UserStatusAccountStatus.

type UserStatusAuthenticationMethod 

type UserStatusAuthenticationMethod string

UserStatusAuthenticationMethod defines model for UserStatus.AuthenticationMethod. 

const (
	EMAILPWD2FA UserStatusAuthenticationMethod = "EMAIL_PWD_2FA"
)

Defines values for UserStatusAuthenticationMethod.

type UserStatusRequest 

type UserStatusRequest struct {
	// Email An email address
	Email openapi_types.Email `json:"email"`
}

UserStatusRequest defines model for UserStatusRequest.

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.