openapi

package
v1.23.8 Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2024 License: MIT Imports: 6 Imported by: 1

README

Go API client for openapi

This is the public Twilio REST API.

Overview

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

  • API version: 1.0.0
  • 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://microvisor.twilio.com

Class Method HTTP request Description
AppsApi DeleteApp Delete /v1/Apps/{Sid}
AppsApi FetchApp Get /v1/Apps/{Sid}
AppsApi ListApp Get /v1/Apps
AppsManifestApi FetchAppManifest Get /v1/Apps/{AppSid}/Manifest
ConfigsApi CreateAccountConfig Post /v1/Configs
ConfigsApi DeleteAccountConfig Delete /v1/Configs/{Key}
ConfigsApi FetchAccountConfig Get /v1/Configs/{Key}
ConfigsApi ListAccountConfig Get /v1/Configs
ConfigsApi UpdateAccountConfig Post /v1/Configs/{Key}
DevicesApi FetchDevice Get /v1/Devices/{Sid}
DevicesApi ListDevice Get /v1/Devices
DevicesApi UpdateDevice Post /v1/Devices/{Sid}
DevicesConfigsApi CreateDeviceConfig Post /v1/Devices/{DeviceSid}/Configs
DevicesConfigsApi DeleteDeviceConfig Delete /v1/Devices/{DeviceSid}/Configs/{Key}
DevicesConfigsApi FetchDeviceConfig Get /v1/Devices/{DeviceSid}/Configs/{Key}
DevicesConfigsApi ListDeviceConfig Get /v1/Devices/{DeviceSid}/Configs
DevicesConfigsApi UpdateDeviceConfig Post /v1/Devices/{DeviceSid}/Configs/{Key}
DevicesSecretsApi CreateDeviceSecret Post /v1/Devices/{DeviceSid}/Secrets
DevicesSecretsApi DeleteDeviceSecret Delete /v1/Devices/{DeviceSid}/Secrets/{Key}
DevicesSecretsApi FetchDeviceSecret Get /v1/Devices/{DeviceSid}/Secrets/{Key}
DevicesSecretsApi ListDeviceSecret Get /v1/Devices/{DeviceSid}/Secrets
DevicesSecretsApi UpdateDeviceSecret Post /v1/Devices/{DeviceSid}/Secrets/{Key}
SecretsApi CreateAccountSecret Post /v1/Secrets
SecretsApi DeleteAccountSecret Delete /v1/Secrets/{Key}
SecretsApi FetchAccountSecret Get /v1/Secrets/{Key}
SecretsApi ListAccountSecret Get /v1/Secrets
SecretsApi UpdateAccountSecret Post /v1/Secrets/{Key}

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) CreateAccountConfig added in v1.3.3 

func (c *ApiService) CreateAccountConfig(params *CreateAccountConfigParams) (*MicrovisorV1AccountConfig, error)

Create a config for an Account.

func (*ApiService) CreateAccountSecret added in v1.3.3 

func (c *ApiService) CreateAccountSecret(params *CreateAccountSecretParams) (*MicrovisorV1AccountSecret, error)

Create a secret for an Account.

func (*ApiService) CreateDeviceConfig added in v1.3.3 

func (c *ApiService) CreateDeviceConfig(DeviceSid string, params *CreateDeviceConfigParams) (*MicrovisorV1DeviceConfig, error)

Create a config for a Microvisor Device.

func (*ApiService) CreateDeviceSecret added in v1.3.3 

func (c *ApiService) CreateDeviceSecret(DeviceSid string, params *CreateDeviceSecretParams) (*MicrovisorV1DeviceSecret, error)

Create a secret for a Microvisor Device.

func (*ApiService) DeleteAccountConfig added in v1.3.3 

func (c *ApiService) DeleteAccountConfig(Key string) error

Delete a config for an Account.

func (*ApiService) DeleteAccountSecret added in v1.3.3 

func (c *ApiService) DeleteAccountSecret(Key string) error

Delete a secret for an Account.

func (*ApiService) DeleteApp 

func (c *ApiService) DeleteApp(Sid string) error

Delete a specific App.

func (*ApiService) DeleteDeviceConfig added in v1.3.3 

func (c *ApiService) DeleteDeviceConfig(DeviceSid string, Key string) error

Delete a config for a Microvisor Device.

func (*ApiService) DeleteDeviceSecret added in v1.3.3 

func (c *ApiService) DeleteDeviceSecret(DeviceSid string, Key string) error

Delete a secret for a Microvisor Device.

func (*ApiService) FetchAccountConfig added in v1.3.3 

func (c *ApiService) FetchAccountConfig(Key string) (*MicrovisorV1AccountConfig, error)

Retrieve a Config for an Account.

func (*ApiService) FetchAccountSecret added in v1.3.3 

func (c *ApiService) FetchAccountSecret(Key string) (*MicrovisorV1AccountSecret, error)

Retrieve a Secret for an Account.

func (*ApiService) FetchApp 

func (c *ApiService) FetchApp(Sid string) (*MicrovisorV1App, error)

Fetch a specific App.

func (*ApiService) FetchAppManifest added in v1.3.5 

func (c *ApiService) FetchAppManifest(AppSid string) (*MicrovisorV1AppManifest, error)

Retrieve the Manifest for an App.

func (*ApiService) FetchDevice 

func (c *ApiService) FetchDevice(Sid string) (*MicrovisorV1Device, error)

Fetch a specific Device.

func (*ApiService) FetchDeviceConfig added in v1.3.3 

func (c *ApiService) FetchDeviceConfig(DeviceSid string, Key string) (*MicrovisorV1DeviceConfig, error)

Retrieve a Config for a Device.

func (*ApiService) FetchDeviceSecret added in v1.3.3 

func (c *ApiService) FetchDeviceSecret(DeviceSid string, Key string) (*MicrovisorV1DeviceSecret, error)

Retrieve a Secret for a Device.

func (*ApiService) ListAccountConfig added in v1.3.3 

func (c *ApiService) ListAccountConfig(params *ListAccountConfigParams) ([]MicrovisorV1AccountConfig, error)

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

func (*ApiService) ListAccountSecret added in v1.3.3 

func (c *ApiService) ListAccountSecret(params *ListAccountSecretParams) ([]MicrovisorV1AccountSecret, error)

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

func (*ApiService) ListApp 

func (c *ApiService) ListApp(params *ListAppParams) ([]MicrovisorV1App, error)

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

func (*ApiService) ListDevice 

func (c *ApiService) ListDevice(params *ListDeviceParams) ([]MicrovisorV1Device, error)

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

func (*ApiService) ListDeviceConfig added in v1.3.3 

func (c *ApiService) ListDeviceConfig(DeviceSid string, params *ListDeviceConfigParams) ([]MicrovisorV1DeviceConfig, error)

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

func (*ApiService) ListDeviceSecret added in v1.3.3 

func (c *ApiService) ListDeviceSecret(DeviceSid string, params *ListDeviceSecretParams) ([]MicrovisorV1DeviceSecret, error)

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

func (*ApiService) PageAccountConfig added in v1.3.3 

func (c *ApiService) PageAccountConfig(params *ListAccountConfigParams, pageToken, pageNumber string) (*ListAccountConfigResponse, error)

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

func (*ApiService) PageAccountSecret added in v1.3.3 

func (c *ApiService) PageAccountSecret(params *ListAccountSecretParams, pageToken, pageNumber string) (*ListAccountSecretResponse, error)

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

func (*ApiService) PageApp 

func (c *ApiService) PageApp(params *ListAppParams, pageToken, pageNumber string) (*ListAppResponse, error)

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

func (*ApiService) PageDevice 

func (c *ApiService) PageDevice(params *ListDeviceParams, pageToken, pageNumber string) (*ListDeviceResponse, error)

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

func (*ApiService) PageDeviceConfig added in v1.3.3 

func (c *ApiService) PageDeviceConfig(DeviceSid string, params *ListDeviceConfigParams, pageToken, pageNumber string) (*ListDeviceConfigResponse, error)

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

func (*ApiService) PageDeviceSecret added in v1.3.3 

func (c *ApiService) PageDeviceSecret(DeviceSid string, params *ListDeviceSecretParams, pageToken, pageNumber string) (*ListDeviceSecretResponse, error)

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

func (*ApiService) StreamAccountConfig added in v1.3.3 

func (c *ApiService) StreamAccountConfig(params *ListAccountConfigParams) (chan MicrovisorV1AccountConfig, chan error)

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

func (*ApiService) StreamAccountSecret added in v1.3.3 

func (c *ApiService) StreamAccountSecret(params *ListAccountSecretParams) (chan MicrovisorV1AccountSecret, chan error)

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

func (*ApiService) StreamApp 

func (c *ApiService) StreamApp(params *ListAppParams) (chan MicrovisorV1App, chan error)

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

func (*ApiService) StreamDevice 

func (c *ApiService) StreamDevice(params *ListDeviceParams) (chan MicrovisorV1Device, chan error)

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

func (*ApiService) StreamDeviceConfig added in v1.3.3 

func (c *ApiService) StreamDeviceConfig(DeviceSid string, params *ListDeviceConfigParams) (chan MicrovisorV1DeviceConfig, chan error)

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

func (*ApiService) StreamDeviceSecret added in v1.3.3 

func (c *ApiService) StreamDeviceSecret(DeviceSid string, params *ListDeviceSecretParams) (chan MicrovisorV1DeviceSecret, chan error)

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

func (*ApiService) UpdateAccountConfig added in v1.3.4 

func (c *ApiService) UpdateAccountConfig(Key string, params *UpdateAccountConfigParams) (*MicrovisorV1AccountConfig, error)

Update a config for an Account.

func (*ApiService) UpdateAccountSecret added in v1.3.4 

func (c *ApiService) UpdateAccountSecret(Key string, params *UpdateAccountSecretParams) (*MicrovisorV1AccountSecret, error)

Update a secret for an Account.

func (*ApiService) UpdateDevice 

func (c *ApiService) UpdateDevice(Sid string, params *UpdateDeviceParams) (*MicrovisorV1Device, error)

Update a specific Device.

func (*ApiService) UpdateDeviceConfig added in v1.3.4 

func (c *ApiService) UpdateDeviceConfig(DeviceSid string, Key string, params *UpdateDeviceConfigParams) (*MicrovisorV1DeviceConfig, error)

Update a config for a Microvisor Device.

func (*ApiService) UpdateDeviceSecret added in v1.3.4 

func (c *ApiService) UpdateDeviceSecret(DeviceSid string, Key string, params *UpdateDeviceSecretParams) (*MicrovisorV1DeviceSecret, error)

Update a secret for a Microvisor Device.

type CreateAccountConfigParams added in v1.3.3 

type CreateAccountConfigParams struct {
	// The config key; up to 100 characters.
	Key *string `json:"Key,omitempty"`
	// The config value; up to 4096 characters.
	Value *string `json:"Value,omitempty"`
}

Optional parameters for the method 'CreateAccountConfig'

func (*CreateAccountConfigParams) SetKey added in v1.3.3 

func (params *CreateAccountConfigParams) SetKey(Key string) *CreateAccountConfigParams

func (*CreateAccountConfigParams) SetValue added in v1.3.3 

func (params *CreateAccountConfigParams) SetValue(Value string) *CreateAccountConfigParams

type CreateAccountSecretParams added in v1.3.3 

type CreateAccountSecretParams struct {
	// The secret key; up to 100 characters.
	Key *string `json:"Key,omitempty"`
	// The secret value; up to 4096 characters.
	Value *string `json:"Value,omitempty"`
}

Optional parameters for the method 'CreateAccountSecret'

func (*CreateAccountSecretParams) SetKey added in v1.3.3 

func (params *CreateAccountSecretParams) SetKey(Key string) *CreateAccountSecretParams

func (*CreateAccountSecretParams) SetValue added in v1.3.3 

func (params *CreateAccountSecretParams) SetValue(Value string) *CreateAccountSecretParams

type CreateDeviceConfigParams added in v1.3.3 

type CreateDeviceConfigParams struct {
	// The config key; up to 100 characters.
	Key *string `json:"Key,omitempty"`
	// The config value; up to 4096 characters.
	Value *string `json:"Value,omitempty"`
}

Optional parameters for the method 'CreateDeviceConfig'

func (*CreateDeviceConfigParams) SetKey added in v1.3.3 

func (params *CreateDeviceConfigParams) SetKey(Key string) *CreateDeviceConfigParams

func (*CreateDeviceConfigParams) SetValue added in v1.3.3 

func (params *CreateDeviceConfigParams) SetValue(Value string) *CreateDeviceConfigParams

type CreateDeviceSecretParams added in v1.3.3 

type CreateDeviceSecretParams struct {
	// The secret key; up to 100 characters.
	Key *string `json:"Key,omitempty"`
	// The secret value; up to 4096 characters.
	Value *string `json:"Value,omitempty"`
}

Optional parameters for the method 'CreateDeviceSecret'

func (*CreateDeviceSecretParams) SetKey added in v1.3.3 

func (params *CreateDeviceSecretParams) SetKey(Key string) *CreateDeviceSecretParams

func (*CreateDeviceSecretParams) SetValue added in v1.3.3 

func (params *CreateDeviceSecretParams) SetValue(Value string) *CreateDeviceSecretParams

type ListAccountConfigParams added in v1.3.3 

type ListAccountConfigParams 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 'ListAccountConfig'

func (*ListAccountConfigParams) SetLimit added in v1.3.3 

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

func (*ListAccountConfigParams) SetPageSize added in v1.3.3 

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

type ListAccountConfigResponse added in v1.3.3 

type ListAccountConfigResponse struct {
	Configs []MicrovisorV1AccountConfig   `json:"configs,omitempty"`
	Meta    ListAccountConfigResponseMeta `json:"meta,omitempty"`
}

ListAccountConfigResponse struct for ListAccountConfigResponse

type ListAccountConfigResponseMeta added in v1.3.3 

type ListAccountConfigResponseMeta struct {
	FirstPageUrl    string  `json:"first_page_url,omitempty"`
	Key             string  `json:"key,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"`
}

ListAccountConfigResponseMeta struct for ListAccountConfigResponseMeta

type ListAccountSecretParams added in v1.3.3 

type ListAccountSecretParams 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 'ListAccountSecret'

func (*ListAccountSecretParams) SetLimit added in v1.3.3 

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

func (*ListAccountSecretParams) SetPageSize added in v1.3.3 

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

type ListAccountSecretResponse added in v1.3.3 

type ListAccountSecretResponse struct {
	Secrets []MicrovisorV1AccountSecret   `json:"secrets,omitempty"`
	Meta    ListAccountConfigResponseMeta `json:"meta,omitempty"`
}

ListAccountSecretResponse struct for ListAccountSecretResponse

type ListAppParams 

type ListAppParams 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 'ListApp'

func (*ListAppParams) SetLimit 

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

func (*ListAppParams) SetPageSize 

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

type ListAppResponse 

type ListAppResponse struct {
	Apps []MicrovisorV1App             `json:"apps,omitempty"`
	Meta ListAccountConfigResponseMeta `json:"meta,omitempty"`
}

ListAppResponse struct for ListAppResponse

type ListDeviceConfigParams added in v1.3.3 

type ListDeviceConfigParams 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 'ListDeviceConfig'

func (*ListDeviceConfigParams) SetLimit added in v1.3.3 

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

func (*ListDeviceConfigParams) SetPageSize added in v1.3.3 

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

type ListDeviceConfigResponse added in v1.3.3 

type ListDeviceConfigResponse struct {
	Configs []MicrovisorV1DeviceConfig    `json:"configs,omitempty"`
	Meta    ListAccountConfigResponseMeta `json:"meta,omitempty"`
}

ListDeviceConfigResponse struct for ListDeviceConfigResponse

type ListDeviceParams 

type ListDeviceParams 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 'ListDevice'

func (*ListDeviceParams) SetLimit 

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

func (*ListDeviceParams) SetPageSize 

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

type ListDeviceResponse 

type ListDeviceResponse struct {
	Devices []MicrovisorV1Device          `json:"devices,omitempty"`
	Meta    ListAccountConfigResponseMeta `json:"meta,omitempty"`
}

ListDeviceResponse struct for ListDeviceResponse

type ListDeviceSecretParams added in v1.3.3 

type ListDeviceSecretParams 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 'ListDeviceSecret'

func (*ListDeviceSecretParams) SetLimit added in v1.3.3 

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

func (*ListDeviceSecretParams) SetPageSize added in v1.3.3 

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

type ListDeviceSecretResponse added in v1.3.3 

type ListDeviceSecretResponse struct {
	Secrets []MicrovisorV1DeviceSecret    `json:"secrets,omitempty"`
	Meta    ListAccountConfigResponseMeta `json:"meta,omitempty"`
}

ListDeviceSecretResponse struct for ListDeviceSecretResponse

type MicrovisorV1AccountConfig added in v1.3.3 

type MicrovisorV1AccountConfig struct {
	// The config key; up to 100 characters.
	Key         *string    `json:"key,omitempty"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The config value; up to 4096 characters.
	Value *string `json:"value,omitempty"`
	// The absolute URL of the Config.
	Url *string `json:"url,omitempty"`
}

MicrovisorV1AccountConfig struct for MicrovisorV1AccountConfig

type MicrovisorV1AccountSecret added in v1.3.3 

type MicrovisorV1AccountSecret struct {
	// The secret key; up to 100 characters.
	Key         *string    `json:"key,omitempty"`
	DateRotated *time.Time `json:"date_rotated,omitempty"`
	// The absolute URL of the Secret.
	Url *string `json:"url,omitempty"`
}

MicrovisorV1AccountSecret struct for MicrovisorV1AccountSecret

type MicrovisorV1App 

type MicrovisorV1App struct {
	// A 34-character string that uniquely identifies this App.
	Sid *string `json:"sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// App manifest hash represented as `hash_algorithm:hash_value`.
	Hash *string `json:"hash,omitempty"`
	// A developer-defined string that uniquely identifies the App. This value must be unique for all Apps on this Account. The `unique_name` value may be used as an alternative to the `sid` in the URL path to address the resource.
	UniqueName *string `json:"unique_name,omitempty"`
	// The date that this App 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 App was last updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URL of this resource.
	Url   *string                 `json:"url,omitempty"`
	Links *map[string]interface{} `json:"links,omitempty"`
}

MicrovisorV1App struct for MicrovisorV1App

type MicrovisorV1AppManifest added in v1.3.5 

type MicrovisorV1AppManifest struct {
	// A 34-character string that uniquely identifies this App.
	AppSid *string `json:"app_sid,omitempty"`
	// App manifest hash represented as `hash_algorithm:hash_value`.
	Hash *string `json:"hash,omitempty"`
	// The base-64 encoded manifest
	EncodedBytes *string `json:"encoded_bytes,omitempty"`
	// The absolute URL of this Manifest.
	Url *string `json:"url,omitempty"`
}

MicrovisorV1AppManifest struct for MicrovisorV1AppManifest

type MicrovisorV1Device 

type MicrovisorV1Device struct {
	// A 34-character string that uniquely identifies this Device.
	Sid *string `json:"sid,omitempty"`
	// A developer-defined string that uniquely identifies the Device. This value must be unique for all Devices on this Account. The `unique_name` value may be used as an alternative to the `sid` in the URL path to address the resource.
	UniqueName *string `json:"unique_name,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// Information about the target App and the App reported by this Device. Contains the properties `target_sid`, `date_targeted`, `update_status` (one of `up-to-date`, `pending` and `error`), `update_error_code`, `reported_sid` and `date_reported`.
	App *interface{} `json:"app,omitempty"`
	// Object specifying whether application logging is enabled for this Device. Contains the properties `enabled` and `date_expires`.
	Logging *interface{} `json:"logging,omitempty"`
	// The date that this Device 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 Device was last updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
	// The absolute URLs of related resources.
	Links *map[string]interface{} `json:"links,omitempty"`
}

MicrovisorV1Device struct for MicrovisorV1Device

type MicrovisorV1DeviceConfig added in v1.3.3 

type MicrovisorV1DeviceConfig struct {
	// A 34-character string that uniquely identifies the parent Device.
	DeviceSid *string `json:"device_sid,omitempty"`
	// The config key; up to 100 characters.
	Key *string `json:"key,omitempty"`
	// The config value; up to 4096 characters.
	Value       *string    `json:"value,omitempty"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Config.
	Url *string `json:"url,omitempty"`
}

MicrovisorV1DeviceConfig struct for MicrovisorV1DeviceConfig

type MicrovisorV1DeviceSecret added in v1.3.3 

type MicrovisorV1DeviceSecret struct {
	// A 34-character string that uniquely identifies the parent Device.
	DeviceSid *string `json:"device_sid,omitempty"`
	// The secret key; up to 100 characters.
	Key         *string    `json:"key,omitempty"`
	DateRotated *time.Time `json:"date_rotated,omitempty"`
	// The absolute URL of the Secret.
	Url *string `json:"url,omitempty"`
}

MicrovisorV1DeviceSecret struct for MicrovisorV1DeviceSecret

type UpdateAccountConfigParams added in v1.3.4 

type UpdateAccountConfigParams struct {
	// The config value; up to 4096 characters.
	Value *string `json:"Value,omitempty"`
}

Optional parameters for the method 'UpdateAccountConfig'

func (*UpdateAccountConfigParams) SetValue added in v1.3.4 

func (params *UpdateAccountConfigParams) SetValue(Value string) *UpdateAccountConfigParams

type UpdateAccountSecretParams added in v1.3.4 

type UpdateAccountSecretParams struct {
	// The secret value; up to 4096 characters.
	Value *string `json:"Value,omitempty"`
}

Optional parameters for the method 'UpdateAccountSecret'

func (*UpdateAccountSecretParams) SetValue added in v1.3.4 

func (params *UpdateAccountSecretParams) SetValue(Value string) *UpdateAccountSecretParams

type UpdateDeviceConfigParams added in v1.3.4 

type UpdateDeviceConfigParams struct {
	// The config value; up to 4096 characters.
	Value *string `json:"Value,omitempty"`
}

Optional parameters for the method 'UpdateDeviceConfig'

func (*UpdateDeviceConfigParams) SetValue added in v1.3.4 

func (params *UpdateDeviceConfigParams) SetValue(Value string) *UpdateDeviceConfigParams

type UpdateDeviceParams 

type UpdateDeviceParams struct {
	// A unique and addressable name to be assigned to this Device by the developer. It may be used in place of the Device SID.
	UniqueName *string `json:"UniqueName,omitempty"`
	// The SID or unique name of the App to be targeted to the Device.
	TargetApp *string `json:"TargetApp,omitempty"`
	// A Boolean flag specifying whether to enable application logging. Logs will be enabled or extended for 24 hours.
	LoggingEnabled *bool `json:"LoggingEnabled,omitempty"`
	// Set to true to restart the App running on the Device.
	RestartApp *bool `json:"RestartApp,omitempty"`
}

Optional parameters for the method 'UpdateDevice'

func (*UpdateDeviceParams) SetLoggingEnabled 

func (params *UpdateDeviceParams) SetLoggingEnabled(LoggingEnabled bool) *UpdateDeviceParams

func (*UpdateDeviceParams) SetRestartApp added in v1.10.0 

func (params *UpdateDeviceParams) SetRestartApp(RestartApp bool) *UpdateDeviceParams

func (*UpdateDeviceParams) SetTargetApp 

func (params *UpdateDeviceParams) SetTargetApp(TargetApp string) *UpdateDeviceParams

func (*UpdateDeviceParams) SetUniqueName 

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

type UpdateDeviceSecretParams added in v1.3.4 

type UpdateDeviceSecretParams struct {
	// The secret value; up to 4096 characters.
	Value *string `json:"Value,omitempty"`
}

Optional parameters for the method 'UpdateDeviceSecret'

func (*UpdateDeviceSecretParams) SetValue added in v1.3.4 

func (params *UpdateDeviceSecretParams) SetValue(Value string) *UpdateDeviceSecretParams

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.