Class: CyberSource::Invoicingv2invoiceSettingsInvoiceSettingsInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Invoicingv2invoiceSettingsInvoiceSettingsInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 96

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#custom_email_message ⇒ Object

The content of the email message that we send to your customers.



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

def custom_email_message
  @custom_email_message
end

#default_currency_code ⇒ Object

Currency used for the order. Use the three-character [ISO Standard Currency Codes.](apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by Authorization Required field. **Authorization Reversal** For an authorization reversal (‘reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.



35
36
37
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 35

def default_currency_code
  @default_currency_code
end

#delivery_language ⇒ Object

The language of the email that we send to your customers. Possible values are ‘zh-CN`, `zh-TW`, `en-US`, `fr-FR`, `de-DE`, `ja-JP`, `pt-BR`, `ru-RU` and `es-419`.



32
33
34
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 32

def delivery_language
  @delivery_language
end

#enable_reminders ⇒ Object

Whether you would like us to send an auto-generated reminder email to your invoice recipients. Currently, this reminder email is sent five days before the invoice is due and one day after it is past due.



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

def enable_reminders
  @enable_reminders
end

#header_style ⇒ Object

Returns the value of attribute header_style.



29
30
31
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 29

def header_style
  @header_style
end

#merchant_display_name ⇒ Object

The merchant’s display name shown on the invoice.



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

def merchant_display_name
  @merchant_display_name
end

#merchant_logo ⇒ Object

The image file, which must be encoded in Base64 format. Supported file formats are ‘png`, `jpg`, and `gif`. The image file size restriction is 1 MB.



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

def 
  @merchant_logo
end

#payer_authentication_in_invoicing ⇒ Object

For a merchant’s invoice payments, enable 3D Secure payer authentication version 1, update to 3D Secure version 2, or disable 3D Secure. Possible values are: - ‘enable` - `update` - `disable`



38
39
40
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 38

def payer_authentication_in_invoicing
  @payer_authentication_in_invoicing
end

#show_vat_number ⇒ Object

Display VAT number on Invoice.



41
42
43
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 41

def show_vat_number
  @show_vat_number
end

#vat_registration_number ⇒ Object

Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes.



44
45
46
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 44

def vat_registration_number
  @vat_registration_number
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 47

def self.attribute_map
  {
    :'merchant_logo' => :'merchantLogo',
    :'merchant_display_name' => :'merchantDisplayName',
    :'custom_email_message' => :'customEmailMessage',
    :'enable_reminders' => :'enableReminders',
    :'header_style' => :'headerStyle',
    :'delivery_language' => :'deliveryLanguage',
    :'default_currency_code' => :'defaultCurrencyCode',
    :'payer_authentication_in_invoicing' => :'payerAuthenticationInInvoicing',
    :'show_vat_number' => :'showVatNumber',
    :'vat_registration_number' => :'vatRegistrationNumber'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'merchant_logo' => :'merchant_logo',
    :'merchant_display_name' => :'merchant_display_name',
    :'custom_email_message' => :'custom_email_message',
    :'enable_reminders' => :'enable_reminders',
    :'header_style' => :'header_style',
    :'delivery_language' => :'delivery_language',
    :'default_currency_code' => :'default_currency_code',
    :'payer_authentication_in_invoicing' => :'payer_authentication_in_invoicing',
    :'show_vat_number' => :'show_vat_number',
    :'vat_registration_number' => :'vat_registration_number'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 79

def self.swagger_types
  {
    :'merchant_logo' => :'String',
    :'merchant_display_name' => :'String',
    :'custom_email_message' => :'String',
    :'enable_reminders' => :'BOOLEAN',
    :'header_style' => :'InvoicingV2InvoiceSettingsGet200ResponseInvoiceSettingsInformationHeaderStyle',
    :'delivery_language' => :'String',
    :'default_currency_code' => :'String',
    :'payer_authentication_in_invoicing' => :'String',
    :'show_vat_number' => :'BOOLEAN',
    :'vat_registration_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      merchant_display_name == o.merchant_display_name &&
      custom_email_message == o.custom_email_message &&
      enable_reminders == o.enable_reminders &&
      header_style == o.header_style &&
      delivery_language == o.delivery_language &&
      default_currency_code == o.default_currency_code &&
      payer_authentication_in_invoicing == o.payer_authentication_in_invoicing &&
      show_vat_number == o.show_vat_number &&
      vat_registration_number == o.vat_registration_number
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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 253

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 319

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 232

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


219
220
221
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



225
226
227
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 225

def hash
  [, merchant_display_name, custom_email_message, enable_reminders, header_style, delivery_language, default_currency_code, payer_authentication_in_invoicing, show_vat_number, vat_registration_number].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



147
148
149
150
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 147

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



299
300
301
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 299

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



305
306
307
308
309
310
311
312
313
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 305

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



293
294
295
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 293

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



154
155
156
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb', line 154

def valid?
  true
end