korewireless / OmniCore-Ruby-SDK

omnicore_client

OmniCoreClient - the Ruby gem for the OmniCore Model and State Management API

This is an OmniCore Model and State Management server.

• API version: 1.8.10
• Package version: {_PACKAGE_VERSION}
• Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit http://www.korewireless.com

Installation

Build a gem

To build the Ruby code into a gem:

gem build omnicore_client.gemspec

Then either install the gem locally:

gem install ./omnicore_client-{_PACKAGE_VERSION}.gem

(for development, run gem install --dev ./omnicore_client-{_PACKAGE_VERSION}.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'omnicore_client', '~> {_PACKAGE_VERSION}'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/korewireless/OmniCore-Ruby-SDK, then add the following in the Gemfile:

gem 'omnicore_client', :git => 'https://github.com/korewireless/OmniCore-Ruby-SDK.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'omnicore_client'

# Setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = OmniCoreClient::DeviceApi.new
subscription_id = 'subscription_id_example' # String | Subscription ID
registry_id = 'registry_id_example' # String | Registry ID
bind = OmniCoreClient::BindRequest.new({device_id: 'device_id_example', gateway_id: 'gateway_id_example'}) # BindRequest | application/json

begin
  result = api_instance.bind_device(subscription_id, registry_id, bind)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Exception when calling DeviceApi->bind_device: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.korewireless.com

Class	Method	HTTP request	Description
OmniCoreClient::DeviceApi	bind_device	POST /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/bindDeviceToGateway
OmniCoreClient::DeviceApi	bind_devices	POST /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/bindDevicesToGateway
OmniCoreClient::DeviceApi	block_device_communcation	PUT /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/communication
OmniCoreClient::DeviceApi	create_device	POST /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices
OmniCoreClient::DeviceApi	delete_device	DELETE /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId}
OmniCoreClient::DeviceApi	get_config	GET /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/configVersions
OmniCoreClient::DeviceApi	get_device	GET /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId}
OmniCoreClient::DeviceApi	get_devices	GET /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices
OmniCoreClient::DeviceApi	get_states	GET /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/states
OmniCoreClient::DeviceApi	get_subscription_devices	GET /omnicore/subscriptions/{subscriptionId}/devices
OmniCoreClient::DeviceApi	send_command_to_device	POST /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/sendCommandToDevice
OmniCoreClient::DeviceApi	un_bind_device	POST /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/unbindDeviceFromGateway
OmniCoreClient::DeviceApi	un_bind_devices	POST /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/unbindDevicesFromGateway
OmniCoreClient::DeviceApi	update_configuration_to_device	POST /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateConfigurationToDevice
OmniCoreClient::DeviceApi	update_custom_onboard_request	POST /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateCustomOnboardRequest
OmniCoreClient::DeviceApi	update_device	PATCH /omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId}
OmniCoreClient::MetricsApi	get_metrics	GET /omnicore/subscriptions/{subscriptionId}/metrics
OmniCoreClient::RegistryApi	create_registry	POST /omnicore/subscriptions/{subscriptionId}/registries
OmniCoreClient::RegistryApi	delete_registry	DELETE /omnicore/subscriptions/{subscriptionId}/registries/{registryId}
OmniCoreClient::RegistryApi	get_registries	GET /omnicore/subscriptions/{subscriptionId}/registries
OmniCoreClient::RegistryApi	get_registry	GET /omnicore/subscriptions/{subscriptionId}/registries/{registryId}
OmniCoreClient::RegistryApi	send_broadcast_to_devices	POST /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/sendBroadcastToDevice
OmniCoreClient::RegistryApi	update_registry	PATCH /omnicore/subscriptions/{subscriptionId}/registries/{registryId}
OmniCoreClient::SinkApi	create_sink	POST /omnicore/subscriptions/{subscriptionId}/sinks
OmniCoreClient::SinkApi	delete_sink	DELETE /omnicore/subscriptions/{subscriptionId}/sinks/{sinkId}
OmniCoreClient::SinkApi	get_a_sink	GET /omnicore/subscriptions/{subscriptionId}/sinks/{sinkId}
OmniCoreClient::SinkApi	get_sinks	GET /omnicore/subscriptions/{subscriptionId}/sinks	Get All Sinks
OmniCoreClient::VaultApi	create_vault_configuration	POST /vault/subscriptions/{subscriptionid}/configurations
OmniCoreClient::VaultApi	create_vault_key	POST /vault/subscriptions/{subscriptionid}/encryptionkeys
OmniCoreClient::VaultApi	delete_configuration	DELETE /vault/subscriptions/{subscriptionid}/configurations/{configid}
OmniCoreClient::VaultApi	delete_vault_key	DELETE /vault/subscriptions/{subscriptionid}/encryptionkeys/{keyid}
OmniCoreClient::VaultApi	enable_encryption	POST /vault/subscriptions/{subscriptionid}/encryption
OmniCoreClient::VaultApi	get_exports	GET /vault/subscriptions/{subscriptionid}/exports
OmniCoreClient::VaultApi	get_registry_data	GET /vault/subscriptions/{subscriptionid}/folders
OmniCoreClient::VaultApi	get_replays	GET /vault/subscriptions/{subscriptionid}/replays
OmniCoreClient::VaultApi	get_vault_audit	GET /vault/subscriptions/{subscriptionid}/audit
OmniCoreClient::VaultApi	get_vault_configurations	GET /vault/subscriptions/{subscriptionid}/configurations
OmniCoreClient::VaultApi	get_vault_files	GET /vault/subscriptions/{subscriptionid}/registry/{registryid}/files
OmniCoreClient::VaultApi	get_vault_keys	GET /vault/subscriptions/{subscriptionid}/encryptionkeys
OmniCoreClient::VaultApi	get_vault_metrics	GET /vault/subscriptions/{subscriptionid}/metrics
OmniCoreClient::VaultApi	get_vault_status	GET /vault/subscriptions/{subscriptionid}/status
OmniCoreClient::VaultApi	set_retention	POST /vault/subscriptions/{subscriptionid}/retention
OmniCoreClient::VaultApi	start_export	POST /vault/subscriptions/{subscriptionid}/exports
OmniCoreClient::VaultApi	start_replay	POST /vault/subscriptions/{subscriptionid}/replays

Documentation for Models

• OmniCoreClient::Audit
• OmniCoreClient::AuditResult
• OmniCoreClient::BindRequest
• OmniCoreClient::BindRequestIdsGateway
• OmniCoreClient::BlockCommunicationBody
• OmniCoreClient::Config
• OmniCoreClient::Configurations
• OmniCoreClient::CreateConfiguration
• OmniCoreClient::CreateVaultKeyBody
• OmniCoreClient::CustomOnboard
• OmniCoreClient::Device
• OmniCoreClient::DeviceCommand
• OmniCoreClient::DeviceConfig
• OmniCoreClient::DeviceConfiguration
• OmniCoreClient::DeviceCredential
• OmniCoreClient::DeviceOnline
• OmniCoreClient::DeviceRegistry
• OmniCoreClient::DeviceState
• OmniCoreClient::EnableEncryptionBody
• OmniCoreClient::ErrorFrame
• OmniCoreClient::ErrorStatus
• OmniCoreClient::EventNotificationConfig
• OmniCoreClient::ExportDetail
• OmniCoreClient::FileDetail
• OmniCoreClient::FileDetails
• OmniCoreClient::Folder
• OmniCoreClient::FolderData
• OmniCoreClient::Frame
• OmniCoreClient::GatewayConfig
• OmniCoreClient::GenericErrorResponse
• OmniCoreClient::GetExportsResponse
• OmniCoreClient::GetKeysResponse
• OmniCoreClient::GetReplaysResponse
• OmniCoreClient::HttpConfig
• OmniCoreClient::Info
• OmniCoreClient::ListDeviceConfigVersionsResponse
• OmniCoreClient::ListDeviceRegistries
• OmniCoreClient::ListDeviceStatesResponse
• OmniCoreClient::ListDevicesOnlineResponse
• OmniCoreClient::ListDevicesResponse
• OmniCoreClient::ListSinks
• OmniCoreClient::LogLevel
• OmniCoreClient::Metrics
• OmniCoreClient::MetricsData
• OmniCoreClient::MetricsDetails
• OmniCoreClient::MetricsLogs
• OmniCoreClient::MetricsResponse
• OmniCoreClient::MetricsResponseDetails
• OmniCoreClient::MqttConfig
• OmniCoreClient::NotificationConfig
• OmniCoreClient::OperationMetrics
• OmniCoreClient::Policy
• OmniCoreClient::PublicKeyCertificate
• OmniCoreClient::PublicKeyCredential
• OmniCoreClient::RegistryCredential
• OmniCoreClient::Replay
• OmniCoreClient::ReplayBody
• OmniCoreClient::SetRetentionBody
• OmniCoreClient::Sink
• OmniCoreClient::StartExportBody
• OmniCoreClient::VaultConfiguration
• OmniCoreClient::VaultEncryptionKey
• OmniCoreClient::VaultStatus
• OmniCoreClient::VaultStatusDetails
• OmniCoreClient::X509CertificateDetails

Documentation for Authorization

bearerAuth

• Type: Bearer authentication (JWT)

apiKey

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header