Class: ShellCardManagementApIs::ScheduleCardBlockResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_card_management_ap_is/models/schedule_card_block_response.rb

Overview

ScheduleCardBlockResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(main_reference = SKIP, request_id = SKIP, status = SKIP, data = SKIP) ⇒ ScheduleCardBlockResponse

Returns a new instance of ScheduleCardBlockResponse.



55
56
57
58
59
60
61
 
# File 'lib/shell_card_management_ap_is/models/schedule_card_block_response.rb', line 55

def initialize(main_reference = SKIP, request_id = SKIP, status = SKIP,
               data = SKIP)
  @main_reference = main_reference unless main_reference == 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[ScheduleCardBlockResponseDataItems]

List of SubmittedScheduleCardBlockCard entity.

Returns:



28
29
30
 
# File 'lib/shell_card_management_ap_is/models/schedule_card_block_response.rb', line 28

def data
  @data
end

#main_reference ⇒ Integer

Reference number for tracking the execution of the request. Note: Reference will be empty for status 9006 and 9012 i.e., request for all the cards failed.

Returns:

  • (Integer) 


16
17
18
 
# File 'lib/shell_card_management_ap_is/models/schedule_card_block_response.rb', line 16

def main_reference
  @main_reference
end

#request_id ⇒ String

API Request ID

Returns:

  • (String) 


20
21
22
 
# File 'lib/shell_card_management_ap_is/models/schedule_card_block_response.rb', line 20

def request_id
  @request_id
end

#status ⇒ String

Overall Status of the API call

Returns:

  • (String) 


24
25
26
 
# File 'lib/shell_card_management_ap_is/models/schedule_card_block_response.rb', line 24

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/shell_card_management_ap_is/models/schedule_card_block_response.rb', line 64

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  main_reference = hash.key?('MainReference') ? hash['MainReference'] : SKIP
  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 << (ScheduleCardBlockResponseDataItems.from_hash(structure) if structure)
    end
  end

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

  # Create object from extracted values.
  ScheduleCardBlockResponse.new(main_reference,
                                request_id,
                                status,
                                data)
end

.names ⇒ Object

A mapping from model property names to API property names.



31
32
33
34
35
36
37
38
 
# File 'lib/shell_card_management_ap_is/models/schedule_card_block_response.rb', line 31

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

.nullables ⇒ Object

An array for nullable fields



51
52
53
 
# File 'lib/shell_card_management_ap_is/models/schedule_card_block_response.rb', line 51

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



41
42
43
44
45
46
47
48
 
# File 'lib/shell_card_management_ap_is/models/schedule_card_block_response.rb', line 41

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