Go API client for hwmux

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: 2.19.0
• Package version: 2.19.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 hwmux "github.com/Silabs-UTF/hwmux-client-golang/v2"

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

Documentation for API Endpoints

All URIs are relative to https://hwmux.silabs.net

Class	Method	HTTP request	Description
CallbackApi	CallbackRetrieve	Get /callback/
DevicesApi	DevicesCreate	Post /api/devices/
DevicesApi	DevicesDestroy	Delete /api/devices/{id}/
DevicesApi	DevicesList	Get /api/devices/
DevicesApi	DevicesListMyList	Get /api/devices/list_my/
DevicesApi	DevicesLocationRetrieve	Get /api/devices/{device_pk}/location/
DevicesApi	DevicesPartialUpdate	Patch /api/devices/{id}/
DevicesApi	DevicesPermissionsPartialUpdate	Patch /api/devices/{id}/permissions/
DevicesApi	DevicesPermissionsRetrieve	Get /api/devices/{id}/permissions/
DevicesApi	DevicesPermissionsUpdate	Put /api/devices/{id}/permissions/
DevicesApi	DevicesReleaseUpdate	Put /api/devices/{id}/release/
DevicesApi	DevicesReserveUpdate	Put /api/devices/{id}/reserve/
DevicesApi	DevicesRetrieve	Get /api/devices/{id}/
DevicesApi	DevicesSearchList	Get /api/devices/search/
DevicesApi	DevicesSetOfflineCreate	Post /api/devices/set_offline/
DevicesApi	DevicesStatusCreate	Post /api/devices/{id}/status/
DevicesApi	DevicesUpdate	Put /api/devices/{id}/
GroupsApi	GroupsAvailableList	Get /api/groups/available/
GroupsApi	GroupsCreate	Post /api/groups/
GroupsApi	GroupsCreateWithDevicesCreate	Post /api/groups/create-with-devices
GroupsApi	GroupsDestroy	Delete /api/groups/{id}/
GroupsApi	GroupsList	Get /api/groups/
GroupsApi	GroupsMyList	Get /api/groups/my/
GroupsApi	GroupsPartialUpdate	Patch /api/groups/{id}/
GroupsApi	GroupsPermissionsPartialUpdate	Patch /api/groups/{id}/permissions/
GroupsApi	GroupsPermissionsRetrieve	Get /api/groups/{id}/permissions/
GroupsApi	GroupsPermissionsUpdate	Put /api/groups/{id}/permissions/
GroupsApi	GroupsReleaseByNameUpdate	Put /api/groups/{group_name}/release_by_name/
GroupsApi	GroupsReleaseUpdate	Put /api/groups/{id}/release/
GroupsApi	GroupsReserveByNameUpdate	Put /api/groups/{group_name}/reserve_by_name/
GroupsApi	GroupsReserveUpdate	Put /api/groups/{id}/reserve/
GroupsApi	GroupsRetrieve	Get /api/groups/{id}/
GroupsApi	GroupsStatusCreate	Post /api/groups/{id}/status/
GroupsApi	GroupsUpdate	Put /api/groups/{id}/
LabelsApi	LabelsCreate	Post /api/labels/
LabelsApi	LabelsDestroy	Delete /api/labels/{id}/
LabelsApi	LabelsList	Get /api/labels/
LabelsApi	LabelsPartialUpdate	Patch /api/labels/{id}/
LabelsApi	LabelsPermissionsPartialUpdate	Patch /api/labels/{id}/permissions/
LabelsApi	LabelsPermissionsRetrieve	Get /api/labels/{id}/permissions/
LabelsApi	LabelsPermissionsUpdate	Put /api/labels/{id}/permissions/
LabelsApi	LabelsReserveAnyUpdate	Put /api/labels/{id}/reserve_any/
LabelsApi	LabelsRetrieve	Get /api/labels/{id}/
LabelsApi	LabelsUpdate	Put /api/labels/{id}/
LogsApi	LogsDestroy	Delete /api/logs/{id}
LogsApi	LogsList	Get /api/logs/
LogsApi	LogsRetrieve	Get /api/logs/{id}/
PartFamiliesApi	PartFamiliesCreate	Post /api/part-families/
PartFamiliesApi	PartFamiliesDestroy	Delete /api/part-families/{name}/
PartFamiliesApi	PartFamiliesList	Get /api/part-families/
PartFamiliesApi	PartFamiliesPartialUpdate	Patch /api/part-families/{name}/
PartFamiliesApi	PartFamiliesPartsCreate	Post /api/part-families/{part_family_pk}/parts/
PartFamiliesApi	PartFamiliesPartsDestroy	Delete /api/part-families/{part_family_pk}/parts/{id}/
PartFamiliesApi	PartFamiliesPartsList	Get /api/part-families/{part_family_pk}/parts/
PartFamiliesApi	PartFamiliesPartsPartialUpdate	Patch /api/part-families/{part_family_pk}/parts/{id}/
PartFamiliesApi	PartFamiliesPartsRetrieve	Get /api/part-families/{part_family_pk}/parts/{id}/
PartFamiliesApi	PartFamiliesPartsUpdate	Put /api/part-families/{part_family_pk}/parts/{id}/
PartFamiliesApi	PartFamiliesRetrieve	Get /api/part-families/{name}/
PartFamiliesApi	PartFamiliesUpdate	Put /api/part-families/{name}/
PartsApi	PartsList	Get /api/parts/
PartsApi	PartsRetrieve	Get /api/parts/{part_no}/
PermissionsApi	PermissionsGroupsCreate	Post /api/permissions/groups/
PermissionsApi	PermissionsGroupsDestroy	Delete /api/permissions/groups/{name_or_id}/
PermissionsApi	PermissionsGroupsDeviceGroupsCreate	Post /api/permissions/groups/{name_or_id}/device_groups/
PermissionsApi	PermissionsGroupsDeviceGroupsDestroy	Delete /api/permissions/groups/{name_or_id}/device_groups/{id}/
PermissionsApi	PermissionsGroupsDeviceGroupsList	Get /api/permissions/groups/{name_or_id}/device_groups/
PermissionsApi	PermissionsGroupsDeviceGroupsPartialUpdate	Patch /api/permissions/groups/{name_or_id}/device_groups/{id}/
PermissionsApi	PermissionsGroupsDeviceGroupsUpdate	Put /api/permissions/groups/{name_or_id}/device_groups/{id}/
PermissionsApi	PermissionsGroupsDevicesCreate	Post /api/permissions/groups/{name_or_id}/devices/
PermissionsApi	PermissionsGroupsDevicesDestroy	Delete /api/permissions/groups/{name_or_id}/devices/{id}/
PermissionsApi	PermissionsGroupsDevicesList	Get /api/permissions/groups/{name_or_id}/devices/
PermissionsApi	PermissionsGroupsDevicesPartialUpdate	Patch /api/permissions/groups/{name_or_id}/devices/{id}/
PermissionsApi	PermissionsGroupsDevicesUpdate	Put /api/permissions/groups/{name_or_id}/devices/{id}/
PermissionsApi	PermissionsGroupsLabelsCreate	Post /api/permissions/groups/{name_or_id}/labels/
PermissionsApi	PermissionsGroupsLabelsDestroy	Delete /api/permissions/groups/{name_or_id}/labels/{id}/
PermissionsApi	PermissionsGroupsLabelsList	Get /api/permissions/groups/{name_or_id}/labels/
PermissionsApi	PermissionsGroupsLabelsPartialUpdate	Patch /api/permissions/groups/{name_or_id}/labels/{id}/
PermissionsApi	PermissionsGroupsLabelsUpdate	Put /api/permissions/groups/{name_or_id}/labels/{id}/
PermissionsApi	PermissionsGroupsList	Get /api/permissions/groups/
PermissionsApi	PermissionsGroupsPartialUpdate	Patch /api/permissions/groups/{name_or_id}/
PermissionsApi	PermissionsGroupsRetrieve	Get /api/permissions/groups/{name_or_id}/
PermissionsApi	PermissionsGroupsUpdate	Put /api/permissions/groups/{name_or_id}/
PermissionsApi	PermissionsGroupsUsersCreate	Post /api/permissions/groups/{name_or_id}/users/
PermissionsApi	PermissionsGroupsUsersDestroy	Delete /api/permissions/groups/{name_or_id}/users/{username_or_id}/
ReservationsApi	ReservationsActionableList	Get /api/reservations/actionable/
ReservationsApi	ReservationsActiveList	Get /api/reservations/active/
ReservationsApi	ReservationsCancelUpdate	Put /api/reservations/{id}/cancel/
ReservationsApi	ReservationsCreate	Post /api/reservations/
ReservationsApi	ReservationsList	Get /api/reservations/
ReservationsApi	ReservationsMetadataPartialUpdate	Patch /api/reservations/{id}/metadata/
ReservationsApi	ReservationsMetadataUpdate	Put /api/reservations/{id}/metadata/
ReservationsApi	ReservationsReleaseUpdate	Put /api/reservations/{id}/release/
ReservationsApi	ReservationsRetrieve	Get /api/reservations/{id}/
ReservationsApi	ReservationsUpdate	Put /api/reservations/{id}/
RoomsApi	RoomsList	Get /api/rooms/
RoomsApi	RoomsRetrieve	Get /api/rooms/{name}/
SchemaApi	SchemaDownloadRetrieve	Get /schema/download
SigninApi	SigninRetrieve	Get /signin/
SignoutApi	SignoutRetrieve	Get /signout/
SitesApi	SitesCreate	Post /api/sites/
SitesApi	SitesDestroy	Delete /api/sites/{name}/
SitesApi	SitesList	Get /api/sites/
SitesApi	SitesPartialUpdate	Patch /api/sites/{name}/
SitesApi	SitesRetrieve	Get /api/sites/{name}/
SitesApi	SitesRoomsCreate	Post /api/sites/{site_pk}/rooms/
SitesApi	SitesRoomsDestroy	Delete /api/sites/{site_pk}/rooms/{id}/
SitesApi	SitesRoomsList	Get /api/sites/{site_pk}/rooms/
SitesApi	SitesRoomsPartialUpdate	Patch /api/sites/{site_pk}/rooms/{id}/
SitesApi	SitesRoomsRetrieve	Get /api/sites/{site_pk}/rooms/{id}/
SitesApi	SitesRoomsUpdate	Put /api/sites/{site_pk}/rooms/{id}/
SitesApi	SitesUpdate	Put /api/sites/{name}/
TokenAuthApi	TokenAuthCreate	Post /api-token-auth/
UserApi	UserCreate	Post /api/user/
UserApi	UserCurrentRetrieve	Get /api/user/current/
UserApi	UserCurrentTokenCreate	Post /api/user/current/token/
UserApi	UserCurrentTokenRetrieve	Get /api/user/current/token/
UserApi	UserDestroy	Delete /api/user/{username_or_id}/
UserApi	UserList	Get /api/user/
UserApi	UserPartialUpdate	Patch /api/user/{username_or_id}/
UserApi	UserRetrieve	Get /api/user/{username_or_id}/
UserApi	UserTokenCreate	Post /api/user/{username_or_id}/token/
UserApi	UserTokenRetrieve	Get /api/user/{username_or_id}/token/
UserApi	UserUpdate	Put /api/user/{username_or_id}/

Documentation For Models

• AuthToken
• DeviceGroup
• DeviceGroupSerializerWithDevicePk
• DeviceSerializerPublic
• EventEnum
• Label
• LabelSerializerWithPermissions
• LightDevice
• Location
• LocationSerializerWriteOnly
• Log
• LoggedInUser
• NestedDeviceGroup
• ObjectPermissions
• PaginatedDeviceGroupList
• PaginatedDeviceSerializerPublicList
• PaginatedLabelList
• PaginatedLogList
• PaginatedLoggedInUserList
• PaginatedPartFamilyList
• PaginatedPartList
• PaginatedPermissionGroupList
• PaginatedReservationSessionSerializerReadOnlyList
• PaginatedRoomList
• PaginatedSiteList
• Part
• PartFamily
• PatchedDeviceGroupSerializerWithDevicePk
• PatchedLabelSerializerWithPermissions
• PatchedLoggedInUser
• PatchedObjectPermissions
• PatchedPart
• PatchedPartFamily
• PatchedPermissionGroup
• PatchedResourcePermissions
• PatchedRoom
• PatchedSite
• PatchedWriteOnlyDevice
• PermissionGroup
• PermissionsEnum
• ReservationRequest
• ReservationSessionSerializerReadOnly
• ReservationSessionSerializerReadOnlyOwner
• ResourcePermissions
• ResourceStatusRequest
• Room
• Site
• StatusEnum
• Token
• User
• WriteOnlyDevice

Documentation For Authorization

cookieAuth

• Type: API key
• API key parameter name: sessionid
• Location:

Note, each API key must be added to a map of map[string]APIKey where the key is: sessionid and passed in as the auth context for each request.

tokenAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

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