Categorygithub.com/efficap-energie/liveobjects-go
repositorypackage
0.0.1
Repository: https://github.com/efficap-energie/liveobjects-go.git
Documentation: pkg.go.dev

# README

Go API client for liveobjects

API description for Live Objects service

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.13.3
  • 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 "./liveobjects"

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 https://liveobjects.orange-business.com

ClassMethodHTTP requestDescription
AccountingV1ApiGetDailyStatisticsUsingGET2Get /api/v1/accounting/dailyGet daily accounting metrics (Beta).
AccountingV1ApiGetMonthlyStatisticsUsingGET2Get /api/v1/accounting/monthlyGet monthly accounting metrics.
ApiKeysApiCreateApiKeyUsingPOSTPost /api/v0/apiKeysCreate an API key
ApiKeysApiDeleteApiKeyUsingDELETEDelete /api/v0/apiKeys/{apiKeyId}Delete an API key
ApiKeysApiGetApiKeyFromAuthenticationUsingGET3Get /api/v0/apiKeys/current_keygetApiKeyFromAuthentication
ApiKeysApiGetApiKeyUsingGET3Get /api/v0/apiKeys/{apiKeyId}Get an API key
ApiKeysApiGetApiKeysUsingGET3Get /api/v0/apiKeysList API keys
ApiKeysApiSetApiKeyDebugModeUsingPUT3Put /api/v0/apiKeys/{apiKeyId}/debugModeActivate/Deactivate the debug mode on an API key
ApiKeysApiUpdateApiKeyUsingPOST1Post /api/v0/apiKeys/{apiKeyId}Update an API key
AuditLogApiSearchUsingGETGet /api/v0/auditlog/messagesRetrieve messages available in your AuditLog
BusManagementApiCreateUsingPOST3Post /api/v0/topics/fifoCreate a FIFO
BusManagementApiDeleteUsingDELETE20Delete /api/v0/topics/fifo/{fifoName}Delete a FIFO
BusManagementApiFifoPublishUsingPOSTPost /api/v0/topics/fifo/{fifoName}Publish a message into a FIFO
BusManagementApiGetUsingGET19Get /api/v0/topics/fifo/{fifoName}Get a FIFO
BusManagementApiListFifoTopicsUsingGETGet /api/v0/topics/fifoList all FIFOs
CACertificatesApiCreateUsingPOSTPost /api/v0/certificates/caUpload CA certificate
CACertificatesApiDeleteUsingDELETE9Delete /api/v0/certificates/ca/{certificateId}Delete CA certificate
CACertificatesApiListUsingGET11Get /api/v0/certificates/caList CA certificates
CACertificatesApiRetrieveUsingGETGet /api/v0/certificates/ca/{certificateId}Retrieve CA certificate
CampaignManagementApiCancelCampaignUsingPUTPut /api/v0/deviceMgt/campaigns/{campaignId}/cancelCancel a campaign
CampaignManagementApiCreateCampaignUsingPOSTPost /api/v0/deviceMgt/campaignsCreate a campaign
CampaignManagementApiDeleteCampaignUsingDELETEDelete /api/v0/deviceMgt/campaigns/{campaignId}Delete a campaign
CampaignManagementApiGetCampaignDetailsUsingGETGet /api/v0/deviceMgt/campaigns/{campaignId}/targetsGet the campaign status per device
CampaignManagementApiGetCampaignUsingGETGet /api/v0/deviceMgt/campaigns/{campaignId}Get a campaign
CampaignManagementApiListCampaignsUsingGETGet /api/v0/deviceMgt/campaignsList all campaigns
CampaignManagementApiUpdateCampaignUsingPATCHPatch /api/v0/deviceMgt/campaigns/{campaignId}Update a campaign
DataBulkInjectionApiAddDataBulkUsingPOSTPost /api/v0/data/bulkInsert a bulk of new Data
DataManagementCustomPipelinesApiDeleteUsingDELETE11Delete /api/v0/pipelines/{pipelineId}Delete a DataMessage pipeline
DataManagementCustomPipelinesApiGetUsingGET12Get /api/v0/pipelines/{pipelineId}Retrieve a DataMessage pipeline
DataManagementCustomPipelinesApiListUsingGET13Get /api/v0/pipelinesRetrieve the list of DataMessage pipelines, ordered by priorityLevel
DataManagementCustomPipelinesApiPostUsingPOST12Post /api/v0/pipelinesCreate a DataMessage pipeline
DataManagementCustomPipelinesApiUpdateUsingPUT6Put /api/v0/pipelines/{pipelineId}Update a DataMessage pipeline
DataManagementDataSearchApiDslQueryHitsOnlyUsingPOSTPost /api/v0/data/search/hitsQuery an Elasticsearch Domain Specific Language request and get only hits result
DataManagementDataSearchApiDslQueryUsingPOSTPost /api/v0/data/searchQuery an Elasticsearch Domain Specific Language request
DataManagementDataStoreApiAddDataMessageUsingPOSTPost /api/v0/data/streams/{streamId}Insert a new Data into the stream
DataManagementDataStoreApiRetrieveDataUsingGETGet /api/v0/data/streams/{streamId}Retrieve data from the streamId
DecodersApiListUsingGET22Get /api/v0/decodersRetrieve the list of all decoders (binary, csv, js)
DecodersBinaryApiActivateUsingPUT8Put /api/v0/decoders/binary/{decoderId}/enabledActivate or deactivate a decoder
DecodersBinaryApiDeleteUsingDELETE8Delete /api/v0/decoders/binary/{decoderId}Delete a binary decoder
DecodersBinaryApiGetUsingGET10Get /api/v0/decoders/binary/{decoderId}Retrieve a binary decoder
DecodersBinaryApiListUsingGET10Get /api/v0/decoders/binaryRetrieve the list of binary decoders
DecodersBinaryApiPostUsingPOST10Post /api/v0/decoders/binaryCreate a binary decoder
DecodersBinaryApiPutUsingPUT2Put /api/v0/decoders/binary/{decoderId}Update a binary decoder
DecodersBinaryApiTestUsingPOST2Post /api/v0/decoders/binary/testTest a binary decoder format with an encoded payload
DecodersCSVApiActivateUsingPUT9Put /api/v0/decoders/csv/{decoderId}/enabledActivate or deactivate a decoder
DecodersCSVApiDeleteUsingDELETE10Delete /api/v0/decoders/csv/{decoderId}Delete a csv decoder
DecodersCSVApiGetUsingGET11Get /api/v0/decoders/csv/{decoderId}Retrieve a csv decoder
DecodersCSVApiListUsingGET12Get /api/v0/decoders/csvRetrieve the list of csv decoders filtered by tags
DecodersCSVApiPostUsingPOST11Post /api/v0/decoders/csvCreate a csv decoder
DecodersCSVApiPutUsingPUT3Put /api/v0/decoders/csv/{decoderId}Update a csv decoder
DecodersCSVApiTestUsingPOST3Post /api/v0/decoders/csv/testTest a csv decoder format with an encoded payload
DecodersPublicApiListUsingGET23Get /api/v0/decoders/publicRetrieve the list of all public decoders (binary, csv, js)
DeprecatedBusManagementRouterApiAddBindingUsingPOSTPost /api/v0/bindingsAdd a binding for a FIFO queue
DeprecatedBusManagementRouterApiDeleteBindingUsingDELETEDelete /api/v0/bindings/{routingKeyFilter}/{fifoName}Delete a binding
DeprecatedBusManagementRouterApiListBindingsUsingGETGet /api/v0/bindingsList registered bindings
DeprecatedDeviceManagementCommandV0UseDeviceManagementCommandsV1InsteadApiAddCommandUsingPOSTPost /api/v0/assets/{assetNamespace}/{assetId}/commandsRegister a new command
DeprecatedDeviceManagementCommandV0UseDeviceManagementCommandsV1InsteadApiDeleteCommandUsingDELETEDelete /api/v0/commands/{commandId}Delete a specific command
DeprecatedDeviceManagementCommandV0UseDeviceManagementCommandsV1InsteadApiGetAssetCommandsUsingGETGet /api/v0/assets/{assetNamespace}/{assetId}/commandsGet a list of commands targeting a specific asset
DeprecatedDeviceManagementCommandV0UseDeviceManagementCommandsV1InsteadApiGetCommandStatusUsingGETGet /api/v0/commands/{commandId}/statusGet the status of a specific command
DeprecatedDeviceManagementCommandV0UseDeviceManagementCommandsV1InsteadApiGetCommandUsingGETGet /api/v0/commands/{commandId}Get a specific command
DeprecatedDeviceManagementCommandV0UseDeviceManagementCommandsV1InsteadApiListCommandsUsingGETGet /api/v0/commandsList registered commands
DeprecatedDeviceManagementCommandV0UseDeviceManagementCommandsV1InsteadApiSetCommandStatusUsingPUTPut /api/v0/commands/{commandId}/statusUpdate the status of specific command
DeprecatedDeviceManagementDevicesFirmwaresApiGetDeviceFirmwareUsingGETGet /api/v1/deviceMgt/devices/{deviceId}/firmwares/{firmwareId}Get a specific device firmware (use /api/v1/deviceMgt/devices/{deviceId}/resources/{resourceId} instead)
DeprecatedDeviceManagementDevicesFirmwaresApiGetDeviceResourceUpdatesUsingGETGet /api/v1/deviceMgt/devices/{deviceId}/firmwareUpdatesGet a list of device firmware updates (use /api/v1/deviceMgt/devices/{deviceId}/resources/updates
DeprecatedDeviceManagementDevicesFirmwaresApiGetLastResourceUpdateUsingGETGet /api/v1/deviceMgt/devices/{deviceId}/firmwares/{firmwareId}/lastUpdateGet info about last update of this device firmware (use /api/v1/deviceMgt/devices/{deviceId}/resources/{resourceId}/updates/latest instead)
DeprecatedDeviceManagementDevicesFirmwaresApiListDeviceResourcesUsingGETGet /api/v1/deviceMgt/devices/{deviceId}/firmwaresGet a map of all device firmwares (use /api/v1/deviceMgt/devices/{deviceId}/resources instead)
DeprecatedDeviceManagementDevicesFirmwaresApiSetDeviceResourceVersionUsingPOSTPost /api/v1/deviceMgt/devices/{deviceId}/firmwares/{firmwareId}Set device firmware versions (use /api/v1/deviceMgt/devices/{deviceId}/resources/{resourceId} instead)
DeprecatedDeviceManagementInventoryV0UseDeviceManagementInventoryV1InsteadApiCreateAssetUsingPOSTPost /api/v0/assetsCreate a device
DeprecatedDeviceManagementInventoryV0UseDeviceManagementInventoryV1InsteadApiDeleteDeviceStatusUsingDELETEDelete /api/v0/assets/{assetNamespace}/{assetId}Delete a device
DeprecatedDeviceManagementInventoryV0UseDeviceManagementInventoryV1InsteadApiGetAssetStatusUsingGETGet /api/v0/assets/{assetNamespace}/{assetId}Get a device status
DeprecatedDeviceManagementInventoryV0UseDeviceManagementInventoryV1InsteadApiListAssetNamespacesUsingGETGet /api/v0/inventory/namespacesEnumerates the used asset namespaces
DeprecatedDeviceManagementInventoryV0UseDeviceManagementInventoryV1InsteadApiListAssetsUsingGETGet /api/v0/assetsList registered assets status
DeprecatedDeviceManagementInventoryV0UseDeviceManagementInventoryV1InsteadApiUpdateAssetUsingPUTPut /api/v0/assets/{assetNamespace}/{assetId}Update a device
DeprecatedDeviceManagementParameterV0UseDeviceManagementConfigurationV1InsteadApiGetAssetParamUsingGETGet /api/v0/assets/{assetNamespace}/{assetId}/params/{paramKey}Get a specific asset parameter
DeprecatedDeviceManagementParameterV0UseDeviceManagementConfigurationV1InsteadApiGetAssetParamsUsingGETGet /api/v0/assets/{assetNamespace}/{assetId}/paramsGet a specific asset list of parameters
DeprecatedDeviceManagementParameterV0UseDeviceManagementConfigurationV1InsteadApiSetAssetParamsUsingPOSTPost /api/v0/assets/{assetNamespace}/{assetId}/paramsUpdate a specific asset list of parameters
DeprecatedDeviceManagementParameterV0UseDeviceManagementConfigurationV1InsteadApiSetDeviceParamUpdateStatusUsingPUTPut /api/v0/assets/{assetNamespace}/{assetId}/params/{paramKey}/statusUpdate the status of a specific asset parameter update
DeprecatedDeviceManagementParameterV0UseDeviceManagementConfigurationV1InsteadApiSetDeviceParamsUpdateStatusUsingPUTPut /api/v0/assets/{assetNamespace}/{assetId}/params/statusUpdate the status of a specific asset parameters update
DeprecatedDeviceManagementResourceV0UseDeviceManagementResourceV1InsteadApiCancelResourceUpdateUsingPOSTPost /api/v0/rm/asset/{assetIdNamespace}/{assetId}/cancelUpdateCancel asset resource update
DeprecatedDeviceManagementResourceV0UseDeviceManagementResourceV1InsteadApiGetAllAssetResourcesUsingGETGet /api/v0/rm/asset/{assetIdNamespace}/{assetId}List the asset's resources (use /api/v1/deviceMgt/devices/{deviceId}/resources instead)
DeprecatedDeviceManagementResourceV0UseDeviceManagementResourceV1InsteadApiGetLastUpdateUsingGETGet /api/v0/rm/asset/{assetIdNamespace}/{assetId}/updateGet the asset's resources update status (use /api/v1/deviceMgt/devices/{deviceId}/firmwares/{firmwareId}/lastUpdate instead)
DeprecatedDeviceManagementResourceV0UseDeviceManagementResourceV1InsteadApiGetUpdateHistoryUsingGETGet /api/v0/rm/asset/{assetIdNamespace}/{assetId}/update/historyGet the asset's resources update history (use /api/v1/deviceMgt/devices/{deviceId}/firmwareUpdates instead)
DeprecatedDeviceManagementResourceV0UseDeviceManagementResourceV1InsteadApiSetAssetTargetResourceVersionUsingPUTPut /api/v0/rm/asset/{assetIdNamespace}/{assetId}/resource/{resourceId}/targetversionSet asset's target resource version (use /api/v1/deviceMgt/devices/{deviceId}/resources/{resourceId} instead)
DeprecatedGroupManagementV0UseDeviceManagementGroupsV1InsteadApiCreateGroupUsingPOSTPost /api/v0/groupsCreate a group
DeprecatedGroupManagementV0UseDeviceManagementGroupsV1InsteadApiDeleteGroupUsingDELETEDelete /api/v0/groups/{groupId}Delete a group
DeprecatedGroupManagementV0UseDeviceManagementGroupsV1InsteadApiGetGroupUsingGETGet /api/v0/groups/{groupId}Get a group
DeprecatedGroupManagementV0UseDeviceManagementGroupsV1InsteadApiListGroupsUsingGETGet /api/v0/groupsList registered groups
DeprecatedGroupManagementV0UseDeviceManagementGroupsV1InsteadApiUpdateGroupUsingPUTPut /api/v0/groups/{groupId}Update a group
DeprecatedRouterTopicManagementApiPublishUsingPOSTPost /api/v0/topics/router/{routingKey}Publishing a message into a ROUTER topic
DeprecatedSMSConnectorApiSendSMSUsingPOSTPost /api/v0/sms-connector/smssend SMS by SMS Connector for a list of MSISDN
DeprecatedSMSConnectorBusinessSettingsUseDeviceManagementConnectorNodesV1InsteadApiCreateBusinessSettingsUsingPOSTPost /api/v0/sms-connector/settings/businessCreate a new business settings of SMS Connector (use Device management - Interfaces - V1 instead)
DeprecatedSMSConnectorBusinessSettingsUseDeviceManagementConnectorNodesV1InsteadApiDeleteBusinessSettingsByMsiSDNUsingDELETEDelete /api/v0/sms-connector/settings/business/msisdnDelete msisdn in business settings of SMS Connector
DeprecatedSMSConnectorBusinessSettingsUseDeviceManagementConnectorNodesV1InsteadApiDeleteBusinessSettingsForOneMsiSDNUsingDELETEDelete /api/v0/sms-connector/settings/business/{serverPhoneNumber}/msisdn/{msisdnNumber}Delete one msisdn in business settings of SMS Connector
DeprecatedSMSConnectorBusinessSettingsUseDeviceManagementConnectorNodesV1InsteadApiGetBusinessSettingsUsingGETGet /api/v0/sms-connector/settings/businessGet a business settings of SMS Connector
DeprecatedSMSConnectorBusinessSettingsUseDeviceManagementConnectorNodesV1InsteadApiListMsisdnUsingGETGet /api/v0/sms-connector/settings/business/msisdnList msisdn of business settings of SMS Connector
DeprecatedSMSConnectorBusinessSettingsUseDeviceManagementConnectorNodesV1InsteadApiListSettingsUsingGETGet /api/v0/sms-connector/settingsList all the business settings of the SMSConnector for a tenant
DeprecatedSMSConnectorBusinessSettingsUseDeviceManagementConnectorNodesV1InsteadApiUpdateBusinessSettingsUsingPOSTPost /api/v0/sms-connector/settings/business/{serverPhoneNumber}Update business settings of the SMSConnector
DeprecatedStatisticsUseAccountingV1AccountingInsteadApiGetTenantStatisticsUsingGET3Get /api/v0/statistics/tenant/{tenantId}Get tenant statistics for a specific tenant and a range of dates
DeprecatedTriggersAndActionsApiCreateUsingPOST1Post /api/v0/event2action/actionPoliciesCreate an ActionPolicy
DeprecatedTriggersAndActionsApiDeleteUsingDELETE12Delete /api/v0/event2action/actionPolicies/{policyId}Delete an ActionPolicy
DeprecatedTriggersAndActionsApiListUsingGET14Get /api/v0/event2action/actionPoliciesList ActionPolicies
DeprecatedTriggersAndActionsApiRetrieveUsingGET1Get /api/v0/event2action/actionPolicies/{policyId}Retrieve an ActionPolicy
DeprecatedTriggersAndActionsApiUpsertUsingPUTPut /api/v0/event2action/actionPolicies/{policyId}Create or update an ActionPolicy
DeprecatedTriggersAndActionsTestApiTestHttpPushUsingPOSTPost /api/v0/event2action/test/http-pushPost an http request for testing a webhook
DeviceManagementCommandsV1ApiAddCommandUsingPOST1Post /api/v1/deviceMgt/devices/{deviceId}/commandsRegister a new command
DeviceManagementCommandsV1ApiDeleteCommandUsingDELETE1Delete /api/v1/deviceMgt/commands/{commandId}Delete a specific command
DeviceManagementCommandsV1ApiGetAssetCommandsUsingGET1Get /api/v1/deviceMgt/devices/{deviceId}/commandsList commands targeting a specific device
DeviceManagementCommandsV1ApiGetCommandStatusUsingGET1Get /api/v1/deviceMgt/commands/{commandId}/statusGet the status of a specific command
DeviceManagementCommandsV1ApiGetCommandUsingGET1Get /api/v1/deviceMgt/commands/{commandId}Get a specific command
DeviceManagementCommandsV1ApiSetCommandStatusUsingPUT1Put /api/v1/deviceMgt/commands/{commandId}/statusUpdate the status of specific command
DeviceManagementConfigurationV1ApiGetDeviceConfigParameterUsingGETGet /api/v1/deviceMgt/devices/{deviceId}/config/parameters/{paramKey}Get state of a specific device configuration parameter
DeviceManagementConfigurationV1ApiGetDeviceConfigParametersUsingGETGet /api/v1/deviceMgt/devices/{deviceId}/config/parametersGet a description of the device configuration parameters
DeviceManagementConfigurationV1ApiGetDeviceConfigurationUsingGETGet /api/v1/deviceMgt/devices/{deviceId}/configGet a description of the device configuration
DeviceManagementConfigurationV1ApiSetDeviceParamUpdateStatusUsingPUT1Put /api/v1/deviceMgt/devices/{deviceId}/config/parameters/{paramKey}/statusUpdate the status of a specific device parameter
DeviceManagementConfigurationV1ApiSetMultipleDeviceConfigParamsUsingPOSTPost /api/v1/deviceMgt/devices/{deviceId}/configSet requested values for a set of device configuration parameters
DeviceManagementConnectorNodesV1ApiDeleteNodeUsingDELETEDelete /api/v1/deviceMgt/connectors/{connector}/nodes/{nodeId}Delete a connector node
DeviceManagementConnectorNodesV1ApiGetNodeUsingGETGet /api/v1/deviceMgt/connectors/{connector}/nodes/{nodeId}Get details of connector node
DeviceManagementConnectorNodesV1ApiListNodesUsingGETGet /api/v1/deviceMgt/connectors/{connector}/nodesList all connector nodes
DeviceManagementConnectorNodesV1ApiUpdateNodeUsingPATCHPatch /api/v1/deviceMgt/connectors/{connector}/nodes/{nodeId}Update a connector node
DeviceManagementForCOAPLWM2MBetaApiGetDeviceUsingGET4Get /api/v0/vendors/lwm2m/identity/{ep}Find a device
DeviceManagementForCOAPLWM2MBetaApiListDevicesUsingGET4Get /api/v0/vendors/lwm2m/identitiesList lwm2m devices
DeviceManagementForCOAPLWM2MBetaApiRegisterDeviceUsingPOST1Post /api/v0/vendors/lwm2m/identitiesRegister LWM2M/DTLS identity
DeviceManagementForCOAPLWM2MBetaApiUnregisterDeviceUsingDELETE1Delete /api/v0/vendors/lwm2m/identity/{ep}Unregister a device
DeviceManagementForCOAPLWM2MBetaApiUpdateDeviceUsingPUTPut /api/v0/vendors/lwm2m/identity/{ep}Update a device
DeviceManagementForLoRaApiCountDevicesUsingGET2Get /api/v0/vendors/lora/devices/countDevice counts
DeviceManagementForLoRaApiGetDeviceProfilesUsingGETGet /api/v1/deviceMgt/connectors/lora/profilesGet LoRa device profiles
DeviceManagementForLoRaApiGetDeviceProfilesUsingGET1Get /api/v0/vendors/lora/profilesGet LoRa device profiles (use /api/v1/deviceMgt/connectors/lora/profiles instead)
DeviceManagementForLoRaApiGetDeviceUsingGET3Get /api/v0/vendors/lora/devices/{devEUI}Get a device (use Device management - Connector nodes - V1 instead)
DeviceManagementForLoRaApiGetGatewayUsingGETGet /api/v1/deviceMgt/connectors/lora/gateways/{id}Get a gateway
DeviceManagementForLoRaApiGetMessageCountUsingGETGet /api/v0/vendors/lora/data/countList of message counts group by period
DeviceManagementForLoRaApiListCommandUsingGETGet /api/v1/deviceMgt/connectors/lora/nodes/{devEUI}/downlinksList commands
DeviceManagementForLoRaApiListCommandUsingGET1Get /api/v0/vendors/lora/devices/{devEUI}/commandsList commands (use /api/v1/deviceMgt/connectors/lora/nodes/{devEUI}/downlinks instead)
DeviceManagementForLoRaApiListConnectivityPlanUsingGETGet /api/v1/deviceMgt/connectors/lora/connectivityList connectivity plan
DeviceManagementForLoRaApiListConnectivityPlansUsingGETGet /api/v1/deviceMgt/connectors/lora/connectivitiesList connectivity plans
DeviceManagementForLoRaApiListDevicesUsingGET3Get /api/v0/vendors/lora/devicesList LoRa devices (use Device management - Connector nodes - V1 instead)
DeviceManagementForLoRaApiListGatewaysUsingGETGet /api/v1/deviceMgt/connectors/lora/gatewaysList gateways
DeviceManagementForLoRaApiRegisterCommandUsingPOSTPost /api/v1/deviceMgt/connectors/lora/nodes/{devEUI}/downlinksRegister a command
DeviceManagementForLoRaApiRegisterCommandUsingPOST1Post /api/v0/vendors/lora/devices/{devEUI}/commandsRegister a command (use /api/v1/deviceMgt/connectors/lora/nodes/{devEUI}/downlinks instead)
DeviceManagementForLoRaApiRegisterDeviceUsingPOSTPost /api/v0/vendors/lora/devicesRegister a LoRa device (use Device management - Interfaces - V1 instead)
DeviceManagementForLoRaApiUnregisterDeviceUsingDELETEDelete /api/v0/vendors/lora/devices/{devEUI}Unregister a device (use Device management - Connector nodes - V1 instead)
DeviceManagementForLoRaApiUpdateDeviceUsingPATCH1Patch /api/v0/vendors/lora/devices/{devEUI}Update a device (use Device management - Connector nodes - V1 instead)
DeviceManagementForLoRaApiUpdateGatewayUsingPATCHPatch /api/v1/deviceMgt/connectors/lora/gateways/{id}Update a gateway.
DeviceManagementGroupsV1ApiCreateGroupUsingPOST1Post /api/v1/deviceMgt/groupsCreate a group
DeviceManagementGroupsV1ApiDeleteGroupUsingDELETE1Delete /api/v1/deviceMgt/groups/{id}Delete a group
DeviceManagementGroupsV1ApiGetGroupUsingGET1Get /api/v1/deviceMgt/groups/{id}Get a group
DeviceManagementGroupsV1ApiListGroupsUsingGET1Get /api/v1/deviceMgt/groupsList registered groups
DeviceManagementGroupsV1ApiUpdateGroupUsingPUT1Put /api/v1/deviceMgt/groups/{id}Update a group
DeviceManagementInterfacesV1ApiAddInterfaceToDeviceUsingPOSTPost /api/v1/deviceMgt/devices/{deviceId}/interfacesAdd an interface to a registered device
DeviceManagementInterfacesV1ApiDeleteInterfaceUsingDELETEDelete /api/v1/deviceMgt/devices/{deviceId}/interfaces/{interfaceId}Delete an interface
DeviceManagementInterfacesV1ApiGetInterfaceForADeviceUsingGETGet /api/v1/deviceMgt/devices/{deviceId}/interfaces/{interfaceId}Get a specific interface for a registered device
DeviceManagementInterfacesV1ApiListInterfacesForADeviceUsingGETGet /api/v1/deviceMgt/devices/{deviceId}/interfacesGet the interface list for a registered device
DeviceManagementInterfacesV1ApiUpdateInterfaceUsingPATCHPatch /api/v1/deviceMgt/devices/{deviceId}/interfaces/{interfaceId}Update an interface
DeviceManagementInventoryV1ApiCreateDeviceUsingPOSTPost /api/v1/deviceMgt/devicesCreate a device
DeviceManagementInventoryV1ApiDeleteDeviceUsingDELETEDelete /api/v1/deviceMgt/devices/{deviceId}Delete a device
DeviceManagementInventoryV1ApiGetDeviceStreamsUsingGETGet /api/v1/deviceMgt/devices/{deviceId}/data/streamsGet a device's streamIds
DeviceManagementInventoryV1ApiGetDeviceUsingGET2Get /api/v1/deviceMgt/devices/{deviceId}Get a device
DeviceManagementInventoryV1ApiListDevicesUsingGET2Get /api/v1/deviceMgt/devicesList registered devices
DeviceManagementInventoryV1ApiUpdateDeviceUsingPATCHPatch /api/v1/deviceMgt/devices/{deviceId}Update a device
DeviceManagementResourcesManagementApiAddResourceUsingPOSTPost /api/v0/rmAdd a resource in Resource Manager
DeviceManagementResourcesManagementApiAddResourceVersionUsingPOSTPost /api/v0/rm/{resourceId}/versionAdd a new version to a resource
DeviceManagementResourcesManagementApiDeleteResourceUsingDELETEDelete /api/v0/rm/{resourceId}Delete a resource
DeviceManagementResourcesManagementApiDeleteResourceVersionUsingDELETEDelete /api/v0/rm/{resourceId}/version/{resourceVersionId}Delete a resource's version
DeviceManagementResourcesManagementApiGetAllConnectorsUsingGETGet /api/v0/rm/connectorsGet all available connectors
DeviceManagementResourcesManagementApiGetConnectorMandatoryAndOptionalMetadataUsingGETGet /api/v0/rm/connectors/{connector}/metadataGet mandatory and optional metadata of a connector
DeviceManagementResourcesManagementApiGetResourceCompatibleVersionsUsingGETGet /api/v0/rm/{resourceId}/compatibleVersion/{currentVersion}List the versions from which a resource update to the version can be done
DeviceManagementResourcesManagementApiGetResourceUsingGETGet /api/v0/rm/{resourceId}Get a resource
DeviceManagementResourcesManagementApiGetResourceVersionUsingGETGet /api/v0/rm/{resourceId}/version/{resourceVersionId}Get a resource's version
DeviceManagementResourcesManagementApiGetResourceVersionsUsingGETGet /api/v0/rm/{resourceId}/versionList resource's versions
DeviceManagementResourcesManagementApiGetResourcesUsingGETGet /api/v0/rmList all resources
DeviceManagementResourcesManagementApiUpdateResourceUsingPUTPut /api/v0/rm/{resourceId}Update a resource
DeviceManagementResourcesManagementApiUpdateResourceVersionUsingPUTPut /api/v0/rm/{resourceId}/version/{resourceVersionId}Update a resource's version
DeviceManagementResourcesV1ApiGetDeviceResourceUpdatesUsingGET1Get /api/v1/deviceMgt/devices/{deviceId}/resources/updatesGet a list of device resource updates
DeviceManagementResourcesV1ApiGetDeviceResourceUsingGETGet /api/v1/deviceMgt/devices/{deviceId}/resources/{resourceId}Get a specific device resource
DeviceManagementResourcesV1ApiGetLastResourceUpdateUsingGET1Get /api/v1/deviceMgt/devices/{deviceId}/resources/{resourceId}/updates/latestGet info about last update of this device resource
DeviceManagementResourcesV1ApiListDeviceResourcesUsingGET1Get /api/v1/deviceMgt/devices/{deviceId}/resourcesGet a map of all device resources
DeviceManagementResourcesV1ApiSetDeviceResourceVersionUsingPOST1Post /api/v1/deviceMgt/devices/{deviceId}/resources/{resourceId}Set device resource versions
EventProcessingActivityApiDeleteUsingDELETE14Delete /api/v0/eventprocessing/activity/rules/{activityRuleId}Delete an ActivityRule
EventProcessingActivityApiGetStatesUsingGETGet /api/v0/eventprocessing/activity/statesRetrieve the list of all the ActivityStates linked to a specific device and/or rule
EventProcessingActivityApiGetUsingGET13Get /api/v0/eventprocessing/activity/rules/{activityRuleId}Retrieve an ActivityRule
EventProcessingActivityApiListUsingGET16Get /api/v0/eventprocessing/activity/rulesRetrieve the list of all the ActivityRules or get an ActivityRule by its name
EventProcessingActivityApiMuteUsingPUTPut /api/v0/eventprocessing/activity/states/muteMute or reset nextAlarm of ActivityStates targeted by a specific deviceId/activityRuleId
EventProcessingActivityApiPostUsingPOST13Post /api/v0/eventprocessing/activity/rulesCreate an ActivityRule
EventProcessingActivityApiUpdateUsingPUT7Put /api/v0/eventprocessing/activity/rules/{activityRuleId}Update an ActivityRule
EventProcessingContextApiClearUsingDELETEDelete /api/v0/eventprocessing/contextDelete all context entries
EventProcessingContextApiDeleteUsingDELETE15Delete /api/v0/eventprocessing/context/{contextKey}Delete a context key
EventProcessingContextApiGetUsingGET14Get /api/v0/eventprocessing/context/{contextKey}Retrieve a context
EventProcessingContextApiListUsingGET17Get /api/v0/eventprocessing/contextRetrieve the list of contexts with optional tag filtering
EventProcessingContextApiSaveUsingPUTPut /api/v0/eventprocessing/context/{contextKey}Save a context
EventProcessingFiringApiDeleteUsingDELETE16Delete /api/v0/eventprocessing/firing-rule/{firingRuleId}Delete a FiringRule
EventProcessingFiringApiGetFiringGuardUsingGETGet /api/v0/eventprocessing/firing-guard/{firingGuardId}Get a FiringGuard
EventProcessingFiringApiGetFiringGuardsUsingPOSTPost /api/v0/eventprocessing/firing-guard/searchGet FiringGuards linked to a FiringRule, and where FiringGuards selection criteria match.
EventProcessingFiringApiGetUsingGET15Get /api/v0/eventprocessing/firing-rule/{firingRuleId}Retrieve a FiringRule
EventProcessingFiringApiListUsingGET18Get /api/v0/eventprocessing/firing-ruleRetrieve the list of all the FiringRules or get a FiringRule by its name
EventProcessingFiringApiPostUsingPOST14Post /api/v0/eventprocessing/firing-ruleCreate a FiringRule
EventProcessingFiringApiRemoveFiringGuardUsingDELETEDelete /api/v0/eventprocessing/firing-guard/{firingGuardId}Remove a FiringGuard
EventProcessingFiringApiRemoveFiringGuardsUsingDELETEDelete /api/v0/eventprocessing/firing-guardRemove the FiringGuards linked to FiringRule, and where FiringGuards selection criteria match.
EventProcessingFiringApiUpdateUsingPUT8Put /api/v0/eventprocessing/firing-rule/{firingRuleId}Update a FiringRule
EventProcessingGeozoneApiDeleteUsingDELETE17Delete /api/v0/eventprocessing/geozones/{zoneId}delete a geographic zone
EventProcessingGeozoneApiGetUsingGET16Get /api/v0/eventprocessing/geozones/{zoneId}retrieve a geozone from repository
EventProcessingGeozoneApiListUsingGET19Get /api/v0/eventprocessing/geozonesretrieve paginated list of geozones
EventProcessingGeozoneApiSaveUsingPUT1Put /api/v0/eventprocessing/geozones/{zoneId}Save a geographic zone
EventProcessingMatchingApiDeleteUsingDELETE18Delete /api/v0/eventprocessing/matching-rule/{matchingRuleId}Delete a MatchingRule
EventProcessingMatchingApiGetUsingGET17Get /api/v0/eventprocessing/matching-rule/{matchingRuleId}Retrieve a MatchingRule
EventProcessingMatchingApiListUsingGET20Get /api/v0/eventprocessing/matching-ruleRetrieve the list of all the MatchingRules or get a MatchingRule by its name
EventProcessingMatchingApiPostUsingPOST15Post /api/v0/eventprocessing/matching-ruleCreate a MatchingRule
EventProcessingMatchingApiTestUsingPOST4Post /api/v0/eventprocessing/matching-rule/testTest a JsonLogic predicate with some data sample
EventProcessingMatchingApiUpdateUsingPUT9Put /api/v0/eventprocessing/matching-rule/{matchingRuleId}Update a MatchingRule
EventProcessingStateProcessingApiDeleteUsingDELETE19Delete /api/v0/eventprocessing/stateprocessing-rule/{stateProcessingRuleId}Delete a StateProcessingRule
EventProcessingStateProcessingApiGetUsingGET18Get /api/v0/eventprocessing/stateprocessing-rule/{stateProcessingRuleId}Retrieve a StateProcessingRule
EventProcessingStateProcessingApiListUsingGET21Get /api/v0/eventprocessing/stateprocessing-ruleRetrieve the list of all the StateProcessingRules or get a StateProcessingRule by its name
EventProcessingStateProcessingApiPostUsingPOST16Post /api/v0/eventprocessing/stateprocessing-ruleCreate a StateProcessingRule
EventProcessingStateProcessingApiTestUsingPOST5Post /api/v0/eventprocessing/stateprocessing-rule/testtest a State Processing function
EventProcessingStateProcessingApiUpdateUsingPUT10Put /api/v0/eventprocessing/stateprocessing-rule/{stateProcessingRuleId}Update a StateProcessingRule
NotificationApiSendMessageUsingPOSTPost /api/v0/contactAPI to send message
PartnerDataPushApiDataPushUsingPOSTPost /api/v0/partners/data/streamsPush data
PartnersManagementApiAddOptionToTenantUsingPOSTPost /api/v0/partners/tenants/{tenantId}/optionsSubscribe an option for a partner's tenant
PartnersManagementApiCreateTenantByPartnerUsingPOSTPost /api/v0/partners/tenantsCreate a partner's tenant
PartnersTokensManagementApiCreatePartnerTokenUsingPOSTPost /api/v0/oauth2/tokenRequest a new Token
TenantAccountsApiGetMyTenantUsingGETGet /api/v0/tenants/meGet details of your account
TriggersAndActionsApiCreateUsingPOST2Post /api/v1/event2action/actionPoliciesCreate an ActionPolicy
TriggersAndActionsApiDeleteUsingDELETE13Delete /api/v1/event2action/actionPolicies/{policyId}Delete an ActionPolicy
TriggersAndActionsApiListUsingGET15Get /api/v1/event2action/actionPoliciesList ActionPolicies
TriggersAndActionsApiRetrieveUsingGET2Get /api/v1/event2action/actionPolicies/{policyId}Retrieve an ActionPolicy
TriggersAndActionsApiUpsertUsingPUT1Put /api/v1/event2action/actionPolicies/{policyId}Create or update an ActionPolicy
TriggersAndActionsTestApiTestHttpPushUsingPOST1Post /api/v1/event2action/test/http-pushPost an http request for testing a webhook
UserAuthenticationApiAuthenticateUserUsingPOSTPost /api/v0/authAuthenticate a user
UserAuthenticationApiCookiesDeleteUsingDELETEDelete /api/v0/cookiescookiesDelete
UserAuthenticationApiGetTenantIdUsingGETGet /api/v0/whoamiGet your tenant id
UserAuthenticationApiLogoutUsingPOSTPost /api/v0/logoutLog out of the current session
UserAuthenticationApiResetUserPasswordUsingPOSTPost /api/v0/resetpwdReset user's password
UserAuthenticationApiUpdateUserEmailWithTokenUsingPOSTPost /api/v0/updateEmailUpdate user's email
UserAuthenticationApiUpdateUserPasswordWithTokenUsingPOSTPost /api/v0/setpwdUpdate user's password
UsersManagementApiActivateUserUsingPOST3Post /api/v0/users/activateUserActivate a user in a tenant account
UsersManagementApiCreateUserAccountUsingPOST3Post /api/v0/usersCreate a user
UsersManagementApiDeleteUserUsingDELETE3Delete /api/v0/users/{userId}Delete a user in a tenant account
UsersManagementApiGetCurrentUserUsingGETGet /api/v0/users/meGet a "myself" user data of Tenant
UsersManagementApiGetUserPortalDataUsingGETGet /api/v0/users/me/portaldataGet the portal data of me
UsersManagementApiGetUserUsingGET3Get /api/v0/users/{userId}Get details of a user in a tenant account
UsersManagementApiListUsersUsingGET1Get /api/v0/usersList all users in a tenant account
UsersManagementApiUpdateUserPasswordUsingPOSTPost /api/v0/users/{userId}/passwordUpdate user password
UsersManagementApiUpdateUserPasswordWithTokenWithoutCaptchaUsingPOSTPost /api/v0/users/activateTrialUpdate user password with a token
UsersManagementApiUpdateUserPortalDataUsingPUTPut /api/v0/users/me/portaldataUpdate the portal data of me
UsersManagementApiUpdateUserUsingPOST1Post /api/v0/users/{userId}Update a user

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

[email protected]