Class: OrbipayPaymentsapiClient::PaymentSchedule

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(payment_recurring_type: nil, payment_recurring_count: nil, payment_amount_type: nil, payment_start_date: nil, payment_end_date: nil, payment_limit_amount: nil, payment_plan_id: nil, payment_defer_days: nil) ⇒ PaymentSchedule

Returns a new instance of PaymentSchedule.

Parameters:

  • payment_recurring_type (String) (defaults to: nil) —

    attribute in the form of String.

  • payment_recurring_count (String) (defaults to: nil) —

    attribute in the form of String.

  • payment_amount_type (String) (defaults to: nil) —

    attribute in the form of String.

  • payment_start_date (String) (defaults to: nil) —

    attribute in the form of String.

  • payment_end_date (String) (defaults to: nil) —

    attribute in the form of String.

  • payment_limit_amount (String) (defaults to: nil) —

    attribute in the form of String.

  • payment_plan_id (String) (defaults to: nil) —

    attribute in the form of String.

  • payment_defer_days (String) (defaults to: nil) —

    attribute in the form of String.



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 73

def initialize(payment_recurring_type: nil, payment_recurring_count: nil, payment_amount_type: nil, payment_start_date: nil, payment_end_date: nil, payment_limit_amount: nil, payment_plan_id: nil, payment_defer_days: nil)
    @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

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.



14
15
16
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 14

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.



34
35
36
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 34

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.



22
23
24
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 22

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.



26
27
28
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 26

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.



30
31
32
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 30

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.



10
11
12
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 10

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.



6
7
8
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 6

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.



18
19
20
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 18

def payment_start_date
  @payment_start_date
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 38

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.



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 52

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.



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 103

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



151
152
153
154
155
156
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
194
195
196
197
198
199
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 151

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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 230

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 130

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

Returns:

  • (Boolean)

See Also:

  • `==` method


117
118
119
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 117

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 123

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 



94
95
96
97
98
99
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 94

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



209
210
211
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 209

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



215
216
217
218
219
220
221
222
223
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 215

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



203
204
205
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 203

def to_s
  to_hash.to_s
end

#with_payment_limit_amount(payment_limit_amount: nil) ⇒ PaymentSchedule

Returns The Instance of PaymentSchedule.

Parameters:

  • payment_limit_amount (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



87
88
89
90
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_schedule.rb', line 87

def with_payment_limit_amount(payment_limit_amount: nil)
    @payment_limit_amount = payment_limit_amount
    self 
end