rentvine 0.1.0

data/examples/ledgers.rb

@@ -0,0 +1,28 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Ledger Examples
+# =========================================
+
+search_for = 'Hays'
+rv_client.ledgers(search_for).each do |ledger|
+  puts [ledger.ledger_id, ledger.name].join(' :: ')
+end
+
+# ===========================
+
+args = {
+  search: 'Hays',
+  is_active: 1
+}
+rv_client.search_ledgers(args).each do |ledger|
+  puts ledger.name
+end

data/examples/object_types.rb

@@ -0,0 +1,15 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Assocation Examples
+# =========================================
+
+puts Rentvine::OBJECT_TYPES.first

data/examples/owners.rb

@@ -0,0 +1,17 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Owner Examples
+# =========================================
+
+rv_client.owners.each do |owner|
+  puts owner.name
+end

data/examples/portfolios.rb

@@ -0,0 +1,17 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Portfolio Examples
+# =========================================
+
+rv_client.portfolios.each do |portfolio|
+  puts portfolio.name
+end

data/examples/properties.rb

@@ -0,0 +1,75 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Property Examples
+# =========================================
+
+rv_client.properties.each do |property|
+  puts property.address
+end
+
+# ===========================
+
+property_id = 13
+rv_obj = rv_client.property(property_id)
+puts rv_obj.address
+
+# ===========================
+
+new_property = Rentvine::Property.new
+new_property.address = '123 Main St'
+new_property.city = 'Reno'
+new_property.state_id = 'NV'
+new_property.postal_code = '89509'
+new_property.county = 'Washoe'
+new_property.country_id = 'US'
+new_property.property_image_id = 1
+new_property.property_type_id = 1
+new_property.is_multi_unit = 0
+new_property.portfolio_id = 7
+new_property.management_fee_setting_id = 1
+new_property.date_time_created = '2022-07-23 22:06:17'
+new_property.reserve_amount = '1200.00'
+new_property.is_active = 1
+new_property.is_from_import = 0
+new_property.unit = {
+  rent: '1250.00',
+  deposit: '1000.00',
+  beds: '2',
+  full_baths: '1',
+  size: 988
+}
+
+new_property_saved_or_rentvine_error = rv_client.save_property(new_property)
+if new_property_saved_or_rentvine_error.is_a?(Rentvine::RentvineError)
+  puts new_property_saved_or_rentvine_error.message
+else
+  puts new_property_saved_or_rentvine_error.address
+end
+
+puts '---------------------------------'
+
+property_id = 13
+rv_client.activate_property(13)
+puts 'Property 13 activated'
+
+puts '---------------------------------'
+
+property_id = 13
+rv_client.deactivate_property(13)
+puts 'Property 13 deactivated'
+
+puts '---------------------------------'
+
+property_id = new_property_saved_or_rentvine_error.property_id
+rv_client.delete_property(property_id)
+
+puts '---------------------------------'

data/examples/tenants.rb

@@ -0,0 +1,17 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Tenant Examples
+# =========================================
+
+rv_client.tenants.each do |tenant|
+  puts tenant.name
+end

data/examples/transaction_entries.rb

@@ -0,0 +1,17 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Transaction Entry Examples
+# =========================================
+
+rv_client.transaction_entries.each do |transaction_entry|
+  puts transaction_entry.credit
+end

data/examples/transactions.rb

@@ -0,0 +1,17 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Transaction Examples
+# =========================================
+
+rv_client.transactions.each do |transaction|
+  puts transaction.description
+end

data/examples/units.rb

@@ -0,0 +1,29 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Unit Examples
+# =========================================
+
+# ===========================
+
+property_id = 13
+rv_client.units(property_id).each do |unit|
+  puts unit.address
+end
+
+# ===========================
+
+property_id = 13
+unit_id = 38
+rvu = rv_client.unit(property_id, unit_id)
+puts rvu.address
+
+# ===========================

data/examples/vendor_trades.rb

@@ -0,0 +1,36 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Vendor Trade Examples
+# =========================================
+
+rv_client.vendor_trades.each do |vendor_trade|
+  puts vendor_trade.vendor_trade_id
+end
+
+# ===========================
+
+vendor_trade_id = 1
+rv_obj = rv_client.vendor_trade(vendor_trade_id)
+puts rv_obj.vendor_trade_id
+
+# ===========================
+
+new_vendor_trade = Rentvine::WorkOrderStatus.new
+new_vendor_trade.name = 'Welding'
+new_vendor_trade.is_visible_tenant_portal = 1
+
+new_vendor_trade_saved_or_rentvine_error = rv_client.save_vendor_trade(new_vendor_trade)
+if new_vendor_trade_saved_or_rentvine_error.is_a?(Rentvine::RentvineError)
+  puts new_vendor_trade_saved_or_rentvine_error.message
+else
+  puts new_vendor_trade_saved_or_rentvine_error.vendor_trade_id
+end

data/examples/vendors.rb

@@ -0,0 +1,17 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Vendor Examples
+# =========================================
+
+rv_client.vendors.each do |vendor|
+  puts vendor.name
+end

data/examples/work_order_statuses.rb

@@ -0,0 +1,36 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Work Order Examples
+# =========================================
+
+rv_client.work_order_statuses.each do |work_order_status|
+  puts work_order_status.work_order_status_id
+end
+
+# ===========================
+
+work_order_status_id = 7
+rv_obj = rv_client.work_order_status(work_order_status_id)
+puts rv_obj.work_order_status_id
+
+# ===========================
+
+new_work_order_status = Rentvine::WorkOrderStatus.new
+new_work_order_status.primary_work_order_status_id = 1
+new_work_order_status.name = 'Wes Work Order Status'
+
+new_work_order_status_saved_or_rentvine_error = rv_client.save_work_order_status(new_work_order_status)
+if new_work_order_status_saved_or_rentvine_error.is_a?(Rentvine::RentvineError)
+  puts new_work_order_status_saved_or_rentvine_error.message
+else
+  puts new_work_order_status_saved_or_rentvine_error.work_order_status_id
+end

data/examples/work_orders.rb

@@ -0,0 +1,42 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Work Order Examples
+# =========================================
+
+rv_client.work_orders.each do |work_order|
+  puts work_order.work_order_id
+end
+
+# ===========================
+
+work_order_id = 7
+rv_obj = rv_client.work_order(work_order_id)
+puts rv_obj.work_order_id
+
+# ===========================
+
+new_work_order = Rentvine::WorkOrder.new
+new_work_order.property_id = 32
+new_work_order.work_order_status_id = 1
+new_work_order.priority_id = 1
+new_work_order.is_owner_approved = 1
+new_work_order.is_vacant = 0
+new_work_order.description = 'This is something to fix'
+new_work_order.is_shared_with_tenant = 1
+new_work_order.is_shared_with_owner = 1
+
+new_work_order_saved_or_rentvine_error = rv_client.save_work_order(new_work_order)
+if new_work_order_saved_or_rentvine_error.is_a?(Rentvine::RentvineError)
+  puts new_work_order_saved_or_rentvine_error.message
+else
+  puts new_work_order_saved_or_rentvine_error.work_order_id
+end

data/lib/rentvine/client/accounts.rb

@@ -0,0 +1,13 @@
+module Rentvine
+  class Client
+    module Accounts
+      def accounts(args = {})
+        results = process_request(:get, 'accounting/accounts', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Account.new(result[:account]) }
+      end
+      alias list_accounts accounts
+    end
+  end
+end

data/lib/rentvine/client/applications.rb

@@ -0,0 +1,18 @@
+module Rentvine
+  class Client
+    module Applications
+      def export_applications(args = {})
+        results = process_request(:get, 'screening/applications/export', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map do |result|
+          rvobj = Rentvine::Portfolio.new(result[:application])
+          rvobj.unit = Rentvine::Unit.new(result[:unit])
+          rvobj.lease = Rentvine::Lease.new(result[:lease])
+          rvobj.meta = { appends: [:unit, :lease] }
+          rvobj
+        end
+      end
+    end
+  end
+end

data/lib/rentvine/client/associations.rb

@@ -0,0 +1,13 @@
+module Rentvine
+  class Client
+    module Associations
+      def associations(args = {})
+        results = process_request(:get, 'associations/search', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Association.new(result[:contact]) }
+      end
+      alias list_associations associations
+    end
+  end
+end

data/lib/rentvine/client/bills.rb

@@ -0,0 +1,32 @@
+module Rentvine
+  class Client
+    module Bills
+      def bills(args = {})
+        results = process_request(:get, 'accounting/bills', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map do |result|
+          rvobj = Rentvine::Bill.new(result[:bill])
+          rvobj.contact = Rentvine::Vendor.new(result[:contact])
+          rvobj.meta = { appends: [:contact] }
+          rvobj
+        end
+      end
+      alias list_bills bills
+
+      def bill(bill_id)
+        result = process_request(:get, "accounting/bills/#{bill_id}")
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::Bill.new(result[:bill])
+      end
+
+      def save_bill(bill_model)
+        result = process_request(:post, 'accounting/bills', body: bill_model.to_rentvine_hash)
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::Bill.new(result[:bill])
+      end
+    end
+  end
+end

data/lib/rentvine/client/diagnostics.rb

@@ -0,0 +1,81 @@
+module Rentvine
+  class Client
+    module Diagnostics
+      def bank_account_reconciliation_lapse
+        results = process_request(:get, '/accounting/diagnostics/bank-account-reconciliation-lapse')
+        return results if results.is_a?(RentvineError)
+        results.map { |result| Rentvine::Diagnostic.new(result) }
+      end
+
+      def credit_debit_mismatch
+        results = process_request(:get, '/accounting/diagnostics/credit-debit-mismatch')
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Diagnostic.new(result) }
+      end
+
+      def escrow_mismatch
+        results = process_request(:get, '/accounting/diagnostics/escrow-mismatch')
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Diagnostic.new(result) }
+      end
+
+      def manager_ledger_balance
+        result = process_request(:get, '/accounting/diagnostics/manager-ledger-balance')
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::Diagnostic.new(result)
+      end
+
+      def negative_bank_accounts
+        results = process_request(:get, '/accounting/diagnostics/negative-bank-accounts')
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Diagnostic.new(result) }
+      end
+
+      def prepayment_mismatch
+        results = process_request(:get, '/accounting/diagnostics/prepayment-mismatch')
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Diagnostic.new(result) }
+      end
+
+      def reserve_not_met
+        results = process_request(:get, '/accounting/diagnostics/reserve-not-met')
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Diagnostic.new(result) }
+      end
+
+      def suppressed_fee_balance_mismatch
+        results = process_request(:get, '/accounting/diagnostics/suppressed-fee-balance-mismatch')
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Diagnostic.new(result) }
+      end
+
+      def unused_prepayments
+        results = process_request(:get, '/accounting/diagnostics/unused-prepayments')
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Diagnostic.new(result) }
+      end
+
+      def unused_vendor_credits
+        results = process_request(:get, '/accounting/diagnostics/unused-vendor-credits')
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Diagnostic.new(result) }
+      end
+
+      def vendor_insurance_lapse
+        results = process_request(:get, '/accounting/diagnostics/vendor-insurance-lapse')
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Diagnostic.new(result) }
+      end
+    end
+  end
+end

data/lib/rentvine/client/files.rb

@@ -0,0 +1,37 @@
+module Rentvine
+  class Client
+    module Files
+      def files(args = {})
+        results = process_request(:get, 'files', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::File.new(result[:file]) }
+      end
+      alias list_files files
+
+      def file(file_id)
+        result = process_request(:get, "files/#{file_id}")
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::File.new(result[:file])
+      end
+
+      def upload_file(path_to_file, object_type_id, object_id)
+        result = process_file(
+          path_to_file,
+          { object_type_id: object_type_id, object_id: object_id }
+        )
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::File.new(result[:file])
+      end
+
+      def delete_file(file_id)
+        result = process_request(:delete, "files/#{file_id}")
+        return result if result.is_a?(RentvineError)
+
+        true
+      end
+    end
+  end
+end

data/lib/rentvine/client/inspections.rb

@@ -0,0 +1,27 @@
+module Rentvine
+  class Client
+    module Inspections
+      def inspections(args = {})
+        results = process_request(:get, 'maintenance/inspections', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Inspection.new(result[:inspection]) }
+      end
+      alias list_inspections inspections
+
+      def inspection(inspection_id)
+        result = process_request(:get, "maintenance/inspections/#{inspection_id}")
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::Inspection.new(result[:inspection])
+      end
+
+      def save_inspection(inspection_model)
+        result = process_request(:post, '/maintenance/inspections', body: inspection_model.to_rentvine_hash)
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::Inspection.new(result[:inspection])
+      end
+    end
+  end
+end

data/lib/rentvine/client/leases.rb

@@ -0,0 +1,20 @@
+module Rentvine
+  class Client
+    module Leases
+      def leases(args = {})
+        results = process_request(:get, 'leases', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Lease.new(result[:lease]) }
+      end
+      alias list_leases leases
+
+      def lease(lease_id)
+        result = process_request(:get, "leases/#{lease_id}")
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::Lease.new(result[:lease])
+      end
+    end
+  end
+end

data/lib/rentvine/client/ledgers.rb

@@ -0,0 +1,25 @@
+module Rentvine
+  class Client
+    module Ledgers
+      def ledgers(search)
+        results = process_request(:get, 'accounting/ledgers', params: { search: search })
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Ledger.new(result[:ledger]) }
+      end
+      alias list_ledgers ledgers
+
+      def search_ledgers(args = {})
+        results = process_request(:get, 'accounting/ledgers/search', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map do |result|
+          rvobj = Rentvine::Ledger.new(result[:ledger])
+          rvobj.unit = Rentvine::Unit.new(result[:unit])
+          rvobj.meta = { appends: [:unit] }
+          rvobj
+        end
+      end
+    end
+  end
+end

data/lib/rentvine/client/owners.rb

@@ -0,0 +1,13 @@
+module Rentvine
+  class Client
+    module Owners
+      def owners(args = {})
+        results = process_request(:get, 'owners/search', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Owner.new(result[:contact]) }
+      end
+      alias list_owners owners
+    end
+  end
+end