gotransverse-tract-api 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c7f435163db5b1137f0375d2e9c8e58aa8610b3
-  data.tar.gz: 42fb7ca3c1b81b1be6f9bc0115fe9859d07f7727
+  metadata.gz: 3e8247a4641747c300186f244e88909e10f4c24b
+  data.tar.gz: 109ee221b923d5fae32d4def190083631b74a64d
 SHA512:
-  metadata.gz: b15ce602d1686d11a4ae79ada887d6d017b4c0b9ce8ffbaa5598473bff638033ebcbef5feb2d006f5e2867156676928b023e45320f6a65d0bbcb313364a2f7c9
-  data.tar.gz: 3fffa4c91445462473355a3f90bad190ba92c01d00d9d80667cebc2108f79d0be5f682f571f565f17733426cb7114ddec8203ae7f0b6729dcb6601a9860c1ce2
+  metadata.gz: affbe1012447ed2010075346f25391a572ee3db14dc27c2bf73cbc068dd19d470482dfd4fb0a9a646c9c16b170f37fd7b3dc2c6fc56383d5d84e30e76cb238f0
+  data.tar.gz: 5a8d05d20a6be221b10e4db2832e698a6c8209fdcc12aa26c11caf6a2397cacb3f2cf54d98f7cd61edde402561547b10f2712416d4335cbae92acb3d045e4411

data/lib/gotransverse-tract-api.rb

@@ -51,13 +51,7 @@ require "gotransverse-tract-api/order/sales_order"
 require "gotransverse-tract-api/order/agreement_configuration"
 require "gotransverse-tract-api/order/discount_configuration"
 require "gotransverse-tract-api/order/inventory_item"
-require "gotransverse-tract-api/order/order_item_usage_rule"
 require "gotransverse-tract-api/order/price_range"
-require "gotransverse-tract-api/order/product_usage_rule"
-require "gotransverse-tract-api/order/recurring_product_price"
-require "gotransverse-tract-api/order/scheduled_charge"
-require "gotransverse-tract-api/order/usage_rate"
-require "gotransverse-tract-api/product/service_resource_category"
 
 require "gotransverse-tract-api/product/action"
 require "gotransverse-tract-api/product/discount_category"
@@ -98,6 +92,7 @@ require "gotransverse-tract-api/usage/usage_lookup_table"
 require "gotransverse-tract-api/usage/usage_lookup_table_entry"
 require "gotransverse-tract-api/usage/usage_rule"
 require "gotransverse-tract-api/usage/usage_price_category"
+require "gotransverse-tract-api/usage/usage_rate"
 
 require "httpclient"
 require "nokogiri"

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

@@ -55,6 +55,7 @@ module GoTransverseTractApi
           orderDate: sales_order[:order_date],
           orderStatus: sales_order[:order_status]
         },
+        customFieldValues: BillingAccount::CustomFieldValue.get_custom_field_values(sales_order[:custom_field_values]), 
         orderItems: {
           attributes: {},
           orderItem: Order::OrderItem.get_order_item(sales_order[:order_items][:order_item])

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

@@ -8,44 +8,50 @@ 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} 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
 
         #
         # @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
 
         #

data/lib/gotransverse-tract-api/billing_account/adjustment_application.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 {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
 
       end

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

@@ -12,30 +12,34 @@ 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} 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 {Boolean} credit_only
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_credit_only credit_only
-          GoTransverseTractApi.get_response_for(self, {credit_only: credit_only})
+        def find_by_credit_only credit_only, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {credit_only: credit_only, queryScope: query_scope})
         end
 
       end

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

@@ -11,114 +11,130 @@ 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} party_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_party_eid party_eid
-          GoTransverseTractApi.get_response_for(self, {party_eid: party_eid})
+        def find_by_party_eid party_eid, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {party_eid: party_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 {String} email_address
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_email_address email_address
-          GoTransverseTractApi.get_response_for(self, {email_address: email_address})
+        def find_by_email_address email_address, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {email_address: email_address, queryScope: query_scope})
         end
 
         #
         # @param {Long} billing_account_category_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_billing_account_category_eid billing_account_category_eid
-          GoTransverseTractApi.get_response_for(self, {billing_account_category_eid: billing_account_category_eid})
+        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})
         end
 
         #
         # @param {Long} purchase_order_number
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_purchase_order_number purchase_order_number
-          GoTransverseTractApi.get_response_for(self, {purchase_order_number: purchase_order_number})
+        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})
         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 {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 {String} bill_type
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_bill_type bill_type
-          GoTransverseTractApi.get_response_for(self, {bill_type: bill_type})
+        def find_by_bill_type bill_type, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {bill_type: bill_type, queryScope: query_scope})
         end
 
         #
         # @param {String} referral
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_referral referral
-          GoTransverseTractApi.get_response_for(self, {referral: referral})
+        def find_by_referral referral, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {referral: referral, queryScope: query_scope})
         end
 
         #
         # @param {Long} billing_account_segment_eid
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_billing_account_segment_eid billing_account_segment_eid
-          GoTransverseTractApi.get_response_for(self, {billing_account_segment_eid: billing_account_segment_eid})
+        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})
         end
 
         #
         # @param {String} currency_type
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_currency_type currency_type
-          GoTransverseTractApi.get_response_for(self, {currency_type: currency_type})
+        def find_by_currency_type currency_type, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {currency_type: currency_type, 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} 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
 
         #
@@ -281,12 +297,12 @@ module GoTransverseTractApi
 
         #
         # @param {Long} eid
-        # @param {Hash} billing_account
+        # @param {Hash} order_details
         #
-        def create_draft_order eid, billing_account
+        def create_draft_order eid, order_details
           data = {
             createDraftOrder: {},
-            salesOrder: GoTransverseTractApi::ApiData.new.sales_order_details(billing_account[:sales_order])
+            salesOrder: GoTransverseTractApi::ApiData.new.sales_order_details(order_details[:sales_order])
           }
 
           xml_data = GoTransverseTractApi.generateXML(data, 'createDraftOrder')
@@ -295,12 +311,12 @@ module GoTransverseTractApi
 
         #
         # @param {Long} eid
-        # @param {Hash} billing_account
+        # @param {Hash} order_details
         #
-        def void_draft_order eid, billing_account
+        def void_draft_order eid, order_details
           data = {
             voidDraftOrder: {},
-            salesOrder: GoTransverseTractApi::ApiData.new.sales_order_details(billing_account[:sales_order])
+            salesOrder: GoTransverseTractApi::ApiData.new.sales_order_details(order_details[:sales_order])
           }
 
           xml_data = GoTransverseTractApi.generateXML(data, 'voidDraftOrder')

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

@@ -8,58 +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} 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 {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} 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} 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 {String} entity_relation_type
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_entity_relation_type entity_relation_type
-          GoTransverseTractApi.get_response_for(self, {entity_relation_type: entity_relation_type})
+        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})
         end
 
         #
         # @param {DateTime} from_date
+        # @param {String} query_scope (default: 'SHALLOW')
         #
-        def find_by_from_date from_date
-          GoTransverseTractApi.get_response_for(self, {from_date: from_date})
+        def find_by_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 find_by_thru_date thru_date
-          GoTransverseTractApi.get_response_for(self, {thru_date: thru_date})
+        def find_by_thru_date thru_date, query_scope=nil
+          GoTransverseTractApi.get_response_for(self, {thru_date: thru_date, queryScope: query_scope})
         end
 
         #