Go API client for openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

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

• API version: 1.6
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

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 "//"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://:443

Class	Method	HTTP request	Description
AudioAPI	ApiAudioEqualizerGet	Get /api/audio/equalizer	Get the current equalizer settings
AudioAPI	ApiAudioEqualizerPut	Put /api/audio/equalizer	Set the current equalizer settings
AudioAPI	ApiAudioInputsDanteReferenceGet	Get /api/audio/inputs/dante/reference	Get settings of the reference input
AudioAPI	ApiAudioInputsDanteReferencePut	Put /api/audio/inputs/dante/reference	Set reference input settings
AudioAPI	ApiAudioInputsMicrophoneBeamDirectionGet	Get /api/audio/inputs/microphone/beam/direction	Get the current direction of the beam
AudioAPI	ApiAudioInputsMicrophoneBeamGet	Get /api/audio/inputs/microphone/beam	Get the current beam settings
AudioAPI	ApiAudioInputsMicrophoneBeamPut	Put /api/audio/inputs/microphone/beam	Set the current beam settings
AudioAPI	ApiAudioInputsMicrophoneExclusionZonesGet	Get /api/audio/inputs/microphone/exclusionZones	Get the supported exclusion zone ids
AudioAPI	ApiAudioInputsMicrophoneExclusionZonesIdGet	Get /api/audio/inputs/microphone/exclusionZones/{id}	Get the current exclusion zone settings of zone number `id`
AudioAPI	ApiAudioInputsMicrophoneExclusionZonesIdPut	Put /api/audio/inputs/microphone/exclusionZones/{id}	Set the current exclusion zone settings of zone number `id`
AudioAPI	ApiAudioInputsMicrophoneLevelGet	Get /api/audio/inputs/microphone/level	Get the current microphone input level
AudioAPI	ApiAudioInputsMicrophonePriorityZonesGet	Get /api/audio/inputs/microphone/priorityZones	Get the supported priority zone ids
AudioAPI	ApiAudioInputsMicrophonePriorityZonesIdGet	Get /api/audio/inputs/microphone/priorityZones/{id}	Get the current priority zone settings of zone number `id`
AudioAPI	ApiAudioInputsMicrophonePriorityZonesIdPut	Put /api/audio/inputs/microphone/priorityZones/{id}	Set the current priority zone settings of zone number `id`
AudioAPI	ApiAudioInputsReferenceLevelGet	Get /api/audio/inputs/reference/level	Get the current level of the digital reference input
AudioAPI	ApiAudioNoiseGateGet	Get /api/audio/noiseGate	Get the current noise gate settings
AudioAPI	ApiAudioNoiseGatePut	Put /api/audio/noiseGate	Set the current noise gate settings
AudioAPI	ApiAudioOutputsAnalogGet	Get /api/audio/outputs/analog	Get the current settings of the analog output
AudioAPI	ApiAudioOutputsAnalogPut	Put /api/audio/outputs/analog	Set the analog output settings
AudioAPI	ApiAudioOutputsDanteFarEndGet	Get /api/audio/outputs/dante/farEnd	Get the current settings of the far end output
AudioAPI	ApiAudioOutputsDanteFarEndPut	Put /api/audio/outputs/dante/farEnd	Set the far end output settings
AudioAPI	ApiAudioOutputsDanteLocalGet	Get /api/audio/outputs/dante/local	Get the current settings of the local output
AudioAPI	ApiAudioOutputsDanteLocalPut	Put /api/audio/outputs/dante/local	Set the local output settings
AudioAPI	ApiAudioOutputsGlobalMuteGet	Get /api/audio/outputs/global/mute	Get the mute status of the device
AudioAPI	ApiAudioOutputsGlobalMutePut	Put /api/audio/outputs/global/mute	Mute all audio outputs
AudioAPI	ApiAudioRoomInUseActivityLevelGet	Get /api/audio/roomInUse/activityLevel	Get the current room in use activity level
AudioAPI	ApiAudioRoomInUseConfigGet	Get /api/audio/roomInUse/config	Get the configuration of the room in use feature
AudioAPI	ApiAudioRoomInUseGet	Get /api/audio/roomInUse	Get the current room in use state
AudioAPI	ApiAudioVoiceLiftGet	Get /api/audio/voiceLift	Get the current voice lift settings
AudioAPI	ApiAudioVoiceLiftPut	Put /api/audio/voiceLift	Set the current voice lift settings
DeviceAPI	ApiDeviceIdentificationGet	Get /api/device/identification	Get the state of device identification
DeviceAPI	ApiDeviceIdentificationPut	Put /api/device/identification	Set the state of device identification
DeviceAPI	ApiDeviceIdentityGet	Get /api/device/identity	Get the device identity
DeviceAPI	ApiDeviceLedsRingGet	Get /api/device/leds/ring	Get the current led ring settings
DeviceAPI	ApiDeviceLedsRingPut	Put /api/device/leds/ring	Set the current led ring brightness and colors
DeviceAPI	ApiDevicePowerPoeDaisychainGet	Get /api/device/power/poe/daisychain	Get the daisy chain and PoE state
DeviceAPI	ApiDeviceSiteGet	Get /api/device/site	Get the device site information
DeviceAPI	ApiDeviceStateGet	Get /api/device/state	Get the device state
FastResourceAPI	ApiAudioInputsMicrophoneBeamDirectionGet	Get /api/audio/inputs/microphone/beam/direction	Get the current direction of the beam
FastResourceAPI	ApiAudioInputsMicrophoneLevelGet	Get /api/audio/inputs/microphone/level	Get the current microphone input level
FastResourceAPI	ApiAudioInputsReferenceLevelGet	Get /api/audio/inputs/reference/level	Get the current level of the digital reference input
FastResourceAPI	ApiAudioRoomInUseActivityLevelGet	Get /api/audio/roomInUse/activityLevel	Get the current room in use activity level
FirmwareUpdateAPI	ApiFirmwareUpdateStateGet	Get /api/firmware/update/state	Get the state of a firmware update
SSCAPI	ApiSscSchemaGet	Get /api/ssc/schema	Get the address tree
SSCAPI	ApiSscStateSubscriptionsGet	Get /api/ssc/state/subscriptions	Start a subscription
SSCAPI	ApiSscStateSubscriptionsSessionUUIDAddPut	Put /api/ssc/state/subscriptions/{sessionUUID}/add	Add resource(s) to the subscription list
SSCAPI	ApiSscStateSubscriptionsSessionUUIDDelete	Delete /api/ssc/state/subscriptions/{sessionUUID}	End an existing subscription
SSCAPI	ApiSscStateSubscriptionsSessionUUIDGet	Get /api/ssc/state/subscriptions/{sessionUUID}	Get the subscription list
SSCAPI	ApiSscStateSubscriptionsSessionUUIDPut	Put /api/ssc/state/subscriptions/{sessionUUID}	Set or change the list of subscriptions associated with the sessionUUID
SSCAPI	ApiSscStateSubscriptionsSessionUUIDRemovePut	Put /api/ssc/state/subscriptions/{sessionUUID}/remove	Remove resource(s) from the subscription list
SSCAPI	ApiSscVersionGet	Get /api/ssc/version	Get the schema version

Documentation For Models

• ApiAudioEqualizerGet200Response
• ApiAudioEqualizerPutRequest
• ApiAudioInputsDanteReferenceGet200Response
• ApiAudioInputsDanteReferencePutRequest
• ApiAudioInputsMicrophoneBeamDirectionGet200Response
• ApiAudioInputsMicrophoneBeamGet200Response
• ApiAudioInputsMicrophoneBeamPutRequest
• ApiAudioInputsMicrophoneExclusionZonesGet200ResponseInner
• ApiAudioInputsMicrophoneExclusionZonesGet200ResponseInnerAzimuth
• ApiAudioInputsMicrophoneExclusionZonesGet200ResponseInnerElevation
• ApiAudioInputsMicrophoneExclusionZonesIdGet200Response
• ApiAudioInputsMicrophoneExclusionZonesIdGet200ResponseAzimuth
• ApiAudioInputsMicrophoneExclusionZonesIdGet200ResponseElevation
• ApiAudioInputsMicrophoneExclusionZonesIdPutRequest
• ApiAudioInputsMicrophoneLevelGet200Response
• ApiAudioInputsMicrophonePriorityZonesGet200ResponseInner
• ApiAudioInputsMicrophonePriorityZonesIdGet200Response
• ApiAudioInputsMicrophonePriorityZonesIdPutRequest
• ApiAudioInputsMicrophonePriorityZonesIdPutRequestAzimuth
• ApiAudioInputsMicrophonePriorityZonesIdPutRequestElevation
• ApiAudioInputsReferenceLevelGet200Response
• ApiAudioNoiseGateGet200Response
• ApiAudioNoiseGatePutRequest
• ApiAudioOutputsAnalogGet200Response
• ApiAudioOutputsAnalogPutRequest
• ApiAudioOutputsDanteFarEndGet200Response
• ApiAudioOutputsDanteFarEndPutRequest
• ApiAudioOutputsDanteLocalGet200Response
• ApiAudioOutputsDanteLocalPutRequest
• ApiAudioOutputsGlobalMuteGet200Response
• ApiAudioOutputsGlobalMutePutRequest
• ApiAudioRoomInUseActivityLevelGet200Response
• ApiAudioRoomInUseConfigGet200Response
• ApiAudioRoomInUseGet200Response
• ApiAudioVoiceLiftGet200Response
• ApiAudioVoiceLiftPutRequest
• ApiDeviceIdentificationGet200Response
• ApiDeviceIdentificationPutRequest
• ApiDeviceIdentityGet200Response
• ApiDeviceLedsRingGet200Response
• ApiDeviceLedsRingGet200ResponseMicCustom
• ApiDeviceLedsRingGet200ResponseMicOn
• ApiDeviceLedsRingPutRequest
• ApiDeviceLedsRingPutRequestMicCustom
• ApiDeviceLedsRingPutRequestMicOn
• ApiDevicePowerPoeDaisychainGet200Response
• ApiDeviceSiteGet200Response
• ApiDeviceStateGet200Response
• ApiFirmwareUpdateStateGet200Response
• ApiSscStateSubscriptionsSessionUUIDAddPut400Response
• ApiSscStateSubscriptionsSessionUUIDRemovePut400Response
• ApiSscVersionGet200Response

Documentation For Authorization

Authentication schemes defined for the API:

basicAuthApi

• 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 for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author