package
2.2.25
Repository: https://github.com/virb3/wgcf.git
Documentation: pkg.go.dev

# README

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: 536
  • 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/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./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(), sw.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(), sw.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 identifield 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(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
DefaultApiGetAccountGet /{apiVersion}/reg/{sourceDeviceId}/accountGetAccount
DefaultApiGetBoundDevicesGet /{apiVersion}/reg/{sourceDeviceId}/account/devicesGetBoundDevices
DefaultApiGetClientConfigGet /{apiVersion}/client_configGetClientConfig
DefaultApiGetSourceDeviceGet /{apiVersion}/reg/{sourceDeviceId}GetSourceDevice
DefaultApiRegisterPost /{apiVersion}/regRegister
DefaultApiResetAccountLicensePost /{apiVersion}/reg/{sourceDeviceId}/account/licenseResetAccountLicense
DefaultApiUpdateAccountPut /{apiVersion}/reg/{sourceDeviceId}/accountUpdateAccount
DefaultApiUpdateBoundDevicePatch /{apiVersion}/reg/{sourceDeviceId}/account/reg/{boundDeviceId}UpdateBoundDevice
DefaultApiUpdateSourceDevicePatch /{apiVersion}/reg/{sourceDeviceId}UpdateSourceDevice

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

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

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
NewGetAccount200Response instantiates a new GetAccount200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetAccount200ResponseWithDefaults instantiates a new GetAccount200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetBoundDevices200Response instantiates a new GetBoundDevices200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetBoundDevices200ResponseWithDefaults instantiates a new GetBoundDevices200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetClientConfig200Response instantiates a new GetClientConfig200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetClientConfig200ResponseCaptivePortal instantiates a new GetClientConfig200ResponseCaptivePortal object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetClientConfig200ResponseCaptivePortalWithDefaults instantiates a new GetClientConfig200ResponseCaptivePortal object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetClientConfig200ResponseDenylist instantiates a new GetClientConfig200ResponseDenylist object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetClientConfig200ResponseDenylistWithDefaults instantiates a new GetClientConfig200ResponseDenylist object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetClientConfig200ResponseNetworks instantiates a new GetClientConfig200ResponseNetworks object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetClientConfig200ResponseNetworks1 instantiates a new GetClientConfig200ResponseNetworks1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetClientConfig200ResponseNetworks1V4 instantiates a new GetClientConfig200ResponseNetworks1V4 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetClientConfig200ResponseNetworks1V4WithDefaults instantiates a new GetClientConfig200ResponseNetworks1V4 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetClientConfig200ResponseNetworks1V6 instantiates a new GetClientConfig200ResponseNetworks1V6 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetClientConfig200ResponseNetworks1V6WithDefaults instantiates a new GetClientConfig200ResponseNetworks1V6 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetClientConfig200ResponseNetworks1WithDefaults instantiates a new GetClientConfig200ResponseNetworks1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetClientConfig200ResponseNetworksWithDefaults instantiates a new GetClientConfig200ResponseNetworks object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetClientConfig200ResponseWithDefaults instantiates a new GetClientConfig200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetSourceDevice200Response instantiates a new GetSourceDevice200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetSourceDevice200ResponseAccount instantiates a new GetSourceDevice200ResponseAccount object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetSourceDevice200ResponseAccountWithDefaults instantiates a new GetSourceDevice200ResponseAccount object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetSourceDevice200ResponseConfig instantiates a new GetSourceDevice200ResponseConfig object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetSourceDevice200ResponseConfigEndpoint instantiates a new GetSourceDevice200ResponseConfigEndpoint object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetSourceDevice200ResponseConfigEndpointWithDefaults instantiates a new GetSourceDevice200ResponseConfigEndpoint object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetSourceDevice200ResponseConfigInterface instantiates a new GetSourceDevice200ResponseConfigInterface object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetSourceDevice200ResponseConfigInterfaceAddresses instantiates a new GetSourceDevice200ResponseConfigInterfaceAddresses object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetSourceDevice200ResponseConfigInterfaceAddressesWithDefaults instantiates a new GetSourceDevice200ResponseConfigInterfaceAddresses object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetSourceDevice200ResponseConfigInterfaceWithDefaults instantiates a new GetSourceDevice200ResponseConfigInterface object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetSourceDevice200ResponseConfigPeers instantiates a new GetSourceDevice200ResponseConfigPeers object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetSourceDevice200ResponseConfigPeersWithDefaults instantiates a new GetSourceDevice200ResponseConfigPeers object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetSourceDevice200ResponseConfigServices instantiates a new GetSourceDevice200ResponseConfigServices object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGetSourceDevice200ResponseConfigServicesWithDefaults instantiates a new GetSourceDevice200ResponseConfigServices object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetSourceDevice200ResponseConfigWithDefaults instantiates a new GetSourceDevice200ResponseConfig object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGetSourceDevice200ResponseWithDefaults instantiates a new GetSourceDevice200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewRegister200Response instantiates a new Register200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRegister200ResponseWithDefaults instantiates a new Register200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRegisterRequest instantiates a new RegisterRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRegisterRequestWithDefaults instantiates a new RegisterRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewResetAccountLicense200Response instantiates a new ResetAccountLicense200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewResetAccountLicense200ResponseWithDefaults instantiates a new ResetAccountLicense200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUpdateAccount200Response instantiates a new UpdateAccount200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUpdateAccount200ResponseWithDefaults instantiates a new UpdateAccount200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUpdateAccountRequest instantiates a new UpdateAccountRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUpdateAccountRequestWithDefaults instantiates a new UpdateAccountRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUpdateBoundDevice200Response instantiates a new UpdateBoundDevice200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUpdateBoundDevice200ResponseWithDefaults instantiates a new UpdateBoundDevice200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUpdateBoundDeviceRequest instantiates a new UpdateBoundDeviceRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUpdateBoundDeviceRequestWithDefaults instantiates a new UpdateBoundDeviceRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUpdateSourceDevice200Response instantiates a new UpdateSourceDevice200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUpdateSourceDevice200ResponseAccount instantiates a new UpdateSourceDevice200ResponseAccount object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUpdateSourceDevice200ResponseAccountWithDefaults instantiates a new UpdateSourceDevice200ResponseAccount object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUpdateSourceDevice200ResponseWithDefaults instantiates a new UpdateSourceDevice200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUpdateSourceDeviceRequest instantiates a new UpdateSourceDeviceRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUpdateSourceDeviceRequestWithDefaults instantiates a new UpdateSourceDeviceRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

APIClient manages communication with the untitled API API v536 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetAccount200Response struct for GetAccount200Response.
GetBoundDevices200Response struct for GetBoundDevices200Response.
GetClientConfig200Response struct for GetClientConfig200Response.
GetClientConfig200ResponseCaptivePortal struct for GetClientConfig200ResponseCaptivePortal.
GetClientConfig200ResponseDenylist struct for GetClientConfig200ResponseDenylist.
GetClientConfig200ResponseNetworks struct for GetClientConfig200ResponseNetworks.
GetClientConfig200ResponseNetworks1 struct for GetClientConfig200ResponseNetworks1.
GetClientConfig200ResponseNetworks1V4 struct for GetClientConfig200ResponseNetworks1V4.
GetClientConfig200ResponseNetworks1V6 struct for GetClientConfig200ResponseNetworks1V6.
GetSourceDevice200Response struct for GetSourceDevice200Response.
GetSourceDevice200ResponseAccount struct for GetSourceDevice200ResponseAccount.
GetSourceDevice200ResponseConfig struct for GetSourceDevice200ResponseConfig.
GetSourceDevice200ResponseConfigEndpoint struct for GetSourceDevice200ResponseConfigEndpoint.
GetSourceDevice200ResponseConfigInterface struct for GetSourceDevice200ResponseConfigInterface.
GetSourceDevice200ResponseConfigInterfaceAddresses struct for GetSourceDevice200ResponseConfigInterfaceAddresses.
GetSourceDevice200ResponseConfigPeers struct for GetSourceDevice200ResponseConfigPeers.
GetSourceDevice200ResponseConfigServices struct for GetSourceDevice200ResponseConfigServices.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Register200Response struct for Register200Response.
RegisterRequest struct for RegisterRequest.
ResetAccountLicense200Response struct for ResetAccountLicense200Response.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
UpdateAccount200Response struct for UpdateAccount200Response.
UpdateAccountRequest struct for UpdateAccountRequest.
UpdateBoundDevice200Response struct for UpdateBoundDevice200Response.
UpdateBoundDeviceRequest struct for UpdateBoundDeviceRequest.
UpdateSourceDevice200Response struct for UpdateSourceDevice200Response.
UpdateSourceDevice200ResponseAccount struct for UpdateSourceDevice200ResponseAccount.
UpdateSourceDeviceRequest struct for UpdateSourceDeviceRequest.

# Type aliases

DefaultApiService DefaultApi service.
ServerConfigurations stores multiple ServerConfiguration items.