octobat 2.0.20 → 2.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46289335eaf2e2d1e07a0f70bd8c7bb94c9247d3e783cc5831d71986bb60bc1c
-  data.tar.gz: f0f90eed29eefe39d4a5a8466ea96506621feb46b180b388f1840143b3f38251
+  metadata.gz: 8c0554602d9f2b3795ebeb50fc235d1b3fdf1da9a01222153d15a3d2167a35b0
+  data.tar.gz: dcf455738a4a19b5ed27028854b1bc344c7ac37efe8ceb63b92239827e54bdcc
 SHA512:
-  metadata.gz: 9256636dcec153772c0f1c61035aa12e1f73f3a3c8f9649d2761144aa778a4b27fc99b8f9faf21ef008ba3f88bdc07da656a8edac93ddd1066bce1a049f2ec23
-  data.tar.gz: b50267b05a5a0245bab7c3b57514bf9a5f1da4f491fed0148cf1b497f00d89b7e35f011645fad6b2ead7a6e537d417afa201de881273df0d1f4527639bb4591a
+  metadata.gz: 4f760778d1fa6800a687b9eb690688f19809d8fbfaf593648a832defa02e983a0d3da1e7e64b86f6d0e24d9767446cb8cb1cd3f5027215d498a15493cd1d434e
+  data.tar.gz: 43e40f5f2152c0d8da4d807cf29738fa296107f4b68eace16f713d94ec79ab67992b850b88d15bcbd42cad3d1962a808044e273d248a49de277a7f66f682ed3d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    octobat (2.0.20)
+    octobat (2.0.25)
       rest-client (>= 1.4, < 4.0)
 
 GEM
@@ -14,7 +14,7 @@ GEM
       domain_name (~> 0.5)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
+    mime-types-data (3.2020.1104)
     netrc (0.11.0)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)

data/History.txt

@@ -1,14 +1,35 @@
+=== 2.0.25 2020-12-24
+* 2 major enhancements:
+  * Add support for Subscription object
+  * Add support for UsageItem object
+
+=== 2.0.24 2020-12-15
+* 1 minor enhancements:
+  * Add support for Invoice#mark_uncollectible endpoint
+
+=== 2.0.23 2020-12-03
+* 1 minor enhancements:
+  * Add support for Invoice#set_payment_terms endpoint
+
+=== 2.0.22 2020-11-23
+* 1 minor enhancements:
+  * Add support for CustomerBalanceTransaction object
+
+=== 2.0.21 2020-11-12
+* 3 major enhancements:
+  * Add support for Supplier object
+  * Add support for SelfBillingInvoice object
+  * Add support for PurchaseItem object
+
 === 2.0.20 2020-10-05
 * 1 major enhancements:
   * Add support for Beanie::Session object
 
-
 === 2.0.19 2020-05-28
 * 2 major enhancements:
   * Add { opts } param for all nested methods, so you can include headers such as the Connected Octobat Account ID in subrequests
   * Add support for CreditNote#cancel endpoint
 
-
 === 2.0.18 2020-05-25
 * 3 major enhancements:
   * Add support for multipart encoder (file upload)

data/VERSION

@@ -1 +1 @@
-2.0.20
+2.0.25

data/lib/octobat.rb

@@ -25,11 +25,15 @@ require 'octobat/singleton_api_resource'
 require 'octobat/list_object'
 
 require 'octobat/customer'
+require 'octobat/supplier'
 require 'octobat/transaction'
+require 'octobat/customer_balance_transaction'
 require 'octobat/item'
+require 'octobat/purchase_item'
 require 'octobat/document'
 require 'octobat/invoice'
 require 'octobat/credit_note'
+require 'octobat/self_billing_invoice'
 require 'octobat/proforma_invoice'
 require 'octobat/payment_recipient'
 require 'octobat/payment_recipient_reference'
@@ -51,6 +55,8 @@ require 'octobat/document_email_template'
 require 'octobat/exports_setting'
 require 'octobat/emails_setting'
 require 'octobat/tax_id'
+require 'octobat/subscription'
+require 'octobat/usage_item'
 
 require 'octobat/file_upload'
 require 'octobat/file_link'

data/lib/octobat/customer.rb

@@ -16,5 +16,10 @@ module Octobat
     def payment_sources(params = {}, opts = {})
       PaymentSource.list(params.merge({ :customer => id }), {api_key: @api_key}.merge(opts))
     end
+    
+    def customer_balance_transactions(params = {}, opts = {})
+      CustomerBalanceTransaction.list(params.merge({ :customer => id }), {api_key: @api_key}.merge(opts))
+    end
+    
   end
 end

data/lib/octobat/customer_balance_transaction.rb

@@ -0,0 +1,50 @@
+module Octobat
+  class CustomerBalanceTransaction < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    
+    
+    def url
+      !parent_obj.nil? ? parentize_url : super
+    end
+    
+    
+    def save_url
+      if self[:id] == nil && self.class.respond_to?(:create)
+        self.relative_save_url
+      else
+        url
+      end
+    end
+    
+    
+    def parentize_url
+      if parent_obj.include?(:customer)
+        "#{Customer.url}/#{CGI.escape(parent_obj[:customer])}/customer_balance_transactions/#{CGI.escape(id)}"
+      else
+        url
+      end
+    end
+    
+    
+    
+    def relative_save_url
+      if self[:customer]
+        "#{Customer.url}/#{CGI.escape(self[:customer])}/customer_balance_transactions"
+      end
+    end
+    
+
+    def self.url
+      if @parent_resource.include?(:customer)
+        "#{Customer.url}/#{CGI.escape(@parent_resource[:customer])}/customer_balance_transactions"
+      end
+    end
+
+    def self.set_parent_resource(filters)
+      @parent_resource = filters.select{|k, v| [:customer].include?(k)}
+    end
+    
+    
+  end
+end

data/lib/octobat/invoice.rb

@@ -37,6 +37,17 @@ module Octobat
       response, api_key = Octobat.request(:patch, confirm_url, @api_key, params, opts)
       refresh_from(response, api_key)
     end
+    
+    def set_payment_terms(params = {}, opts = {})
+      response, api_key = Octobat.request(:patch, set_payment_terms_url, @api_key, params, opts)
+      refresh_from(response, api_key)
+    end
+    
+    def mark_uncollectible(params = {}, opts = {})
+      response, api_key = Octobat.request(:patch, mark_uncollectible_url, @api_key, params, opts)
+      refresh_from(response, api_key)
+    end
+    
 
     def cancel(params = {}, opts = {})
       response, api_key = Octobat.request(:patch, cancel_url, @api_key, params, opts)
@@ -71,6 +82,14 @@ module Octobat
       def confirm_url
         url + '/confirm'
       end
+      
+      def mark_uncollectible_url
+        url + '/mark_uncollectible'
+      end
+      
+      def set_payment_terms_url
+        url + '/set_payment_terms'
+      end
 
       def cancel_url
         url + '/cancel'

data/lib/octobat/purchase_item.rb

@@ -0,0 +1,52 @@
+module Octobat
+  class PurchaseItem < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+    include Octobat::APIOperations::Delete
+    
+    
+    def url
+      !parent_obj.nil? ? parentize_url : super
+    end
+    
+    
+    def save_url
+      if self[:id] == nil && self.class.respond_to?(:create)
+        self.relative_save_url
+      else
+        url
+      end
+    end
+    
+    
+    def parentize_url
+      if parent_obj.include?(:self_billing_invoice)
+        "#{SelfBillingInvoice.url}/#{CGI.escape(parent_obj[:self_billing_invoice])}/purchase_items/#{CGI.escape(id)}"
+      else
+        url
+      end
+    end
+    
+    
+    
+    def relative_save_url
+      if self[:self_billing_invoice]
+        "#{SelfBillingInvoice.url}/#{CGI.escape(self[:self_billing_invoice])}/purchase_items"
+      end
+    end
+    
+
+    def self.url
+      if @parent_resource.include?(:self_billing_invoice)
+        "#{SelfBillingInvoice.url}/#{CGI.escape(@parent_resource[:self_billing_invoice])}/purchase_items"
+      end
+    end
+
+    def self.set_parent_resource(filters)
+      @parent_resource = filters.select{|k, v| [:self_billing_invoice].include?(k)}
+    end
+    
+    
+  end
+end

data/lib/octobat/self_billing_invoice.rb

@@ -0,0 +1,77 @@
+module Octobat
+  class SelfBillingInvoice < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+    
+    
+    # def self.pdf_export(params = {}, opts={})
+    #   api_key, headers = Util.parse_opts(opts)
+    #   api_key ||= @api_key
+    #   opts[:api_key] = api_key
+    #
+    #   instance = self.new(nil, opts)
+    #
+    #   response, api_key = Octobat.request(:post, url + '/pdf_export', api_key, params, opts)
+    #   return true
+    # end
+    #
+    # def self.csv_export(params = {}, opts={})
+    #   api_key, headers = Util.parse_opts(opts)
+    #   api_key ||= @api_key
+    #   opts[:api_key] = api_key
+    #
+    #   instance = self.new(nil, opts)
+    #
+    #   response, api_key = Octobat.request(:post, url + '/csv_export', api_key, params, opts)
+    #   return true
+    # end
+    
+
+    def send_by_email(params = {}, opts = {})
+      response, api_key = Octobat.request(:post, send_url, @api_key, params, opts)
+      refresh_from(response, api_key)
+    end
+
+    def confirm(params = {}, opts = {})
+      response, api_key = Octobat.request(:patch, confirm_url, @api_key, params, opts)
+      refresh_from(response, api_key)
+    end
+
+    def cancel(params = {}, opts = {})
+      response, api_key = Octobat.request(:patch, cancel_url, @api_key, params, opts)
+      refresh_from(response, api_key)
+    end
+
+    def delete(params = {}, opts = {})
+      response, api_key = Octobat.request(:delete, url, @api_key, params, opts)
+      refresh_from(response, api_key)
+    end
+
+    def purchase_items(params = {}, opts = {})
+      PurchaseItem.list(params.merge({ :self_billing_invoice => id }), {api_key: @api_key}.merge(opts))
+    end
+
+    # def transactions(params = {}, opts = {})
+    #   Transaction.list(params.merge(invoice: id), {api_key: @api_key}.merge(opts))
+    # end
+
+
+    private
+
+      def send_url
+        url + '/send'
+      end
+
+      def confirm_url
+        url + '/confirm'
+      end
+
+      def cancel_url
+        url + '/cancel'
+      end
+
+  end
+
+
+end

data/lib/octobat/subscription.rb

@@ -0,0 +1,13 @@
+module Octobat
+  class Subscription < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    
+    def usage_items(params = {}, opts = {})
+      UsageItem.list(params.merge({ subscription: id }), { api_key: @api_key }.merge(opts))
+    end
+
+  end
+
+
+end

data/lib/octobat/supplier.rb

@@ -0,0 +1,8 @@
+module Octobat
+  class Supplier < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+    include Octobat::APIOperations::Delete
+  end
+end

data/lib/octobat/usage_item.rb

@@ -0,0 +1,51 @@
+module Octobat
+  class UsageItem < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Delete
+    
+    
+    def url
+      !parent_obj.nil? ? parentize_url : super
+    end
+    
+    
+    def save_url
+      if self[:id] == nil && self.class.respond_to?(:create)
+        self.relative_save_url
+      else
+        url
+      end
+    end
+    
+    
+    def parentize_url
+      if parent_obj.include?(:subscription)
+        "#{Subscription.url}/#{CGI.escape(parent_obj[:subscription])}/usage_items/#{CGI.escape(id)}"
+      else
+        url
+      end
+    end
+    
+    
+    
+    def relative_save_url
+      if self[:subscription]
+        "#{Subscription.url}/#{CGI.escape(self[:subscription])}/usage_items"
+      end
+    end
+    
+
+    def self.url
+      if @parent_resource.include?(:subscription)
+        "#{Subscription.url}/#{CGI.escape(@parent_resource[:subscription])}/usage_items"
+      end
+    end
+
+    def self.set_parent_resource(filters)
+      @parent_resource = filters.select{|k, v| [:subscription].include?(k)}
+    end
+    
+    
+  end
+end

data/lib/octobat/util.rb

@@ -47,7 +47,11 @@ module Octobat
         'invoice' => Invoice,
         'credit_note' => CreditNote,
         'item' => Item,
+        'purchase_item' => PurchaseItem,
         'customer' => Customer,
+        'customer_balance_transaction' => CustomerBalanceTransaction,
+        'supplier' => Supplier,
+        'self_billing_invoice' => SelfBillingInvoice,
         'payout' => Payout,
         'balance_transaction' => BalanceTransaction,
         'document_template' => DocumentTemplate,
@@ -66,6 +70,8 @@ module Octobat
         'exports_setting' => ExportsSetting,
         'document' => Document,
         'emails_setting' => EmailsSetting,
+        'subscription' => Subscription,
+        'usage_item' => UsageItem,
         'file' => FileUpload,
         'file_link' => FileLink,
         'beanie.session' => Beanie::Session,

data/lib/octobat/version.rb

@@ -1,3 +1,3 @@
 module Octobat
-  VERSION = '2.0.20'
+  VERSION = '2.0.25'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octobat
 version: !ruby/object:Gem::Version
-  version: 2.0.20
+  version: 2.0.25
 platform: ruby
 authors:
 - Gaultier Laperche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -68,6 +68,7 @@ files:
 - lib/octobat/credit_note.rb
 - lib/octobat/credit_note_numbering_sequence.rb
 - lib/octobat/customer.rb
+- lib/octobat/customer_balance_transaction.rb
 - lib/octobat/document.rb
 - lib/octobat/document_email_template.rb
 - lib/octobat/document_language.rb
@@ -95,14 +96,19 @@ files:
 - lib/octobat/payout.rb
 - lib/octobat/product.rb
 - lib/octobat/proforma_invoice.rb
+- lib/octobat/purchase_item.rb
 - lib/octobat/reporting/report_run.rb
 - lib/octobat/reporting/report_type.rb
+- lib/octobat/self_billing_invoice.rb
 - lib/octobat/singleton_api_resource.rb
+- lib/octobat/subscription.rb
+- lib/octobat/supplier.rb
 - lib/octobat/tax_evidence.rb
 - lib/octobat/tax_evidence_request.rb
 - lib/octobat/tax_id.rb
 - lib/octobat/tax_region_setting.rb
 - lib/octobat/transaction.rb
+- lib/octobat/usage_item.rb
 - lib/octobat/util.rb
 - lib/octobat/version.rb
 - octobat.gemspec