class PS::RecurringPayment

Attributes

balance_remaining[RW]
billing_frequency_param[RW]
billing_frequency_type[RW]
customer_account_id[RW]
customer_id[RW]
date_of_last_payment_made[RW]
description[RW]
end_date[RW]
first_payment_amount[RW]
first_payment_date[RW]
first_payment_done[RW]
has_end_date[RW]
invoice_no[RW]
number_of_payment_made[RW]
number_of_payments_remaining[RW]
order_id[RW]
pause_until_date[RW]
payment_amount[RW]
schedule_status[RW]
schedule_type[RW]
start_date[RW]
total_amount_paid[RW]
total_due_amount[RW]
total_number_of_payments[RW]

Public Class Methods

create(params={}) click to toggle source
# File lib/ps/objects/recurring_payment.rb, line 38
def self.create(params={})
  recurring_payment = new(params)
  recurring_payment.save()
  return recurring_payment
end
find(schedule_id) click to toggle source
# File lib/ps/objects/recurring_payment.rb, line 56
def self.find(schedule_id)
  request("GetRecurringPaymentSchedule", { :scheduleId => schedule_id }, &instantiate_object)
end
list(start_date, end_date, customer_id, criteria=nil, filter={}) click to toggle source
# File lib/ps/objects/recurring_payment.rb, line 44
def self.list(start_date, end_date, customer_id, criteria=nil, filter={}) 
  criteria ||= { :Page => 1, :items_per_page => 12 }
  request("listrecurringpayments", 
          {
            :startDate => start_date,
            :endDate => end_date,
            :customerId => customer_id,
            :filter => filter,
            :criteria => criteria
          }, &instantiate_object)
end

Public Instance Methods

destroy() click to toggle source
# File lib/ps/objects/recurring_payment.rb, line 33
def destroy
  request("deleterecurringschedule", { :scheduleId => self.ps_reference_id })
  true
end
resume() click to toggle source
# File lib/ps/objects/recurring_payment.rb, line 28
def resume
  request("resumerecurringpaymentschedule", { :scheduleId => self.ps_reference_id }, &update_self)
  true
end
save() click to toggle source
# File lib/ps/objects/recurring_payment.rb, line 5
def save
  begin 
    save!()
    true
  rescue Exception
    false
  end
end
save!() click to toggle source
# File lib/ps/objects/recurring_payment.rb, line 14
def save!
  request("addrecurringpayment", { :recurringPayment => attributes }, &update_self)
end
suspend() click to toggle source
# File lib/ps/objects/recurring_payment.rb, line 23
def suspend
  request("suspendrecurringpaymentschedule", { :scheduleId => self.ps_reference_id }, &update_self)
  true
end
update() click to toggle source
# File lib/ps/objects/recurring_payment.rb, line 18
def update
  request("modifyrecurringpaymentschedule", { :paymentSchedule => attributes })
  true
end