gotransverse-tract-api 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 412b022eed460ee7a6fba9ccea3d6af95de9fb6d
-  data.tar.gz: a9d4498166810fb309ffc9b0e9a39bcb4f7d9299
+  metadata.gz: 6b5c6c10d87f68b4e989cf51a01ed71f86b9e46a
+  data.tar.gz: 2a40c0379d1ce0be0a43c3c4535be66449f561d5
 SHA512:
-  metadata.gz: 2d32a86ceb302fe9434cf3cf3c4889f3a9f221caafb1f8a0c786ec6e3a6318e90c7f2cd684213bc9395acc877b3ed2844c58bb3e4cdb79c6f3266785025db0e1
-  data.tar.gz: 8fc9410a44a658b0a3826705387f810377f1f3b2d1b6bbb8c6940e5357e42d6a7b9c57685a224135993a218dc0f17dbc0219714d910096c9f06d5993169032ec
+  metadata.gz: 6eef510765a90d1b45e9b18b5a30a0a20d2d5a43593efd2e35fd6e6d9729bfd2e96ad4e3626cc5e8aef9718bb16bfd272cb102b28b919aa92bd9a509a7f62e75
+  data.tar.gz: 931ad46776a4a726bf0ce96c4fd6a364f4f66854ffd6a368783975c5fe50113de254037a49910b2d1afea55d7825b54c9c6d4dd2846453e32ffdbaae38651117

data/lib/gotransverse-tract-api.rb

@@ -72,7 +72,6 @@ require "gotransverse-tract-api/product/product_price"
 require "gotransverse-tract-api/product/one_time_product_price"
 require "gotransverse-tract-api/product/product_tag"
 require "gotransverse-tract-api/product/recurring_product_price"
-require "gotransverse-tract-api/product/usage_rule"
 
 require "gotransverse-tract-api/service/service"
 require "gotransverse-tract-api/service/service_device_inventory_item"

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

@@ -227,6 +227,12 @@ module GoTransverseTractApi
       ba_details.delete_if{|k,v| v.nil?}
     end
 
+    def get_query_params(params, options={})
+      params.merge!(options) if(options.present?)
+
+      params
+    end
+
     def get_addresses(entity)
       addresses = {
         attributes: {}

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

@@ -8,50 +8,68 @@ 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 {Long} billing_account_eid
+        # @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_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} billing_account_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Long} account_num
+        # @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_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} 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} invoice_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_invoice_eid invoice_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {invoice_eid: invoice_eid, queryScope: query_scope})
+        def find_by_invoice_eid invoice_eid, options=nil
+          return nil unless invoice_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({invoice_eid: invoice_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
 
         #

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

@@ -8,18 +8,24 @@ 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} 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
 
       end

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

@@ -6,40 +6,56 @@ 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} 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 {Boolean} credit_only
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_credit_only credit_only, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {credit_only: credit_only, queryScope: query_scope})
+        def find_by_credit_only credit_only, options=nil
+          return nil unless credit_only.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({credit_only: credit_only}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
       end

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

@@ -5,136 +5,189 @@ module GoTransverseTractApi
     class BillingAccount
 
       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} party_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_party_eid party_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {party_eid: party_eid, queryScope: query_scope})
+        def find_by_party_eid party_eid, options=nil
+          return nil unless party_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({party_eid: party_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 {String} email_address
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_email_address email_address, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {email_address: email_address, queryScope: query_scope})
+        def find_by_email_address email_address, options=nil
+          return nil unless email_address.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({email_address: email_address}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} billing_account_category_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_billing_account_category_eid billing_account_category_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {billing_account_category_eid: billing_account_category_eid, queryScope: query_scope})
+        def find_by_billing_account_category_eid billing_account_category_eid, options=nil
+          return nil unless billing_account_category_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({billing_account_category_eid: billing_account_category_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} purchase_order_number
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_purchase_order_number purchase_order_number, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {purchase_order_number: purchase_order_number, queryScope: query_scope})
+        def find_by_purchase_order_num purchase_order_number, options=nil
+          return nil unless purchase_order_number.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({purchase_order_number: purchase_order_number}, 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 {Long} custom_field_value_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_custom_field_value_eid custom_field_value_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {custom_field_value_eid: custom_field_value_eid, queryScope: query_scope})
+        def find_by_custom_field_value_eid custom_field_value_eid, options=nil
+          return nil unless custom_field_value_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({custom_field_value_eid: custom_field_value_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} bill_type
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_bill_type bill_type, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {bill_type: bill_type, queryScope: query_scope})
+        def find_by_bill_type bill_type, options=nil
+          return nil unless bill_type.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({bill_type: bill_type}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} referral
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_referral referral, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {referral: referral, queryScope: query_scope})
+        def find_by_referral referral, options=nil
+          return nil unless referral.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({referral: referral}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} billing_account_segment_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_billing_account_segment_eid billing_account_segment_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {billing_account_segment_eid: billing_account_segment_eid, queryScope: query_scope})
+        def find_by_billing_account_segment_eid billing_account_segment_eid, options=nil
+          return nil unless billing_account_segment_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({billing_account_segment_eid: billing_account_segment_eid}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {String} currency_type
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_currency_type currency_type, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {currency_type: currency_type, queryScope: query_scope})
+        def find_by_currency_type currency_type, options=nil
+          return nil unless currency_type.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({currency_type: currency_type}, options)
+          GoTransverseTractApi.get_response_for(self, params)
         end
 
         #
         # @param {Long} product_eid
-        # @param {String} query_scope (default: 'SHALLOW')
+        # @param {Hash} options
         #
-        def find_by_product_eid product_eid, query_scope=nil
-          GoTransverseTractApi.get_response_for(self, {product_eid: product_eid, queryScope: query_scope})
+        def find_by_product_eid product_eid, options=nil
+          return nil unless product_eid.present?
+
+          params ||= GoTransverseTractApi::ApiData.new.get_query_params({product_eid: product_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
 
         #