Class: Deliveree::DelivereeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/deliveree_client/api/deliveree_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DelivereeApi

Returns a new instance of DelivereeApi.



13
14
15
 
# File 'lib/deliveree_client/api/deliveree_api.rb', line 13

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



11
12
13
 
# File 'lib/deliveree_client/api/deliveree_api.rb', line 11

def api_client
  @api_client
end

Instance Method Details

#cancel_booking(id, opts = {}) ⇒ nil

Parameters:

  • id —

    ID of delivery

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) — default: default to en

Returns:

  • (nil) 


20
21
22
23
 
# File 'lib/deliveree_client/api/deliveree_api.rb', line 20

def cancel_booking(id, opts = {})
  cancel_booking_with_http_info(id, opts)
  nil
end

#cancel_booking_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • id —

    ID of delivery

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

Returns:

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

    nil, response status code and response headers



29
30
31
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
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/deliveree_client/api/deliveree_api.rb', line 29

def cancel_booking_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DelivereeApi.cancel_booking ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DelivereeApi.cancel_booking"
  end
  # resource path
  local_var_path = '/deliveries/{id}/cancel'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/xml', 'application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DelivereeApi#cancel_booking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#deliveries_get_quote(body, opts = {}) ⇒ ResponseWithData

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) — default: default to en

Returns:



72
73
74
75
 
# File 'lib/deliveree_client/api/deliveree_api.rb', line 72

def deliveries_get_quote(body, opts = {})
  data, _status_code, _headers = deliveries_get_quote_with_http_info(body, opts)
  data
end

#deliveries_get_quote_with_http_info(body, opts = {}) ⇒ Array<(ResponseWithData, Fixnum, Hash)>

Returns ResponseWithData data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

Returns:

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

    ResponseWithData data, response status code and response headers



81
82
83
84
85
86
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
 
# File 'lib/deliveree_client/api/deliveree_api.rb', line 81

def deliveries_get_quote_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DelivereeApi.deliveries_get_quote ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DelivereeApi.deliveries_get_quote"
  end
  # resource path
  local_var_path = '/deliveries/get_quote'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/xml', 'application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['ApiKeyAuth']
  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 => 'ResponseWithData')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DelivereeApi#deliveries_get_quote\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#deliveries_post(body, opts = {}) ⇒ ResponseDefault

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) — default: default to en

Returns:



125
126
127
128
 
# File 'lib/deliveree_client/api/deliveree_api.rb', line 125

def deliveries_post(body, opts = {})
  data, _status_code, _headers = deliveries_post_with_http_info(body, opts)
  data
end

#deliveries_post_with_http_info(body, opts = {}) ⇒ Array<(ResponseDefault, Fixnum, Hash)>

Returns ResponseDefault data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

Returns:

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

    ResponseDefault data, response status code and response headers



134
135
136
137
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
166
167
168
169
170
171
172
173
 
# File 'lib/deliveree_client/api/deliveree_api.rb', line 134

def deliveries_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DelivereeApi.deliveries_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DelivereeApi.deliveries_post"
  end
  # resource path
  local_var_path = '/deliveries'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/xml', 'application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['ApiKeyAuth']
  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 => 'ResponseDefault')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DelivereeApi#deliveries_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end