Class: ShellDataReportingApIs::CardUsageSummaryResponse

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

Overview

CardUsageSummaryResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(usage_summary = SKIP, request_id = SKIP, error = SKIP) ⇒ CardUsageSummaryResponse

Returns a new instance of CardUsageSummaryResponse.



47
48
49
50
51
 
# File 'lib/shell_data_reporting_ap_is/models/card_usage_summary_response.rb', line 47

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

Instance Attribute Details

#error ⇒ ErrorStatus

API Request Id

Returns:



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

def error
  @error
end

#request_id ⇒ String

API Request Id

Returns:

  • (String) 


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

def request_id
  @request_id
end

#usage_summary ⇒ Array[UsageSummary]

TODO: Write general description for this method

Returns:



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

def usage_summary
  @usage_summary
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/shell_data_reporting_ap_is/models/card_usage_summary_response.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  usage_summary = nil
  unless hash['UsageSummary'].nil?
    usage_summary = []
    hash['UsageSummary'].each do |structure|
      usage_summary << (UsageSummary.from_hash(structure) if structure)
    end
  end

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

  # Create object from extracted values.
  CardUsageSummaryResponse.new(usage_summary,
                               request_id,
                               error)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/shell_data_reporting_ap_is/models/card_usage_summary_response.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['usage_summary'] = 'UsageSummary'
  @_hash['request_id'] = 'RequestId'
  @_hash['error'] = 'Error'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/shell_data_reporting_ap_is/models/card_usage_summary_response.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
40
 
# File 'lib/shell_data_reporting_ap_is/models/card_usage_summary_response.rb', line 34

def self.optionals
  %w[
    usage_summary
    request_id
    error
  ]
end