Class: WineShipping::InventoryApi

Inherits:
Object
  • Object
show all
Defined in:
lib/wine_shipping/api/inventory_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InventoryApi

Returns a new instance of InventoryApi.



19
20
21
 
# File 'lib/wine_shipping/api/inventory_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/wine_shipping/api/inventory_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_inventory_details(authentication_details, opts = {}) ⇒ Array<Inventory>

This operation provides inventory information with warehouse, status, quantity on hand, quantity reserved on orders, quantity on backorder, quantity available, and quantity on an inbound PO. This operation accepts a customer number to summarize inventory information within the Wineshipping system. This is a Legacy operation for backward compatibility. For new integration the recomended operation is GetInventoryStatus.

Parameters:

  • authentication_details
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/wine_shipping/api/inventory_api.rb', line 26

def get_inventory_details(authentication_details, opts = {})
  data, _status_code, _headers = get_inventory_details_with_http_info(authentication_details, opts)
  data
end

#get_inventory_details_with_http_info(authentication_details, opts = {}) ⇒ Array<(Array<Inventory>, Fixnum, Hash)>

This operation provides inventory information with warehouse, status, quantity on hand, quantity reserved on orders, quantity on backorder, quantity available, and quantity on an inbound PO. This operation accepts a customer number to summarize inventory information within the Wineshipping system. This is a Legacy operation for backward compatibility. For new integration the recomended operation is GetInventoryStatus.

Parameters:

  • authentication_details
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<Inventory>, Fixnum, Hash)>) —

    Array<Inventory> data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/wine_shipping/api/inventory_api.rb', line 35

def get_inventory_details_with_http_info(authentication_details, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoryApi.get_inventory_details ...'
  end
  # verify the required parameter 'authentication_details' is set
  if @api_client.config.client_side_validation && authentication_details.nil?
    fail ArgumentError, "Missing the required parameter 'authentication_details' when calling InventoryApi.get_inventory_details"
  end
  # resource path
  local_var_path = '/api/Inventory/GetDetails'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(authentication_details)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Inventory>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoryApi#get_inventory_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inventory_status(invent_status_request, opts = {}) ⇒ InventoryStatusResult

This operation provides inventory information with warehouse, status, quantity on hand, quantity reserved on orders, quantity on backorder, quantity available, and quantity on an inbound PO. This operation optionally accepts a warehouse code to return related inventory records for a specific Wineshipping warehouse, if omitted the operation will return inventory records for all warehouses. The operation also accepts an array of items to query inventory records, if omitted returns inventory records for all items in the warehouse specified.

Parameters:

  • invent_status_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



78
79
80
81
 
# File 'lib/wine_shipping/api/inventory_api.rb', line 78

def get_inventory_status(invent_status_request, opts = {})
  data, _status_code, _headers = get_inventory_status_with_http_info(invent_status_request, opts)
  data
end

#get_inventory_status_with_http_info(invent_status_request, opts = {}) ⇒ Array<(InventoryStatusResult, Fixnum, Hash)>

This operation provides inventory information with warehouse, status, quantity on hand, quantity reserved on orders, quantity on backorder, quantity available, and quantity on an inbound PO. This operation optionally accepts a warehouse code to return related inventory records for a specific Wineshipping warehouse, if omitted the operation will return inventory records for all warehouses. The operation also accepts an array of items to query inventory records, if omitted returns inventory records for all items in the warehouse specified.

Parameters:

  • invent_status_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InventoryStatusResult, Fixnum, Hash)>) —

    InventoryStatusResult data, response status code and response headers



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/wine_shipping/api/inventory_api.rb', line 87

def get_inventory_status_with_http_info(invent_status_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoryApi.get_inventory_status ...'
  end
  # verify the required parameter 'invent_status_request' is set
  if @api_client.config.client_side_validation && invent_status_request.nil?
    fail ArgumentError, "Missing the required parameter 'invent_status_request' when calling InventoryApi.get_inventory_status"
  end
  # resource path
  local_var_path = '/api/Inventory/GetStatus'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(invent_status_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InventoryStatusResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoryApi#get_inventory_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end