gotransverse-tract-api 0.5.2 → 0.5.3

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

@@ -12,37 +12,42 @@ 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 {String} name
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_name name
-          GoTransverseTractApi.get_response_for(self, {name: name})
+        def find_by_name name, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {name: name, queryScope: query_scope})
         end
 
         #
         # @param {String} type
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_type type
-          GoTransverseTractApi.get_response_for(self, {type: type})
+        def find_by_type type, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {type: type, queryScope: query_scope})
         end
 
         #
         # @param {Boolean} enabled
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_enabled enabled
-          GoTransverseTractApi.get_response_for(self, {enabled: enabled})
+        def find_by_enabled enabled, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {enabled: enabled, queryScope: query_scope})
         end
 
         #
         # @param {Boolean} searchable
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_searchable searchable
-          GoTransverseTractApi.get_response_for(self, {searchable: searchable})
+        def find_by_searchable searchable, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {searchable: searchable, queryScope: query_scope})
         end
 
       end

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

@@ -12,81 +12,106 @@ 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} account_num
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_account_num account_num
-          GoTransverseTractApi.get_response_for(self, {account_num: account_num})
+        def find_by_account_num account_num, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {account_num: account_num, queryScope: query_scope})
         end
 
         #
         # @param {Long} external_account_num
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_external_account_num external_account_num
-          GoTransverseTractApi.get_response_for(self, {external_account_num: external_account_num})
+        def find_by_external_account_num external_account_num, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {external_account_num: external_account_num, queryScope: query_scope})
         end
 
         #
         # @param {Long} billing_account_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_billing_account_eid billing_account_eid
-          GoTransverseTractApi.get_response_for(self, {billing_account_eid: billing_account_eid})
+        def 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 {Long} custom_field_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_custom_field_eid custom_field_eid
-          GoTransverseTractApi.get_response_for(self, {custom_field_eid: custom_field_eid})
+        def find_by_custom_field_eid custom_field_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {custom_field_eid: custom_field_eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} order_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_order_eid order_eid
-          GoTransverseTractApi.get_response_for(self, {order_eid: order_eid})
+        def find_by_order_eid order_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {order_eid: order_eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} service_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_service_eid service_eid
-          GoTransverseTractApi.get_response_for(self, {service_eid: service_eid})
+        def find_by_service_eid service_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {service_eid: service_eid, 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 {Long} order_num
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_order_num order_num
-          GoTransverseTractApi.get_response_for(self, {order_num: order_num})
+        def find_by_order_num order_num, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {order_num: order_num, queryScope: query_scope})
         end
 
         #
         # @param {String} custom_field_name
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_custom_field_name custom_field_name
-          GoTransverseTractApi.get_response_for(self, {custom_field_name: custom_field_name})
+        def find_by_custom_field_name custom_field_name, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {custom_field_name: custom_field_name, queryScope: query_scope})
         end
 
         #
         # @param {Long} value
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_value value
-          GoTransverseTractApi.get_response_for(self, {value: value})
+        def find_by_value value, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {value: value, queryScope: query_scope})
         end
 
+        #
+        # @param {Hash} obj (Order or Service or Billing Account)
+        #
+        def get_custom_field_values(obj={})
+          custom_field_values = {
+            attributes: {},
+            customFieldValue: {
+              attributes: {value: obj[:custom_field_value][:value]},
+              customField: {eid: obj[:custom_field_value][:custom_field][:eid]}
+            }
+          }
+
+          custom_field_values
+        end
       end
 
     end

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

@@ -8,67 +8,76 @@ 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} account_num
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_account_num account_num
-          GoTransverseTractApi.get_response_for(self, {account_num: account_num})
+        def 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 find_by_billing_account_eid billing_account_eid
-          GoTransverseTractApi.get_response_for(self, {billing_account_eid: billing_account_eid})
+        def 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 {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
 
         #
         # @param {Long} event_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_event_eid event_eid
-          GoTransverseTractApi.get_response_for(self, {event_eid: event_eid})
+        def find_by_event_eid event_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {event_eid: event_eid, queryScope: query_scope})
         end
 
         #
         # @param {String} status
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_status status
-          GoTransverseTractApi.get_response_for(self, {status: status})
+        def find_by_status status, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {status: status, 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 {Long} adjustment_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_adjustment_eid adjustment_eid
-          GoTransverseTractApi.get_response_for(self, {adjustment_eid: adjustment_eid})
+        def find_by_adjustment_eid adjustment_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {adjustment_eid: adjustment_eid, queryScope: query_scope})
         end
 
         #
         # @param {DateTime} where_invoice
+        # @param {String} query_scope (default: 'SHALLOW')
         #
         # Example
         # whereInvoice=(occurredOn gte '2011-06-15' and occurredOn lte '2011-07-13')
-        def find_by_where_invoice where_invoice
-          GoTransverseTractApi.get_response_for(self, {where_invoice: where_invoice})
+        def find_by_where_invoice where_invoice, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {where_invoice: where_invoice, queryScope: query_scope})
         end
 
         #

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

@@ -8,23 +8,26 @@ 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} 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
 
         #
         # @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
 
       end

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

@@ -8,9 +8,10 @@ module GoTransverseTractApi
 
         #
         # @param {Long} invoice_item_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_invoice_item_eid invoice_item_eid
-          GoTransverseTractApi.get_response_for(self, {invoice_item_eid: invoice_item_eid})
+        def find_by_invoice_item_eid invoice_item_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {invoice_item_eid: invoice_item_eid, queryScope: query_scope})
         end
 
       end

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

@@ -6,51 +6,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 {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/reason.rb

@@ -12,23 +12,26 @@ 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 {String} name
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_name name
-          GoTransverseTractApi.get_response_for(self, {name: name})
+        def find_by_name name, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {name: name, queryScope: query_scope})
         end
 
         #
         # @param {String} type
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_type type
-          GoTransverseTractApi.get_response_for(self, {type: type})
+        def find_by_type type, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {type: type, queryScope: query_scope})
         end
 
       end

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

@@ -12,23 +12,26 @@ 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} account_num
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_account_num account_num
-          GoTransverseTractApi.get_response_for(self, {account_num: account_num, query_scope: 'DEEP'})
+        def 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 find_by_billing_account_eid billing_account_eid
-          GoTransverseTractApi.get_response_for(self, {billing_account_eid: billing_account_eid})
+        def 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
 
       end