Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::PaymentScheduleVo

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb

Overview

.

############################################################################################
## This class subject to change without prior notice, Please dont use this class directly.##
############################################################################################

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentScheduleVo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
117
118
119
120
121
122
123
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 86

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

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

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

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

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

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

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

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

Instance Attribute Details

#payment_amount_type ⇒ String (readonly)

The amount type that is used to set the amount for payments created as part of a recurring payment or autopay setup. In the case of a recurring payment setup, the payment amount can be specified by the customer. In that case, the payment_amount_type should not be sent as it would default to 'other'. In the case of an autopay setup, the payment amount type is mandatory and it cannot be specified as 'other'. In this case, the payment amount should not be sent.

Returns:

  • (String) —

    The attribute payment_amount_type.



34
35
36
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 34

def payment_amount_type
  @payment_amount_type
end

#payment_defer_days ⇒ String (readonly)

The number of days from the bill due date that the customer wishes to delay the autopay payment by. By default an autopay payment is drafted on the bill due date.

Returns:

  • (String) —

    The attribute payment_defer_days.



54
55
56
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 54

def payment_defer_days
  @payment_defer_days
end

#payment_end_date ⇒ String (readonly)

The date by which the last payment will be drafted as part of a recurring payment setup. This is to be specified in the ISO8601 full-date format, namely, YYYY-MM-DD. This cannot be specified for autopay setups.

Returns:

  • (String) —

    The attribute payment_end_date.



42
43
44
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 42

def payment_end_date
  @payment_end_date
end

#payment_limit_amount ⇒ String (readonly)

The upper limit for the payment amount in the case of recurring or autopay payments. Any amount above the limit will not be paid automatically as part of recurring payments and autopay.

Returns:

  • (String) —

    The attribute payment_limit_amount.



46
47
48
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 46

def payment_limit_amount
  @payment_limit_amount
end

#payment_plan_id ⇒ String (readonly)

The reference to the payment plan, offered by the biller, that is used to set up the recurring payment. The list of payment plans offered is published as part of the biller set-up.

Returns:

  • (String) —

    The attribute payment_plan_id.



50
51
52
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 50

def payment_plan_id
  @payment_plan_id
end

#payment_recurring_count ⇒ String (readonly)

The maximum number of payments that can be created as part of a recurring payment setup. This cannot be specified for autopay setups.

Returns:

  • (String) —

    The attribute payment_recurring_count.



30
31
32
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 30

def payment_recurring_count
  @payment_recurring_count
end

#payment_recurring_type ⇒ String (readonly)

The frequency of the payments created as part of a payment setup. This is applicable only for recurring payment setup, in which case it is mandatory.

Returns:

  • (String) —

    The attribute payment_recurring_type.



26
27
28
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 26

def payment_recurring_type
  @payment_recurring_type
end

#payment_start_date ⇒ String (readonly)

The date on which the first payment will be drafted as part of a recurring payment setup. This is to be specified in the ISO8601 full-date format, namely, YYYY-MM-DD. This is mandatory for recurring payment setup. This cannot be specified for autopay setups.

Returns:

  • (String) —

    The attribute payment_start_date.



38
39
40
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 38

def payment_start_date
  @payment_start_date
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 57

def self.attribute_map
  {
    :'payment_recurring_type' => :'payment_recurring_type',
    :'payment_recurring_count' => :'payment_recurring_count',
    :'payment_amount_type' => :'payment_amount_type',
    :'payment_start_date' => :'payment_start_date',
    :'payment_end_date' => :'payment_end_date',
    :'payment_limit_amount' => :'payment_limit_amount',
    :'payment_plan_id' => :'payment_plan_id',
    :'payment_defer_days' => :'payment_defer_days'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 71

def self.swagger_types
  {
    :'payment_recurring_type' => :'String',
    :'payment_recurring_count' => :'String',
    :'payment_amount_type' => :'String',
    :'payment_start_date' => :'String',
    :'payment_end_date' => :'String',
    :'payment_limit_amount' => :'String',
    :'payment_plan_id' => :'String',
    :'payment_defer_days' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_recurring_type == o.payment_recurring_type &&
      payment_recurring_count == o.payment_recurring_count &&
      payment_amount_type == o.payment_amount_type &&
      payment_start_date == o.payment_start_date &&
      payment_end_date == o.payment_end_date &&
      payment_limit_amount == o.payment_limit_amount &&
      payment_plan_id == o.payment_plan_id &&
      payment_defer_days == o.payment_defer_days
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (string) —

    Data type

  • value (string) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 185

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    if value.nil?
      value
    else
      value.to_s
    end
  when :Integer
    if value.nil?
      value
    else
      value.to_i
    end
  when :Float
    if value.nil?
      value
    else
      value.to_f
    end
  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 = OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash, Object

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

  • (Object) —

    Returns the object if it cannot be converted to hash



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 264

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 164

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

  • o (Object) —

    Object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


151
152
153
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 157

def hash
  [payment_recurring_type, payment_recurring_count, payment_amount_type, payment_start_date, payment_end_date, payment_limit_amount, payment_plan_id, payment_defer_days].hash
end

#set_values(args) ⇒ Object 



126
127
128
129
130
131
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 126

def set_values(args)
  args.each do |attr, arg|
    (class << self; self; end).send(:attr_reader, attr.to_sym)
    instance_variable_set("@#{attr}", arg)
  end
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



243
244
245
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 243

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



249
250
251
252
253
254
255
256
257
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 249

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



237
238
239
 
# File 'lib/orbipay_paymentsapi_client/models/payment_schedule_vo.rb', line 237

def to_s
  to_hash.to_s
end