octobat 2.0.21 → 2.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39cb7d7e756a8a19162b43f02eddf46ff9ea2b0d3cf6cc7fa63c35e130393c36
-  data.tar.gz: a199b92d99133f31b953ff6da3793e15ae0f29c0efd870e309a27a3ebb57352a
+  metadata.gz: 330a8b81687cd079b059ebd5b768f80152d7f93ce97f255637b8fc1bd45d681f
+  data.tar.gz: 3647619a56554df275ec31fc6c14aeed477b260d2bb00608ee23418cd0ac78e5
 SHA512:
-  metadata.gz: '069f1946a31e8e0cc703a297bfccc4388ad8f1fd7709405f40f1e87578f76cd41f249c3611142a49ea94ff8c21673b971bcf9700dfba28815ce7a12b51727f94'
-  data.tar.gz: f8146563ae30ef4bd58d134ad563c3faf783fdc5c7fdf37962803100b40a2753af56825570943a53dc8d42c439d1717d897a09d2be50fead8b6567173b33c498
+  metadata.gz: 96a550fd8e9c24cfe1446ebfe3ebe3ae5a87b4d1adcac7c7575e3e68b7f3cf370a705d00e8f60d835c0108c8f7b397ffdfd2c45c0608be1285a18614d893068d
+  data.tar.gz: 3c08c868d74a6f9bd4b1fb0314def0745d8d5510054fb2f453e86831124db8992111af23a34b5db574c79041ffbf7c3b914a18718610bbd5e85968eafc58d2d9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    octobat (2.0.21)
+    octobat (2.0.26)
       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.1104)
+    mime-types-data (3.2021.0225)
     netrc (0.11.0)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)

data/History.txt

@@ -1,3 +1,25 @@
+=== 2.0.26 2021-05-31
+* 2 major enhancements:
+  * Add support for Octobat Plaza endpoints
+  * Add persistence of the octobat_account header through requests
+
+=== 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
@@ -13,7 +35,6 @@
   * 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.21
+2.0.26

data/lib/octobat.rb

@@ -27,6 +27,7 @@ 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'
@@ -54,10 +55,19 @@ 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'
+
 require 'octobat/beanie/session'
+
+require 'octobat/plaza/account'
+require 'octobat/plaza/capability'
+require 'octobat/plaza/country_spec'
+
+
 require 'octobat/reporting/report_type'
 require 'octobat/reporting/report_run'
 

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/octobat_object.rb

@@ -24,8 +24,10 @@ module Octobat
       @api_key = opts[:api_key]
       
       @retrieve_options.merge!(opts.clone).delete(:api_key)
+
       @headers['Octobat-Version'] = @retrieve_options.delete('Octobat-Version') if @retrieve_options.has_key?('Octobat-Version')
-      
+      @headers[:octobat_account] = @retrieve_options.delete(:octobat_account) if @retrieve_options.has_key?(:octobat_account)
+
       @values = {}
       # This really belongs in APIResource, but not putting it there allows us
       # to have a unified inspect method

data/lib/octobat/plaza/account.rb

@@ -0,0 +1,39 @@
+module Octobat
+  module Plaza
+    class Account < Octobat::APIResource
+      extend Octobat::APIOperations::List
+      include Octobat::APIOperations::Create
+      include Octobat::APIOperations::Update
+
+      def self.url
+        '/plaza/accounts'
+      end
+
+      def activate(params = {}, opts = {})
+        response, api_key = Octobat.request(:patch, activate_url, @api_key, params, opts)
+        refresh_from(response, api_key)
+      end
+  
+      def deactivate(params = {}, opts = {})
+        response, api_key = Octobat.request(:patch, deactivate_url, @api_key, params, opts)
+        refresh_from(response, api_key)
+      end
+
+      def list_capabilities(params = {}, opts = {})
+        Capability.list(params.merge({ :account => id }), {api_key: @api_key}.merge(opts))
+      end
+  
+
+      private
+      def activate_url
+        url + '/activate'
+      end
+
+      def deactivate_url
+        url + '/deactivate'
+      end
+
+  
+    end
+  end
+end

data/lib/octobat/plaza/capability.rb

@@ -0,0 +1,56 @@
+module Octobat
+  module Plaza
+    class Capability < Octobat::APIResource
+      extend Octobat::APIOperations::List
+
+      def url
+        !parent_obj.nil? ? parentize_url : super
+      end
+
+      def ask(params = {}, opts = {})
+        response, api_key = Octobat.request(:patch, ask_url, @api_key, params, opts)
+        refresh_from(response, api_key)
+      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?(:account)
+          "#{Account.url}/#{CGI.escape(parent_obj[:account])}/capabilities/#{CGI.escape(id)}"
+        else
+          url
+        end
+      end
+      
+      
+      
+      def relative_save_url
+        if self[:account]
+          "#{Account.url}/#{CGI.escape(self[:account])}/capabilities"
+        end
+      end
+
+      def ask_url
+        "#{parentize_url}/request"
+      end
+      
+      def self.url
+        if @parent_resource.include?(:account)
+          "#{Account.url}/#{CGI.escape(@parent_resource[:account])}/capabilities"
+        end
+      end
+  
+      def self.set_parent_resource(filters)
+        @parent_resource = filters.select{|k, v| [:account].include?(k)}
+      end
+  
+    end
+  end
+end

data/lib/octobat/plaza/country_spec.rb

@@ -0,0 +1,12 @@
+module Octobat
+  module Plaza
+    class CountrySpec < Octobat::APIResource
+      extend Octobat::APIOperations::List
+      
+      def self.url
+        '/plaza/country_specs'
+      end
+  
+    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/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

@@ -49,6 +49,7 @@ module Octobat
         'item' => Item,
         'purchase_item' => PurchaseItem,
         'customer' => Customer,
+        'customer_balance_transaction' => CustomerBalanceTransaction,
         'supplier' => Supplier,
         'self_billing_invoice' => SelfBillingInvoice,
         'payout' => Payout,
@@ -69,9 +70,14 @@ module Octobat
         'exports_setting' => ExportsSetting,
         'document' => Document,
         'emails_setting' => EmailsSetting,
+        'subscription' => Subscription,
+        'usage_item' => UsageItem,
         'file' => FileUpload,
         'file_link' => FileLink,
         'beanie.session' => Beanie::Session,
+        'plaza.account' => Plaza::Account,
+        'plaza.capability' => Plaza::Capability,
+        'plaza.country_spec' => Plaza::CountrySpec,
         'reporting.report_type' => Reporting::ReportType,
         'reporting.report_run' => Reporting::ReportRun
       }

data/lib/octobat/version.rb

@@ -1,3 +1,3 @@
 module Octobat
-  VERSION = '2.0.21'
+  VERSION = '2.0.26'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octobat
 version: !ruby/object:Gem::Version
-  version: 2.0.21
+  version: 2.0.26
 platform: ruby
 authors:
 - Gaultier Laperche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2021-05-31 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
@@ -93,6 +94,9 @@ files:
 - lib/octobat/payment_recipient_reference.rb
 - lib/octobat/payment_source.rb
 - lib/octobat/payout.rb
+- lib/octobat/plaza/account.rb
+- lib/octobat/plaza/capability.rb
+- lib/octobat/plaza/country_spec.rb
 - lib/octobat/product.rb
 - lib/octobat/proforma_invoice.rb
 - lib/octobat/purchase_item.rb
@@ -100,12 +104,14 @@ files:
 - 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