Class: WineShipping::TrackingApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TrackingApi 



19
20
21
 
# File 'lib/wine_shipping/api/tracking_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/tracking_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_details(track_order, opts = {}) ⇒ Array<TrackingResult>

This operation provides sales order and associated package tracking information and their status if available. This operation accepts a customer number and order number to locate the order information within the Wineshipping system. The result will include individual packages, associated tracking numbers, carrier status, and the shipping address information.



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

def get_details(track_order, opts = {})
  data, _status_code, _headers = get_details_with_http_info(track_order, opts)
  data
end

#get_details_with_http_info(track_order, opts = {}) ⇒ Array<(Array<TrackingResult>, Fixnum, Hash)>

This operation provides sales order and associated package tracking information and their status if available. This operation accepts a customer number and order number to locate the order information within the Wineshipping system. The result will include individual packages, associated tracking numbers, carrier status, and the shipping address information.



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/tracking_api.rb', line 35

def get_details_with_http_info(track_order, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TrackingApi.get_details ...'
  end
  # verify the required parameter 'track_order' is set
  if @api_client.config.client_side_validation && track_order.nil?
    fail ArgumentError, "Missing the required parameter 'track_order' when calling TrackingApi.get_details"
  end
  # resource path
  local_var_path = '/api/Tracking/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(track_order)
  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<TrackingResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrackingApi#get_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end