# VmosoApi.FileApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**addAttachment**](FileApi.md#addAttachment) | **PUT** /files/{objectKey}/addFileAsAttachment | 
[**createFile**](FileApi.md#createFile) | **POST** /files | 
[**deleteFiles**](FileApi.md#deleteFiles) | **POST** /files/delete | 
[**fileRecordAction**](FileApi.md#fileRecordAction) | **POST** /files/{key}/stream | 
[**getCloudConnectionData**](FileApi.md#getCloudConnectionData) | **GET** /files/getCloudConnectionData | 
[**getContainerHistory**](FileApi.md#getContainerHistory) | **GET** /files/{key}/history | 
[**getContainerPermissions**](FileApi.md#getContainerPermissions) | **GET** /files/{key}/getpermissions/{containerKey} | 
[**getDownloadToken**](FileApi.md#getDownloadToken) | **POST** /files/token | 
[**getFiles**](FileApi.md#getFiles) | **GET** /files/lookup | 
[**getPreviewInfo**](FileApi.md#getPreviewInfo) | **GET** /files/{key}/pre | 
[**getPreviewStatus**](FileApi.md#getPreviewStatus) | **GET** /files/{key}/pre/status | 
[**getThumbnailInfo**](FileApi.md#getThumbnailInfo) | **GET** /files/{key}/thumbnails | 
[**removeAttachments**](FileApi.md#removeAttachments) | **POST** /files/{objectKey}/removeFileAsAttachment | 
[**removeCSIPermissions**](FileApi.md#removeCSIPermissions) | **POST** /files/csiRemovePermissions | 
[**setCSIAccess**](FileApi.md#setCSIAccess) | **GET** /files/{key}/csi/setAccess | 
[**setCSIToken**](FileApi.md#setCSIToken) | **POST** /files/csiSetUserToken | 
[**setContainerPermissions**](FileApi.md#setContainerPermissions) | **PUT** /files/{key}/setpermissions/{containerKey} | 
[**setFavorite**](FileApi.md#setFavorite) | **POST** /files/favorite | 
[**setImportant**](FileApi.md#setImportant) | **POST** /files/important | 
[**viewFile**](FileApi.md#viewFile) | **GET** /files/{key} | 


<a name="addAttachment"></a>
# **addAttachment**
> AddAttachmentResult addAttachment(objectKey, input)





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

var objectKey = "objectKey_example"; // {String} 

var input = new VmosoApi.AddAttachmentInput(); // {AddAttachmentInput} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **objectKey** | **String**|  | 
 **input** | [**AddAttachmentInput**](AddAttachmentInput.md)|  | 

### Return type

[**AddAttachmentResult**](AddAttachmentResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="createFile"></a>
# **createFile**
> CreateFileResult createFile(input)



Use this API to upload a new file to Vmoso.

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

var input = new VmosoApi.CreateFileInput(); // {CreateFileInput} Details for new file.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**CreateFileInput**](CreateFileInput.md)| Details for new file. | 

### Return type

[**CreateFileResult**](CreateFileResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="deleteFiles"></a>
# **deleteFiles**
> DeleteFilesResult deleteFiles(input)



Use this API to delete files.

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

var input = new VmosoApi.DeleteFilesInput(); // {DeleteFilesInput} Key of files to delete.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**DeleteFilesInput**](DeleteFilesInput.md)| Key of files to delete. | 

### Return type

[**DeleteFilesResult**](DeleteFilesResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="fileRecordAction"></a>
# **fileRecordAction**
> FileRecordActionResult fileRecordAction(key, input)





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

var key = "key_example"; // {String} 

var input = new VmosoApi.FileRecordActionInput(); // {FileRecordActionInput} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**|  | 
 **input** | [**FileRecordActionInput**](FileRecordActionInput.md)|  | 

### Return type

[**FileRecordActionResult**](FileRecordActionResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getCloudConnectionData"></a>
# **getCloudConnectionData**
> GetCloudConnectionDataResult getCloudConnectionData(provider)



Use this API to get the cloud connection 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.FileApi()

var provider = "provider_example"; // {String} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **provider** | **String**|  | 

### Return type

[**GetCloudConnectionDataResult**](GetCloudConnectionDataResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getContainerHistory"></a>
# **getContainerHistory**
> GetContainerHistoryResult getContainerHistory(key, 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.FileApi()

var key = "key_example"; // {String} 

var opts = { 
  'options': "options_example", // {String} 
  'pg': "pg_example", // {String} 
  'containerKey': "containerKey_example" // {String} 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**|  | 
 **options** | **String**|  | [optional] 
 **pg** | **String**|  | [optional] 
 **containerKey** | **String**|  | [optional] 

### Return type

[**GetContainerHistoryResult**](GetContainerHistoryResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getContainerPermissions"></a>
# **getContainerPermissions**
> GetContainerPermissionsResult getContainerPermissions(key, containerKey)





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

var key = "key_example"; // {String} 

var containerKey = "containerKey_example"; // {String} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**|  | 
 **containerKey** | **String**|  | 

### Return type

[**GetContainerPermissionsResult**](GetContainerPermissionsResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getDownloadToken"></a>
# **getDownloadToken**
> GetDownloadTokenResult getDownloadToken(input)





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

var input = new VmosoApi.GetDownloadTokenInput(); // {GetDownloadTokenInput} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**GetDownloadTokenInput**](GetDownloadTokenInput.md)|  | 

### Return type

[**GetDownloadTokenResult**](GetDownloadTokenResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getFiles"></a>
# **getFiles**
> GetFilesResult getFiles(keys)





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

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


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

### Parameters

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

### Return type

[**GetFilesResult**](GetFilesResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getPreviewInfo"></a>
# **getPreviewInfo**
> GetPreviewInfoResult getPreviewInfo(key)





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

var key = "key_example"; // {String} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**|  | 

### Return type

[**GetPreviewInfoResult**](GetPreviewInfoResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getPreviewStatus"></a>
# **getPreviewStatus**
> GetPreviewStatusResult getPreviewStatus(key)





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

var key = "key_example"; // {String} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**|  | 

### Return type

[**GetPreviewStatusResult**](GetPreviewStatusResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getThumbnailInfo"></a>
# **getThumbnailInfo**
> GetThumbnailInfoResult getThumbnailInfo(key)





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

var key = "key_example"; // {String} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**|  | 

### Return type

[**GetThumbnailInfoResult**](GetThumbnailInfoResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="removeAttachments"></a>
# **removeAttachments**
> RemoveAttachmentsResult removeAttachments(objectKey, input)





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

var objectKey = "objectKey_example"; // {String} 

var input = new VmosoApi.RemoveAttachmentsInput(); // {RemoveAttachmentsInput} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **objectKey** | **String**|  | 
 **input** | [**RemoveAttachmentsInput**](RemoveAttachmentsInput.md)|  | 

### Return type

[**RemoveAttachmentsResult**](RemoveAttachmentsResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="removeCSIPermissions"></a>
# **removeCSIPermissions**
> RemoveCSIPermissionsResult removeCSIPermissions(input)





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

var input = new VmosoApi.RemoveCSIPermissionsInput(); // {RemoveCSIPermissionsInput} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**RemoveCSIPermissionsInput**](RemoveCSIPermissionsInput.md)|  | 

### Return type

[**RemoveCSIPermissionsResult**](RemoveCSIPermissionsResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="setCSIAccess"></a>
# **setCSIAccess**
> SetCSIAccessResult setCSIAccess(key, 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.FileApi()

var key = "key_example"; // {String} 

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

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**|  | 
 **containerKey** | **String**|  | [optional] 

### Return type

[**SetCSIAccessResult**](SetCSIAccessResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="setCSIToken"></a>
# **setCSIToken**
> SetCSITokenResult setCSIToken(input)





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

var input = new VmosoApi.SetCSITokenInput(); // {SetCSITokenInput} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**SetCSITokenInput**](SetCSITokenInput.md)|  | 

### Return type

[**SetCSITokenResult**](SetCSITokenResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="setContainerPermissions"></a>
# **setContainerPermissions**
> SetContainerPermissionsResult setContainerPermissions(key, containerKey, input)





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

var key = "key_example"; // {String} 

var containerKey = "containerKey_example"; // {String} 

var input = new VmosoApi.SetContainerPermissionsInput(); // {SetContainerPermissionsInput} 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**|  | 
 **containerKey** | **String**|  | 
 **input** | [**SetContainerPermissionsInput**](SetContainerPermissionsInput.md)|  | 

### Return type

[**SetContainerPermissionsResult**](SetContainerPermissionsResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="setFavorite"></a>
# **setFavorite**
> SetFavoriteResult setFavorite(input)



Use this API to set files as favorites.

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

var input = new VmosoApi.SetFavoriteInput(); // {SetFavoriteInput} Files to set as favorite.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**SetFavoriteInput**](SetFavoriteInput.md)| Files to set as favorite. | 

### Return type

[**SetFavoriteResult**](SetFavoriteResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="setImportant"></a>
# **setImportant**
> SetImportantResult setImportant(input)



Use this API to set files as important.

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

var input = new VmosoApi.SetImportantInput(); // {SetImportantInput} Files to set as important.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**SetImportantInput**](SetImportantInput.md)| Files to set as important. | 

### Return type

[**SetImportantResult**](SetImportantResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="viewFile"></a>
# **viewFile**
> ViewFileResult viewFile(key, 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.FileApi()

var key = "key_example"; // {String} 

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

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**|  | 
 **containerKey** | **String**|  | [optional] 

### Return type

[**ViewFileResult**](ViewFileResult.md)

### Authorization

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

### HTTP reuqest headers

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