Class: SwaggerPetstoreOpenApi30::UserController

Inherits:
BaseController show all
Defined in:
lib/swagger_petstore_open_api30/controllers/user_controller.rb

Overview

UserController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

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

Constructor Details

This class inherits a constructor from SwaggerPetstoreOpenApi30::BaseController

Instance Method Details

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

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:

  • (User) —

    Response from the API call.



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
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.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))
                .local_error('default',
                             'Unexpected error',
                             APIException))
    .execute
end

#create_users_with_list_input(body: nil) ⇒ User

Creates list of users with given input array. here

Parameters:

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

    Optional parameter: TODO: type description

Returns:

  • (User) —

    Response from the API call.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 56

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))
                .local_error('default',
                             'Unexpected error',
                             APIException))
    .execute
end

#delete_user(username) ⇒ void

This method returns an undefined value.

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

Parameters:

  • username (String) —

    Required parameter: The name that needs to be



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 202

def delete_user(username)
  @api_call
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/user/{username}',
                                 Server::DEFAULT)
               .template_param(new_parameter(username, key: 'username')
                                .should_encode(true)))
    .response(new_response_handler
                .is_response_void(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(username) ⇒ User

Get user detail based on username. fetched. Use user1 for testing

Parameters:

  • username (String) —

    Required parameter: The name that needs to be

Returns:

  • (User) —

    Response from the API call.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 123

def get_user_by_name(username)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/user/{username}',
                                 Server::DEFAULT)
               .template_param(new_parameter(username, key: 'username')
                                .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))
                .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) ⇒ String

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:

  • (String) —

    Response from the API call.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 79

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_primitive_response(true)
                .local_error('400',
                             'Invalid username/password supplied',
                             APIException)
                .local_error('default',
                             'Unexpected error',
                             APIException))
    .execute
end

#logout_user ⇒ void

This method returns an undefined value.

Log user out of the system.



106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 106

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

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

This method returns an undefined value.

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

Parameters:

  • username_template (String) —

    Required parameter: name that need to be

  • 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



160
161
162
163
164
165
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
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 160

def update_user(username_template,
                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/{username}',
                                 Server::DEFAULT)
               .template_param(new_parameter(username_template, key: 'username')
                                .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)
                .local_error('400',
                             'bad request',
                             APIException)
                .local_error('404',
                             'user not found',
                             APIException)
                .local_error('default',
                             'Unexpected error',
                             APIException))
    .execute
end