Class: HappyCo::InspectionServiceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/happyco_json/api/inspection_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InspectionServiceApi

Returns a new instance of InspectionServiceApi.



30
31
32
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#add_inspection_photos(body, opts = {}) ⇒ V1AddInspectionPhotosResponse

  • No longer supported since 2.6.

Parameters:

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

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 39

def add_inspection_photos(body, opts = {})
  data, _status_code, _headers = add_inspection_photos_with_http_info(body, opts)
  return data
end

#add_inspection_photos_with_http_info(body, opts = {}) ⇒ Array<(V1AddInspectionPhotosResponse, Fixnum, Hash)>

  • No longer supported since 2.6.

Parameters:

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

    the optional parameters

Returns:



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
89
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 49

def add_inspection_photos_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InspectionServiceApi.add_inspection_photos ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling InspectionServiceApi.add_inspection_photos" if body.nil?
  # resource path
  local_var_path = "/api/v1/inspect/inspection/photos/add".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#archive_inspections(body, opts = {}) ⇒ V1SetInspectionsArchivedResponse

  • Archive inspections should be used to archive inspections that are no longer wanted. No method for purging archived inspections is available via the API. All inspections must belong to the same folder.

Parameters:

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

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 96

def archive_inspections(body, opts = {})
  data, _status_code, _headers = archive_inspections_with_http_info(body, opts)
  return data
end

#archive_inspections_with_http_info(body, opts = {}) ⇒ Array<(V1SetInspectionsArchivedResponse, Fixnum, Hash)>

  • Archive inspections should be used to archive inspections that are no longer wanted. No method for purging archived inspections is available via the API. All inspections must belong to the same folder.

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 106

def archive_inspections_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InspectionServiceApi.archive_inspections ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling InspectionServiceApi.archive_inspections" if body.nil?
  # resource path
  local_var_path = "/api/v1/inspect/inspections/archive".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#create_delegated_inspection_links(body, opts = {}) ⇒ V1CreateDelegatedInspectionLinksResponse

Parameters:

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

    the optional parameters

Returns:



153
154
155
156
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 153

def create_delegated_inspection_links(body, opts = {})
  data, _status_code, _headers = create_delegated_inspection_links_with_http_info(body, opts)
  return data
end

#create_delegated_inspection_links_with_http_info(body, opts = {}) ⇒ Array<(V1CreateDelegatedInspectionLinksResponse, Fixnum, Hash)>

Returns V1CreateDelegatedInspectionLinksResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:



163
164
165
166
167
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
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 163

def create_delegated_inspection_links_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InspectionServiceApi.create_delegated_inspection_links ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling InspectionServiceApi.create_delegated_inspection_links" if body.nil?
  # resource path
  local_var_path = "/api/v1/inspect/inspection/links/create".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#create_inspections(body, opts = {}) ⇒ V1CreateInspectionsResponse

  • Create inspections can create inspections with any status (normally scheduled).

Parameters:

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

    the optional parameters

Returns:



210
211
212
213
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 210

def create_inspections(body, opts = {})
  data, _status_code, _headers = create_inspections_with_http_info(body, opts)
  return data
end

#create_inspections_with_http_info(body, opts = {}) ⇒ Array<(V1CreateInspectionsResponse, Fixnum, Hash)>

  • Create inspections can create inspections with any status (normally scheduled).

Parameters:

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

    the optional parameters

Returns:



220
221
222
223
224
225
226
227
228
229
230
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
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 220

def create_inspections_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InspectionServiceApi.create_inspections ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling InspectionServiceApi.create_inspections" if body.nil?
  # resource path
  local_var_path = "/api/v1/inspect/inspections/create".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#list_inspections(body, opts = {}) ⇒ V1ListInspectionsResponse

  • List inspections gets a paginated and optionally filtered list of inspections from one or more folders.

Parameters:

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

    the optional parameters

Returns:



267
268
269
270
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 267

def list_inspections(body, opts = {})
  data, _status_code, _headers = list_inspections_with_http_info(body, opts)
  return data
end

#list_inspections_with_http_info(body, opts = {}) ⇒ Array<(V1ListInspectionsResponse, Fixnum, Hash)>

  • List inspections gets a paginated and optionally filtered list of inspections from one or more folders.

Parameters:

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

    the optional parameters

Returns:

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

    V1ListInspectionsResponse data, response status code and response headers



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 277

def list_inspections_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InspectionServiceApi.list_inspections ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling InspectionServiceApi.list_inspections" if body.nil?
  # resource path
  local_var_path = "/api/v1/inspect/inspections/list".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#unarchive_inspections(body, opts = {}) ⇒ V1SetInspectionsArchivedResponse

  • Unarchive inspections should be used if previously archived inspections need to be restored. All inspections must belong to the same folder.

Parameters:

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

    the optional parameters

Returns:



324
325
326
327
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 324

def unarchive_inspections(body, opts = {})
  data, _status_code, _headers = unarchive_inspections_with_http_info(body, opts)
  return data
end

#unarchive_inspections_with_http_info(body, opts = {}) ⇒ Array<(V1SetInspectionsArchivedResponse, Fixnum, Hash)>

  • Unarchive inspections should be used if previously archived inspections need to be restored. All inspections must belong to the same folder.

Parameters:

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

    the optional parameters

Returns:



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 334

def unarchive_inspections_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InspectionServiceApi.unarchive_inspections ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling InspectionServiceApi.unarchive_inspections" if body.nil?
  # resource path
  local_var_path = "/api/v1/inspect/inspections/unarchive".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#update_inspections(body, opts = {}) ⇒ V1UpdateInspectionsResponse

  • Update inspections can change the contents of inspections. Currently an inspection cannot have its asset_id or template_id updated.

Parameters:

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

    the optional parameters

Returns:



381
382
383
384
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 381

def update_inspections(body, opts = {})
  data, _status_code, _headers = update_inspections_with_http_info(body, opts)
  return data
end

#update_inspections_with_http_info(body, opts = {}) ⇒ Array<(V1UpdateInspectionsResponse, Fixnum, Hash)>

  • Update inspections can change the contents of inspections. Currently an inspection cannot have its asset_id or template_id updated.

Parameters:

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

    the optional parameters

Returns:



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/happyco_json/api/inspection_service_api.rb', line 391

def update_inspections_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InspectionServiceApi.update_inspections ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling InspectionServiceApi.update_inspections" if body.nil?
  # resource path
  local_var_path = "/api/v1/inspect/inspections/update".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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