# VmosoApi.DeviceApi

All URIs are relative to *https://www.vmoso.com/svc*

Method | HTTP request | Description
------------- | ------------- | -------------
[**checkUrl**](DeviceApi.md#checkUrl) | **GET** /device/checkUrl | 
[**registerCVDevice**](DeviceApi.md#registerCVDevice) | **POST** /cv/device/set | 
[**registerDevice**](DeviceApi.md#registerDevice) | **POST** /device/set | 
[**unregisterCVDevice**](DeviceApi.md#unregisterCVDevice) | **POST** /cv/device/unset | 
[**unregisterDevice**](DeviceApi.md#unregisterDevice) | **POST** /device/unset | 


<a name="checkUrl"></a>
# **checkUrl**
> CheckUrlResult checkUrl(url)



Use this API to check the URL of the device.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.DeviceApi()

var url = "url_example"; // {String} URL of device.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkUrl(url, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **url** | **String**| URL of device. | 

### Return type

[**CheckUrlResult**](CheckUrlResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="registerCVDevice"></a>
# **registerCVDevice**
> RegisterCVDeviceResult registerCVDevice(input)



Use this API to set the Clearvale device for a user

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.DeviceApi()

var input = new VmosoApi.RegisterCVDeviceInput(); // {RegisterCVDeviceInput} The Clearvale device type and ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerCVDevice(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**RegisterCVDeviceInput**](RegisterCVDeviceInput.md)| The Clearvale device type and ID. | 

### Return type

[**RegisterCVDeviceResult**](RegisterCVDeviceResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="registerDevice"></a>
# **registerDevice**
> RegisterDeviceResult registerDevice(input)



Use this API to set the device for a user.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.DeviceApi()

var input = new VmosoApi.RegisterDeviceInput(); // {RegisterDeviceInput} Device type and ID to set.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerDevice(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**RegisterDeviceInput**](RegisterDeviceInput.md)| Device type and ID to set. | 

### Return type

[**RegisterDeviceResult**](RegisterDeviceResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="unregisterCVDevice"></a>
# **unregisterCVDevice**
> UnregisterCVDeviceResult unregisterCVDevice(input)



Use this API to unset a Clearvale device for a user.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.DeviceApi()

var input = new VmosoApi.UnregisterCVDeviceInput(); // {UnregisterCVDeviceInput} Clearvale device type and ID to unset.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unregisterCVDevice(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**UnregisterCVDeviceInput**](UnregisterCVDeviceInput.md)| Clearvale device type and ID to unset. | 

### Return type

[**UnregisterCVDeviceResult**](UnregisterCVDeviceResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="unregisterDevice"></a>
# **unregisterDevice**
> UnregisterDeviceResult unregisterDevice(input)



Use this API to unset a device for a user.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.DeviceApi()

var input = new VmosoApi.UnregisterDeviceInput(); // {UnregisterDeviceInput} Device type and ID to unset.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unregisterDevice(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**UnregisterDeviceInput**](UnregisterDeviceInput.md)| Device type and ID to unset. | 

### Return type

[**UnregisterDeviceResult**](UnregisterDeviceResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json