/samples/client/petstore/php/SwaggerClient-php/docs/UserApi.md
Markdown | 374 lines | 245 code | 129 blank | 0 comment | 0 complexity | 0a416733ba76e1f4d44a79961ea2c0ab MD5 | raw file
- # Swagger\Client\UserApi
- All URIs are relative to *http://petstore.swagger.io/v2*
- Method | HTTP request | Description
- ------------- | ------------- | -------------
- [**createUser**](UserApi.md#createUser) | **POST** /user | Create user
- [**createUsersWithArrayInput**](UserApi.md#createUsersWithArrayInput) | **POST** /user/createWithArray | Creates list of users with given input array
- [**createUsersWithListInput**](UserApi.md#createUsersWithListInput) | **POST** /user/createWithList | Creates list of users with given input array
- [**deleteUser**](UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user
- [**getUserByName**](UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name
- [**loginUser**](UserApi.md#loginUser) | **GET** /user/login | Logs user into the system
- [**logoutUser**](UserApi.md#logoutUser) | **GET** /user/logout | Logs out current logged in user session
- [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user
- # **createUser**
- > createUser($body)
- Create user
- This can only be done by the logged in user.
- ### Example
- ```php
- <?php
- require_once(__DIR__ . '/vendor/autoload.php');
- $api_instance = new Swagger\Client\Api\UserApi();
- $body = new \Swagger\Client\Model\User(); // \Swagger\Client\Model\User | Created user object
- try {
- $api_instance->createUser($body);
- } catch (Exception $e) {
- echo 'Exception when calling UserApi->createUser: ', $e->getMessage(), "\n";
- }
- ?>
- ```
- ### Parameters
- Name | Type | Description | Notes
- ------------- | ------------- | ------------- | -------------
- **body** | [**\Swagger\Client\Model\User**](\Swagger\Client\Model\User.md)| Created user object | [optional]
- ### Return type
- void (empty response body)
- ### Authorization
- No authorization required
- ### HTTP reuqest headers
- - **Content-Type**: Not defined
- - **Accept**: application/json, application/xml
- [[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)
- # **createUsersWithArrayInput**
- > createUsersWithArrayInput($body)
- Creates list of users with given input array
- ### Example
- ```php
- <?php
- require_once(__DIR__ . '/vendor/autoload.php');
- $api_instance = new Swagger\Client\Api\UserApi();
- $body = array(new User()); // \Swagger\Client\Model\User[] | List of user object
- try {
- $api_instance->createUsersWithArrayInput($body);
- } catch (Exception $e) {
- echo 'Exception when calling UserApi->createUsersWithArrayInput: ', $e->getMessage(), "\n";
- }
- ?>
- ```
- ### Parameters
- Name | Type | Description | Notes
- ------------- | ------------- | ------------- | -------------
- **body** | [**\Swagger\Client\Model\User[]**](User.md)| List of user object | [optional]
- ### Return type
- void (empty response body)
- ### Authorization
- No authorization required
- ### HTTP reuqest headers
- - **Content-Type**: Not defined
- - **Accept**: application/json, application/xml
- [[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)
- # **createUsersWithListInput**
- > createUsersWithListInput($body)
- Creates list of users with given input array
- ### Example
- ```php
- <?php
- require_once(__DIR__ . '/vendor/autoload.php');
- $api_instance = new Swagger\Client\Api\UserApi();
- $body = array(new User()); // \Swagger\Client\Model\User[] | List of user object
- try {
- $api_instance->createUsersWithListInput($body);
- } catch (Exception $e) {
- echo 'Exception when calling UserApi->createUsersWithListInput: ', $e->getMessage(), "\n";
- }
- ?>
- ```
- ### Parameters
- Name | Type | Description | Notes
- ------------- | ------------- | ------------- | -------------
- **body** | [**\Swagger\Client\Model\User[]**](User.md)| List of user object | [optional]
- ### Return type
- void (empty response body)
- ### Authorization
- No authorization required
- ### HTTP reuqest headers
- - **Content-Type**: Not defined
- - **Accept**: application/json, application/xml
- [[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**
- > deleteUser($username)
- Delete user
- This can only be done by the logged in user.
- ### Example
- ```php
- <?php
- require_once(__DIR__ . '/vendor/autoload.php');
- // Configure HTTP basic authorization: test_http_basic
- Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
- Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
- $api_instance = new Swagger\Client\Api\UserApi();
- $username = "username_example"; // string | The name that needs to be deleted
- try {
- $api_instance->deleteUser($username);
- } catch (Exception $e) {
- echo 'Exception when calling UserApi->deleteUser: ', $e->getMessage(), "\n";
- }
- ?>
- ```
- ### Parameters
- Name | Type | Description | Notes
- ------------- | ------------- | ------------- | -------------
- **username** | **string**| The name that needs to be deleted |
- ### Return type
- void (empty response body)
- ### Authorization
- [test_http_basic](../README.md#test_http_basic)
- ### HTTP reuqest headers
- - **Content-Type**: Not defined
- - **Accept**: application/json, application/xml
- [[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)
- # **getUserByName**
- > \Swagger\Client\Model\User getUserByName($username)
- Get user by user name
- ### Example
- ```php
- <?php
- require_once(__DIR__ . '/vendor/autoload.php');
- $api_instance = new Swagger\Client\Api\UserApi();
- $username = "username_example"; // string | The name that needs to be fetched. Use user1 for testing.
- try {
- $result = $api_instance->getUserByName($username);
- print_r($result);
- } catch (Exception $e) {
- echo 'Exception when calling UserApi->getUserByName: ', $e->getMessage(), "\n";
- }
- ?>
- ```
- ### Parameters
- Name | Type | Description | Notes
- ------------- | ------------- | ------------- | -------------
- **username** | **string**| The name that needs to be fetched. Use user1 for testing. |
- ### Return type
- [**\Swagger\Client\Model\User**](User.md)
- ### Authorization
- No authorization required
- ### HTTP reuqest headers
- - **Content-Type**: Not defined
- - **Accept**: application/json, application/xml
- [[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)
- # **loginUser**
- > string loginUser($username, $password)
- Logs user into the system
- ### Example
- ```php
- <?php
- require_once(__DIR__ . '/vendor/autoload.php');
- $api_instance = new Swagger\Client\Api\UserApi();
- $username = "username_example"; // string | The user name for login
- $password = "password_example"; // string | The password for login in clear text
- try {
- $result = $api_instance->loginUser($username, $password);
- print_r($result);
- } catch (Exception $e) {
- echo 'Exception when calling UserApi->loginUser: ', $e->getMessage(), "\n";
- }
- ?>
- ```
- ### Parameters
- Name | Type | Description | Notes
- ------------- | ------------- | ------------- | -------------
- **username** | **string**| The user name for login | [optional]
- **password** | **string**| The password for login in clear text | [optional]
- ### Return type
- **string**
- ### Authorization
- No authorization required
- ### HTTP reuqest headers
- - **Content-Type**: Not defined
- - **Accept**: application/json, application/xml
- [[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)
- # **logoutUser**
- > logoutUser()
- Logs out current logged in user session
- ### Example
- ```php
- <?php
- require_once(__DIR__ . '/vendor/autoload.php');
- $api_instance = new Swagger\Client\Api\UserApi();
- try {
- $api_instance->logoutUser();
- } catch (Exception $e) {
- echo 'Exception when calling UserApi->logoutUser: ', $e->getMessage(), "\n";
- }
- ?>
- ```
- ### Parameters
- This endpoint does not need any parameter.
- ### Return type
- void (empty response body)
- ### Authorization
- No authorization required
- ### HTTP reuqest headers
- - **Content-Type**: Not defined
- - **Accept**: application/json, application/xml
- [[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**
- > updateUser($username, $body)
- Updated user
- This can only be done by the logged in user.
- ### Example
- ```php
- <?php
- require_once(__DIR__ . '/vendor/autoload.php');
- $api_instance = new Swagger\Client\Api\UserApi();
- $username = "username_example"; // string | name that need to be deleted
- $body = new \Swagger\Client\Model\User(); // \Swagger\Client\Model\User | Updated user object
- try {
- $api_instance->updateUser($username, $body);
- } catch (Exception $e) {
- echo 'Exception when calling UserApi->updateUser: ', $e->getMessage(), "\n";
- }
- ?>
- ```
- ### Parameters
- Name | Type | Description | Notes
- ------------- | ------------- | ------------- | -------------
- **username** | **string**| name that need to be deleted |
- **body** | [**\Swagger\Client\Model\User**](\Swagger\Client\Model\User.md)| Updated user object | [optional]
- ### Return type
- void (empty response body)
- ### Authorization
- No authorization required
- ### HTTP reuqest headers
- - **Content-Type**: Not defined
- - **Accept**: application/json, application/xml
- [[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)