class PetStore::UserApi

Defined in:

pet_store/api/user_api.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : PetStore::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_create_user(*, user : PetStore::User | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_create_users_with_array_input(*, user : Array(PetStore::User) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_create_users_with_list_input(*, user : Array(PetStore::User) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_delete_user(*, username : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_user_by_name(*, username : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_login_user(*, username : String | Nil = nil, password : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_logout_user : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_update_user(*, username : String | Nil = nil, user : PetStore::User | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation(*args, **options) #

[View source]
def client_side_validation(*args, **options, &) #

[View source]
def create_user(*, user : PetStore::User | Nil = nil) : Nil #

Create user This can only be done by the logged in user. @required @param user [PetStore::User?] Created user object @return [Nil]


[View source]
def create_user(*, user : PetStore::User | Nil = nil, &block : Crest::Response -> ) : Nil #

Create user This can only be done by the logged in user. @required @param user [PetStore::User?] Created user object @return nil


[View source]
def create_user_with_http_info(*, user : PetStore::User | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String)) #

Create user This can only be done by the logged in user. @required @param user [PetStore::User?] Created user object @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers


[View source]
def create_users_with_array_input(*, user : Array(PetStore::User) | Nil = nil) : Nil #

Creates list of users with given input array

@required @param user [Array(PetStore::User)?] List of user object @return [Nil]


[View source]
def create_users_with_array_input(*, user : Array(PetStore::User) | Nil = nil, &block : Crest::Response -> ) : Nil #

Creates list of users with given input array

@required @param user [Array(PetStore::User)?] List of user object @return nil


[View source]
def create_users_with_array_input_with_http_info(*, user : Array(PetStore::User) | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String)) #

Creates list of users with given input array

@required @param user [Array(PetStore::User)?] List of user object @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers


[View source]
def create_users_with_list_input(*, user : Array(PetStore::User) | Nil = nil) : Nil #

Creates list of users with given input array

@required @param user [Array(PetStore::User)?] List of user object @return [Nil]


[View source]
def create_users_with_list_input(*, user : Array(PetStore::User) | Nil = nil, &block : Crest::Response -> ) : Nil #

Creates list of users with given input array

@required @param user [Array(PetStore::User)?] List of user object @return nil


[View source]
def create_users_with_list_input_with_http_info(*, user : Array(PetStore::User) | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String)) #

Creates list of users with given input array

@required @param user [Array(PetStore::User)?] List of user object @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers


[View source]
def debugging(*args, **options) #

[View source]
def debugging(*args, **options, &) #

[View source]
def delete_user(*, username : String | Nil = nil) : Nil #

Delete user This can only be done by the logged in user. @required @param username [String?] The name that needs to be deleted @return [Nil]


[View source]
def delete_user(*, username : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Delete user This can only be done by the logged in user. @required @param username [String?] The name that needs to be deleted @return nil


[View source]
def delete_user_with_http_info(*, username : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String)) #

Delete user This can only be done by the logged in user. @required @param username [String?] The name that needs to be deleted @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers


[View source]
def get_user_by_name(*, username : String | Nil = nil) : PetStore::User #

Get user by user name

@required @param username [String?] The name that needs to be fetched. Use user1 for testing. @return [PetStore::User]


[View source]
def get_user_by_name(*, username : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Get user by user name

@required @param username [String?] The name that needs to be fetched. Use user1 for testing. @return nil


[View source]
def get_user_by_name_with_http_info(*, username : String | Nil = nil) : Tuple(PetStore::User, Int32, Hash(String, Array(String) | String)) #

Get user by user name

@required @param username [String?] The name that needs to be fetched. Use user1 for testing. @return [Tuple(PetStore::User, Integer, Hash)] PetStore::User, response status code and response headers


[View source]
def login_user(*, username : String | Nil = nil, password : String | Nil = nil) : String #

Logs user into the system

@required @param username [String?] The user name for login @required @param password [String?] The password for login in clear text @return [String]


[View source]
def login_user(*, username : String | Nil = nil, password : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Logs user into the system

@required @param username [String?] The user name for login @required @param password [String?] The password for login in clear text @return nil


[View source]
def login_user_with_http_info(*, username : String | Nil = nil, password : String | Nil = nil) : Tuple(String, Int32, Hash(String, Array(String) | String)) #

Logs user into the system

@required @param username [String?] The user name for login @required @param password [String?] The password for login in clear text @return [Tuple(String, Integer, Hash)] String, response status code and response headers


[View source]
def logout_user : Nil #

Logs out current logged in user session

@return [Nil]


[View source]
def logout_user(&block : Crest::Response -> ) : Nil #

Logs out current logged in user session

@return nil


[View source]
def logout_user_with_http_info : Tuple(Nil, Int32, Hash(String, Array(String) | String)) #

Logs out current logged in user session

@return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers


[View source]
def update_user(*, username : String | Nil = nil, user : PetStore::User | Nil = nil) : Nil #

Updated user This can only be done by the logged in user. @required @param username [String?] name that need to be deleted @required @param user [PetStore::User?] Updated user object @return [Nil]


[View source]
def update_user(*, username : String | Nil = nil, user : PetStore::User | Nil = nil, &block : Crest::Response -> ) : Nil #

Updated user This can only be done by the logged in user. @required @param username [String?] name that need to be deleted @required @param user [PetStore::User?] Updated user object @return nil


[View source]
def update_user_with_http_info(*, username : String | Nil = nil, user : PetStore::User | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String)) #

Updated user This can only be done by the logged in user. @required @param username [String?] name that need to be deleted @required @param user [PetStore::User?] Updated user object @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers


[View source]