# NoobchefApi.UsersApi

All URIs are relative to *http://127.0.0.1:3000/api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**v1UsersGet**](UsersApi.md#v1UsersGet) | **GET** /v1/users | 
[**v1UsersMeGet**](UsersApi.md#v1UsersMeGet) | **GET** /v1/users/me | 
[**v1UsersUserIdDelete**](UsersApi.md#v1UsersUserIdDelete) | **DELETE** /v1/users/{userId} | 
[**v1UsersUserIdFreezersFreezerIdGet**](UsersApi.md#v1UsersUserIdFreezersFreezerIdGet) | **GET** /v1/users/{userId}/freezers/{freezerId} | 
[**v1UsersUserIdFreezersFreezerIdPut**](UsersApi.md#v1UsersUserIdFreezersFreezerIdPut) | **PUT** /v1/users/{userId}/freezers/{freezerId} | 
[**v1UsersUserIdFreezersPost**](UsersApi.md#v1UsersUserIdFreezersPost) | **POST** /v1/users/{userId}/freezers | 
[**v1UsersUserIdGet**](UsersApi.md#v1UsersUserIdGet) | **GET** /v1/users/{userId} | 
[**v1UsersUserIdPut**](UsersApi.md#v1UsersUserIdPut) | **PUT** /v1/users/{userId} | 
[**v1UsersUserIdRanksRankIdGet**](UsersApi.md#v1UsersUserIdRanksRankIdGet) | **GET** /v1/users/{userId}/ranks/{rankId} | 


<a name="v1UsersGet"></a>
# **v1UsersGet**
> v1UsersGet(authorization, opts)



Fetch all users

### Example
```javascript
var NoobchefApi = require('noobchef_api');

var apiInstance = new NoobchefApi.UsersApi();

var authorization = "authorization_example"; // String | 

var opts = { 
  'page': 56, // Number | Page number
  'perpage': 56, // Number | The numbers of items to return
  'search': "search_example" // String | search by field:search String
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **authorization** | **String**|  | 
 **page** | **Number**| Page number | [optional] 
 **perpage** | **Number**| The numbers of items to return | [optional] 
 **search** | **String**| search by field:search String | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="v1UsersMeGet"></a>
# **v1UsersMeGet**
> v1UsersMeGet(authorization)



Fetch user by token

### Example
```javascript
var NoobchefApi = require('noobchef_api');

var apiInstance = new NoobchefApi.UsersApi();

var authorization = "authorization_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.v1UsersMeGet(authorization, callback);
```

### Parameters

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

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="v1UsersUserIdDelete"></a>
# **v1UsersUserIdDelete**
> v1UsersUserIdDelete(userId, authorization)



### Example
```javascript
var NoobchefApi = require('noobchef_api');

var apiInstance = new NoobchefApi.UsersApi();

var userId = "userId_example"; // String | The id of the user entity to retrieve

var authorization = "authorization_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.v1UsersUserIdDelete(userId, authorization, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userId** | **String**| The id of the user entity to retrieve | 
 **authorization** | **String**|  | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="v1UsersUserIdFreezersFreezerIdGet"></a>
# **v1UsersUserIdFreezersFreezerIdGet**
> v1UsersUserIdFreezersFreezerIdGet(authorization, userId, freezerId)



### Example
```javascript
var NoobchefApi = require('noobchef_api');

var apiInstance = new NoobchefApi.UsersApi();

var authorization = "authorization_example"; // String | 

var userId = "userId_example"; // String | The id of the user entity to retrieve

var freezerId = "freezerId_example"; // String | The id of the freezer entity to retrieve


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.v1UsersUserIdFreezersFreezerIdGet(authorization, userId, freezerId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **authorization** | **String**|  | 
 **userId** | **String**| The id of the user entity to retrieve | 
 **freezerId** | **String**| The id of the freezer entity to retrieve | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="v1UsersUserIdFreezersFreezerIdPut"></a>
# **v1UsersUserIdFreezersFreezerIdPut**
> v1UsersUserIdFreezersFreezerIdPut(authorization, userId, freezerId, user)



update a user&#39;s freezer

### Example
```javascript
var NoobchefApi = require('noobchef_api');

var apiInstance = new NoobchefApi.UsersApi();

var authorization = "authorization_example"; // String | 

var userId = "userId_example"; // String | The id of the existent user entity

var freezerId = "freezerId_example"; // String | The id of the freezer entity to retrieve

var user = new NoobchefApi.FreezerRequest(); // FreezerRequest | Freezer data


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.v1UsersUserIdFreezersFreezerIdPut(authorization, userId, freezerId, user, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **authorization** | **String**|  | 
 **userId** | **String**| The id of the existent user entity | 
 **freezerId** | **String**| The id of the freezer entity to retrieve | 
 **user** | [**FreezerRequest**](FreezerRequest.md)| Freezer data | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="v1UsersUserIdFreezersPost"></a>
# **v1UsersUserIdFreezersPost**
> v1UsersUserIdFreezersPost(authorization, user)



Create a new user&#39;s freezer

### Example
```javascript
var NoobchefApi = require('noobchef_api');

var apiInstance = new NoobchefApi.UsersApi();

var authorization = "authorization_example"; // String | 

var user = new NoobchefApi.FreezerRequest(); // FreezerRequest | User data


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.v1UsersUserIdFreezersPost(authorization, user, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **authorization** | **String**|  | 
 **user** | [**FreezerRequest**](FreezerRequest.md)| User data | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="v1UsersUserIdGet"></a>
# **v1UsersUserIdGet**
> v1UsersUserIdGet(userId, authorization)



### Example
```javascript
var NoobchefApi = require('noobchef_api');

var apiInstance = new NoobchefApi.UsersApi();

var userId = "userId_example"; // String | The id of the user entity to retrieve

var authorization = "authorization_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.v1UsersUserIdGet(userId, authorization, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userId** | **String**| The id of the user entity to retrieve | 
 **authorization** | **String**|  | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="v1UsersUserIdPut"></a>
# **v1UsersUserIdPut**
> v1UsersUserIdPut(authorization, userId, user)



update a user

### Example
```javascript
var NoobchefApi = require('noobchef_api');

var apiInstance = new NoobchefApi.UsersApi();

var authorization = "authorization_example"; // String | 

var userId = "userId_example"; // String | The id of the existent user entity

var user = new NoobchefApi.UserUpdateRequest(); // UserUpdateRequest | User data


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.v1UsersUserIdPut(authorization, userId, user, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **authorization** | **String**|  | 
 **userId** | **String**| The id of the existent user entity | 
 **user** | [**UserUpdateRequest**](UserUpdateRequest.md)| User data | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="v1UsersUserIdRanksRankIdGet"></a>
# **v1UsersUserIdRanksRankIdGet**
> v1UsersUserIdRanksRankIdGet(authorization, userId, rankId)



### Example
```javascript
var NoobchefApi = require('noobchef_api');

var apiInstance = new NoobchefApi.UsersApi();

var authorization = "authorization_example"; // String | 

var userId = "userId_example"; // String | The id of the user entity to retrieve

var rankId = "rankId_example"; // String | The id of the rank entity to retrieve


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.v1UsersUserIdRanksRankIdGet(authorization, userId, rankId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **authorization** | **String**|  | 
 **userId** | **String**| The id of the user entity to retrieve | 
 **rankId** | **String**| The id of the rank entity to retrieve | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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