Class: SwaggerPetstoreOpenApi30::UserApi

Inherits:
BaseApi
  • Object
show all
Defined in:
lib/swagger_petstore_open_api30/apis/user_api.rb

Overview

UserApi

Constant Summary

Constants inherited from BaseApi

BaseApi::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseApi

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseApi

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from SwaggerPetstoreOpenApi30::BaseApi

Instance Method Details

#create_user(id: nil, username: nil, first_name: nil, last_name: nil, email: nil, password: nil, phone: nil, user_status: nil) ⇒ ApiResponse

This can only be done by the logged in user. here here

Parameters:

  • id (Integer) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • username (String) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • first_name (String) (defaults to: nil) —

    Optional parameter: TODO: type description

  • last_name (String) (defaults to: nil) —

    Optional parameter: TODO: type description

  • email (String) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • password (String) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • phone (String) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • user_status (Integer) (defaults to: nil) —

    Optional parameter: User Status

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/swagger_petstore_open_api30/apis/user_api.rb', line 21

def create_user(id: nil,
                username: nil,
                first_name: nil,
                last_name: nil,
                email: nil,
                password: nil,
                phone: nil,
                user_status: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user',
                                 Server::DEFAULT)
               .form_param(new_parameter(id, key: 'id'))
               .form_param(new_parameter(username, key: 'username'))
               .form_param(new_parameter(first_name, key: 'firstName'))
               .form_param(new_parameter(last_name, key: 'lastName'))
               .form_param(new_parameter(email, key: 'email'))
               .form_param(new_parameter(password, key: 'password'))
               .form_param(new_parameter(phone, key: 'phone'))
               .form_param(new_parameter(user_status, key: 'userStatus'))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
               .header_param(new_parameter('application/json', key: 'accept')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(User.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Unexpected error',
                             APIException))
    .execute
end

#create_users_with_list_input(body: nil) ⇒ ApiResponse

Creates list of users with given input array. here

Parameters:

  • body (Array[User]) (defaults to: nil) —

    Optional parameter: TODO: type description

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/swagger_petstore_open_api30/apis/user_api.rb', line 57

def create_users_with_list_input(body: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/user/createWithList',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(User.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Unexpected error',
                             APIException))
    .execute
end

#delete_user(usersname) ⇒ ApiResponse

This can only be done by the logged in user. be processed

Parameters:

  • usersname (String) —

    Required parameter: The username that needs to

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/swagger_petstore_open_api30/apis/user_api.rb', line 210

def delete_user(usersname)
  @api_call
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/user/{usersname}',
                                 Server::DEFAULT)
               .template_param(new_parameter(usersname, key: 'usersname')
                                .is_required(true)
                                .should_encode(true)))
    .response(new_response_handler
                .is_response_void(true)
                .is_api_response(true)
                .local_error('400',
                             'Invalid username supplied',
                             APIException)
                .local_error('404',
                             'User not found',
                             APIException)
                .local_error('default',
                             'Unexpected error',
                             APIException))
    .execute
end

#get_user_by_name(usersname) ⇒ ApiResponse

Get user detail based on username. be processed

Parameters:

  • usersname (String) —

    Required parameter: The username that needs to

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/swagger_petstore_open_api30/apis/user_api.rb', line 127

def get_user_by_name(usersname)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/user/{usersname}',
                                 Server::DEFAULT)
               .template_param(new_parameter(usersname, key: 'usersname')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(User.method(:from_hash))
                .is_api_response(true)
                .local_error('400',
                             'Invalid username supplied',
                             APIException)
                .local_error('404',
                             'User not found',
                             APIException)
                .local_error('default',
                             'Unexpected error',
                             APIException))
    .execute
end

#login_user(username: nil, password: nil) ⇒ ApiResponse

Log into the system. clear text

Parameters:

  • username (String) (defaults to: nil) —

    Optional parameter: The user name for login

  • password (String) (defaults to: nil) —

    Optional parameter: The password for login in

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/swagger_petstore_open_api30/apis/user_api.rb', line 81

def (username: nil,
               password: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/user/login',
                                 Server::DEFAULT)
               .query_param(new_parameter(username, key: 'username'))
               .query_param(new_parameter(password, key: 'password'))
               .header_param(new_parameter('application/xml', key: 'accept')))
    .response(new_response_handler
                .deserializer(XmlUtilities.method(:deserialize_xml))
                .deserialize_into(String)
                .is_xml_response(true)
                .xml_attribute(XmlAttributes.new
                                            .root_element_name('response'))
                .is_api_response(true)
                .is_primitive_response(true)
                .local_error('400',
                             'Invalid username/password supplied',
                             APIException)
                .local_error('default',
                             'Unexpected error',
                             APIException))
    .execute
end

#logout_user ⇒ ApiResponse

Log user out of the system.

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/swagger_petstore_open_api30/apis/user_api.rb', line 109

def logout_user
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/user/logout',
                                 Server::DEFAULT))
    .response(new_response_handler
                .is_response_void(true)
                .is_api_response(true)
                .local_error('default',
                             'Unexpected error',
                             APIException))
    .execute
end

#update_user(usersname, id: nil, username: nil, first_name: nil, last_name: nil, email: nil, password: nil, phone: nil, user_status: nil) ⇒ ApiResponse

This can only be done by the logged in user. be processed here here

Parameters:

  • usersname (String) —

    Required parameter: The username that needs to

  • id (Integer) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • username (String) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • first_name (String) (defaults to: nil) —

    Optional parameter: TODO: type description

  • last_name (String) (defaults to: nil) —

    Optional parameter: TODO: type description

  • email (String) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • password (String) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • phone (String) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • user_status (Integer) (defaults to: nil) —

    Optional parameter: User Status

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/swagger_petstore_open_api30/apis/user_api.rb', line 166

def update_user(usersname,
                id: nil,
                username: nil,
                first_name: nil,
                last_name: nil,
                email: nil,
                password: nil,
                phone: nil,
                user_status: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::PUT,
                                 '/user/{usersname}',
                                 Server::DEFAULT)
               .template_param(new_parameter(usersname, key: 'usersname')
                                .is_required(true)
                                .should_encode(true))
               .form_param(new_parameter(id, key: 'id'))
               .form_param(new_parameter(username, key: 'username'))
               .form_param(new_parameter(first_name, key: 'firstName'))
               .form_param(new_parameter(last_name, key: 'lastName'))
               .form_param(new_parameter(email, key: 'email'))
               .form_param(new_parameter(password, key: 'password'))
               .form_param(new_parameter(phone, key: 'phone'))
               .form_param(new_parameter(user_status, key: 'userStatus'))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type')))
    .response(new_response_handler
                .is_response_void(true)
                .is_api_response(true)
                .local_error('400',
                             'bad request',
                             APIException)
                .local_error('404',
                             'user not found',
                             APIException)
                .local_error('default',
                             'Unexpected error',
                             APIException))
    .execute
end