# VmosoApi.ContactApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**acceptNewUserInvitation**](ContactApi.md#acceptNewUserInvitation) | **POST** /contacts/newUserAcceptInvitation | 
[**acceptRegisteredUserInvitation**](ContactApi.md#acceptRegisteredUserInvitation) | **POST** /contacts/registeredUserAcceptInvitation | 
[**confirmRegistrationEmail**](ContactApi.md#confirmRegistrationEmail) | **POST** /contacts/registrationEmailConfirmation | 
[**deleteContacts**](ContactApi.md#deleteContacts) | **POST** /contacts/delete | 
[**deleteRequest**](ContactApi.md#deleteRequest) | **POST** /contacts/cancelRequest | 
[**downgradeContacts**](ContactApi.md#downgradeContacts) | **POST** /contacts/downgrade | 
[**getExistingTasks**](ContactApi.md#getExistingTasks) | **POST** /contacts/checkExistingChats | 
[**getGoogleConnectionData**](ContactApi.md#getGoogleConnectionData) | **GET** /contacts/getGoogleConnectionData | 
[**getMutualTypes**](ContactApi.md#getMutualTypes) | **GET** /contacts/mutual/types | 
[**getProfile**](ContactApi.md#getProfile) | **GET** /contacts/{key} | 
[**importAcquaintances**](ContactApi.md#importAcquaintances) | **POST** /contacts/importAsAcquaintance | 
[**importContacts**](ContactApi.md#importContacts) | **GET** /contacts/importContacts | 
[**inviteEmailAddress**](ContactApi.md#inviteEmailAddress) | **POST** /contacts/inviteByEmailAddress | 
[**inviteUsers**](ContactApi.md#inviteUsers) | **POST** /contacts/inviteByKeys | 
[**processAction**](ContactApi.md#processAction) | **POST** /contacts/processRequestAction | 


<a name="acceptNewUserInvitation"></a>
# **acceptNewUserInvitation**
> AcceptNewUserInvitationResult acceptNewUserInvitation(input)



Use this API to accept a new user invitation.

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

var input = new VmosoApi.AcceptNewUserInvitationInput(); // {AcceptNewUserInvitationInput} Invitation information


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**AcceptNewUserInvitationInput**](AcceptNewUserInvitationInput.md)| Invitation information | 

### Return type

[**AcceptNewUserInvitationResult**](AcceptNewUserInvitationResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="acceptRegisteredUserInvitation"></a>
# **acceptRegisteredUserInvitation**
> AcceptRegisteredUserInvitationResult acceptRegisteredUserInvitation(input)



Use this API to accept a registered user invitation.

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

var input = new VmosoApi.AcceptRegisteredUserInvitationInput(); // {AcceptRegisteredUserInvitationInput} Invitation information.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**AcceptRegisteredUserInvitationInput**](AcceptRegisteredUserInvitationInput.md)| Invitation information. | 

### Return type

[**AcceptRegisteredUserInvitationResult**](AcceptRegisteredUserInvitationResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="confirmRegistrationEmail"></a>
# **confirmRegistrationEmail**
> ConfirmRegistrationEmailResult confirmRegistrationEmail(input)



Use this API to confirm a registration email.

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

var input = new VmosoApi.ConfirmRegistrationEmailInput(); // {ConfirmRegistrationEmailInput} Invitation information.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**ConfirmRegistrationEmailInput**](ConfirmRegistrationEmailInput.md)| Invitation information. | 

### Return type

[**ConfirmRegistrationEmailResult**](ConfirmRegistrationEmailResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="deleteContacts"></a>
# **deleteContacts**
> DeleteContactsResult deleteContacts(input)



Use this API to delete Vmoso contacts. When you delete a contact, you are no longer connected to them in Vmoso. You do not delete them from 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.ContactApi()

var input = new VmosoApi.DeleteContactsInput(); // {DeleteContactsInput} Keys of the people to delete as your contacts.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**DeleteContactsInput**](DeleteContactsInput.md)| Keys of the people to delete as your contacts. | 

### Return type

[**DeleteContactsResult**](DeleteContactsResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="deleteRequest"></a>
# **deleteRequest**
> DeleteRequestResult deleteRequest(input)



Use this API to cancel a request to be a contact.

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

var input = new VmosoApi.DeleteRequestInput(); // {DeleteRequestInput} Request to cancel.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**DeleteRequestInput**](DeleteRequestInput.md)| Request to cancel. | 

### Return type

[**DeleteRequestResult**](DeleteRequestResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="downgradeContacts"></a>
# **downgradeContacts**
> DowngradeContactsResult downgradeContacts(input)



Use this API to downgrade the type of connection you have with one or more contacts.

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

var input = new VmosoApi.DowngradeContactsInput(); // {DowngradeContactsInput} Contacts for whom to change connection type.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**DowngradeContactsInput**](DowngradeContactsInput.md)| Contacts for whom to change connection type. | 

### Return type

[**DowngradeContactsResult**](DowngradeContactsResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getExistingTasks"></a>
# **getExistingTasks**
> GetExistingTasksResult getExistingTasks(input)



Use this API to get existing chats with certain people.

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

var input = new VmosoApi.GetExistingTasksInput(); // {GetExistingTasksInput} Individuals or groups with whom you have a chat


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**GetExistingTasksInput**](GetExistingTasksInput.md)| Individuals or groups with whom you have a chat | 

### Return type

[**GetExistingTasksResult**](GetExistingTasksResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getGoogleConnectionData"></a>
# **getGoogleConnectionData**
> GetGoogleConnectionDataResult getGoogleConnectionData(opts)



Use this API to get Google 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.ContactApi()

var opts = { 
  'type': "type_example", // {String} Type. Not used at this point.
  'inargs': "inargs_example" // {String} Input arguments. Not used at this point.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **type** | **String**| Type. Not used at this point. | [optional] 
 **inargs** | **String**| Input arguments. Not used at this point. | [optional] 

### Return type

[**GetGoogleConnectionDataResult**](GetGoogleConnectionDataResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getMutualTypes"></a>
# **getMutualTypes**
> GetMutualTypesResult getMutualTypes(contactKeys, types, opts)



Use this API to get mutual objects for selected contacts.

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

var contactKeys = ["contactKeys_example"]; // {[String]} Contact keys.

var types = ["types_example"]; // {[String]} Object types.

var opts = { 
  'permission': "permission_example" // {String} Use this to require the contacts have the same permission to the object. Options are: Create, Read, Edit, Delete, Index, Categorize, ViewRating, Rate, ViewComment, Comment, Download, Share 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **contactKeys** | [**[String]**](String.md)| Contact keys. | 
 **types** | [**[String]**](String.md)| Object types. | 
 **permission** | **String**| Use this to require the contacts have the same permission to the object. Options are: Create, Read, Edit, Delete, Index, Categorize, ViewRating, Rate, ViewComment, Comment, Download, Share  | [optional] 

### Return type

[**GetMutualTypesResult**](GetMutualTypesResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="getProfile"></a>
# **getProfile**
> GetProfileResult getProfile(key)



Use this API to get the profile information for one of your contacts in 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.ContactApi()

var key = "key_example"; // {String} ID of the contact whose information you want to view. You can enter your Vmoso ID to get your profile information or the ID of a Vmoso contact.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **key** | **String**| ID of the contact whose information you want to view. You can enter your Vmoso ID to get your profile information or the ID of a Vmoso contact. | 

### Return type

[**GetProfileResult**](GetProfileResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="importAcquaintances"></a>
# **importAcquaintances**
> ImportAcquaintancesResult importAcquaintances(input)



Use this API to import contacts as acquaintances. Acquaintances appear in Vmoso as possible people to work with. They are not invited to use Vmoso until you ask them to be a connected or trusted contact.

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

var input = new VmosoApi.ImportAcquaintancesInput(); // {ImportAcquaintancesInput} Users to import.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**ImportAcquaintancesInput**](ImportAcquaintancesInput.md)| Users to import. | 

### Return type

[**ImportAcquaintancesResult**](ImportAcquaintancesResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="importContacts"></a>
# **importContacts**
> ImportContactsResult importContacts(type, opts)



Use this API to import contacts 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.ContactApi()

var type = "type_example"; // {String} Type of import. Options are: excel or google

var opts = { 
  'args': "args_example", // {String} File ID for import file.
  'pg': "pg_example" // {String} Pagination options.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **type** | **String**| Type of import. Options are: excel or google | 
 **args** | **String**| File ID for import file. | [optional] 
 **pg** | **String**| Pagination options. | [optional] 

### Return type

[**ImportContactsResult**](ImportContactsResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="inviteEmailAddress"></a>
# **inviteEmailAddress**
> InviteEmailAddressResult inviteEmailAddress(input)



Use this API to add someone as your contact by using their email address.

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

var input = new VmosoApi.InviteEmailAddressInput(); // {InviteEmailAddressInput} Email invitation details.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**InviteEmailAddressInput**](InviteEmailAddressInput.md)| Email invitation details. | 

### Return type

[**InviteEmailAddressResult**](InviteEmailAddressResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="inviteUsers"></a>
# **inviteUsers**
> InviteUsersResult inviteUsers(input)



Use this API to add someone as your contact by using their Vmoso ID.

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

var input = new VmosoApi.InviteUsersInput(); // {InviteUsersInput} Invitation details.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**InviteUsersInput**](InviteUsersInput.md)| Invitation details. | 

### Return type

[**InviteUsersResult**](InviteUsersResult.md)

### Authorization

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

### HTTP reuqest headers

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

<a name="processAction"></a>
# **processAction**
> ProcessActionResult processAction(input)



Use this API to handle invitation requests. You can accept or ignore a request.

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

var input = new VmosoApi.ProcessActionInput(); // {ProcessActionInput} Whether to accept the request and the type of connection to make.


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**ProcessActionInput**](ProcessActionInput.md)| Whether to accept the request and the type of connection to make. | 

### Return type

[**ProcessActionResult**](ProcessActionResult.md)

### Authorization

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

### HTTP reuqest headers

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