gotransverse-tract-api 0.5.2 → 0.5.3

data/lib/gotransverse-tract-api/product/product_price.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 {Long} product_eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_product_eid product_eid
-        GoTransverseTractApi.get_response_for(self, {product_eid: product_eid})
+      def self.find_by_product_eid product_eid, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {product_eid: product_eid, queryScope: query_scope})
       end
 
       #
       # @param {DateTime} from_date
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_from_date from_date
-        GoTransverseTractApi.get_response_for(self, {from_date: from_date})
+      def self.find_from_date from_date, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {from_date: from_date, queryScope: query_scope})
       end
 
       #
       # @param {DateTime} thru_date
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_thru_date thru_date
-        GoTransverseTractApi.get_response_for(self, {thru_date: thru_date})
+      def self.find_thru_date thru_date, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {thru_date: thru_date, queryScope: query_scope})
       end
 
       #
       # @param {Long} price_list_eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_price_list_eid price_list_eid
-        GoTransverseTractApi.get_response_for(self, {price_list_eid: price_list_eid})
+      def self.find_by_price_list_eid price_list_eid, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {price_list_eid: price_list_eid, queryScope: query_scope})
       end
 
       #
       # @param {Boolean} price_list_is_master
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_price_list_is_master price_list_is_master
-        GoTransverseTractApi.get_response_for(self, {price_list_is_master: price_list_is_master})
+      def self.find_by_price_list_is_master price_list_is_master, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {price_list_is_master: price_list_is_master, 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
 
     end

data/lib/gotransverse-tract-api/product/product_price_range.rb

@@ -6,44 +6,50 @@ 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} product_eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_product_eid product_eid
-        GoTransverseTractApi.get_response_for(self, {product_eid: product_eid})
+      def self.find_by_product_eid product_eid, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {product_eid: product_eid, queryScope: query_scope})
       end
 
       #
       # @param {Long} product_price_eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_product_price_eid product_price_eid
-        GoTransverseTractApi.get_response_for(self, {product_price_eid: product_price_eid})
+      def self.find_by_product_price_eid product_price_eid, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {product_price_eid: product_price_eid, queryScope: query_scope})
       end
 
       #
       # @param {Long} price_list_eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_price_list_eid price_list_eid
-        GoTransverseTractApi.get_response_for(self, {price_list_eid: price_list_eid})
+      def self.find_by_price_list_eid price_list_eid, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {price_list_eid: price_list_eid, queryScope: query_scope})
       end
 
       #
       # @param {Boolean} price_list_is_master
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_price_list_is_master price_list_is_master
-        GoTransverseTractApi.get_response_for(self, {price_list_is_master: price_list_is_master})
+      def self.find_by_price_list_is_master price_list_is_master, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {price_list_is_master: price_list_is_master, 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
 
     end

data/lib/gotransverse-tract-api/product/product_tag.rb

@@ -10,23 +10,26 @@ 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 {Long} product_eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_product_eid product_eid
-        GoTransverseTractApi.get_response_for(self, {product_eid: product_eid})
+      def self.find_by_product_eid product_eid, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {product_eid: product_eid, queryScope: query_scope})
       end
 
     end

data/lib/gotransverse-tract-api/product/recurring_product_price.rb

@@ -8,53 +8,95 @@ module GoTransverseTractApi
 
         #
         # @param {Long} recurrence_period
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_recurrence_period recurrence_period
-          GoTransverseTractApi.get_response_for(self, {recurrence_period: recurrence_period})
+        def find_by_recurrence_period recurrence_period, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {recurrence_period: recurrence_period, queryScope: query_scope})
         end
 
         #
         # @param {Long} recurrence_amount
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_recurrence_amount recurrence_amount
-          GoTransverseTractApi.get_response_for(self, {recurrence_amount: recurrence_amount})
+        def find_by_recurrence_amount recurrence_amount, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {recurrence_amount: recurrence_amount, queryScope: query_scope})
         end
 
         #
         # @param {Boolean} recurring_payment_required
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_recurring_payment_required recurring_payment_required
-          GoTransverseTractApi.get_response_for(self, {recurring_payment_required: recurring_payment_required})
+        def find_by_recurring_payment_required recurring_payment_required, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {recurring_payment_required: recurring_payment_required, queryScope: query_scope})
         end
 
         #
         # @param {Boolean} bill_in_advance
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_bill_in_advance bill_in_advance
-          GoTransverseTractApi.get_response_for(self, {bill_in_advance: bill_in_advance})
+        def find_by_bill_in_advance bill_in_advance, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {bill_in_advance: bill_in_advance, queryScope: query_scope})
         end
 
         #
         # @param {Boolean} prorated_on_cancel
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_prorated_on_cancel prorated_on_cancel
-          GoTransverseTractApi.get_response_for(self, {prorated_on_cancel: prorated_on_cancel})
+        def find_by_prorated_on_cancel prorated_on_cancel, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {prorated_on_cancel: prorated_on_cancel, queryScope: query_scope})
         end
 
         #
         # @param {Boolean} prorated_on_order
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_prorated_on_order prorated_on_order
-          GoTransverseTractApi.get_response_for(self, {prorated_on_order: prorated_on_order})
+        def find_by_prorated_on_order prorated_on_order, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {prorated_on_order: prorated_on_order, queryScope: query_scope})
         end
 
         #
         # @param {Boolean} prorated_on_order_no_charge
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_prorated_on_order_no_charge prorated_on_order_no_charge
-          GoTransverseTractApi.get_response_for(self, {prorated_on_order_no_charge: prorated_on_order_no_charge})
+        def find_by_prorated_on_order_no_charge prorated_on_order_no_charge, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {prorated_on_order_no_charge: prorated_on_order_no_charge, queryScope: query_scope})
         end
 
+        #
+        # @param {Hash} recurring_product_price
+        #
+        def get_recurring_product_price(recurring_product_price)
+          if recurring_product_price.has_key?('price_ranges')
+            price_ranges = Order::PriceRange.get_price_ranges(recurring_product_price[:price_ranges])
+          end
+
+          if recurring_product_price.has_key?('product_usage_rules')
+            product_usage_rules = Usage::ProductUsageRule.get_product_usage_rule(recurring_product_price[:product_usage_rules])
+          end
+
+          recurringProductPrice = {
+            attributes: {
+              fromDate: recurring_product_price[:from_date],
+              priceOverride: recurring_product_price[:price_override],
+              type: recurring_product_price[:type],
+              paymentOnPurchaseRequired: recurring_product_price[:payment_on_purchase_required],
+              recurringPaymentRequired: recurring_product_price[:recurring_payment_required],
+              recurrencePeriod: recurring_product_price[:recurrence_period],
+              recurrenceAmount: recurring_product_price[:recurrence_amount],
+              allowScheduledCharges: recurring_product_price[:allow_scheduled_charges],
+              currencyType: recurring_product_price[:currency_type],
+              proratedOnOrder: recurring_product_price[:prorated_on_order],
+              proratedOnCancel: recurring_product_price[:prorated_on_cancel],
+              proratedOnOrderNoCharge: recurring_product_price[:prorated_on_order_no_charge],
+              billInAdvance: recurring_product_price[:bill_in_advance],
+              eid: recurring_product_price[:eid]
+            }.delete_if{|k,v| v.nil?},
+            priceRanges: price_ranges,
+            productUsageRules: product_usage_rules
+          }
+
+          recurringProductPrice.delete_if{|k,v| v.nil?}
+        end
       end
 
     end

data/lib/gotransverse-tract-api/product/usage_rule.rb

@@ -6,20 +6,22 @@ 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} service_period_eid
+      # @param {String} query_scope (default: 'SHALLOW')
       #
-      def self.find_by_service_period_eid service_period_eid
-        GoTransverseTractApi.get_response_for(self, {service_period_eid: service_period_eid})
+      def self.find_by_service_period_eid service_period_eid, query_scope=nil
+        GoTransverseTractApi.get_response_for(self, {service_period_eid: service_period_eid, queryScope: query_scope})
       end
 
     end
 
   end
 
-end
+end

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

@@ -8,72 +8,82 @@ 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} product_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_product_eid product_eid
-          GoTransverseTractApi.get_response_for(self, {product_eid: product_eid})
+        def find_by_product_eid product_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {product_eid: product_eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} custom_field_value_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_custom_field_value_eid custom_field_value_eid
-          GoTransverseTractApi.get_response_for(self, {custom_field_value_eid: custom_field_value_eid})
+        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})
         end
 
         #
         # @param {Long} parent_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def self.find_by_parent_eid parent_eid
-          GoTransverseTractApi.get_response_for(self, {parent_eid: parent_eid})
+        def self.find_by_parent_eid parent_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {parent_eid: parent_eid, 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} agreement_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_agreement_eid agreement_eid
-          GoTransverseTractApi.get_response_for(self, {agreement_eid: agreement_eid})
+        def find_by_agreement_eid agreement_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {agreement_eid: agreement_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} service_resource_identifier
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_service_resource_identifier service_resource_identifier
-          GoTransverseTractApi.get_response_for(self, {service_resource_identifier: service_resource_identifier})
+        def find_by_service_resource_identifier service_resource_identifier, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {service_resource_identifier: service_resource_identifier, queryScope: query_scope})
         end
 
         #
         # @param {Long} renewal_count
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_renewal_count renewal_count
-          GoTransverseTractApi.get_response_for(self, {renewal_count: renewal_count})
+        def find_by_renewal_count renewal_count, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {renewal_count: renewal_count, queryScope: query_scope})
         end
 
         #

data/lib/gotransverse-tract-api/service/service_device_inventory_item.rb

@@ -8,30 +8,34 @@ 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} product_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_product_eid product_eid
-          GoTransverseTractApi.get_response_for(self, {product_eid: product_eid})
+        def find_by_product_eid product_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {product_eid: product_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 {Long} serial_number
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def self.find_by_serial_number serial_number
-          GoTransverseTractApi.get_response_for(self, {serial_number: serial_number})
+        def self.find_by_serial_number serial_number, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {serial_number: serial_number, queryScope: query_scope})
         end
 
       end