gotransverse-tract-api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e136ed93de32f0dc8a13c76f362f9cdd24ad4457
-  data.tar.gz: b0f04900756ca56d5721773f80e51ef4890274ec
+  metadata.gz: 428eb65f3391a15ecbd6d8ea365279f04f3703a1
+  data.tar.gz: d4d5e187560e9fe8954018f4fb88a8d37f431d4a
 SHA512:
-  metadata.gz: aa9de324e988989664f018d6c2dd9eb9ff41deed33c5cba7391f41427df4988dfa9838f29bb9fd3efcd355134a1e7a812a208926668374fefa336b69e0394096
-  data.tar.gz: ab8c0bc5acf68940438afca5339727faeed5703aaf484441328410523771545ddfa3cb0dfcb091f88f62f9e58fca8cf52c8e2bd839e5bf3d8337b923bdfffb57
+  metadata.gz: 79ba20a0621ac7d169cf9456c434eadcada54ea939e39ad38f84a494b01988177c3a6cf274d6c11d9ed3853e55d866f19c357931068559373ef9909797461866
+  data.tar.gz: 118bf4a58e46df1ff1c94dd66e7f29270516b73da990a52551f9dc60a3078b8c1c84830cf2d367fb6a375cdf78c5bf7461cc6decf0435b6b768c17209cbc66c4

data/README.md

@@ -89,8 +89,8 @@ Please keep version number increments under control :)
 
 ## Authors
 
-Julien DeFrance
-Ravikumar Gudipati
+* Julien DeFrance
+* Ravikumar Gudipati
 
 
 ## Donations

data/lib/gotransverse-tract-api/order/agreement.rb

@@ -4,12 +4,70 @@ module GoTransverseTractApi
 
     class Agreement
 
-      def self.find_all
-        GoTransverseTractApi.get_response_for(self)
-      end
+      class << self
+        def find_all
+          GoTransverseTractApi.get_response_for(self)
+        end
+
+        #
+        # @param {Long} eid
+        #
+        def find_by_eid eid
+          GoTransverseTractApi.get_response_for(self, {eid: eid})
+        end
+
+        #
+        # @param {String} name
+        #
+        def find_by_name name
+          GoTransverseTractApi.get_response_for(self, {name: name})
+        end
+
+        #
+        # @param {Long} product_eid
+        #
+        def find_by_product_eid product_eid
+          GoTransverseTractApi.get_response_for(self, {product_eid: product_eid})
+        end
+
+        #
+        # @param {String} status
+        #
+        def find_by_status status
+          GoTransverseTractApi.get_response_for(self, {status: status})
+        end
 
+        #
+        # @param {String} termination_fee_currency_type
+        #
+        def find_by_termination_fee_currency_type termination_fee_currency_type
+          GoTransverseTractApi.get_response_for(self, {termination_fee_currency_type: termination_fee_currency_type})
+        end
+
+        #
+        # @param {String} max_termination_fee_currency_type
+        #
+        def find_by_max_termination_fee_currency_type max_termination_fee_currency_type
+          GoTransverseTractApi.get_response_for(self, {max_termination_fee_currency_type: max_termination_fee_currency_type})
+        end
+
+        #
+        # @param {Date} from_date
+        #
+        def find_by_from_date from_date
+          GoTransverseTractApi.get_response_for(self, {from_date: from_date})
+        end
+
+        #
+        # @param {Date} thru_date
+        #
+        def find_by_thru_date thru_date
+          GoTransverseTractApi.get_response_for(self, {thru_date: thru_date})
+        end
+
+      end
     end
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/order/bill_cycle.rb

@@ -4,12 +4,42 @@ module GoTransverseTractApi
 
     class BillCycle
 
-      def self.find_all
-        GoTransverseTractApi.get_response_for(self)
+      class << self
+        def find_all
+          GoTransverseTractApi.get_response_for(self)
+        end
+
+        #
+        # @param {Long} eid
+        #
+        def find_by_eid eid
+          GoTransverseTractApi.get_response_for(self, {eid: eid})
+        end
+
+        #
+        # @param {String} name
+        #
+        def find_by_name name
+          GoTransverseTractApi.get_response_for(self, {name: name})
+        end
+
+        #
+        # @param {String} type
+        #
+        def find_by_type type
+          GoTransverseTractApi.get_response_for(self, {type: type})
+        end
+
+        #
+        # @param {String} status
+        #
+        def find_by_status status
+          GoTransverseTractApi.get_response_for(self, {status: status})
+        end
       end
 
     end
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/order/billing_account_category.rb

@@ -4,12 +4,35 @@ module GoTransverseTractApi
 
     class BillingAccountCategory
 
-      def self.find_all
-        GoTransverseTractApi.get_response_for(self)
+      class << self
+        def find_all
+          GoTransverseTractApi.get_response_for(self)
+        end
+
+        #
+        # @param {Long} eid
+        #
+        def find_by_eid eid
+          GoTransverseTractApi.get_response_for(self, {eid: eid})
+        end
+
+        #
+        # @param {String} desc
+        #
+        def find_by_desc desc
+          GoTransverseTractApi.get_response_for(self, {desc: desc})
+        end
+
+        #
+        # @param {String} status
+        #
+        def find_by_status status
+          GoTransverseTractApi.get_response_for(self, {status: status})
+        end
       end
 
     end
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/order/order_item_charge.rb

@@ -4,8 +4,61 @@ module GoTransverseTractApi
 
     class OrderItemCharge
 
+      class << self
+
+        #
+        # @param {Long} eid
+        #
+        def find_by_eid eid
+          GoTransverseTractApi.get_response_for(self, {eid: eid})
+        end
+
+        #
+        # @param {Long} order_eid
+        #
+        def find_by_order_eid order_eid
+          GoTransverseTractApi.get_response_for(self, {order_eid: order_eid})
+        end
+
+        #
+        # @param {Long} order_item_eid
+        #
+        def find_by_order_item_eid order_item_eid
+          GoTransverseTractApi.get_response_for(self, {order_item_eid: order_item_eid})
+        end
+
+        #
+        # @param {Long} account_num
+        #
+        def find_by_account_num account_num
+          GoTransverseTractApi.get_response_for(self, {account_num: account_num})
+        end
+
+        #
+        # @param {Long} billing_account_eid
+        #
+        def find_by_billing_account_eid billing_account_eid
+          GoTransverseTractApi.get_response_for(self, {billing_account_eid: billing_account_eid})
+        end
+
+        #
+        # @param {String} not_to_invoice
+        #
+        def find_by_not_to_invoice not_to_invoice
+          GoTransverseTractApi.get_response_for(self, {not_to_invoice: not_to_invoice})
+        end
+
+        #
+        # @param {Boolean} invoiced
+        #
+        def find_by_invoiced invoiced
+          GoTransverseTractApi.get_response_for(self, {invoiced: invoiced})
+        end
+
+      end
+
     end
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/order/organization.rb

@@ -29,8 +29,24 @@ module GoTransverseTractApi
         GoTransverseTractApi.get_response_for(self, {billing_account_eid: billing_account_eid})
       end
 
+      #
+      # @param {Long} eid
+      # @param {Nokogiri::XML::Document} address
+      #
+      def self.add_address eid, address
+        GoTransverseTractApi.post_request_for(self, {eid: eid}, address.to_s, "addAddress")
+      end
+
+      #
+      # @param {Long} eid
+      # @param {Nokogiri::XML::Document} organization
+      #
+      def self.update eid, organization
+        GoTransverseTractApi.put_request_for(self, {eid: eid}, organization.to_s)
+      end
+
     end
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/order/party_category.rb

@@ -4,6 +4,10 @@ module GoTransverseTractApi
 
     class PartyCategory
 
+      def self.find_all
+        GoTransverseTractApi.get_response_for(self)
+      end
+
       #
       # @param {Long} eid
       #
@@ -36,4 +40,4 @@ module GoTransverseTractApi
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/order/people.rb

@@ -41,7 +41,7 @@ module GoTransverseTractApi
       # @param {Nokogiri::XML::Document} people
       #
       def self.update eid, people
-        GoTransverseTractApi.put_response_for(self, {eid: eid}, people.to_s)
+        GoTransverseTractApi.put_request_for(self, {eid: eid}, people.to_s)
       end
 
       #
@@ -49,11 +49,27 @@ module GoTransverseTractApi
       # @param {Nokogiri::XML::Document} address
       #
       def self.add_address eid, address
-        GoTransverseTractApi.post_response_for(self, {eid: eid}, address.to_s, "addAddress")
+        GoTransverseTractApi.post_request_for(self, {eid: eid}, address.to_s, "addAddress")
+      end
+
+      #
+      # @param {Long} eid
+      # @param {Nokogiri::XML::Document} person
+      #
+      def self.add_person eid, person
+        GoTransverseTractApi.post_request_for(self, {eid: eid}, person.to_s, "addPerson")
+      end
+
+      #
+      # @param {Long} eid
+      # @param {Nokogiri::XML::Document} person
+      #
+      def self.remove_person eid, person
+        GoTransverseTractApi.post_request_for(self, {eid: eid}, person.to_s, "removePerson")
       end
 
     end
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/order/product_relation.rb

@@ -4,8 +4,33 @@ module GoTransverseTractApi
 
     class ProductRelation
 
+      class << self
+
+        #
+        # @param {Long} eid
+        #
+        def find_by_eid eid
+          GoTransverseTractApi.get_response_for(self, {eid: eid})
+        end
+
+        #
+        # @param {Long} product_eid
+        #
+        def find_by_product_eid product_eid
+          GoTransverseTractApi.get_response_for(self, {product_eid: product_eid})
+        end
+
+        #
+        # @param {String} type
+        #
+        def find_by_type type
+          GoTransverseTractApi.get_response_for(self, {type: type})
+        end
+
+      end
+
     end
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/order/renewal_order.rb

@@ -4,8 +4,82 @@ module GoTransverseTractApi
 
     class RenewalOrder
 
+      class << self
+
+        #
+        # @param {Long} eid
+        #
+        def find_by_eid eid
+          GoTransverseTractApi.get_response_for(self, {eid: eid})
+        end
+
+        #
+        # @param {Long} order_num
+        #
+        def find_by_order_num order_num
+          GoTransverseTractApi.get_response_for(self, {order_num: order_num})
+        end
+
+        #
+        # @param {Long} billing_account_eid
+        #
+        def find_by_billing_account_eid billing_account_eid
+          GoTransverseTractApi.get_response_for(self, {billing_account_eid: billing_account_eid})
+        end
+
+        #
+        # @param {Long} account_num
+        #
+        def find_by_account_num account_num
+          GoTransverseTractApi.get_response_for(self, {account_num: account_num})
+        end
+
+        #
+        # @param {Long} external_account_num
+        #
+        def find_by_external_account_num external_account_num
+          GoTransverseTractApi.get_response_for(self, {external_account_num: external_account_num})
+        end
+
+        #
+        # @param {Date} order_date
+        #
+        def find_by_order_date order_date
+          GoTransverseTractApi.get_response_for(self, {order_date: order_date})
+        end
+
+        #
+        # @param {String} referral
+        #
+        def find_by_referral referral
+          GoTransverseTractApi.get_response_for(self, {referral: referral})
+        end
+
+        #
+        # @param {Long} purchase_order_number
+        #
+        def find_by_purchase_order_number purchase_order_number
+          GoTransverseTractApi.get_response_for(self, {purchase_order_number: purchase_order_number})
+        end
+
+        #
+        # @param {Date} renewal_date
+        #
+        def find_by_renewal_date renewal_date
+          GoTransverseTractApi.get_response_for(self, {renewal_date: renewal_date})
+        end
+
+        #
+        # @param {Long} custom_field_value_eid
+        #
+        def find_by_custom_field_value_eid custom_field_value_eid
+          GoTransverseTractApi.get_response_for(self, {custom_field_value_eid: custom_field_value_eid})
+        end
+
+      end
+
     end
 
   end
 
-end
+end

data/lib/gotransverse-tract-api/order/sales_order.rb

@@ -4,8 +4,124 @@ module GoTransverseTractApi
 
     class SalesOrder
 
+      class << self
+
+        #
+        # @param {Long} eid
+        #
+        def find_by_eid eid
+          GoTransverseTractApi.get_response_for(self, {eid: eid})
+        end
+
+        #
+        # @param {Long} order_num
+        #
+        def find_by_order_num order_num
+          GoTransverseTractApi.get_response_for(self, {order_num: order_num})
+        end
+
+        #
+        # @param {Long} billing_account_eid
+        #
+        def find_by_billing_account_eid billing_account_eid
+          GoTransverseTractApi.get_response_for(self, {billing_account_eid: billing_account_eid})
+        end
+
+        #
+        # @param {Long} account_num
+        #
+        def find_by_account_num account_num
+          GoTransverseTractApi.get_response_for(self, {account_num: account_num})
+        end
+
+        #
+        # @param {Long} external_account_num
+        #
+        def find_by_external_account_num external_account_num
+          GoTransverseTractApi.get_response_for(self, {external_account_num: external_account_num})
+        end
+
+        #
+        # @param {Date} order_date
+        #
+        def find_by_order_date order_date
+          GoTransverseTractApi.get_response_for(self, {order_date: order_date})
+        end
+
+        #
+        # @param {String} referral
+        #
+        def find_by_referral referral
+          GoTransverseTractApi.get_response_for(self, {referral: referral})
+        end
+
+        #
+        # @param {Long} purchase_order_num
+        #
+        def find_by_purchase_order_num purchase_order_num
+          GoTransverseTractApi.get_response_for(self, {purchase_order_num: purchase_order_num})
+        end
+
+        #
+        # @param {String} status
+        #
+        def find_by_status status
+          GoTransverseTractApi.get_response_for(self, {status: status})
+        end
+
+        #
+        # @param {Long} custom_field_value_eid
+        #
+        def find_by_custom_field_value_eid custom_field_value_eid
+          GoTransverseTractApi.get_response_for(self, {custom_field_value_eid: custom_field_value_eid})
+        end
+
+        #
+        # @param {Long} eid
+        # @param {Long} sequence
+        # @param {Nokogiri::XML::Document} sales_order
+        #
+        def approve eid, sequence, sales_order
+          GoTransverseTractApi.post_request_for(self, {eid: eid}, sales_order.to_s, "item/#{sequence}/approve")
+        end
+
+        #
+        # @param {Long} eid
+        # @param {Long} sequence
+        # @param {Nokogiri::XML::Document} sales_order
+        #
+        def deny eid, sequence, sales_order
+          GoTransverseTractApi.post_request_for(self, {eid: eid}, sales_order.to_s, "item/#{sequence}/deny")
+        end
+
+        #
+        # @param {Long} eid
+        # @param {Nokogiri::XML::Document} sales_order
+        #
+        def self.add_custom_field_value eid, sales_order
+          GoTransverseTractApi.post_request_for(self, {eid: eid}, sales_order.to_s, "addCustomFieldValue")
+        end
+
+        #
+        # @param {Long} eid
+        # @param {Nokogiri::XML::Document} sales_order
+        #
+        def self.remove_custom_field_value eid, sales_order
+          GoTransverseTractApi.post_request_for(self, {eid: eid}, sales_order.to_s, "removeCustomFieldValue")
+        end
+
+        #
+        # @param {Nokogiri::XML::Document} person
+        #
+        def self.create_sales_order sales_order
+          GoTransverseTractApi.post_request_for(self, {}, sales_order.to_s, "")
+        end
+
+
+      end
+
     end
 
   end
 
-end
+end

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

@@ -1,6 +1,6 @@
 module GoTransverseTractApi
 
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
   TARGET_API_VERSION = "1.28"
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gotransverse-tract-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Julien DeFrance