# openapi.api.UserApi ## Load the API package ```dart import 'package:openapi/api.dart'; ``` All URIs are relative to */api* Method | HTTP request | Description ------------- | ------------- | ------------- [**createProfileImage**](UserApi.md#createprofileimage) | **POST** /user/profile-image | [**createUser**](UserApi.md#createuser) | **POST** /user | [**deleteUser**](UserApi.md#deleteuser) | **DELETE** /user/{userId} | [**getAllUsers**](UserApi.md#getallusers) | **GET** /user | [**getMyUserInfo**](UserApi.md#getmyuserinfo) | **GET** /user/me | [**getProfileImage**](UserApi.md#getprofileimage) | **GET** /user/profile-image/{userId} | [**getUserById**](UserApi.md#getuserbyid) | **GET** /user/info/{userId} | [**getUserCount**](UserApi.md#getusercount) | **GET** /user/count | [**restoreUser**](UserApi.md#restoreuser) | **POST** /user/{userId}/restore | [**updateUser**](UserApi.md#updateuser) | **PUT** /user | # **createProfileImage** > CreateProfileImageResponseDto createProfileImage(file) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = UserApi(); final file = BINARY_DATA_HERE; // MultipartFile | try { final result = api_instance.createProfileImage(file); print(result); } catch (e) { print('Exception when calling UserApi->createProfileImage: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file** | **MultipartFile**| | ### Return type [**CreateProfileImageResponseDto**](CreateProfileImageResponseDto.md) ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **createUser** > UserResponseDto createUser(createUserDto) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = UserApi(); final createUserDto = CreateUserDto(); // CreateUserDto | try { final result = api_instance.createUser(createUserDto); print(result); } catch (e) { print('Exception when calling UserApi->createUser: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createUserDto** | [**CreateUserDto**](CreateUserDto.md)| | ### Return type [**UserResponseDto**](UserResponseDto.md) ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **deleteUser** > UserResponseDto deleteUser(userId) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = UserApi(); final userId = userId_example; // String | try { final result = api_instance.deleteUser(userId); print(result); } catch (e) { print('Exception when calling UserApi->deleteUser: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **userId** | **String**| | ### Return type [**UserResponseDto**](UserResponseDto.md) ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getAllUsers** > List getAllUsers(isAll) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = UserApi(); final isAll = true; // bool | try { final result = api_instance.getAllUsers(isAll); print(result); } catch (e) { print('Exception when calling UserApi->getAllUsers: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **isAll** | **bool**| | ### Return type [**List**](UserResponseDto.md) ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getMyUserInfo** > UserResponseDto getMyUserInfo() ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = UserApi(); try { final result = api_instance.getMyUserInfo(); print(result); } catch (e) { print('Exception when calling UserApi->getMyUserInfo: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**UserResponseDto**](UserResponseDto.md) ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getProfileImage** > Object getProfileImage(userId) ### Example ```dart import 'package:openapi/api.dart'; final api_instance = UserApi(); final userId = userId_example; // String | try { final result = api_instance.getProfileImage(userId); print(result); } catch (e) { print('Exception when calling UserApi->getProfileImage: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **userId** | **String**| | ### Return type [**Object**](Object.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getUserById** > UserResponseDto getUserById(userId) ### Example ```dart import 'package:openapi/api.dart'; final api_instance = UserApi(); final userId = userId_example; // String | try { final result = api_instance.getUserById(userId); print(result); } catch (e) { print('Exception when calling UserApi->getUserById: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **userId** | **String**| | ### Return type [**UserResponseDto**](UserResponseDto.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getUserCount** > UserCountResponseDto getUserCount(admin) ### Example ```dart import 'package:openapi/api.dart'; final api_instance = UserApi(); final admin = true; // bool | try { final result = api_instance.getUserCount(admin); print(result); } catch (e) { print('Exception when calling UserApi->getUserCount: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **admin** | **bool**| | [optional] [default to false] ### Return type [**UserCountResponseDto**](UserCountResponseDto.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **restoreUser** > UserResponseDto restoreUser(userId) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = UserApi(); final userId = userId_example; // String | try { final result = api_instance.restoreUser(userId); print(result); } catch (e) { print('Exception when calling UserApi->restoreUser: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **userId** | **String**| | ### Return type [**UserResponseDto**](UserResponseDto.md) ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **updateUser** > UserResponseDto updateUser(updateUserDto) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = UserApi(); final updateUserDto = UpdateUserDto(); // UpdateUserDto | try { final result = api_instance.updateUser(updateUserDto); print(result); } catch (e) { print('Exception when calling UserApi->updateUser: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **updateUserDto** | [**UpdateUserDto**](UpdateUserDto.md)| | ### Return type [**UserResponseDto**](UserResponseDto.md) ### Authorization [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)