Class: Rentvine::Client

Inherits:
Object
  • Object
show all
Includes:
Accounts, Applications, Associations, Bills, Diagnostics, Files, Inspections, LeaseStatuses, Leases, Ledgers, Owners, Portfolios, Properties, RecurringCharges, Tenants, TransactionEntries, Transactions, Units, VendorTrades, Vendors, WorkOrderStatuses, WorkOrders
Defined in:
lib/rentvine/client.rb,
lib/rentvine/client/bills.rb,
lib/rentvine/client/files.rb,
lib/rentvine/client/units.rb,
lib/rentvine/client/leases.rb,
lib/rentvine/client/owners.rb,
lib/rentvine/client/ledgers.rb,
lib/rentvine/client/tenants.rb,
lib/rentvine/client/vendors.rb,
lib/rentvine/client/accounts.rb,
lib/rentvine/client/portfolios.rb,
lib/rentvine/client/properties.rb,
lib/rentvine/client/diagnostics.rb,
lib/rentvine/client/inspections.rb,
lib/rentvine/client/work_orders.rb,
lib/rentvine/client/applications.rb,
lib/rentvine/client/associations.rb,
lib/rentvine/client/transactions.rb,
lib/rentvine/client/vendor_trades.rb,
lib/rentvine/client/lease_statuses.rb,
lib/rentvine/client/recurring_charges.rb,
lib/rentvine/client/transaction_entries.rb,
lib/rentvine/client/work_order_statuses.rb

Defined Under Namespace

Modules: Accounts, Applications, Associations, Bills, Diagnostics, Files, Inspections, LeaseStatuses, Leases, Ledgers, Owners, Portfolios, Properties, RecurringCharges, Tenants, TransactionEntries, Transactions, Units, VendorTrades, Vendors, WorkOrderStatuses, WorkOrders

Instance Method Summary collapse

Methods included from WorkOrders

#save_work_order, #work_order, #work_orders

Methods included from WorkOrderStatuses

#save_work_order_status, #work_order_status, #work_order_statuses

Methods included from Vendors

#vendors

Methods included from VendorTrades

#save_vendor_trade, #vendor_trade, #vendor_trades

Methods included from Units

#export_units, #unit, #units

Methods included from Transactions

#transactions

Methods included from TransactionEntries

#transaction_entries

Methods included from Tenants

#tenant, #tenants

Methods included from RecurringCharges

#recurring_charge, #recurring_charges

Methods included from Properties

#activate_property, #deactivate_property, #delete_property, #export_properties, #properties, #property, #save_property

Methods included from Portfolios

#portfolios

Methods included from Owners

#owners

Methods included from Ledgers

#ledgers, #search_ledgers

Methods included from LeaseStatuses

#lease_status, #lease_statuses

Methods included from Leases

#export_leases, #lease, #lease_occupants, #lease_tenants, #leases

Methods included from Inspections

#inspection, #inspections, #save_inspection

Methods included from Files

#delete_file, #file, #files, #upload_file

Methods included from Diagnostics

#bank_account_reconciliation_lapse, #credit_debit_mismatch, #escrow_mismatch, #manager_ledger_balance, #negative_bank_accounts, #prepayment_mismatch, #reserve_not_met, #suppressed_fee_balance_mismatch, #unused_prepayments, #unused_vendor_credits, #vendor_insurance_lapse

Methods included from Bills

#bill, #bills, #save_bill

Methods included from Associations

#associations

Methods included from Applications

#export_applications

Methods included from Accounts

#accounts

Constructor Details

#initialize(auth = nil) ⇒ Client

Returns a new instance of Client.



76
77
78
79
80
81
82
 
# File 'lib/rentvine/client.rb', line 76

def initialize(auth = nil)
  @auth = auth || load_from_environment

  if @auth.nil?
    raise RentvineError, 'API authentication incomplete! You need the account code, api key and api secret.'
  end
end