Class: ShellDataReportingApIs::InvoiceSummaryResponse

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

Overview

InvoiceSummaryResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(request_id = SKIP, status = SKIP, data = SKIP) ⇒ InvoiceSummaryResponse

Returns a new instance of InvoiceSummaryResponse.



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

def initialize(request_id = SKIP, status = SKIP, data = SKIP)
  @request_id = request_id unless request_id == SKIP
  @status = status unless status == SKIP
  @data = data unless data == SKIP
end

Instance Attribute Details

#data ⇒ Array[InvoiceSummaryDetails]

Indicates overall status of the request. Allowed values: SUCCES, FAILED

Returns:



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

def data
  @data
end

#request_id ⇒ String

API Request Id

Returns:

  • (String) 


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

def request_id
  @request_id
end

#status ⇒ String

Indicates overall status of the request. Allowed values: SUCCES, FAILED

Returns:

  • (String) 


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

def status
  @status
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/invoice_summary_response.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
  status = hash.key?('Status') ? hash['Status'] : SKIP
  # Parameter is an array, so we need to iterate through it
  data = nil
  unless hash['Data'].nil?
    data = []
    hash['Data'].each do |structure|
      data << (InvoiceSummaryDetails.from_hash(structure) if structure)
    end
  end

  data = SKIP unless hash.key?('Data')

  # Create object from extracted values.
  InvoiceSummaryResponse.new(request_id,
                             status,
                             data)
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/invoice_summary_response.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['request_id'] = 'RequestId'
  @_hash['status'] = 'Status'
  @_hash['data'] = 'Data'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/shell_data_reporting_ap_is/models/invoice_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/invoice_summary_response.rb', line 34

def self.optionals
  %w[
    request_id
    status
    data
  ]
end