gotransverse-tract-api 0.3.4 → 0.4.0

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

@@ -59,7 +59,16 @@ module GoTransverseTractApi
         # @param {Hash} service_resource
         #
         def request service_resource
-          GoTransverseTractApi.post_request_for(self, {}, service_resource, "request")
+          data = {
+            :requestServiceResource => {
+              :identifier => service_resource[:identifier],
+              :status => service_resource[:status],
+              :description => service_resource[:description]
+            },
+            :serviceResourceCategory => {eid: service_resource[:service_resource_category][:eid]}
+          }
+          xml_data = GoTransverseTractApi.generateXML(data, 'requestServiceResource')
+          GoTransverseTractApi.post_request_for(self, {}, xml_data, "request")
         end
 
         #
@@ -67,7 +76,21 @@ module GoTransverseTractApi
         # @param {Hash} service_resource
         #
         def change eid, service_resource
-          GoTransverseTractApi.post_request_for(self, {eid: eid}, service_resource, "change")
+          data = {
+            :changeServiceResource => {},
+            :serviceResource => {eid: eid},
+            :changeToServiceResource => {
+              :attributes => {
+                :identifier => service_resource[:change_to_service_resource][:identifier],
+                :status => service_resource[:change_to_service_resource][:status],
+                :description => service_resource[:change_to_service_resource][:description]
+              },
+              :category => {eid: service_resource[:category][:eid]}
+            }
+          }
+
+          xml_data = GoTransverseTractApi.generateXML(data, 'changeServiceResource')
+          GoTransverseTractApi.post_request_for(self, {eid: eid}, xml_data, "change")
         end
 
         #
@@ -75,14 +98,30 @@ module GoTransverseTractApi
         # @param {Hash} service_resource
         #
         def deactivate eid, service_resource
-          GoTransverseTractApi.post_request_for(self, {eid: eid}, service_resource, "deactivate")
+          data = {
+            :deactivateServiceResource => {},
+            :serviceResource => {eid: eid}
+          }
+
+          xml_data = GoTransverseTractApi.generateXML(data, 'deactivateServiceResource')
+          GoTransverseTractApi.post_request_for(self, {eid: eid}, xml_data, "deactivate")
         end
 
         #
         # @param {Hash} service_resource
         #
         def create_service_resource service_resource
-          GoTransverseTractApi.post_request_for(self, {}, service_resource, "")
+          data = {
+            :serviceResource => {
+              :identifier => service_resource[:identifier],
+              :status => service_resource[:status],
+              :description => service_resource[:description]
+            },
+            :category => {eid: service_resource[:category][:eid]}
+          }
+
+          xml_data = GoTransverseTractApi.generateXML(data, 'serviceResource')
+          GoTransverseTractApi.post_request_for(self, {}, xml_data, "")
         end
 
         #
@@ -97,8 +136,20 @@ module GoTransverseTractApi
         # @param {Long} eid
         # @param {Hash} service_resource
         #
-        def self.add_service_resource eid, service_resource
-          GoTransverseTractApi.post_request_for(self, {eid: eid}, service_resource, "addServiceResource")
+        def add_service_resource eid, service_resource
+          data = {
+            :addServiceResourceToService => {},
+            :service => {eid: eid},
+            :serviceResource => {
+              :attributes => {
+                :identifier => service_resource[:identifier]
+              },
+              :category => {eid: service_resource[:category][:eid]}
+            }
+          }
+
+          xml_data = GoTransverseTractApi.generateXML(data, 'addServiceResourceToService')
+          GoTransverseTractApi.post_request_for(self, {eid: eid}, xml_data, "addServiceResource")
         end
 
         #
@@ -106,7 +157,14 @@ module GoTransverseTractApi
         # @param {Hash} service_resource
         #
         def self.remove_service_resource eid, service_resource
-          GoTransverseTractApi.post_request_for(self, {eid: eid}, service_resource, "removeServiceResource")
+          data = {
+            :removeServiceResourceFromService => {},
+            :service => {eid: eid},
+            :serviceResource => {eid: service_resource[:eid]}
+          }
+
+          xml_data = GoTransverseTractApi.generateXML(data, 'removeServiceResourceFromService')
+          GoTransverseTractApi.post_request_for(self, {eid: eid}, xml_data, "removeServiceResource")
         end
 
       end

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

@@ -69,21 +69,76 @@ module GoTransverseTractApi
         # @param {Hash} usage_event
         #
         def create_usage_event usage_event
-          GoTransverseTractApi.post_request_for(self, {}, usage_event, "")
+          data = {
+            usageEvent: {
+              startTime: usage_event[:start_time],
+              serviceResourceId: usage_event[:service_resource_id],
+              usageUom: usage_event[:usage_uom],
+              usageAmount: usage_event[:usage_amount],
+              number01: usage_event[:number01]
+            },
+            serviceResourceType: usage_event[:service_resource_type]
+          }
+
+          xml_data = GoTransverseTractApi.generateXML(data, 'usageEvent')
+          GoTransverseTractApi.post_request_for(self, xml_data, "")
         end
 
         #
         # @param {Hash} usage_event
         #
         def bulk usage_event
-          GoTransverseTractApi.post_request_for(self, {}, usage_event, "bulk")
+          data = {
+            bulkUsageEvents: {},
+            usageEvents: get_usage_events(usage_event)
+          }
+
+          xml_data = GoTransverseTractApi.generateXML(data, 'bulkUsageEvents')
+          GoTransverseTractApi.post_request_for(self, {}, xml_data, "bulk")
         end
 
         #
         # @param {Hash} usage_event
         #
         def void_event usage_event
-          GoTransverseTractApi.post_request_for(self, {}, usage_event, "void_event")
+          
+          data = {
+            voidUsageEvent: {},
+            usageEvent: {
+              eid: usage_event[:eid]
+            }
+          }
+
+          xml_data = GoTransverseTractApi.generateXML(data, 'voidUsageEvent')
+          GoTransverseTractApi.post_request_for(self, usage_event, "void_event")
+        end
+
+        private
+
+        #
+        # params: [Array] Usage Events
+        #
+        # Returns [Array] of usage events for XML
+        #
+        def get_usage_events(usage_event)
+          events = []
+
+          usage_event.each do|event|
+            events << {
+              usageEvent: {
+                attributes: {
+                  startTime: event[:start_time],
+                  serviceResourceId: event[:service_resource_id],
+                  usageUom: event[:usage_uom],
+                  usageAmount: event[:usage_amount],
+                  description: event[:description]
+                },
+                serviceResourceType: event[:service_resource_type]
+              }
+            }
+          end
+
+          events      
         end
 
       end

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

@@ -0,0 +1,19 @@
+module GoTransverseTractApi
+
+  module UsageMain
+
+    class << self
+
+      #
+      # @param {Long} eid
+      #
+      def find_by_eid eid
+        debugger
+        GoTransverseTractApi.get_response_for(self, {eid: eid})
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,24 @@
+module GoTransverseTractApi
+
+  module Usage
+
+    class UsageSome 
+      include UsageMain
+
+      class << self
+
+        #
+        # @param {Long} billing_account_eid
+        # @param {Boolean} closed
+        #
+        def find_by_billing_account_eid billing_account_eid, closed
+          GoTransverseTractApi.get_response_for(self, {billing_account_eid: billing_account_eid, closed: closed})
+        end
+
+      end
+      
+    end
+
+  end
+
+end

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

@@ -1,6 +1,6 @@
 module GoTransverseTractApi
 
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
   TARGET_API_VERSION = "1.28"
 
 end

data/spec/gotransverse-tract-api/billing_account/adjustment_spec.rb

@@ -0,0 +1,190 @@
+require 'spec_helper'
+
+module GoTransverseTractApi
+
+  RSpec.describe BillingAccount::Adjustment do
+    before(:each) { http_auth }
+
+    let(:response)  { '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' }
+    let(:eid) { '48406' }
+    let(:data) { { 
+          :full_amount => 'true',
+          :occurred_on => '2014-10-01T00:00:00',
+          :amount => '1.00',
+          :description => 'dsfsfsdfsdfsd sdsdsdvss',
+          :invoiced => 'false',
+          :credit => 'true',
+          :status => 'pending',
+          :type => 'MANUAL',
+          :manual_invoice_application => 'true',
+          eid: '124343',
+          :billing_account => {
+            :account_num => '5635',
+            :bill_type => 'EMAIL',
+            :automatic_recurring_payment => 'false',
+            :status => 'Active',
+            :pending_charges_total => '0.00',
+            :balance => '-10.00',
+            :start_date => '2014-11-11T10:00:00',
+            :tax_exempt => 'false',
+            eid: '3663',
+            :daily_bill_cycle => {
+              :name => 'daily 10 to 3',
+              :start_date => '2014-11-11T10:00:00',
+              :end_date => '2014-11-12T10:00:00',
+              :bill_cycle_type => 'Daily',
+              :auto_bill => 'true',
+              :use_payment_term => 'true',
+              :status => 'ACTIVE',
+              eid: '223'
+            },
+            :person => {
+              :first_name => 'John',
+              :last_name => 'Smith',
+              eid: '3305',
+              :addresses => {
+                :postal_address => {
+                  :purpose => 'BILLING',
+                  :country => 'USA',
+                  :city => 'Dallas',
+                  :region_or_state => 'TX',
+                  :postal_code => '78665',
+                  :line1 => '123 Main St',
+                  eid: '3453'
+                },
+                :email_address => {
+                  :purpose => 'PRIMARY',
+                  :email => 'john@smith.com',
+                  eid: '3453'
+                }
+              }
+            },
+            :billing_account_category => {
+              :type => 'All',
+              :description => 'dsdgdg dhretsdfdg eggdg',
+              :status => 'ACTIVE',
+              eid: '45354'
+            },
+            :services => {
+              :page_number => '1',
+              :page_size => '50',
+              :total_elements => '1',
+              :element_count => '0',
+              :total_pages => '1'
+            },
+            :payment_term => {
+              :name => 'Immediate',
+              :term_days => '0',
+              :grace_days => '0',
+              eid: '353'
+            }
+          },
+          :reason => {
+            :name => 'Default Credit Adjustment',
+            :description => 'sefwgsvd dhgrgsfree ergreg',
+            :status => 'Active',
+            :credit_only => 'true',
+            eid: '99'
+          }
+        } }
+
+    context ".post" do
+      it "posts the adjustment" do
+        data_for_post = { 
+          eid: '124343'
+        }
+
+        allow(subject).to receive(:post).with(eid, data_for_post).and_return(response)
+        expect(subject.post(eid, data_for_post)).to eq(response)
+      end
+    end
+
+    context ".reverse" do
+      it "reverses the adjustment" do
+        allow(subject).to receive(:reverse).with(eid, data).and_return(response)
+        expect(subject.reverse(eid, data)).to eq(response)
+      end
+    end
+
+    context ".add_invoice_application" do
+      it "adds invoice application to adjustment" do
+        data[:invoice_adjustment_application] = {
+          :amount => '1.0',
+          :invoice => {
+            :invoice_num => '23',
+            :amount => '10.00',
+            :pdf_path => 'https://my.tractbilling.com/t/s/r/1.28/invoices/2914/pdf',
+            :occurred_on => '2014-10-10T00:00:00',
+            :due_date => '2014-10-10T00:00:00',
+            :amount_to_pay => '4.00',
+            :late_fee_charged => 'false',
+            :status => 'open',
+            :usage_csv_path => 'https://my.tractbilling.com/t/s/r/1.28/invoices/2914/csv',
+            eid: '2342'
+          }
+        }
+
+        allow(subject).to receive(:add_invoice_application).with(eid, data).and_return(response)
+        expect(subject.add_invoice_application(eid, data)).to eq(response)
+      end
+    end
+
+    context ".reverse_invoice_application" do
+      it "reverses invoice application from adjustment" do
+
+        data[:invoice_adjustment_application] = {
+          :reversed => 'false',
+          :applied_on => '2014-10-10T10:10:10',
+          :amount => '1.0',
+          eid: '197',
+          :account_adjustment => {
+            :invoiced => 'true',
+            :credit => 'true',
+            :status => 'POSTED',
+            :posted_on => '2014-01-01T10:00:00',
+            :posted_by => 'Admin'
+          },
+          :invoice => {
+            :invoice_num => '23',
+            :amount => '10.00',
+            :pdf_path => 'https://my.tractbilling.com/t/s/r/1.28/invoices/2914/pdf',
+            :occurred_on => '2014-10-10T00:00:00',
+            :due_date => '2014-10-10T00:00:00',
+            :amount_to_pay => '4.00',
+            :late_fee_charged => 'false',
+            :status => 'open',
+            :usage_csv_path => 'https://my.tractbilling.com/t/s/r/1.28/invoices/2914/csv',
+            eid: '2342'
+          }
+        }
+
+        allow(subject).to receive(:reverse_invoice_application).with(eid, data).and_return(response)
+        expect(subject.reverse_invoice_application(eid, data)).to eq(response)
+      end
+    end
+
+    context ".create_adjustment" do
+      it "creates an adjustment" do
+        data = {
+          :occurred_on => '2013-11-11T11:00:00',
+          :amount => '10.00',
+          :description => 'some thing fishy',
+          :type => 'MANUAL',
+          :credit => 'true',
+          :posted => 'false',
+          :billing_account => {
+            eid: '322'
+          },
+          :reason => {
+            eid: '6456'
+          }
+        }
+
+        allow(subject).to receive(:create_adjustment).with(data).and_return(response)
+        expect(subject.create_adjustment(data)).to eq(response)
+      end
+    end
+
+  end
+end
+

data/spec/gotransverse-tract-api/billing_account/billing_account_spec.rb

@@ -0,0 +1,380 @@
+require 'spec_helper'
+
+module GoTransverseTractApi
+
+  RSpec.describe BillingAccount::BillingAccount do
+    before(:each) { http_auth }
+
+    let(:response)  { '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' }
+    let(:eid) { '48406' }
+    let(:addresses) { {
+      :email_address => {
+        :purpose => 'primary',
+        :email => 'test@test.com'
+      },
+      :postal_address => {
+        :purpose => 'BILLING',
+        :country => 'USA',
+        :city => 'Pleasanton',
+        :region_or_state => 'CA',
+        :attention => 'John Simth',
+        :postal_code => '94588',
+        :line1 => '3423 something st.'
+      },
+      :telecom_address => {
+        :purpose => 'OFFICE',
+        :dialing_prefix => '9',
+        :country_code => '1',
+        :area_code => '925',
+        :number => '2341212',
+        :extension => '21'
+      }
+    } }
+
+
+    context ".apply_payment" do
+      it "applies a payment to the invoice" do
+        data = {
+          :billing_account => {
+            eid: '123'
+          },
+          :invoice => {
+            eid: '456'
+          },
+          :payment => {
+            :amount => '27',
+            :use_recurring_payment => 'false',
+            :credit_card_payment => {
+              :card_type => 'VISA',
+              :card_holder_first_name => 'Mary',
+              :card_holder_last_name => 'Smith',
+              :card_identifier_number => '4111111111111111111',
+              :card_verification_number => '123',
+              :card_expiration => '12/2016',
+              :description => 'Test Desc'
+            },
+            :billing_account => {
+              eid: '123'
+            }
+          }
+        }
+
+        allow(subject).to receive(:apply_payment).with(eid, data).and_return(response)
+        expect(subject.apply_payment(eid, data)).to eq(response)
+      end
+    end
+
+    context ".suspend" do
+      it "suspends a billing account" do
+        data = {
+          :billing_account => {
+            eid: '123'
+          },
+          :reason => {
+            eid: '456'
+          }
+        }
+
+        allow(subject).to receive(:suspend).with(eid, data).and_return(response)
+        expect(subject.suspend(eid, data)).to eq(response)
+      end
+    end
+
+    context ".resume" do
+      it "resumes a billing account" do
+        data = {
+          :billing_account => {eid: eid},
+          :start_date => '2014-11-11T10:00:00',
+          :notes => 'Test notes here'
+        }
+
+        allow(subject).to receive(:resume).with(eid, data).and_return(response)
+        expect(subject.resume(eid, data)).to eq(response)
+      end
+    end
+
+    context ".add_recurring_payment" do
+      it "adds a recurring payment to the billing account" do
+        data = {
+          :billing_account => {eid: eid},
+          :recurring_payment => {
+            :credit_card_payment_method => {
+              :card_type => 'VISA',
+              :card_holder_first_name => 'Mary',
+              :card_holder_last_name => 'Smith',
+              :card_identifier_number => '4111111111111111111',
+              :card_expiration => '12/2016'
+            }
+          }
+        }
+
+        allow(subject).to receive(:add_recurring_payment).with(eid, data).and_return(response)
+        expect(subject.add_recurring_payment(eid, data)).to eq(response)
+      end
+    end
+
+    context ".change_service" do
+      it "changes service on a billing account" do
+        data = {
+          :service => {eid: '136'},
+          :order => {
+            :note => 'Simple note',
+            :order_items => {
+              :order_item => {
+                :quantity => 2,
+                :description => 'change service',
+                :products => [{
+                  eid: '1234'
+                },
+                {
+                  eid: '4567'
+                }]
+              }
+            },
+            :billing_account => {eid: eid}
+          }
+        }
+
+        allow(subject).to receive(:change_service).with(eid, data).and_return(response)
+        expect(subject.change_service(eid, data)).to eq(response)
+      end
+    end
+
+    context ".add_custom_field_value" do
+      it "adds custom field value to the billing account" do
+        data = { 
+          :billing_account => { eid: eid },
+          :custom_field_value => { :value => 'yes' }
+        }
+
+        allow(subject).to receive(:add_custom_field_value).with(eid, data).and_return(response)
+        expect(subject.add_custom_field_value(eid, data)).to eq(response)
+      end
+    end
+
+    context ".remove_custom_field_value" do
+      it "removes custom field value from the billing account" do
+        data = { 
+          :billing_account => { eid: eid },
+          :custom_field_value => { eid: '486' }
+        }
+
+        allow(subject).to receive(:remove_custom_field_value).with(eid, data).and_return(response)
+        expect(subject.remove_custom_field_value(eid, data)).to eq(response)
+      end
+    end
+
+    context ".deactivate" do
+      it "deactivates a billing account" do
+        data = {
+          :billing_account => { eid: '123' },
+          :reason => { eid: '456' }
+        }
+
+        allow(subject).to receive(:deactivate).with(eid, data).and_return(response)
+        expect(subject.deactivate(eid, data)).to eq(response)
+      end
+    end
+
+    context ".create_billing_account" do
+      it "creates a billing account" do
+        data = {
+          :bill_type => 'EMAIL',
+          :daily_bill_cycle => { eid: '123' },
+          :organization => {
+            :name => 'test services',
+            :addresses => addresses
+          },
+          :billing_account_category => {
+            eid: '123'
+          }
+        }
+
+        allow(subject).to receive(:create_billing_account).with(data).and_return(response)
+        expect(subject.create_billing_account(data)).to eq(response)
+      end
+    end
+
+    context ".add_person" do
+      it "adds a person to the billing account" do
+        data = {
+          :billing_account => { eid: eid },
+          :person => {
+            :first_name => 'Tim',
+            :last_name => 'John',
+            :middle_name => 'R',
+            :addresses => addresses
+          }
+        }
+
+        allow(subject).to receive(:add_person).with(eid, data).and_return(response)
+        expect(subject.add_person(eid, data)).to eq(response)
+      end
+    end
+     
+    context ".remove_billing_account" do
+      it "removes a person from the billing account" do
+        data = {
+          :billing_account => { eid: eid },
+          :person => { eid: '123' }
+        }
+
+        allow(subject).to receive(:remove_billing_account).with(eid, data).and_return(response)
+        expect(subject.remove_billing_account(eid, data)).to eq(response)
+      end
+    end
+
+    context ".create_draft_order" do
+      it "creates a draft sales order for the billing account" do
+
+        data = {
+          :sales_order => {
+            :referral => 'Order Item',
+            :order_date => '2015-07-09',
+            :order_status => 'DRAFT',
+            :order_items => {
+              :page_number => '1',
+              :page_size => '50',
+              :total_elements => '0',
+              :element_count => '0',
+              :total_pages => '0',
+              :order_item => {
+                :quantity => '1',
+                :products => [{
+                  :name => 'sdfsdfsvs',
+                  :description => 'dsfsgegebdbb',
+                  :short_description => 'asfgerdbdb',
+                  :product_type_code => 'udygciww',
+                  :product_state => 'afwfwss',
+                  :requires_agreement => 'true',
+                  :serialized => 'false',
+                  :taxable => 'false',
+                  :trial => 'asda',
+                  :default_quantity => '10',
+                  :min_service_resources => '0',
+                  :max_service_resources => '0',
+                  :trial_override => 'false',
+                  eid: '234',
+                  :product_prices => {
+                    :page_number => '1',
+                    :page_size => '50',
+                    :total_elements => '2',
+                    :element_count => '2',
+                    :total_pages => '1',
+                    :productprices => [{
+                      :from_date => '2013-02-10T01:00:00',
+                      :price_override => 'true',
+                      :type => 'OneTime',
+                      :recurring_payment_required => 'false',
+                      eid: '12345',
+                      :price_ranges => {
+                        :page_number => '1',
+                        :page_size => '50',
+                        :total_elements => '1',
+                        :element_count => '1',
+                        :total_pages => '1',
+                        :priceranges => [{
+                          :quantity_begin_range => '0.00',
+                          :price => '100.00',
+                          :level => '1',
+                          eid: '781'
+                        }]
+                      }
+                    },
+                    {
+                      :from_date => '2013-12-10T01:00:00',
+                      :price_override => 'true',
+                      :type => 'Recurring',
+                      :recurring_payment_required => 'false',
+                      eid: '348',
+                      :price_ranges => {
+                        :page_number => '1',
+                        :page_size => '50',
+                        :total_elements => '1',
+                        :element_count => '1',
+                        :total_pages => '1',
+                        :priceranges => [{
+                          :quantity_begin_range => '0.00',
+                          :price => '10.00',
+                          :level => '1',
+                          eid: '812'
+                        }]
+                      }
+                    }]
+                  },
+                  :product_category => {
+                    :name => 'sdfsdfs',
+                    :description => 'wrggdgd',
+                    :status => 'Active',
+                    eid: '234'
+                  },
+                  :actions => {
+                    :page_number => '1',
+                    :page_size => '50',
+                    :total_elements => '1',
+                    :element_count => '1',
+                    :total_pages => '1'
+                  },
+                  :product_usage_rules => {
+                    :page_number => '1',
+                    :page_size => '50',
+                    :total_elements => '1',
+                    :element_count => '1',
+                    :total_pages => '1'
+                  }
+                }]
+              }
+            },
+            :billing_account => {
+              :account_num => '5635',
+              :bill_type => 'EMAIL',
+              :automatic_recurring_payment => 'false',
+              :status => 'Active',
+              :pending_charges_total => '0.00',
+              :balance => '-10.00',
+              :start_date => '2014-11-11T10:00:00',
+              :tax_exempt => 'false',
+              eid: '3663',
+              :daily_bill_cycle => {
+                :name => 'daily 10 to 3',
+                :start_date => '2014-11-11T10:00:00',
+                :end_date => '2014-11-12T10:00:00',
+                :bill_cycle_type => 'Daily',
+                :auto_bill => 'true',
+                :status => 'ACTIVE',
+                eid: '223'
+              },
+              :person => {
+                :first_name => 'John',
+                :last_name => 'Smith',
+                :middle_name => 'S',
+                eid: '3305',
+                :addresses => addresses
+              },
+              :billing_account_category => {
+                :type => 'All',
+                :description => 'dsdgdg dhretsdfdg eggdg',
+                :status => 'ACTIVE',
+                eid: '45354'
+              },
+              :payment_term => {
+                :name => 'Immediate',
+                :term_days => '0',
+                :grace_days => '0',
+                eid: '353'
+              }
+            }
+          }
+        }
+
+        data[:sales_order][:billing_account][:person][:addresses][:email_address][:eid] = '123'
+        data[:sales_order][:billing_account][:person][:addresses][:postal_address][:eid] = '345'
+        data[:sales_order][:billing_account][:person][:addresses][:telecom_address][:eid] = '678'
+
+        allow(subject).to receive(:create_draft_order).with(eid, data).and_return(response)
+        expect(subject.create_draft_order(eid, data)).to eq(response)
+      end
+    end
+
+  end
+end