Class: CyberSource::InvoicingV2InvoicesAllGet200ResponseInvoices

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb

Overview

A list of invoices.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvoicingV2InvoicesAllGet200ResponseInvoices

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



58
59
60
61
62
63
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/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 58

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'_links')
    self._links = attributes[:'_links']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'customerInformation')
    self.customer_information = attributes[:'customerInformation']
  end

  if attributes.has_key?(:'invoiceInformation')
    self.invoice_information = attributes[:'invoiceInformation']
  end

  if attributes.has_key?(:'orderInformation')
    self.order_information = attributes[:'orderInformation']
  end
end

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



18
19
20
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 18

def _links
  @_links
end

#customer_information ⇒ Object

Returns the value of attribute customer_information.



26
27
28
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 26

def customer_information
  @customer_information
end

#id ⇒ Object

An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response.



21
22
23
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 21

def id
  @id
end

#invoice_information ⇒ Object

Returns the value of attribute invoice_information.



28
29
30
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 28

def invoice_information
  @invoice_information
end

#order_information ⇒ Object

Returns the value of attribute order_information.



30
31
32
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 30

def order_information
  @order_information
end

#status ⇒ Object

The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED



24
25
26
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 24

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 33

def self.attribute_map
  {
    :'_links' => :'_links',
    :'id' => :'id',
    :'status' => :'status',
    :'customer_information' => :'customerInformation',
    :'invoice_information' => :'invoiceInformation',
    :'order_information' => :'orderInformation'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 45

def self.swagger_types
  {
    :'_links' => :'InvoicingV2InvoicesAllGet200ResponseLinks1',
    :'id' => :'String',
    :'status' => :'String',
    :'customer_information' => :'InvoicingV2InvoicesAllGet200ResponseCustomerInformation',
    :'invoice_information' => :'InvoicingV2InvoicesAllGet200ResponseInvoiceInformation',
    :'order_information' => :'InvoicingV2InvoicesAllGet200ResponseOrderInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 110

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _links == o._links &&
      id == o.id &&
      status == o.status &&
      customer_information == o.customer_information &&
      invoice_information == o.invoice_information &&
      order_information == o.order_information
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 157

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 223

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 136

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


123
124
125
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 123

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 129

def hash
  [_links, id, status, customer_information, invoice_information, order_information].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



91
92
93
94
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 91

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



203
204
205
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 203

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



209
210
211
212
213
214
215
216
217
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 209

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



197
198
199
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 197

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



98
99
100
 
# File 'lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb', line 98

def valid?
  true
end