Class: ShellCardManagementApIs::CardMoveRes

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

Overview

CardMoveRes Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

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

Returns a new instance of CardMoveRes.



53
54
55
56
57
58
59
# File 'lib/shell_card_management_ap_is/models/card_move_res.rb', line 53

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

Instance Attribute Details

#dataArray[SubmittedMoveCard]

API Request Overall status

Returns:



26
27
28
# File 'lib/shell_card_management_ap_is/models/card_move_res.rb', line 26

def data
  @data
end

#main_referenceInteger

Move-Card reference number for tracking the execution of the request.

Returns:

  • (Integer)


18
19
20
# File 'lib/shell_card_management_ap_is/models/card_move_res.rb', line 18

def main_reference
  @main_reference
end

#request_idString

API Request ID

Returns:

  • (String)


14
15
16
# File 'lib/shell_card_management_ap_is/models/card_move_res.rb', line 14

def request_id
  @request_id
end

#statusString

API Request Overall status

Returns:

  • (String)


22
23
24
# File 'lib/shell_card_management_ap_is/models/card_move_res.rb', line 22

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

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

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

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

.namesObject

A mapping from model property names to API property names.



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

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

.nullablesObject

An array for nullable fields



49
50
51
# File 'lib/shell_card_management_ap_is/models/card_move_res.rb', line 49

def self.nullables
  []
end

.optionalsObject

An array for optional fields



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

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

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



95
96
97
98
99
# File 'lib/shell_card_management_ap_is/models/card_move_res.rb', line 95

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} request_id: #{@request_id.inspect}, main_reference:"\
  " #{@main_reference.inspect}, status: #{@status.inspect}, data: #{@data.inspect}>"
end

#to_sObject

Provides a human-readable string representation of the object.



88
89
90
91
92
# File 'lib/shell_card_management_ap_is/models/card_move_res.rb', line 88

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} request_id: #{@request_id}, main_reference: #{@main_reference}, status:"\
  " #{@status}, data: #{@data}>"
end