gotransverse-tract-api 0.5.2 → 0.5.3

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

@@ -8,37 +8,42 @@ 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_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 {Date} start_date
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_start_date start_date
-          GoTransverseTractApi.get_response_for(self, {start_date: start_date})
+        def find_by_start_date start_date, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {start_date: start_date, queryScope: query_scope})
         end
 
         #
         # @param {Date} end_date
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_end_date end_date
-          GoTransverseTractApi.get_response_for(self, {end_date: end_date})
+        def find_by_end_date end_date, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {end_date: end_date, queryScope: query_scope})
         end
 
         #
         # @param {Boolean} closed
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_closed closed
-          GoTransverseTractApi.get_response_for(self, {closed: closed})
+        def find_by_closed closed, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {closed: closed, queryScope: query_scope})
         end
 
       end

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

@@ -8,37 +8,42 @@ 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_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 {Date} start_date
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_start_date start_date
-          GoTransverseTractApi.get_response_for(self, {start_date: start_date})
+        def find_by_start_date start_date, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {start_date: start_date, queryScope: query_scope})
         end
 
         #
         # @param {Date} end_date
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_end_date end_date
-          GoTransverseTractApi.get_response_for(self, {end_date: end_date})
+        def find_by_end_date end_date, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {end_date: end_date, queryScope: query_scope})
         end
 
         #
         # @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
 
       end

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

@@ -8,16 +8,18 @@ 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_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
 
       end

data/lib/gotransverse-tract-api/service/service_resource.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} 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} service_resource_category_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_service_resource_category_eid service_resource_category_eid
-          GoTransverseTractApi.get_response_for(self, {service_resource_category_eid: service_resource_category_eid})
+        def find_by_service_resource_category_eid service_resource_category_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {service_resource_category_eid: service_resource_category_eid, queryScope: query_scope})
         end
 
         #
         # @param {Long} identifier
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_identifier identifier
-          GoTransverseTractApi.get_response_for(self, {identifier: identifier})
+        def find_by_identifier identifier, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {identifier: identifier, 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 {String} description
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_description description
-          GoTransverseTractApi.get_response_for(self, {description: description})
+        def find_by_description description, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {description: description, queryScope: query_scope})
         end
 
         #

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

@@ -12,25 +12,41 @@ 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 {Hash} service_resource_category
+        #
+        def get_service_resource_category(service_resource_category)
+          svc_resource_category = {
+            name: service_resource_category[:name],
+            type: service_resource_category[:type],
+            status: service_resource_category[:status],
+            eid: service_resource_category[:eid]
+          }
+
+          svc_resource_category
+        end
       end
 
     end

data/lib/gotransverse-tract-api/usage/global_usage_rule.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 {Boolean} is_global
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_is_global is_global
-          GoTransverseTractApi.get_response_for(self, {is_global: is_global})
+        def find_by_is_global is_global, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {is_global: is_global, 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
 
       end

data/lib/gotransverse-tract-api/usage/order_item_usage_rule.rb

@@ -8,25 +8,66 @@ 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} 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 {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 {Hash} order_item_usage_rule
+        #
+        def get_order_item_usage_rule(order_item_usage_rule)
+          if order_item_usage_rule.has_key?(:match_all_order_item_usage_rule)
+            if order_item_usage_rule[:match_all_order_item_usage_rule].has_key?(:usage_rate)
+              usage_rate = UsageRate.get_usage_rate(order_item_usage_rule[:match_all_order_item_usage_rule][:usage_rate])
+            end
+          end
+
+          order_item_usage_rules = {
+            attributes: {},
+            matchAllOrderItemUsageRule: {
+              attributes: {
+                eid: order_item_usage_rule[:match_all_order_item_usage_rule][:eid],
+                limit: order_item_usage_rule[:match_all_order_item_usage_rule][:limit],
+                usageUom: order_item_usage_rule[:match_all_order_item_usage_rule][:usage_uom],
+                name: order_item_usage_rule[:match_all_order_item_usage_rule][:name],
+                order: order_item_usage_rule[:match_all_order_item_usage_rule][:order],
+                proratedOnOrder: order_item_usage_rule[:match_all_order_item_usage_rule][:prorated_on_order],
+                proratedOnCancel: order_item_usage_rule[:match_all_order_item_usage_rule][:prorated_on_cancel],
+                rollOverType: order_item_usage_rule[:match_all_order_item_usage_rule][:roll_over_type],
+                allowanceType: order_item_usage_rule[:match_all_order_item_usage_rule][:allowance_type],
+                validFrom: order_item_usage_rule[:match_all_order_item_usage_rule][:valid_from],
+                validTo: order_item_usage_rule[:match_all_order_item_usage_rule][:valid_to],
+                ruleType: order_item_usage_rule[:match_all_order_item_usage_rule][:rule_type],
+                status: order_item_usage_rule[:match_all_order_item_usage_rule][:status],
+                chargeCategory: order_item_usage_rule[:match_all_order_item_usage_rule][:charge_category]
+              }.delete_if{|k,v| v.nil?},
+              matchAllProductUsageRule: {
+                eid: order_item_usage_rule[:match_all_order_item_usage_rule][:match_all_product_usage_rule][:eid]
+              },
+              usageRate: usage_rate
+            }
+          }
+
+          order_item_usage_rules.delete_if{|k,v| v.nil?}
+        end
       end
 
     end

data/lib/gotransverse-tract-api/usage/product_usage_rule.rb

@@ -8,32 +8,65 @@ 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} 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} product_price_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_product_price_eid product_price_eid
-          GoTransverseTractApi.get_response_for(self, {product_price_eid: product_price_eid})
+        def 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 {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 {Hash} product_usage_rules
+        #
+        def get_product_usage_rules(product_usage_rules)
+          product_usage_rule = {
+            attributes: {},
+            matchAllProductUsageRule: {
+              attributes: {
+                eid: product_usage_rule[:eid],
+                limit: product_usage_rule[:limit],
+                usageUom: product_usage_rule[:usage_uom],
+                name: product_usage_rule[:name],
+                order: product_usage_rule[:order],
+                proratedOnOrder: product_usage_rule[:prorated_on_order],
+                proratedOnCancel: product_usage_rule[:prorated_on_cancel],
+                rollOverType: product_usage_rule[:roll_over_type],
+                allowanceType: product_usage_rule[:allowance_type],
+                validFrom: product_usage_rule[:valid_from],
+                validTo: product_usage_rule[:valid_to],
+                ruleType: product_usage_rule[:rule_type],
+                status: product_usage_rule[:status],
+                chargeCategory: product_usage_rule[:charge_category]
+              }.delete_if{|k,v| v.nil?},
+              usageRate: UsageRate.get_usage_rate(product_usage_rule[:usage_rate])
+            }
+          }
+
+          product_usage_rule
+        end
       end
 
     end

data/lib/gotransverse-tract-api/usage/rate_table.rb

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