# VmosoApi.SparcApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**getASCCounts**](SparcApi.md#getASCCounts) | **GET** /sparc/ASC/counts | 
[**getASCUnreadCounts**](SparcApi.md#getASCUnreadCounts) | **GET** /sparc/ASC/unread/count | 
[**getAttachmentUnreadCounts**](SparcApi.md#getAttachmentUnreadCounts) | **GET** /sparc/ASC/counts/attachment | 
[**getChatNUTCount**](SparcApi.md#getChatNUTCount) | **GET** /sparc/getNUTCount/chat | 
[**getLMBCount**](SparcApi.md#getLMBCount) | **GET** /sparc/LMB/count/{objectKey} | 
[**getLatestAction**](SparcApi.md#getLatestAction) | **GET** /sparc/lastAction | 
[**getNUTCount**](SparcApi.md#getNUTCount) | **GET** /sparc/getNUTCount | 
[**getSkinnyData**](SparcApi.md#getSkinnyData) | **GET** /sparc/tiny/{type}/{key}/{sparcType} | 
[**getSparcActions**](SparcApi.md#getSparcActions) | **GET** /sparc/view | 


<a name="getASCCounts"></a>
# **getASCCounts**
> GetASCCountsResult getASCCounts(key, opts)



Use this API to get the ASC (Action Stream Consolidated) counts.

### 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.SparcApi()

var key = "key_example"; // {String} Object ID.

var opts = { 
  'flagFilter': "flagFilter_example" // {String} Flag filter. Options are: all, refme, follow
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**| Object ID. | 
 **flagFilter** | **String**| Flag filter. Options are: all, refme, follow | [optional] 

### Return type

[**GetASCCountsResult**](GetASCCountsResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getASCUnreadCounts"></a>
# **getASCUnreadCounts**
> GetASCUnreadCountsResult getASCUnreadCounts(keys)



Use this API to get the unread ASC counts.

### 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.SparcApi()

var keys = ["keys_example"]; // {[String]} Object ID.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **keys** | [**[String]**](String.md)| Object ID. | 

### Return type

[**GetASCUnreadCountsResult**](GetASCUnreadCountsResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getAttachmentUnreadCounts"></a>
# **getAttachmentUnreadCounts**
> GetAttachmentUnreadCountsResult getAttachmentUnreadCounts(objectKey)



Use this API to get the unread attachment counts.

### 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.SparcApi()

var objectKey = "objectKey_example"; // {String} Object ID.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **objectKey** | **String**| Object ID. | 

### Return type

[**GetAttachmentUnreadCountsResult**](GetAttachmentUnreadCountsResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getChatNUTCount"></a>
# **getChatNUTCount**
> GetChatNUTCountResult getChatNUTCount(opts)



Use this API to get the chat new unread tiles count.

### 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.SparcApi()

var opts = { 
  'spaceKey': "spaceKey_example" // {String} Space key. Specify the space to limit the count to a particular space. If you omit the space, a total count is provided.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **spaceKey** | **String**| Space key. Specify the space to limit the count to a particular space. If you omit the space, a total count is provided. | [optional] 

### Return type

[**GetChatNUTCountResult**](GetChatNUTCountResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getLMBCount"></a>
# **getLMBCount**
> GetLMBCountResult getLMBCount(objectKey, opts)



Use this API to get the local menu bar count.

### 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.SparcApi()

var objectKey = "objectKey_example"; // {String} Object ID.

var opts = { 
  'containerKey': "containerKey_example" // {String} Container key.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **objectKey** | **String**| Object ID. | 
 **containerKey** | **String**| Container key. | [optional] 

### Return type

[**GetLMBCountResult**](GetLMBCountResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getLatestAction"></a>
# **getLatestAction**
> GetLatestActionResult getLatestAction(objectKey)



Use this API to get the last action.

### 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.SparcApi()

var objectKey = "objectKey_example"; // {String} Object ID.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **objectKey** | **String**| Object ID. | 

### Return type

[**GetLatestActionResult**](GetLatestActionResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getNUTCount"></a>
# **getNUTCount**
> GetNUTCountResult getNUTCount



Use this API to get the new unread tile count.

### 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.SparcApi()

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

### Parameters
This endpoint does not need any parameter.

### Return type

[**GetNUTCountResult**](GetNUTCountResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getSkinnyData"></a>
# **getSkinnyData**
> GetSkinnyDataResult getSkinnyData(type, key, sparcType, opts)



Use this API to get skinny data.

### 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.SparcApi()

var type = "type_example"; // {String} Object type.

var key = "key_example"; // {String} Object ID.

var sparcType = "sparcType_example"; // {String} SPARC type.

var opts = { 
  'sparcSubType': "sparcSubType_example", // {String} SPARC subtype.
  'pg': "pg_example", // {String} Pagination options.
  'format': "format_example" // {String} Format.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSkinnyData(type, key, sparcType, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **type** | **String**| Object type. | 
 **key** | **String**| Object ID. | 
 **sparcType** | **String**| SPARC type. | 
 **sparcSubType** | **String**| SPARC subtype. | [optional] 
 **pg** | **String**| Pagination options. | [optional] 
 **format** | **String**| Format. | [optional] 

### Return type

[**GetSkinnyDataResult**](GetSkinnyDataResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getSparcActions"></a>
# **getSparcActions**
> GetSparcActionsResult getSparcActions(options, objectKey, pg, opts)





### 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.SparcApi()

var options = "options_example"; // {String} Query based on ActionOptionsRecord.

var objectKey = "objectKey_example"; // {String} Object ID.

var pg = "pg_example"; // {String} Pagination options.

var opts = { 
  'cache': true // {Boolean} Whether cache is needed or not.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSparcActions(options, objectKey, pg, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **options** | **String**| Query based on ActionOptionsRecord. | 
 **objectKey** | **String**| Object ID. | 
 **pg** | **String**| Pagination options. | 
 **cache** | **Boolean**| Whether cache is needed or not. | [optional] 

### Return type

[**GetSparcActionsResult**](GetSparcActionsResult.md)

### Authorization

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

### HTTP reuqest headers

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