Class: XeroRuby::Accounting::PaymentService

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/accounting/payment_service.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentService

Initializes the object

Parameters:

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

    Model attributes in the form of hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 64

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::PaymentService` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Accounting::PaymentService`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'payment_service_id')
    self.payment_service_id = attributes[:'payment_service_id']
  end

  if attributes.key?(:'payment_service_name')
    self.payment_service_name = attributes[:'payment_service_name']
  end

  if attributes.key?(:'payment_service_url')
    self.payment_service_url = attributes[:'payment_service_url']
  end

  if attributes.key?(:'pay_now_text')
    self.pay_now_text = attributes[:'pay_now_text']
  end

  if attributes.key?(:'payment_service_type')
    self.payment_service_type = attributes[:'payment_service_type']
  end

  if attributes.key?(:'validation_errors')
    if (value = attributes[:'validation_errors']).is_a?(Array)
      self.validation_errors = value
    end
  end
end

Instance Attribute Details

#pay_now_text ⇒ Object

The text displayed on the Pay Now button in Xero Online Invoicing. If this is not set it will default to Pay by credit card



30
31
32
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 30

def pay_now_text
  @pay_now_text
end

#payment_service_id ⇒ Object

Xero identifier



21
22
23
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 21

def payment_service_id
  @payment_service_id
end

#payment_service_name ⇒ Object

Name of payment service



24
25
26
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 24

def payment_service_name
  @payment_service_name
end

#payment_service_type ⇒ Object

This will always be CUSTOM for payment services created via the API.



33
34
35
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 33

def payment_service_type
  @payment_service_type
end

#payment_service_url ⇒ Object

The custom payment URL



27
28
29
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 27

def payment_service_url
  @payment_service_url
end

#validation_errors ⇒ Object

Displays array of validation error messages from the API



36
37
38
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 36

def validation_errors
  @validation_errors
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
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 39

def self.attribute_map
  {
    :'payment_service_id' => :'PaymentServiceID',
    :'payment_service_name' => :'PaymentServiceName',
    :'payment_service_url' => :'PaymentServiceUrl',
    :'pay_now_text' => :'PayNowText',
    :'payment_service_type' => :'PaymentServiceType',
    :'validation_errors' => :'ValidationErrors'
  }
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



145
146
147
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 145

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 51

def self.openapi_types
  {
    :'payment_service_id' => :'String',
    :'payment_service_name' => :'String',
    :'payment_service_url' => :'String',
    :'pay_now_text' => :'String',
    :'payment_service_type' => :'String',
    :'validation_errors' => :'Array<ValidationError>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 119

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_service_id == o.payment_service_id &&
      payment_service_name == o.payment_service_name &&
      payment_service_url == o.payment_service_url &&
      pay_now_text == o.pay_now_text &&
      payment_service_type == o.payment_service_type &&
      validation_errors == o.validation_errors
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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 173

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::Accounting.const_get(type).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



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 240

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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 152

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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


132
133
134
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 132

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



138
139
140
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 138

def hash
  [payment_service_id, payment_service_name, payment_service_url, pay_now_text, payment_service_type, validation_errors].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



106
107
108
109
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 106

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object

customized data_parser



255
256
257
258
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 255

def parse_date(datestring)
  seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
  return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



220
221
222
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 220

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



226
227
228
229
230
231
232
233
234
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 226

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



214
215
216
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 214

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



113
114
115
 
# File 'lib/xero-ruby/models/accounting/payment_service.rb', line 113

def valid?
  true
end