# EduchatApi.UserApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**userList**](UserApi.md#userList) | **GET** /v1/user/ | Paginated;
[**userMeList**](UserApi.md#userMeList) | **GET** /v1/user/me/ | No documentation beyond REST Standards;
[**userPartialUpdate**](UserApi.md#userPartialUpdate) | **PATCH** /v1/user/{id}/ | No documentation beyond REST Standards;
[**userSignupCreate**](UserApi.md#userSignupCreate) | **POST** /v1/user/signup/ | No documentation beyond REST Standards;
[**userVerifyList**](UserApi.md#userVerifyList) | **GET** /v1/user/verify/ | No documentation beyond REST Standards;


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

Paginated;

Paginated; Filter by Optional( { &#39;id&#39;        : [&#39;exact&#39;], &#39;first_name&#39;: [&#39;exact&#39;, &#39;icontains&#39;], &#39;last_name&#39; : [&#39;exact&#39;, &#39;icontains&#39;], } );

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

var apiInstance = new EduchatApi.UserApi();

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 | 
  'firstName': "firstName_example", // String | 
  'firstNameIcontains': "firstNameIcontains_example", // String | 
  'lastName': "lastName_example", // String | 
  'lastNameIcontains': "lastNameIcontains_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userList(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] 
 **id** | **String**|  | [optional] 
 **firstName** | **String**|  | [optional] 
 **firstNameIcontains** | **String**|  | [optional] 
 **lastName** | **String**|  | [optional] 
 **lastNameIcontains** | **String**|  | [optional] 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

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

No documentation beyond REST Standards;

No documentation beyond REST Standards;

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

var apiInstance = new EduchatApi.UserApi();

var opts = { 
  'limit': 56, // Number | Number of results to return per page.
  'offset': 56 // Number | The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userMeList(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] 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

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

No documentation beyond REST Standards;

No documentation beyond REST Standards;

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

var apiInstance = new EduchatApi.UserApi();

var id = "id_example"; // String | 

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

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

### Parameters

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

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

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

No documentation beyond REST Standards;

No documentation beyond REST Standards;

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

var apiInstance = new EduchatApi.UserApi();

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

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

### Parameters

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

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

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

No documentation beyond REST Standards;

No documentation beyond REST Standards;

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

var apiInstance = new EduchatApi.UserApi();

var opts = { 
  'limit': 56, // Number | Number of results to return per page.
  'offset': 56 // Number | The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userVerifyList(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] 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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