Class: SwaggerPetstoreOpenApi30::StoreController

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

Overview

StoreController

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

#delete_order(order_id) ⇒ void

This method returns an undefined value.

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors to be deleted

Parameters:

  • order_id (Integer) —

    Required parameter: ID of the order that needs



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/swagger_petstore_open_api30/controllers/store_controller.rb', line 89

def delete_order(order_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/store/order/{orderId}',
                                 Server::DEFAULT)
               .template_param(new_parameter(order_id, key: 'orderId')
                                .should_encode(true)))
    .response(new_response_handler
               .is_response_void(true)
               .local_error('400',
                            'Invalid ID supplied',
                            APIException)
               .local_error('404',
                            'Order not found',
                            APIException))
    .execute
end

#get_inventory ⇒ Hash[String, Integer]

Returns a map of status codes to quantities

Returns:

  • (Hash[String, Integer]) —

    response from the API call



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

def get_inventory
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/store/inventory',
                                 Server::DEFAULT)
               .auth(Single.new('api_key')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:deserialize_primitive_types))
               .deserialize_into(proc do |response| response.to_i end)
               .is_primitive_response(true))
    .execute
end

#get_order_by_id(order_id) ⇒ Order

For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions. fetched

Parameters:

  • order_id (Integer) —

    Required parameter: ID of order that needs to be

Returns:

  • (Order) —

    response from the API call



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/swagger_petstore_open_api30/controllers/store_controller.rb', line 64

def get_order_by_id(order_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/store/order/{orderId}',
                                 Server::DEFAULT)
               .template_param(new_parameter(order_id, key: 'orderId')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(Order.method(:from_hash))
               .local_error('400',
                            'Invalid ID supplied',
                            APIException)
               .local_error('404',
                            'Order not found',
                            APIException))
    .execute
end

#place_order(id: nil, pet_id: nil, quantity: nil, ship_date: nil, order_status: OrderStatusEnum::APPROVED, complete: nil) ⇒ Order

Place a new order in the store

Parameters:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

  • ship_date (DateTime) (defaults to: nil) —

    Optional parameter: Example:

  • order_status (OrderStatusEnum) (defaults to: OrderStatusEnum::APPROVED) —

    Optional parameter: Order Status

  • complete (TrueClass | FalseClass) (defaults to: nil) —

    Optional parameter: Example:

Returns:

  • (Order) —

    response from the API call



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/swagger_petstore_open_api30/controllers/store_controller.rb', line 32

def place_order(id: nil,
                pet_id: nil,
                quantity: nil,
                ship_date: nil,
                order_status: OrderStatusEnum::APPROVED,
                complete: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/store/order',
                                 Server::DEFAULT)
               .form_param(new_parameter(id, key: 'id'))
               .form_param(new_parameter(pet_id, key: 'petId'))
               .form_param(new_parameter(quantity, key: 'quantity'))
               .form_param(new_parameter(ship_date, key: 'shipDate'))
               .form_param(new_parameter(order_status, key: 'orderStatus'))
               .form_param(new_parameter(complete, key: 'complete'))
               .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(Order.method(:from_hash))
               .local_error('405',
                            'Invalid input',
                            APIException))
    .execute
end