openapi-generator/samples/client/petstore/objc/docs/SWGUserApi.md

SWGUserApi

All URIs are relative to http://petstore.swagger.io/v2

Method	HTTP request	Description
createUser	POST /user	Create user
createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
deleteUser	DELETE /user/{username}	Delete user
getUserByName	GET /user/{username}	Get user by user name
loginUser	GET /user/login	Logs user into the system
logoutUser	GET /user/logout	Logs out current logged in user session
updateUser	PUT /user/{username}	Updated user

createUser

-(NSNumber*) createUserWithBody: (SWGUser*) body
        completionHandler: (void (^)(NSError* error)) handler;

Create user

This can only be done by the logged in user.

Example

SWGUser* body = [[SWGUser alloc] init]; // Created user object (optional)

@try
{ 
    SWGUserApi *apiInstance = [[SWGUserApi alloc] init];

    // Create user
    [apiInstance createUserWithBody:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
}
@catch (NSException *exception)
{
    NSLog(@"Exception when calling SWGUserApi->createUser: %@ ", exception.name);
    NSLog(@"Reason: %@ ", exception.reason);
}

Parameters

Name	Type	Description	Notes
body	SWGUser*	Created user object	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createUsersWithArrayInput

-(NSNumber*) createUsersWithArrayInputWithBody: (NSArray<SWGUser>*) body
        completionHandler: (void (^)(NSError* error)) handler;

Creates list of users with given input array

Example

NSArray<SWGUser>* body = @[[[SWGUser alloc] init]]; // List of user object (optional)

@try
{ 
    SWGUserApi *apiInstance = [[SWGUserApi alloc] init];

    // Creates list of users with given input array
    [apiInstance createUsersWithArrayInputWithBody:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
}
@catch (NSException *exception)
{
    NSLog(@"Exception when calling SWGUserApi->createUsersWithArrayInput: %@ ", exception.name);
    NSLog(@"Reason: %@ ", exception.reason);
}

Parameters

Name	Type	Description	Notes
body	NSArray<SWGUser>*	List of user object	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createUsersWithListInput

-(NSNumber*) createUsersWithListInputWithBody: (NSArray<SWGUser>*) body
        completionHandler: (void (^)(NSError* error)) handler;

Creates list of users with given input array

Example

NSArray<SWGUser>* body = @[[[SWGUser alloc] init]]; // List of user object (optional)

@try
{ 
    SWGUserApi *apiInstance = [[SWGUserApi alloc] init];

    // Creates list of users with given input array
    [apiInstance createUsersWithListInputWithBody:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
}
@catch (NSException *exception)
{
    NSLog(@"Exception when calling SWGUserApi->createUsersWithListInput: %@ ", exception.name);
    NSLog(@"Reason: %@ ", exception.reason);
}

Parameters

Name	Type	Description	Notes
body	NSArray<SWGUser>*	List of user object	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteUser

-(NSNumber*) deleteUserWithUsername: (NSString*) username
        completionHandler: (void (^)(NSError* error)) handler;

Delete user

This can only be done by the logged in user.

Example

NSString* username = @"username_example"; // The name that needs to be deleted

@try
{ 
    SWGUserApi *apiInstance = [[SWGUserApi alloc] init];

    // Delete user
    [apiInstance deleteUserWithUsername:username
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
}
@catch (NSException *exception)
{
    NSLog(@"Exception when calling SWGUserApi->deleteUser: %@ ", exception.name);
    NSLog(@"Reason: %@ ", exception.reason);
}

Parameters

Name	Type	Description	Notes
username	NSString*	The name that needs to be deleted

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserByName

-(NSNumber*) getUserByNameWithUsername: (NSString*) username
        completionHandler: (void (^)(SWGUser* output, NSError* error)) handler;

Get user by user name

Example

NSString* username = @"username_example"; // The name that needs to be fetched. Use user1 for testing. 

@try
{ 
    SWGUserApi *apiInstance = [[SWGUserApi alloc] init];

    // Get user by user name
    [apiInstance getUserByNameWithUsername:username
              completionHandler: ^(SWGUser* output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
}
@catch (NSException *exception)
{
    NSLog(@"Exception when calling SWGUserApi->getUserByName: %@ ", exception.name);
    NSLog(@"Reason: %@ ", exception.reason);
}

Parameters

Name	Type	Description	Notes
username	NSString*	The name that needs to be fetched. Use user1 for testing.

Return type

SWGUser*

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

loginUser

-(NSNumber*) loginUserWithUsername: (NSString*) username
    password: (NSString*) password
        completionHandler: (void (^)(NSString* output, NSError* error)) handler;

Logs user into the system

Example

NSString* username = @"username_example"; // The user name for login (optional)
NSString* password = @"password_example"; // The password for login in clear text (optional)

@try
{ 
    SWGUserApi *apiInstance = [[SWGUserApi alloc] init];

    // Logs user into the system
    [apiInstance loginUserWithUsername:username
                  password:password
              completionHandler: ^(NSString* output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
}
@catch (NSException *exception)
{
    NSLog(@"Exception when calling SWGUserApi->loginUser: %@ ", exception.name);
    NSLog(@"Reason: %@ ", exception.reason);
}

Parameters

Name	Type	Description	Notes
username	NSString*	The user name for login	[optional]
password	NSString*	The password for login in clear text	[optional]

Return type

NSString*

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

logoutUser

-(NSNumber*) logoutUserWithCompletionHandler: 
        (void (^)(NSError* error)) handler;

Logs out current logged in user session

Example

@try
{ 
    SWGUserApi *apiInstance = [[SWGUserApi alloc] init];

    // Logs out current logged in user session
    [apiInstance logoutUserWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
}
@catch (NSException *exception)
{
    NSLog(@"Exception when calling SWGUserApi->logoutUser: %@ ", exception.name);
    NSLog(@"Reason: %@ ", exception.reason);
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateUser

-(NSNumber*) updateUserWithUsername: (NSString*) username
    body: (SWGUser*) body
        completionHandler: (void (^)(NSError* error)) handler;

Updated user

This can only be done by the logged in user.

Example

NSString* username = @"username_example"; // name that need to be deleted
SWGUser* body = [[SWGUser alloc] init]; // Updated user object (optional)

@try
{ 
    SWGUserApi *apiInstance = [[SWGUserApi alloc] init];

    // Updated user
    [apiInstance updateUserWithUsername:username
                  body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
}
@catch (NSException *exception)
{
    NSLog(@"Exception when calling SWGUserApi->updateUser: %@ ", exception.name);
    NSLog(@"Reason: %@ ", exception.reason);
}

Parameters

Name	Type	Description	Notes
username	NSString*	name that need to be deleted
body	SWGUser*	Updated user object	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]