Class: CyberSource::Invoicingv2invoicesInvoiceInformation

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

Overview

Contains all of the invoice-specific fields, such as the invoice number and due date.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Invoicingv2invoicesInvoiceInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 79

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?(:'invoiceNumber')
    self.invoice_number = attributes[:'invoiceNumber']
  end

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

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

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

  if attributes.has_key?(:'sendImmediately')
    self.send_immediately = attributes[:'sendImmediately']
  else
    self.send_immediately = false
  end

  if attributes.has_key?(:'allowPartialPayments')
    self.allow_partial_payments = attributes[:'allowPartialPayments']
  else
    self.allow_partial_payments = false
  end

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

Instance Attribute Details

#allow_partial_payments ⇒ Object

If set to ‘true`, the payer can make a partial invoice payment.



33
34
35
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 33

def allow_partial_payments
  @allow_partial_payments
end

#delivery_mode ⇒ Object

If this field is set to ‘None’, an invoice will be generated with the status ‘CREATED’, but no email will be dispatched. Possible values: - ‘None` - `Email`



36
37
38
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 36

def delivery_mode
  @delivery_mode
end

#description ⇒ Object

The description included in the invoice.



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

def description
  @description
end

#due_date ⇒ Object

The invoice due date. This field is required for creating an invoice. Format: ‘YYYY-MM-DD`, where `YYYY` = year, `MM` = month, and `DD` = day



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

def due_date
  @due_date
end

#expiration_date ⇒ Object

Define an expiration date for the link. Format: ‘YYYY-MM-DD`, where `YYYY` = year, `MM` = month, and `DD` = day



27
28
29
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 27

def expiration_date
  @expiration_date
end

#invoice_number ⇒ Object

Invoice Number.



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

def invoice_number
  @invoice_number
end

#send_immediately ⇒ Object

If set to ‘true`, we send the invoice immediately. If set to `false`, the invoice remains in draft mode.



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

def send_immediately
  @send_immediately
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 39

def self.attribute_map
  {
    :'invoice_number' => :'invoiceNumber',
    :'description' => :'description',
    :'due_date' => :'dueDate',
    :'expiration_date' => :'expirationDate',
    :'send_immediately' => :'sendImmediately',
    :'allow_partial_payments' => :'allowPartialPayments',
    :'delivery_mode' => :'deliveryMode'
  }
end

.json_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 52

def self.json_map
  {
    :'invoice_number' => :'invoice_number',
    :'description' => :'description',
    :'due_date' => :'due_date',
    :'expiration_date' => :'expiration_date',
    :'send_immediately' => :'send_immediately',
    :'allow_partial_payments' => :'allow_partial_payments',
    :'delivery_mode' => :'delivery_mode'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 65

def self.swagger_types
  {
    :'invoice_number' => :'String',
    :'description' => :'String',
    :'due_date' => :'Date',
    :'expiration_date' => :'Date',
    :'send_immediately' => :'BOOLEAN',
    :'allow_partial_payments' => :'BOOLEAN',
    :'delivery_mode' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      invoice_number == o.invoice_number &&
      description == o.description &&
      due_date == o.due_date &&
      expiration_date == o.expiration_date &&
      send_immediately == o.send_immediately &&
      allow_partial_payments == o.allow_partial_payments &&
      delivery_mode == o.delivery_mode
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 201

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



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 267

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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 180

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


167
168
169
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 167

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 173

def hash
  [invoice_number, description, due_date, expiration_date, send_immediately, allow_partial_payments, delivery_mode].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



120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @due_date.nil?
    invalid_properties.push('invalid value for "due_date", due_date cannot be nil.')
  end

  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



247
248
249
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 247

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



253
254
255
256
257
258
259
260
261
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 253

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



241
242
243
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 241

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



135
136
137
138
139
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_invoice_information.rb', line 135

def valid?
  return false if @description.nil?
  return false if @due_date.nil?
  true
end