# EduchatApi.ChatApi

All URIs are relative to *https://api.edu.chat*

Method | HTTP request | Description
------------- | ------------- | -------------
[**chatCreate**](ChatApi.md#chatCreate) | **POST** /v1/chat/ | Paginated;
[**chatDelete**](ChatApi.md#chatDelete) | **DELETE** /v1/chat/{id}/ | No documentation beyond REST Standards;
[**chatList**](ChatApi.md#chatList) | **GET** /v1/chat/ | Paginated;
[**chatPartialUpdate**](ChatApi.md#chatPartialUpdate) | **PATCH** /v1/chat/{id}/ | No documentation beyond REST Standards;
[**chatResourcesList**](ChatApi.md#chatResourcesList) | **GET** /v1/chat/{chat}/resources/ | Paginated;


<a name="chatCreate"></a>
# **chatCreate**
> InlineResponse2011 chatCreate(opts)

Paginated;

Paginated; filter by {parent} and { &#39;name&#39;: [&#39;exact&#39;, &#39;icontains&#39;], &#39;description&#39;: [&#39;exact&#39;, &#39;icontains&#39;], &#39;is_class&#39; : [&#39;exact&#39;] };

### Example
```javascript
var EduchatApi = require('educhat_api');

var apiInstance = new EduchatApi.ChatApi();

var opts = { 
  'data': new EduchatApi.Data2() // Data2 | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **data** | [**Data2**](Data2.md)|  | [optional] 

### Return type

[**InlineResponse2011**](InlineResponse2011.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="chatDelete"></a>
# **chatDelete**
> InlineResponse2011 chatDelete(id)

No documentation beyond REST Standards;

No documentation beyond REST Standards;

### Example
```javascript
var EduchatApi = require('educhat_api');

var apiInstance = new EduchatApi.ChatApi();

var id = "id_example"; // String | 


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

### Parameters

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

### Return type

[**InlineResponse2011**](InlineResponse2011.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="chatList"></a>
# **chatList**
> InlineResponse2011 chatList(opts)

Paginated;

Paginated; filter by {parent} and { &#39;name&#39;: [&#39;exact&#39;, &#39;icontains&#39;], &#39;description&#39;: [&#39;exact&#39;, &#39;icontains&#39;], &#39;is_class&#39; : [&#39;exact&#39;] };

### Example
```javascript
var EduchatApi = require('educhat_api');

var apiInstance = new EduchatApi.ChatApi();

var opts = { 
  'limit': 56, // Number | Number of results to return per page.
  'offset': 56, // Number | The initial index from which to return the results.
  'name': "name_example", // String | 
  'nameIcontains': "nameIcontains_example", // String | 
  'description': "description_example", // String | 
  'descriptionIcontains': "descriptionIcontains_example", // String | 
  'isClass': "isClass_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **limit** | **Number**| Number of results to return per page. | [optional] 
 **offset** | **Number**| The initial index from which to return the results. | [optional] 
 **name** | **String**|  | [optional] 
 **nameIcontains** | **String**|  | [optional] 
 **description** | **String**|  | [optional] 
 **descriptionIcontains** | **String**|  | [optional] 
 **isClass** | **String**|  | [optional] 

### Return type

[**InlineResponse2011**](InlineResponse2011.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="chatPartialUpdate"></a>
# **chatPartialUpdate**
> InlineResponse2011 chatPartialUpdate(id, opts)

No documentation beyond REST Standards;

No documentation beyond REST Standards;

### Example
```javascript
var EduchatApi = require('educhat_api');

var apiInstance = new EduchatApi.ChatApi();

var id = "id_example"; // String | 

var opts = { 
  'data': new EduchatApi.Data3() // Data3 | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **data** | [**Data3**](Data3.md)|  | [optional] 

### Return type

[**InlineResponse2011**](InlineResponse2011.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="chatResourcesList"></a>
# **chatResourcesList**
> InlineResponse2011 chatResourcesList(chat, opts)

Paginated;

Paginated; Filter by Optional( { &#39;created&#39;        : [&#39;gte&#39;], &#39;text&#39;           : [&#39;exact&#39;, &#39;icontains&#39;], &#39;user_id&#39;        : [&#39;exact&#39;], &#39;file__name&#39;     : [&#39;exact&#39;], } );

### Example
```javascript
var EduchatApi = require('educhat_api');

var apiInstance = new EduchatApi.ChatApi();

var chat = "chat_example"; // String | 

var opts = { 
  'limit': 56, // Number | Number of results to return per page.
  'offset': 56, // Number | The initial index from which to return the results.
  'id': "id_example", // String | 
  'createdGte': "createdGte_example", // String | 
  'text': "text_example", // String | 
  'textIcontains': "textIcontains_example", // String | 
  'userId': "userId_example", // String | 
  'fileName': "fileName_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **chat** | **String**|  | 
 **limit** | **Number**| Number of results to return per page. | [optional] 
 **offset** | **Number**| The initial index from which to return the results. | [optional] 
 **id** | **String**|  | [optional] 
 **createdGte** | **String**|  | [optional] 
 **text** | **String**|  | [optional] 
 **textIcontains** | **String**|  | [optional] 
 **userId** | **String**|  | [optional] 
 **fileName** | **String**|  | [optional] 

### Return type

[**InlineResponse2011**](InlineResponse2011.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined