openapi-generator/samples/client/petstore/ruby/docs/StoreApi.md

Petstore::StoreApi

All URIs are relative to http://petstore.swagger.io:80/v2

Method	HTTP request	Description
delete_order	DELETE /store/order/{order_id}	Delete purchase order by ID
get_inventory	GET /store/inventory	Returns pet inventories by status
get_order_by_id	GET /store/order/{order_id}	Find purchase order by ID
place_order	POST /store/order	Place an order for a pet

delete_order

delete_order(order_id)

Delete purchase order by ID

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

Examples

require 'time'
require 'petstore'

api_instance = Petstore::StoreApi.new
order_id = 'order_id_example' # String | ID of the order that needs to be deleted

begin
  # Delete purchase order by ID
  api_instance.delete_order(order_id)
rescue Petstore::ApiError => e
  puts "Error when calling StoreApi->delete_order: #{e}"
end

Using the delete_order_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_order_with_http_info(order_id)

begin
  # Delete purchase order by ID
  data, status_code, headers = api_instance.delete_order_with_http_info(order_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Petstore::ApiError => e
  puts "Error when calling StoreApi->delete_order_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
order_id	String	ID of the order that needs to be deleted

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

get_inventory

Hash<String, Integer> get_inventory

Returns pet inventories by status

Returns a map of status codes to quantities

Examples

require 'time'
require 'petstore'
# setup authorization
Petstore.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['api_key'] = 'Bearer'
end

api_instance = Petstore::StoreApi.new

begin
  # Returns pet inventories by status
  result = api_instance.get_inventory
  p result
rescue Petstore::ApiError => e
  puts "Error when calling StoreApi->get_inventory: #{e}"
end

Using the get_inventory_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Hash<String, Integer>, Integer, Hash)> get_inventory_with_http_info

begin
  # Returns pet inventories by status
  data, status_code, headers = api_instance.get_inventory_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Hash<String, Integer>
rescue Petstore::ApiError => e
  puts "Error when calling StoreApi->get_inventory_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Hash<String, Integer>

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

get_order_by_id

get_order_by_id(order_id)

Find purchase order by ID

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

Examples

require 'time'
require 'petstore'

api_instance = Petstore::StoreApi.new
order_id = 789 # Integer | ID of pet that needs to be fetched

begin
  # Find purchase order by ID
  result = api_instance.get_order_by_id(order_id)
  p result
rescue Petstore::ApiError => e
  puts "Error when calling StoreApi->get_order_by_id: #{e}"
end

Using the get_order_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_order_by_id_with_http_info(order_id)

begin
  # Find purchase order by ID
  data, status_code, headers = api_instance.get_order_by_id_with_http_info(order_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Order>
rescue Petstore::ApiError => e
  puts "Error when calling StoreApi->get_order_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
order_id	Integer	ID of pet that needs to be fetched

Return type

Order

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

place_order

place_order(order)

Place an order for a pet

Examples

require 'time'
require 'petstore'

api_instance = Petstore::StoreApi.new
order = Petstore::Order.new # Order | order placed for purchasing the pet

begin
  # Place an order for a pet
  result = api_instance.place_order(order)
  p result
rescue Petstore::ApiError => e
  puts "Error when calling StoreApi->place_order: #{e}"
end

Using the place_order_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> place_order_with_http_info(order)

begin
  # Place an order for a pet
  data, status_code, headers = api_instance.place_order_with_http_info(order)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Order>
rescue Petstore::ApiError => e
  puts "Error when calling StoreApi->place_order_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
order	Order	order placed for purchasing the pet

Return type

Order

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/xml, application/json