Class: TapyrusApiClient::TrackingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tapyrus-api-client/api/tracking_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TrackingApi

Returns a new instance of TrackingApi.



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

def api_client
  @api_client
end

Instance Method Details

#consume_tracking(consume_tracking_request, opts = {}) ⇒ TrackingResponse

モノのトラッキングを終了します。 トラッキング中のモノが消費されたものとみなして、トラッキングを終了します。モノがトラッキング中でない場合は失敗します。

Parameters:

Returns:



27
28
29
30
 
# File 'lib/tapyrus-api-client/api/tracking_api.rb', line 27

def consume_tracking(consume_tracking_request, opts = {})
  data, _status_code, _headers = consume_tracking_with_http_info(consume_tracking_request, opts)
  data
end

#consume_tracking_with_http_info(consume_tracking_request, opts = {}) ⇒ Array<(TrackingResponse, Integer, Hash)>

モノのトラッキングを終了します。 トラッキング中のモノが消費されたものとみなして、トラッキングを終了します。モノがトラッキング中でない場合は失敗します。

Parameters:

Returns:

  • (Array<(TrackingResponse, Integer, Hash)>) —

    TrackingResponse data, response status code and response headers



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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/tapyrus-api-client/api/tracking_api.rb', line 37

def consume_tracking_with_http_info(consume_tracking_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TrackingApi.consume_tracking ...'
  end
  # verify the required parameter 'consume_tracking_request' is set
  if @api_client.config.client_side_validation && consume_tracking_request.nil?
    fail ArgumentError, "Missing the required parameter 'consume_tracking_request' when calling TrackingApi.consume_tracking"
  end
  # resource path
  local_var_path = '/tracking/consume'

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(consume_tracking_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TrackingResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TrackingApi.consume_tracking",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrackingApi#consume_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tracking_subjects(subject_id, opts = {}) ⇒ Array<TrackingTrace>

モノの移動の履歴を返します。 モノの移動の履歴を返します。履歴は発生日時の昇順でソートされています。

Parameters:

  • subject_id (String) —

    モノの識別子。

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/tapyrus-api-client/api/tracking_api.rb', line 95

def get_tracking_subjects(subject_id, opts = {})
  data, _status_code, _headers = get_tracking_subjects_with_http_info(subject_id, opts)
  data
end

#get_tracking_subjects_with_http_info(subject_id, opts = {}) ⇒ Array<(Array<TrackingTrace>, Integer, Hash)>

モノの移動の履歴を返します。 モノの移動の履歴を返します。履歴は発生日時の昇順でソートされています。

Parameters:

  • subject_id (String) —

    モノの識別子。

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

    the optional parameters

Returns:

  • (Array<(Array<TrackingTrace>, Integer, Hash)>) —

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/tapyrus-api-client/api/tracking_api.rb', line 105

def get_tracking_subjects_with_http_info(subject_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TrackingApi.get_tracking_subjects ...'
  end
  # verify the required parameter 'subject_id' is set
  if @api_client.config.client_side_validation && subject_id.nil?
    fail ArgumentError, "Missing the required parameter 'subject_id' when calling TrackingApi.get_tracking_subjects"
  end
  # resource path
  local_var_path = '/tracking/subjects/{subject_id}/traces'.sub('{' + 'subject_id' + '}', CGI.escape(subject_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TrackingTrace>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TrackingApi.get_tracking_subjects",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrackingApi#get_tracking_subjects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tracking_traces(trace_id, opts = {}) ⇒ TrackingTracesResponse

モノの移動履歴(trace)に関する情報を返します。 モノの移動履歴(trace)に関する情報を返します。

Parameters:

  • trace_id (Float) —

    モノの移動履歴(trace)に一意に振られたID

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/tapyrus-api-client/api/tracking_api.rb', line 158

def get_tracking_traces(trace_id, opts = {})
  data, _status_code, _headers = get_tracking_traces_with_http_info(trace_id, opts)
  data
end

#get_tracking_traces_with_http_info(trace_id, opts = {}) ⇒ Array<(TrackingTracesResponse, Integer, Hash)>

モノの移動履歴(trace)に関する情報を返します。 モノの移動履歴(trace)に関する情報を返します。

Parameters:

  • trace_id (Float) —

    モノの移動履歴(trace)に一意に振られたID

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

    the optional parameters

Returns:

  • (Array<(TrackingTracesResponse, Integer, Hash)>) —

    TrackingTracesResponse data, response status code and response headers



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/tapyrus-api-client/api/tracking_api.rb', line 168

def get_tracking_traces_with_http_info(trace_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TrackingApi.get_tracking_traces ...'
  end
  # verify the required parameter 'trace_id' is set
  if @api_client.config.client_side_validation && trace_id.nil?
    fail ArgumentError, "Missing the required parameter 'trace_id' when calling TrackingApi.get_tracking_traces"
  end
  # resource path
  local_var_path = '/tracking/traces/{trace_id}'.sub('{' + 'trace_id' + '}', CGI.escape(trace_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TrackingTracesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TrackingApi.get_tracking_traces",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrackingApi#get_tracking_traces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#supply_tracking(opts = {}) ⇒ TrackingResponse

新規でトラッキングを開始します。 新規でトラッキングを開始します。指定されたモノがすでにトラッキング中の場合はトラッキングの開始に失敗します。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



221
222
223
224
 
# File 'lib/tapyrus-api-client/api/tracking_api.rb', line 221

def supply_tracking(opts = {})
  data, _status_code, _headers = supply_tracking_with_http_info(opts)
  data
end

#supply_tracking_with_http_info(opts = {}) ⇒ Array<(TrackingResponse, Integer, Hash)>

新規でトラッキングを開始します。 新規でトラッキングを開始します。指定されたモノがすでにトラッキング中の場合はトラッキングの開始に失敗します。

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TrackingResponse, Integer, Hash)>) —

    TrackingResponse data, response status code and response headers



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/tapyrus-api-client/api/tracking_api.rb', line 231

def supply_tracking_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TrackingApi.supply_tracking ...'
  end
  # resource path
  local_var_path = '/tracking/supply'

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'supply_tracking_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'TrackingResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TrackingApi.supply_tracking",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrackingApi#supply_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#transport_tracking(transport_tracking_request, opts = {}) ⇒ TrackingResponse

トラッキング中のモノの移動を記録します。 トラッキング中のモノの移動を記録します。モノがトラッキング中でない場合は記録に失敗します。

Parameters:

Returns:



285
286
287
288
 
# File 'lib/tapyrus-api-client/api/tracking_api.rb', line 285

def transport_tracking(transport_tracking_request, opts = {})
  data, _status_code, _headers = transport_tracking_with_http_info(transport_tracking_request, opts)
  data
end

#transport_tracking_with_http_info(transport_tracking_request, opts = {}) ⇒ Array<(TrackingResponse, Integer, Hash)>

トラッキング中のモノの移動を記録します。 トラッキング中のモノの移動を記録します。モノがトラッキング中でない場合は記録に失敗します。

Parameters:

Returns:

  • (Array<(TrackingResponse, Integer, Hash)>) —

    TrackingResponse data, response status code and response headers



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/tapyrus-api-client/api/tracking_api.rb', line 295

def transport_tracking_with_http_info(transport_tracking_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TrackingApi.transport_tracking ...'
  end
  # verify the required parameter 'transport_tracking_request' is set
  if @api_client.config.client_side_validation && transport_tracking_request.nil?
    fail ArgumentError, "Missing the required parameter 'transport_tracking_request' when calling TrackingApi.transport_tracking"
  end
  # resource path
  local_var_path = '/tracking/transport'

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transport_tracking_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TrackingResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TrackingApi.transport_tracking",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TrackingApi#transport_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end