gotransverse-tract-api 0.7.4 → 0.7.5

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

@@ -8,66 +8,90 @@ module GoTransverseTractApi
 
         #
         # @param {Long} eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_eid eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
+        def find_by_eid eid, options=nil
+          return nil unless eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({eid: eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} service_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_service_eid service_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {service_eid: service_eid, queryScope: query_scope})
+        def find_by_service_eid service_eid, options=nil
+          return nil unless service_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({service_eid: service_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} name
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_name name, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {name: name, queryScope: query_scope})
+        def find_by_name name, options=nil
+          return nil unless name.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({name: name}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} status
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_status status, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {status: status, queryScope: query_scope})
+        def find_by_status status, options=nil
+          return nil unless status.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({status: status}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} type
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_type type, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {type: type, queryScope: query_scope})
+        def find_by_type type, options=nil
+          return nil unless type.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({type: type}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} entity_relation_type
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_entity_relation_type entity_relation_type, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {entity_relation_type: entity_relation_type, queryScope: query_scope})
+        def find_by_entity_relation_type entity_relation_type, options=nil
+          return nil unless entity_relation_type.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({entity_relation_type: entity_relation_type}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
-        # @param {DateTime} from_date
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Date} from_date
+        # @param {Hash} options
         #
-        def find_by_from_date from_date, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {from_date: from_date, queryScope: query_scope})
+        def find_by_from_date from_date, options=nil
+          return nil unless from_date.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({from_date: from_date}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
-        # @param {DateTime} thru_date
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Date} thru_date
+        # @param {Hash} options
         #
-        def find_by_thru_date thru_date, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {thru_date: thru_date, queryScope: query_scope})
+        def find_by_thru_date thru_date, options=nil
+          return nil unless thru_date.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({thru_date: thru_date}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #

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

@@ -6,48 +6,67 @@ module GoTransverseTractApi
 
       class << self
 
-        def find_all
-          GoTransverseTractApi.get_response_for(self)
+        #
+        # @param {Hash} options
+        #
+        def find_all options=nil
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_eid eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
+        def find_by_eid eid, options=nil
+          return nil unless eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({eid: eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} name
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_name name, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {name: name, queryScope: query_scope})
+        def find_by_name name, options=nil
+          return nil unless name.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({name: name}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} type
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_type type, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {type: type, queryScope: query_scope})
+        def find_by_type type, options=nil
+          return nil unless type.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({type: type}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Boolean} enabled
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_enabled enabled, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {enabled: enabled, queryScope: query_scope})
+        def find_by_enabled enabled, options=nil
+          return nil unless enabled.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({enabled: enabled}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Boolean} searchable
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_searchable searchable, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {searchable: searchable, queryScope: query_scope})
+        def find_by_searchable searchable, options=nil
+          return nil unless searchable.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({searchable: searchable}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
       end

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

@@ -6,96 +6,133 @@ module GoTransverseTractApi
 
       class << self
 
-        def find_all
-          GoTransverseTractApi.get_response_for(self)
+        #
+        # @param {Hash} options
+        #
+        def find_all options=nil
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_eid eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
+        def find_by_eid eid, options=nil
+          return nil unless eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({eid: eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} account_num
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_account_num account_num, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {account_num: account_num, queryScope: query_scope})
+        def find_by_account_num account_num, options=nil
+          return nil unless account_num.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({account_num: account_num}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} external_account_num
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        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})
+        def find_by_external_account_num external_account_num, options=nil
+          return nil unless external_account_num.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({external_account_num: external_account_num}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} billing_account_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        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})
+        def find_by_billing_account_eid billing_account_eid, options=nil
+          return nil unless billing_account_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({billing_account_eid: billing_account_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} custom_field_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        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})
+        def find_by_custom_field_eid custom_field_eid, options=nil
+          return nil unless custom_field_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({custom_field_eid: custom_field_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} order_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_order_eid order_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {order_eid: order_eid, queryScope: query_scope})
+        def find_by_order_eid order_eid, options=nil
+          return nil unless order_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({order_eid: order_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} service_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_service_eid service_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {service_eid: service_eid, queryScope: query_scope})
+        def find_by_service_eid service_eid, options=nil
+          return nil unless service_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({service_eid: service_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} order_item_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        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})
+        def find_by_order_item_eid order_item_eid, options=nil
+          return nil unless order_item_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({order_item_eid: order_item_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} order_num
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_order_num order_num, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {order_num: order_num, queryScope: query_scope})
+        def find_by_order_num order_num, options=nil
+          return nil unless order_num.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({order_num: order_num}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} custom_field_name
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        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})
+        def find_by_custom_field_name custom_field_name, options=nil
+          return nil unless custom_field_name.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({custom_field_name: custom_field_name}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} value
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_value value, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {value: value, queryScope: query_scope})
+        def find_by_value value, options=nil
+          return nil unless value.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({value: value}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #

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

@@ -8,76 +8,103 @@ module GoTransverseTractApi
 
         #
         # @param {Long} eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_eid eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {eid: eid, queryScope: query_scope})
+        def find_by_eid eid, options=nil
+          return nil unless eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({eid: eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} account_num
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_account_num account_num, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {account_num: account_num, queryScope: query_scope})
+        def find_by_account_num account_num, options=nil
+          return nil unless account_num.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({account_num: account_num}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} billing_account_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        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})
+        def find_by_billing_account_eid billing_account_eid, options=nil
+          return nil unless billing_account_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({billing_account_eid: billing_account_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} invoice_num
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_invoice_num invoice_num, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {invoice_num: invoice_num, queryScope: query_scope})
+        def find_by_invoice_num invoice_num, options=nil
+          return nil unless invoice_num.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({invoice_num: invoice_num}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} event_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_event_eid event_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {event_eid: event_eid, queryScope: query_scope})
+        def find_by_event_eid event_eid, options=nil
+          return nil unless event_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({event_eid: event_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} status
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_status status, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {status: status, queryScope: query_scope})
+        def find_by_status status, options=nil
+          return nil unless status.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({status: status}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {DateTime} occurred_on
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_occurred_on occurred_on, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {occurred_on: occurred_on, queryScope: query_scope})
+        def find_by_occurred_on occurred_on, options=nil
+          return nil unless occurred_on.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({occurred_on: occurred_on}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} adjustment_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_adjustment_eid adjustment_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {adjustment_eid: adjustment_eid, queryScope: query_scope})
+        def find_by_adjustment_eid adjustment_eid, options=nil
+          return nil unless adjustment_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({adjustment_eid: adjustment_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {DateTime} where_invoice
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
         # Example
         # whereInvoice=(occurredOn gte '2011-06-15' and occurredOn lte '2011-07-13')
-        def find_by_where_invoice where_invoice, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {where_invoice: where_invoice, queryScope: query_scope})
+        def find_by_where_invoice where_invoice, options=nil
+          return nil unless where_invoice.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({where_invoice: where_invoice}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #