gotransverse-tract-api 0.5.2 → 0.5.3

data/lib/gotransverse-tract-api/billing_account/refund.rb

@@ -10,58 +10,66 @@ module GoTransverseTractApi
 
       #
       # @param {Long} eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_eid eid
-        GoTransverseTractApi.get_response_for(self, {eid: eid})
+      def self.find_by_eid eid, query_scope=nil 
+        GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
       end
 
       #
       # @param {Long} payment_eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_payment_eid payment_eid
-        GoTransverseTractApi.get_response_for(self, {payment_eid: payment_eid})
+      def self.find_by_payment_eid payment_eid, query_scope=nil 
+        GoTransverseTractApi.get_response_for(self, {payment_eid: payment_eid, queryScope: query_scope})
       end
 
       #
       # @param {String} account_num
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_account_num account_num
-        GoTransverseTractApi.get_response_for(self, {account_num: account_num})
+      def self.find_by_account_num account_num, query_scope=nil 
+        GoTransverseTractApi.get_response_for(self, {account_num: account_num, queryScope: query_scope})
       end
 
       #
       # @param {Long} billing_account_eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_billing_account_eid billing_account_eid
-        GoTransverseTractApi.get_response_for(self, {billing_account_eid: billing_account_eid})
+      def self.find_by_billing_account_eid billing_account_eid, query_scope=nil 
+        GoTransverseTractApi.get_response_for(self, {billing_account_eid: billing_account_eid, queryScope: query_scope})
       end
 
       #
       # @param {DateTime} occured_on
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_occured_on occured_on
-        GoTransverseTractApi.get_response_for(self, {occured_on: occured_on})
+      def self.find_by_occured_on occured_on, query_scope=nil 
+        GoTransverseTractApi.get_response_for(self, {occured_on: occured_on, queryScope: query_scope})
       end
 
       #
       # @param {String} reference
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_reference reference
-        GoTransverseTractApi.get_response_for(self, {reference: reference})
+      def self.find_by_reference reference, query_scope=nil 
+        GoTransverseTractApi.get_response_for(self, {reference: reference, queryScope: query_scope})
       end
 
       #
       # @param {String} status
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_status status
-        GoTransverseTractApi.get_response_for(self, {status: status})
+      def self.find_by_status status, query_scope=nil 
+        GoTransverseTractApi.get_response_for(self, {status: status, queryScope: query_scope})
       end
 
       #
       # @param {String} authorization
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_authorization authorization
-        GoTransverseTractApi.get_response_for(self, {authorization: authorization})
+      def self.find_by_authorization authorization, query_scope=nil 
+        GoTransverseTractApi.get_response_for(self, {authorization: authorization, queryScope: query_scope})
       end
 
       #

data/lib/gotransverse-tract-api/billing_account/scheduled_charge.rb

@@ -12,32 +12,53 @@ module GoTransverseTractApi
 
         #
         # @param {Long} eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_eid eid
-          GoTransverseTractApi.get_response_for(self, {eid: eid})
+        def find_by_eid eid, query_scope=nil 
+          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} service_price_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_service_price_eid service_price_eid
-          GoTransverseTractApi.get_response_for(self, {service_price_eid: service_price_eid})
+        def find_by_service_price_eid service_price_eid, query_scope=nil 
+          GoTransverseTractApi.get_response_for(self, {service_price_eid: service_price_eid, queryScope: query_scope})
         end
 
         #
         # @param {Boolean} invoiced
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_invoiced invoiced
-          GoTransverseTractApi.get_response_for(self, {invoiced: invoiced})
+        def find_by_invoiced invoiced, query_scope=nil 
+          GoTransverseTractApi.get_response_for(self, {invoiced: invoiced, queryScope: query_scope})
         end
 
         #
         # @param {Long} order_item_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_order_item_eid order_item_eid
-          GoTransverseTractApi.get_response_for(self, {order_item_eid: order_item_eid})
+        def find_by_order_item_eid order_item_eid, query_scope=nil 
+          GoTransverseTractApi.get_response_for(self, {order_item_eid: order_item_eid, queryScope: query_scope})
         end
 
+        #
+        # @param {Hash} scheduled_charges
+        #
+        def self.get_scheduled_charges scheduled_charges
+          sch_charges = {
+            attributes: api_data.get_page_info(scheduled_charges),
+            scheduleCharge: {
+              eid: scheduled_charges[:eid],
+              description: scheduled_charges[:description],
+              amount: scheduled_charges[:amount],
+              invoiced: scheduled_charges[:invoiced],
+              chargeDate: scheduled_charges[:charge_date]
+            }
+          }
+
+          sch_charges.delete_if{|k,v| v.nil?}
+        end
       end
 
     end

data/lib/gotransverse-tract-api/billing_account/standard_invoice_adjustment_application.rb

@@ -8,16 +8,18 @@ module GoTransverseTractApi
 
         #
         # @param {Long} invoice_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_invoice_eid invoice_eid
-          GoTransverseTractApi.get_response_for(self, {invoice_eid: invoice_eid})
+        def find_by_invoice_eid invoice_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {invoice_eid: invoice_eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} invoice_num
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_invoice_num invoice_num
-          GoTransverseTractApi.get_response_for(self, {invoice_num: invoice_num})
+        def find_by_invoice_num invoice_num, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {invoice_num: invoice_num, queryScope: query_scope})
         end
 
       end

data/lib/gotransverse-tract-api/general_ledger/general_ledger.rb

@@ -10,27 +10,30 @@ module GoTransverseTractApi
 
       #
       # @param {Long} eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_eid eid
-        GoTransverseTractApi.get_response_for(self, {eid: eid})
+      def self.find_by_eid eid, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
       end
 
       #
       # @param {String} name
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_name name
-        GoTransverseTractApi.get_response_for(self, {name: name})
+      def self.find_by_name name, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {name: name, queryScope: query_scope})
       end
 
       #
       # @param {String} status
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_status status
-        GoTransverseTractApi.get_response_for(self, {status: status})
+      def self.find_by_status status, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {status: status, queryScope: query_scope})
       end
 
     end
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/general_ledger/gl_account.rb

@@ -6,34 +6,38 @@ module GoTransverseTractApi
 
       #
       # @param {Long} eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_eid eid
-        GoTransverseTractApi.get_response_for(self, {eid: eid})
+      def self.find_by_eid eid, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
       end
 
       #
       # @param {Long} general_ledger_eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_general_ledger_eid general_ledger_eid
-        GoTransverseTractApi.get_response_for(self, {general_ledger_eid: general_ledger_eid})
+      def self.find_by_general_ledger_eid general_ledger_eid, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {general_ledger_eid: general_ledger_eid, queryScope: query_scope})
       end
 
       #
       # @param {String} name
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_name name
-        GoTransverseTractApi.get_response_for(self, {name: name})
+      def self.find_by_name name, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {name: name, queryScope: query_scope})
       end
 
       #
       # @param {String} account_num
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_account_num account_num
-        GoTransverseTractApi.get_response_for(self, {account_num: account_num})
+      def self.find_by_account_num account_num, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {account_num: account_num, queryScope: query_scope})
       end
 
     end
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/general_ledger/gl_account_category.rb

@@ -6,27 +6,30 @@ module GoTransverseTractApi
 
       #
       # @param {Long} eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_eid eid
-        GoTransverseTractApi.get_response_for(self, {eid: eid})
+      def self.find_by_eid eid, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
       end
 
       #
       # @param {String} name
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_name name
-        GoTransverseTractApi.get_response_for(self, {name: name})
+      def self.find_by_name name, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {name: name, queryScope: query_scope})
       end
 
       #
       # @param {String} status
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_status status
-        GoTransverseTractApi.get_response_for(self, {status: status})
+      def self.find_by_status status, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {status: status, queryScope: query_scope})
       end
 
     end
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/general_ledger/gl_accounting_entry.rb

@@ -8,44 +8,50 @@ module GoTransverseTractApi
 
         #
         # @param {Long} eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_eid eid
-          GoTransverseTractApi.get_response_for(self, {eid: eid})
+        def find_by_eid eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} gl_account_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_gl_account_eid gl_account_eid
-          GoTransverseTractApi.get_response_for(self, {gl_account_eid: gl_account_eid})
+        def find_by_gl_account_eid gl_account_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {gl_account_eid: gl_account_eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} gl_accounting_transaction_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_gl_accounting_transaction_eid gl_accounting_transaction_eid
-          GoTransverseTractApi.get_response_for(self, {gl_accounting_transaction_eid: gl_accounting_transaction_eid})
+        def find_by_gl_accounting_transaction_eid gl_accounting_transaction_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {gl_accounting_transaction_eid: gl_accounting_transaction_eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} gl_transaction_batch_num
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_gl_transaction_batch_num gl_transaction_batch_num
-          GoTransverseTractApi.get_response_for(self, {gl_transaction_batch_num: gl_transaction_batch_num})
+        def find_by_gl_transaction_batch_num gl_transaction_batch_num, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {gl_transaction_batch_num: gl_transaction_batch_num, queryScope: query_scope})
         end
 
         #
         # @param {Long} gl_aggregate_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_gl_aggregate_eid gl_aggregate_eid
-          GoTransverseTractApi.get_response_for(self, {gl_aggregate_eid: gl_aggregate_eid})
+        def find_by_gl_aggregate_eid gl_aggregate_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {gl_aggregate_eid: gl_aggregate_eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} gl_aggregate_batch_num
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_gl_aggregate_batch_num gl_aggregate_batch_num
-          GoTransverseTractApi.get_response_for(self, {gl_aggregate_batch_num: gl_aggregate_batch_num})
+        def find_by_gl_aggregate_batch_num gl_aggregate_batch_num, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {gl_aggregate_batch_num: gl_aggregate_batch_num, queryScope: query_scope})
         end
 
       end

data/lib/gotransverse-tract-api/general_ledger/gl_accounting_transaction.rb

@@ -8,51 +8,58 @@ module GoTransverseTractApi
 
         #
         # @param {Long} eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def self.find_by_eid eid
-          GoTransverseTractApi.get_response_for(self, {eid: eid})
+        def self.find_by_eid eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} gl_transaction_batch_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def self.find_by_gl_transaction_batch_eid gl_transaction_batch_eid
-          GoTransverseTractApi.get_response_for(self, {gl_transaction_batch_eid: gl_transaction_batch_eid})
+        def self.find_by_gl_transaction_batch_eid gl_transaction_batch_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {gl_transaction_batch_eid: gl_transaction_batch_eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} batch_num
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def self.find_by_batch_num batch_num
-          GoTransverseTractApi.get_response_for(self, {batch_num: batch_num})
+        def self.find_by_batch_num batch_num, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {batch_num: batch_num, queryScope: query_scope})
         end
 
         #
         # @param {Date} batch_posted_on
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def self.find_by_batch_posted_on batch_posted_on
-          GoTransverseTractApi.get_response_for(self, {batch_posted_on: batch_posted_on})
+        def self.find_by_batch_posted_on batch_posted_on, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {batch_posted_on: batch_posted_on, queryScope: query_scope})
         end
 
         #
         # @param {Date} occurred_on
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def self.find_by_occurred_on occurred_on
-          GoTransverseTractApi.get_response_for(self, {occurred_on: occurred_on})
+        def self.find_by_occurred_on occurred_on, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {occurred_on: occurred_on, queryScope: query_scope})
         end
 
         #
         # @param {String} currency_type
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def self.find_by_currency_type currency_type
-          GoTransverseTractApi.get_response_for(self, {currency_type: currency_type})
+        def self.find_by_currency_type currency_type, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {currency_type: currency_type, queryScope: query_scope})
         end
 
         #
         # @param {String} original_currency_type
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def self.find_by_original_currency_type original_currency_type
-          GoTransverseTractApi.get_response_for(self, {original_currency_type: original_currency_type})
+        def self.find_by_original_currency_type original_currency_type, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {original_currency_type: original_currency_type, queryScope: query_scope})
         end
 
       end

data/lib/gotransverse-tract-api/general_ledger/gl_adjustment_accounting_transaction.rb

@@ -8,51 +8,58 @@ module GoTransverseTractApi
 
         #
         # @param {Long} eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_eid eid
-          GoTransverseTractApi.get_response_for(self, {eid: eid})
+        def find_by_eid eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} batch_num
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_batch_num batch_num
-          GoTransverseTractApi.get_response_for(self, {batch_num: batch_num})
+        def find_by_batch_num batch_num, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {batch_num: batch_num, queryScope: query_scope})
         end
 
         #
         # @param {Long} gl_transaction_batch_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_gl_transaction_batch_eid gl_transaction_batch_eid
-          GoTransverseTractApi.get_response_for(self, {gl_transaction_batch_eid: gl_transaction_batch_eid})
+        def find_by_gl_transaction_batch_eid gl_transaction_batch_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {gl_transaction_batch_eid: gl_transaction_batch_eid, queryScope: query_scope})
         end
 
         #
         # @param {String} currency_type
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_currency_type currency_type
-          GoTransverseTractApi.get_response_for(self, {currency_type: currency_type})
+        def find_by_currency_type currency_type, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {currency_type: currency_type, queryScope: query_scope})
         end
 
         #
         # @param {String} original_currency_type
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_original_currency_type original_currency_type
-          GoTransverseTractApi.get_response_for(self, {original_currency_type: original_currency_type})
+        def find_by_original_currency_type original_currency_type, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {original_currency_type: original_currency_type, queryScope: query_scope})
         end
 
         #
         # @param {DateTime} occurred_on
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_occurred_on occurred_on
-          GoTransverseTractApi.get_response_for(self, {occurred_on: occurred_on})
+        def find_by_occurred_on occurred_on, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {occurred_on: occurred_on, queryScope: query_scope})
         end
 
         #
         # @param {DateTime} batch_posted_on
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_batch_posted_on batch_posted_on
-          GoTransverseTractApi.get_response_for(self, {batch_posted_on: batch_posted_on})
+        def find_by_batch_posted_on batch_posted_on, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {batch_posted_on: batch_posted_on, queryScope: query_scope})
         end
 
       end