bill_forward 1.2014.296

data/lib/bill_forward/custom_hash.rb

@@ -0,0 +1,14 @@
+module BillForward
+	# Note: does not use indifferent access! Only entities themselves have indifferent access!
+	class OrderedHashWithDotAccess < ActiveSupport::OrderedHash
+		def method_missing(method_id, *arguments, &block)
+			# no call to super; our criteria is all keys.
+			#setter
+			if /^(\w+)=$/ =~ method_id.to_s
+				return self[$1] = arguments.first
+			end
+			#getter
+			self[method_id.to_s]
+		end
+	end
+end

data/lib/bill_forward/deny_method.rb

@@ -0,0 +1,4 @@
+module BillForward
+	class DenyMethod < StandardError
+	end
+end

data/lib/bill_forward/entities/account.rb

@@ -0,0 +1,19 @@
+module BillForward
+  # This entity exposes the following child entities via method_missing:
+  # 
+  # Role[]           .roles
+  # PaymentMethod[]  .paymentMethods
+  # Profile          .profile
+  class Account < MutableEntity
+  	@resource_path = BillForward::ResourcePath.new("accounts", "account")
+
+  protected
+    def unserialize_all(hash)
+      super
+      unserialize_entity('profile', Profile, hash)
+
+      unserialize_array_of_entities('roles', Role, hash)
+      unserialize_array_of_entities('paymentMethods', PaymentMethod, hash)
+    end
+  end
+end

data/lib/bill_forward/entities/address.rb

@@ -0,0 +1,25 @@
+module BillForward
+  class Address < MutableEntity
+  	@resource_path = BillForward::ResourcePath.new('addresses', 'address')
+
+  	class << self
+	  	def get_by_id(id, query_params = {}, customClient = nil)
+	  		raise DenyMethod.new 'Get by ID support is denied for this entity; '+
+			 'at the time of writing, no API endpoint exists to support it.'+
+			 'The entity can be GETted through cascade only (i.e. GET a related entity).'
+	  	end
+
+	  	def get_all(query_params = {}, customClient = nil)
+	  		raise DenyMethod.new 'Get All support is denied for this entity; '+
+			 'at the time of writing, no API endpoint exists to support it.'+
+			 'The entity can be GETted through cascade only (i.e. GET a related entity).'
+	  	end
+	end
+
+  	def save()
+  		raise DenyMethod.new 'Save support is denied for this entity; '+
+		 'at the time of writing, the provided API endpoint is not functioning.'+
+		 'The entity can be saved through cascade only (i.e. save a related entity).'
+  	end
+  end
+end

data/lib/bill_forward/entities/amendments/amendment.rb

@@ -0,0 +1,11 @@
+module BillForward
+  class Amendment < InsertableEntity
+  	@resource_path = BillForward::ResourcePath.new("amendments", "amendment")
+
+    def initialize(*args)
+      raise AbstractInstantiateError.new('This abstract class cannot be instantiated!') if self.class == Amendment
+      super
+    end
+
+  end
+end

data/lib/bill_forward/entities/amendments/invoice_recalculation_amendment.rb

@@ -0,0 +1,10 @@
+module BillForward
+	class InvoiceRecalculationAmendment < Amendment
+		@resource_path = BillForward::ResourcePath.new("amendments", "amendment")
+		
+		def initialize(*args)
+			super
+			set_state_param('@type', 'InvoiceRecalculationAmendment')
+		end
+	end
+end

data/lib/bill_forward/entities/api_configuration.rb

@@ -0,0 +1,11 @@
+module BillForward
+  class APIConfiguration < MutableEntity
+  	class << self
+		def create(entity = nil)
+	  		raise DenyMethod.new 'Create support is denied for this entity; '+
+		 	'at the time of writing, no API endpoint exists to support it. '+
+		 	'The entity can be created through cascade only (i.e. instantiated within another entity).'
+	  	end
+	end
+  end
+end

data/lib/bill_forward/entities/authorize_net_token.rb

@@ -0,0 +1,9 @@
+module BillForward
+	class AuthorizeNetToken < MutableEntity
+		# WARNING: resource paths for AuthorizeNetTokens do not follow the usual pattern;
+		# instead of posting to 'root' of a URL root reserved for AuthorizeNetTokens, 
+		# this routing is a bit less standard; for example we can't GET from the same
+		# place we POST to.
+  		@resource_path = BillForward::ResourcePath.new('vaulted-gateways/authorize-net', 'authorizeNetToken')
+	end
+end

data/lib/bill_forward/entities/credit_note.rb

@@ -0,0 +1,13 @@
+module BillForward
+  class CreditNote < MutableEntity
+  	@resource_path = BillForward::ResourcePath.new('credit-notes', 'creditNote')
+
+  	class << self
+	  	def get_all(query_params = {}, customClient = nil)
+	  		raise DenyMethod.new 'Get All support is denied for this entity; '+
+			 'at the time of writing, no API endpoint exists to support it.'+
+			 'The entity can be GETted by ID only.'
+	  	end
+	end
+  end
+end

data/lib/bill_forward/entities/invoice.rb

@@ -0,0 +1,25 @@
+module BillForward
+  # This entity exposes the following child entities via method_missing:
+  # 
+  # InvoiceLine[]     .invoiceLines
+  # TaxLine[]         .taxLines
+  # InvoicePayment[]  .invoicePayments
+  class Invoice < MutableEntity
+  	@resource_path = BillForward::ResourcePath.new('invoices', 'invoice')
+
+    class << self
+      def create(entity = nil)
+        raise DenyMethod.new 'Create support is denied for this entity; '+
+          'Invoices are generated instead by the BillForward Engines.'
+      end
+    end
+
+  protected
+    def unserialize_all(hash)
+      super
+      unserialize_array_of_entities('invoiceLines', InvoiceLine, hash)
+      unserialize_array_of_entities('taxLines', TaxLine, hash)
+      unserialize_array_of_entities('invoicePayments', InvoicePayment, hash)
+    end
+  end
+end

data/lib/bill_forward/entities/invoice_parts/invoice_line.rb

@@ -0,0 +1,37 @@
+module BillForward
+  # This entity exposes the following child entities via method_missing:
+  # 
+  # UnitOfMeasure     .unitOfMeasure
+  class InvoiceLine < MutableEntity
+  	class << self
+  		def create(entity = nil)
+	  		raise DenyMethod.new 'Create support is denied for this entity; '+
+		 	'at the time of writing, no API endpoint exists to support it. '+
+		 	'The entity can be created through cascade only (i.e. instantiated within another entity).'
+	  	end
+
+	  	def get_by_id(id, query_params = {}, customClient = nil)
+	  		raise DenyMethod.new 'Get by ID support is denied for this entity; '+
+			 'at the time of writing, no API endpoint exists to support it.'+
+			 'The entity can be GETted through cascade only (i.e. GET a related entity).'
+	  	end
+
+	  	def get_all(query_params = {}, customClient = nil)
+	  		raise DenyMethod.new 'Get All support is denied for this entity; '+
+			 'at the time of writing, no API endpoint exists to support it.'+
+			 'The entity can be GETted through cascade only (i.e. GET a related entity).'
+	  	end
+	end
+
+  	def save()
+  		raise DenyMethod.new 'Save support is denied for this entity; '+
+		 'at the time of writing, the provided API endpoint is not functioning.'+
+		 'The entity can be saved through cascade only (i.e. save a related entity).'
+  	end
+  protected
+    def unserialize_all(hash)
+      super
+      unserialize_entity('unitOfMeasure', UnitOfMeasure, hash)
+    end
+  end
+end

data/lib/bill_forward/entities/invoice_parts/invoice_payment.rb

@@ -0,0 +1,29 @@
+module BillForward
+  class InvoicePayment < MutableEntity
+  	class << self
+  		def create(entity = nil)
+	  		raise DenyMethod.new 'Create support is denied for this entity; '+
+		 	'at the time of writing, no API endpoint exists to support it. '+
+		 	'The entity can be created through cascade only (i.e. instantiated within another entity).'
+	  	end
+
+	  	def get_by_id(id, query_params = {}, customClient = nil)
+	  		raise DenyMethod.new 'Get by ID support is denied for this entity; '+
+			 'at the time of writing, no API endpoint exists to support it.'+
+			 'The entity can be GETted through cascade only (i.e. GET a related entity).'
+	  	end
+
+	  	def get_all(query_params = {}, customClient = nil)
+	  		raise DenyMethod.new 'Get All support is denied for this entity; '+
+			 'at the time of writing, no API endpoint exists to support it.'+
+			 'The entity can be GETted through cascade only (i.e. GET a related entity).'
+	  	end
+	end
+
+  	def save()
+  		raise DenyMethod.new 'Save support is denied for this entity; '+
+		 'at the time of writing, the provided API endpoint is not functioning.'+
+		 'The entity can be saved through cascade only (i.e. save a related entity).'
+  	end
+  end
+end

data/lib/bill_forward/entities/invoice_parts/tax_line.rb

@@ -0,0 +1,23 @@
+module BillForward
+  class TaxLine < InsertableEntity
+    class << self
+  		def create(entity = nil)
+	  		raise DenyMethod.new 'Create support is denied for this entity; '+
+		 	'at the time of writing, no API endpoint exists to support it. '+
+		 	'The entity can be created through cascade only (i.e. instantiated within another entity).'
+	  	end
+
+	  	def get_by_id(id, query_params = {}, customClient = nil)
+	  		raise DenyMethod.new 'Get by ID support is denied for this entity; '+
+			 'at the time of writing, no API endpoint exists to support it.'+
+			 'The entity can be GETted through cascade only (i.e. GET a related entity).'
+	  	end
+
+	  	def get_all(query_params = {}, customClient = nil)
+	  		raise DenyMethod.new 'Get All support is denied for this entity; '+
+			 'at the time of writing, no API endpoint exists to support it.'+
+			 'The entity can be GETted through cascade only (i.e. GET a related entity).'
+	  	end
+	end
+  end
+end

data/lib/bill_forward/entities/invoice_parts/taxation_link.rb

@@ -0,0 +1,5 @@
+module BillForward
+  class TaxationLink < MutableEntity
+    @resource_path = BillForward::ResourcePath.new("taxation-links", "TaxationLink")
+  end
+end

data/lib/bill_forward/entities/organisation.rb

@@ -0,0 +1,37 @@
+module BillForward
+  # This entity exposes the following child entities via method_missing:
+  # 
+  # APIConfiguration[]  .apiConfigurations
+  class Organisation < MutableEntity
+  	@resource_path = BillForward::ResourcePath.new("organizations", "organization")
+
+  	class << self
+  		def get_mine(options = {}, customClient = nil)
+			client = customClient
+			client = singleton_client if client.nil?
+
+  			route = resource_path.path
+			endpoint = 'mine'
+			url_full = "#{route}/#{endpoint}"
+
+			response = client.get(url_full)
+			results = response["results"]
+			
+			# maybe use build_entity_array here for consistency
+			entity_array = Array.new
+			# maybe it's an empty array, but that's okay too.
+			results.each do |value|
+				entity = self.new(value, client)
+				entity_array.push(entity)
+			end
+			entity_array
+  		end
+  	end
+
+  protected
+    def unserialize_all(hash)
+      super
+      unserialize_array_of_entities('apiConfigurations', APIConfiguration, hash)
+    end
+  end
+end

data/lib/bill_forward/entities/payment_method.rb

@@ -0,0 +1,5 @@
+module BillForward
+	class PaymentMethod < MutableEntity
+  		@resource_path = BillForward::ResourcePath.new("payment-methods", "paymentMethod")
+	end
+end

data/lib/bill_forward/entities/payment_method_subscription_link.rb

@@ -0,0 +1,5 @@
+module BillForward
+  class PaymentMethodSubscriptionLink < MutableEntity
+    @resource_path = BillForward::ResourcePath.new("payment-method-subcription-links", "PaymentMethodSubscriptionLink")
+  end
+end

data/lib/bill_forward/entities/pricing_component.rb

@@ -0,0 +1,21 @@
+module BillForward
+  # This entity exposes the following child entities via method_missing:
+  # 
+  # PricingComponentTier[]  .tiers
+  class PricingComponent < MutableEntity
+    @resource_path = BillForward::ResourcePath.new("pricing-components", "PricingComponent")
+
+    def self.get_all(options=nil, customClient=nil)
+      raise ArgumentError.new('Get All support is denied for this entity;
+        at the time of writing, no working API endpoint exists to support it.
+        The entity can be GETted through cascade (i.e. GET a related entity), or by ID only.'
+      )
+    end
+
+    protected
+      def unserialize_all(hash)
+        super
+        unserialize_array_of_entities('tiers', PricingComponentTier, hash)
+      end
+  end
+end

data/lib/bill_forward/entities/pricing_component_tier.rb

@@ -0,0 +1,5 @@
+module BillForward
+  class PricingComponentTier < MutableEntity
+    @resource_path = BillForward::ResourcePath.new("pricing-component-tiers", "pricingComponentTier")
+  end
+end

data/lib/bill_forward/entities/pricing_component_value.rb

@@ -0,0 +1,5 @@
+module BillForward
+  class PricingComponentValue < MutableEntity
+    @resource_path = BillForward::ResourcePath.new("pricing-component-values", "PricingComponentValue")
+  end
+end

data/lib/bill_forward/entities/pricing_component_value_change.rb

@@ -0,0 +1,5 @@
+module BillForward
+  class PricingComponentValueChange < MutableEntity
+    @resource_path = BillForward::ResourcePath.new("pricing-component-value-changes", "PricingComponentValueChange")
+  end
+end

data/lib/bill_forward/entities/product.rb

@@ -0,0 +1,5 @@
+module BillForward
+  class Product < MutableEntity
+    @resource_path = BillForward::ResourcePath.new("products", "product")
+  end
+end

data/lib/bill_forward/entities/product_rate_plan.rb

@@ -0,0 +1,19 @@
+module BillForward
+  # This entity exposes the following child entities via method_missing:
+  # 
+  # Product             .product
+  # TaxationLink[]      .taxation
+  # PricingComponent[]  .pricingComponents
+  class ProductRatePlan < MutableEntity
+    @resource_path = BillForward::ResourcePath.new("product-rate-plans", "productRatePlan")
+
+    protected
+      def unserialize_all(hash)
+        super
+        unserialize_entity('product', Product, hash)
+
+        unserialize_array_of_entities('taxation', TaxationLink, hash)
+        unserialize_array_of_entities('pricingComponents', PricingComponent, hash)
+      end
+  end
+end

data/lib/bill_forward/entities/profile.rb

@@ -0,0 +1,15 @@
+module BillForward
+	# This entity exposes the following child entities via method_missing:
+	# 
+	# Address[]      .addresses
+	class Profile < MutableEntity
+		@resource_path = BillForward::ResourcePath.new("profiles", "profile")
+
+	protected
+	    def unserialize_all(hash)
+	      super
+
+	      unserialize_array_of_entities('addresses', Address, hash)
+	    end
+	end
+end

data/lib/bill_forward/entities/role.rb

@@ -0,0 +1,4 @@
+module BillForward
+  class Role < InsertableEntity
+  end
+end

data/lib/bill_forward/entities/subscription.rb

@@ -0,0 +1,53 @@
+module BillForward
+  # This entity exposes the following child entities via method_missing:
+  # 
+  # PricingComponentValue[]        .pricingComponentValues
+  # PricingComponentValueChange[]  .pricingComponentValueChanges
+  class Subscription < MutableEntity
+    @resource_path = BillForward::ResourcePath.new("subscriptions", "subscription")
+
+    class << self
+      def get_by_account_id(id, query_params = {}, customClient = nil)
+        client = customClient
+        client = singleton_client if client.nil?
+
+        raise ArgumentError.new("id cannot be nil") if id.nil?
+        TypeCheck.verifyObj(Hash, query_params, 'query_params')
+
+        route = resource_path.path
+        endpoint = 'account'
+        url_full = "#{route}/#{endpoint}/#{id}"
+
+        response = client.get(url_full, query_params)
+        results = response["results"]
+
+        # maybe use build_entity_array here for consistency
+        entity_array = Array.new
+        # maybe it's an empty array, but that's okay too.
+        results.each do |value|
+          entity = self.new(value, client)
+          entity_array.push(entity)
+        end
+        entity_array
+      end
+    end
+
+    def activate
+      set_state_param('state', 'AwaitingPayment')
+      response = save
+      response
+    end
+
+    protected
+      def unserialize_all(hash)
+        super
+        # always has these:
+        unserialize_array_of_entities('pricingComponentValues', PricingComponentValue, hash)
+        unserialize_array_of_entities('pricingComponentValueChanges', PricingComponentValueChange, hash)
+
+
+        # think about the other entities later..
+        # unserialize_array_of_entities('paymentMethodSubscriptionLinks', PaymentMethodSubscriptionLink, hash)
+      end
+  end
+end