# WeaviateApi.AdaptersApi

All URIs are relative to *https://localhost/weaviate/v1-alpha*

Method | HTTP request | Description
------------- | ------------- | -------------
[**weaveAdaptersAccept**](AdaptersApi.md#weaveAdaptersAccept) | **POST** /adapters/accept | 
[**weaveAdaptersActivate**](AdaptersApi.md#weaveAdaptersActivate) | **POST** /adapters/{adapterId}/activate | 
[**weaveAdaptersDeactivate**](AdaptersApi.md#weaveAdaptersDeactivate) | **POST** /adapters/{adapterId}/deactivate | 
[**weaveAdaptersGet**](AdaptersApi.md#weaveAdaptersGet) | **GET** /adapters/{adapterId} | 
[**weaveAdaptersList**](AdaptersApi.md#weaveAdaptersList) | **GET** /adapters | 


<a name="weaveAdaptersAccept"></a>
# **weaveAdaptersAccept**
> AdaptersAcceptResponse weaveAdaptersAccept(opts)



Used by an adapter provider to accept an activation and prevent it from expiring.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

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

var apiInstance = new WeaviateApi.AdaptersApi();

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'activationId': "activationId_example" // String | The ID of the activation to accept. This represents a Weave user.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **activationId** | **String**| The ID of the activation to accept. This represents a Weave user. | [optional] 

### Return type

[**AdaptersAcceptResponse**](AdaptersAcceptResponse.md)

### Authorization

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

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveAdaptersActivate"></a>
# **weaveAdaptersActivate**
> AdaptersActivateResponse weaveAdaptersActivate(adapterId, opts)



Activates an adapter. The activation will be contingent upon the adapter provider accepting the activation. If the activation is not accepted within 15 minutes, the activation will be deleted.

### Example
```javascript
var WeaviateApi = require('weaviate_api');

var apiInstance = new WeaviateApi.AdaptersApi();

var adapterId = "adapterId_example"; // String | The ID of the adapter to activate.

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **adapterId** | **String**| The ID of the adapter to activate. | 
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 

### Return type

[**AdaptersActivateResponse**](AdaptersActivateResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveAdaptersDeactivate"></a>
# **weaveAdaptersDeactivate**
> AdaptersDeactivateResponse weaveAdaptersDeactivate(adapterId, opts)



Deactivates an adapter. This will also delete all devices provided by that adapter.

### Example
```javascript
var WeaviateApi = require('weaviate_api');

var apiInstance = new WeaviateApi.AdaptersApi();

var adapterId = "adapterId_example"; // String | The ID of the adapter to deactivate.

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **adapterId** | **String**| The ID of the adapter to deactivate. | 
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 

### Return type

[**AdaptersDeactivateResponse**](AdaptersDeactivateResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveAdaptersGet"></a>
# **weaveAdaptersGet**
> Adapter weaveAdaptersGet(adapterId, opts)



Get an adapter.

### Example
```javascript
var WeaviateApi = require('weaviate_api');

var apiInstance = new WeaviateApi.AdaptersApi();

var adapterId = "adapterId_example"; // String | Unique ID of the adapter.

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **adapterId** | **String**| Unique ID of the adapter. | 
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 

### Return type

[**Adapter**](Adapter.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveAdaptersList"></a>
# **weaveAdaptersList**
> AdaptersListResponse weaveAdaptersList(opts)



Lists adapters.

### Example
```javascript
var WeaviateApi = require('weaviate_api');

var apiInstance = new WeaviateApi.AdaptersApi();

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 

### Return type

[**AdaptersListResponse**](AdaptersListResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml