Class: ShellDataReportingApIs::UpdateOdometerResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_data_reporting_ap_is/models/update_odometer_response.rb

Overview

UpdateOdometerResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(service_reference = SKIP, update_odometer_references = SKIP, error = SKIP, request_id = SKIP) ⇒ UpdateOdometerResponse

Returns a new instance of UpdateOdometerResponse.



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/shell_data_reporting_ap_is/models/update_odometer_response.rb', line 53

def initialize(service_reference = SKIP, update_odometer_references = SKIP,
               error = SKIP, request_id = SKIP)
  @service_reference = service_reference unless service_reference == SKIP
  unless update_odometer_references == SKIP
    @update_odometer_references =
      update_odometer_references
  end
  @error = error unless error == SKIP
  @request_id = request_id unless request_id == SKIP
end

Instance Attribute Details

#error ⇒ ErrorStatus

Main reference number for tracking.

Returns:



22
23
24
 
# File 'lib/shell_data_reporting_ap_is/models/update_odometer_response.rb', line 22

def error
  @error
end

#request_id ⇒ String

API Request Id

Returns:

  • (String) 


26
27
28
 
# File 'lib/shell_data_reporting_ap_is/models/update_odometer_response.rb', line 26

def request_id
  @request_id
end

#service_reference ⇒ Integer

Main reference number for tracking.

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/shell_data_reporting_ap_is/models/update_odometer_response.rb', line 14

def service_reference
  @service_reference
end

#update_odometer_references ⇒ Array[UpdateOdometerReference]

Main reference number for tracking.

Returns:



18
19
20
 
# File 'lib/shell_data_reporting_ap_is/models/update_odometer_response.rb', line 18

def update_odometer_references
  @update_odometer_references
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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/shell_data_reporting_ap_is/models/update_odometer_response.rb', line 65

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  service_reference =
    hash.key?('ServiceReference') ? hash['ServiceReference'] : SKIP
  # Parameter is an array, so we need to iterate through it
  update_odometer_references = nil
  unless hash['UpdateOdometerReferences'].nil?
    update_odometer_references = []
    hash['UpdateOdometerReferences'].each do |structure|
      update_odometer_references << (UpdateOdometerReference.from_hash(structure) if structure)
    end
  end

  update_odometer_references = SKIP unless hash.key?('UpdateOdometerReferences')
  error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
  request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP

  # Create object from extracted values.
  UpdateOdometerResponse.new(service_reference,
                             update_odometer_references,
                             error,
                             request_id)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
 
# File 'lib/shell_data_reporting_ap_is/models/update_odometer_response.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['service_reference'] = 'ServiceReference'
  @_hash['update_odometer_references'] = 'UpdateOdometerReferences'
  @_hash['error'] = 'Error'
  @_hash['request_id'] = 'RequestId'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/shell_data_reporting_ap_is/models/update_odometer_response.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
45
46
 
# File 'lib/shell_data_reporting_ap_is/models/update_odometer_response.rb', line 39

def self.optionals
  %w[
    service_reference
    update_odometer_references
    error
    request_id
  ]
end