Class: ShellCardManagementApIs::ResponseDeliveryAddressUpdate

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

Overview

ResponseDeliveryAddressUpdate 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 = nil, status = nil, main_reference = SKIP, data = SKIP) ⇒ ResponseDeliveryAddressUpdate

Returns a new instance of ResponseDeliveryAddressUpdate.



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

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

Instance Attribute Details

#dataArray[Datum]

List of Delivery address update entity. The fields of this entity are described below.

Returns:



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

def data
  @data
end

#main_referenceInteger

Main reference number for tracking.

Returns:

  • (Integer)


23
24
25
# File 'lib/shell_card_management_ap_is/models/response_delivery_address_update.rb', line 23

def main_reference
  @main_reference
end

#request_idUUID | String

Mandatory UUID (according to RFC 4122 standards) for requests and responses. This will be played back in the response from the requests.

Returns:

  • (UUID | String)


15
16
17
# File 'lib/shell_card_management_ap_is/models/response_delivery_address_update.rb', line 15

def request_id
  @request_id
end

#statusDeliveryAddressUpdateStatusEnum

Indicates overall status of the request



19
20
21
# File 'lib/shell_card_management_ap_is/models/response_delivery_address_update.rb', line 19

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/response_delivery_address_update.rb', line 62

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  request_id = hash.key?('RequestId') ? hash['RequestId'] : nil
  status = hash.key?('Status') ? hash['Status'] : nil
  main_reference = hash.key?('MainReference') ? hash['MainReference'] : 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 << (Datum.from_hash(structure) if structure)
    end
  end

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

  # Create object from extracted values.

  ResponseDeliveryAddressUpdate.new(request_id,
                                    status,
                                    main_reference,
                                    data)
end

.namesObject

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/response_delivery_address_update.rb', line 31

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

.nullablesObject

An array for nullable fields



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

def self.nullables
  []
end

.optionalsObject

An array for optional fields



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

def self.optionals
  %w[
    main_reference
    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/response_delivery_address_update.rb', line 95

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} request_id: #{@request_id.inspect}, status: #{@status.inspect},"\
  " main_reference: #{@main_reference.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/response_delivery_address_update.rb', line 88

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