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_api_call_builder, #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.

Parameters:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: User Status

Returns:

  • (User) —

    response from the API call



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 52

def create_user(id: nil,
                username: nil,
                first_name: nil,
                last_name: nil,
                email: nil,
                password: nil,
                phone: nil,
                user_status: nil)
  new_api_call_builder
    .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)))
    .execute
end

#create_users_with_list_input(body: nil) ⇒ User

Creates list of users with given input array

Parameters:

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

    Optional parameter: Example:

Returns:

  • (User) —

    response from the API call



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 24

def create_users_with_list_input(body: nil)
  new_api_call_builder
    .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',
                            'successful operation',
                            APIException))
    .execute
end

#delete_user(name) ⇒ void

This method returns an undefined value.

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

Parameters:

  • name (String) —

    Required parameter: The name that needs to be



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 171

def delete_user(name)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/user/{name}',
                                 Server::DEFAULT)
               .template_param(new_parameter(name, key: 'name')
                                .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))
    .execute
end

#get_user_by_name(name) ⇒ User

TODO: type endpoint description here fetched. Use user1 for testing.

Parameters:

  • name (String) —

    Required parameter: The name that needs to be

Returns:

  • (User) —

    response from the API call



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 107

def get_user_by_name(name)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/user/{name}',
                                 Server::DEFAULT)
               .template_param(new_parameter(name, key: 'name')
                                .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))
    .execute
end

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

TODO: type endpoint description here 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



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

def (username: nil,
               password: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/user/login',
                                 Server::DEFAULT)
               .query_param(new_parameter(username, key: 'username'))
               .query_param(new_parameter(password, key: 'password')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:deserialize_primitive_types))
               .deserialize_into(proc do |response| response.to_s end)
               .is_primitive_response(true)
               .local_error('400',
                            'Invalid username/password supplied',
                            APIException))
    .execute
end

#logout_user ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



11
12
13
14
15
16
17
18
19
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 11

def logout_user
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/user/logout',
                                 Server::DEFAULT))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#update_user(name, 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.

Parameters:

  • name (String) —

    Required parameter: name that need to be deleted

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: User Status



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/swagger_petstore_open_api30/controllers/user_controller.rb', line 138

def update_user(name,
                id: nil,
                username: nil,
                first_name: nil,
                last_name: nil,
                email: nil,
                password: nil,
                phone: nil,
                user_status: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::PUT,
                                 '/user/{name}',
                                 Server::DEFAULT)
               .template_param(new_parameter(name, key: 'name')
                                .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))
    .execute
end