invoiced 0.14.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 30c5827c11d5486e3b59fe3443bb63d8674eca3c
-  data.tar.gz: 7edd7c088f5df46d2159842c33620493ac1866b3
+SHA256:
+  metadata.gz: ae182e66a354b88c600800a9f0ef40ff695c44671c8b3bf2bd24100c61be2cdf
+  data.tar.gz: 3e0897128ea15e9086098560b4beac41e61a97e44a8ec8db542be023e7486e75
 SHA512:
-  metadata.gz: 507af5506883b32332cd60a0dc2fafecc084b57fd600e267f615690bc1ba8cfc9fd4b3969e6b2387582c211b1b648470625914bf8d0da9b9cb309f00d7a961ff
-  data.tar.gz: 4cd5f77e2feeba132dee73ab7cb34b60d9e8d3eceeea5ae437cf7121c249967468cacd5982ed0497b032d6d08968a764d4fbc5c42b4764a65ca1d0fea5446896
+  metadata.gz: 4039ccc2d285ddfcdd0c0aa97aae3c02330fdfdbcfddd1e4c559d0f08b101ec698f396baba1f33a075ac11e805318bad24dac55cbabaafd675e7654e33549424
+  data.tar.gz: e2d7415d9b996f6ef9b1a63e80f4b14ebbdf411a1fccff21f07803a53048f4922d3eb015162b7f606b7d7a37e471ad8ef40943a4628e7d8c459b819d65c1ec07

data/.gitignore

@@ -1,4 +1,6 @@
 Gemfile.lock
 example.rb
 /invoiced-*.gem
-/coverage
+/coverage
+.DS_Store
+.idea/

data/.travis.yml

@@ -5,6 +5,9 @@ rvm:
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
 
 sudo: false
 

data/README.md

@@ -3,8 +3,9 @@ invoiced-ruby
 
 This repository contains the Ruby client library for the [Invoiced](https://invoiced.com) API.
 
-[![Build Status](https://travis-ci.org/Invoiced/invoiced-ruby.svg?branch=master)](https://travis-ci.org/Invoiced/invoiced-ruby)
+[![Build Status](https://travis-ci.com/Invoiced/invoiced-ruby.svg?branch=master)](https://travis-ci.com/Invoiced/invoiced-ruby)
 [![Coverage Status](https://coveralls.io/repos/Invoiced/invoiced-ruby/badge.svg?branch=master&service=github)](https://coveralls.io/github/Invoiced/invoiced-ruby?branch=master)
+[![Gem Version](https://badge.fury.io/rb/invoiced.svg)](https://badge.fury.io/rb/invoiced)
 
 ## Installing
 
@@ -44,10 +45,16 @@ Then, API calls can be made like this:
 invoice = invoiced.Invoice.retrieve("{INVOICE_ID}")
 
 # mark as paid
-transaction = invoiced.Transaction.create(
-    :invoice => invoice.id,
+payment = invoiced.Payment.create(
     :amount => invoice.balance,
-    :method => "check")
+    :method => "check",
+    :applied_to => [
+        {
+            :type => "invoice",
+            :invoice => invoice.id,
+            :amount => invoice.balance
+        }
+    ])
 ```
 
 If you want to use the sandbox API instead then you must set the second argument on the client to `true` like this:

data/lib/invoiced.rb

@@ -18,9 +18,14 @@ require 'invoiced/operations/delete'
 require 'invoiced/operations/update'
 
 require 'invoiced/object'
+require 'invoiced/payment_source_object'
 require 'invoiced/attachment'
-require 'invoiced/catalog_item'
+require 'invoiced/bank_account'
+require 'invoiced/card'
+require 'invoiced/charge'
 require 'invoiced/contact'
+require 'invoiced/coupon'
+require 'invoiced/credit_balance_adjustment'
 require 'invoiced/credit_note'
 require 'invoiced/customer'
 require 'invoiced/email'
@@ -28,11 +33,19 @@ require 'invoiced/estimate'
 require 'invoiced/event'
 require 'invoiced/file'
 require 'invoiced/invoice'
+require 'invoiced/item'
+require 'invoiced/letter'
 require 'invoiced/line_item'
+require 'invoiced/note'
+require 'invoiced/payment'
 require 'invoiced/payment_plan'
+require 'invoiced/payment_source'
 require 'invoiced/plan'
+require 'invoiced/refund'
 require 'invoiced/subscription'
-require 'invoiced/transaction'
+require 'invoiced/task'
+require 'invoiced/tax_rate'
+require 'invoiced/text_message'
 
 module Invoiced
     class Client
@@ -43,7 +56,7 @@ module Invoiced
         ReadTimeout = 80
 
         attr_reader :api_key, :api_url, :sandbox, :sso_key
-        attr_reader :CatalogItem, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Plan, :Subscription, :Transaction
+        attr_reader :Item, :Charge, :Coupon, :CreditBalanceAdjustment, :CreditNote, :Customer, :Estimate, :Event, :File, :Invoice, :Note, :Payment, :Plan, :Refund, :Subscription, :Task, :TaxRate
 
         def initialize(api_key, sandbox=false, sso_key=false)
           @api_key = api_key
@@ -52,16 +65,23 @@ module Invoiced
           @sso_key = sso_key
 
           # Object endpoints
-          @CatalogItem = Invoiced::CatalogItem.new(self)
+          @Item = Invoiced::Item.new(self)
+          @Charge = Invoiced::Charge.new(self)
+          @Coupon = Invoiced::Coupon.new(self)
+          @CreditBalanceAdjustment = Invoiced::CreditBalanceAdjustment.new(self)
           @CreditNote = Invoiced::CreditNote.new(self)
           @Customer = Invoiced::Customer.new(self)
           @Estimate = Invoiced::Estimate.new(self)
           @Event = Invoiced::Event.new(self)
           @File = Invoiced::File.new(self)
           @Invoice = Invoiced::Invoice.new(self)
+          @Note = Invoiced::Note.new(self)
+          @Payment = Invoiced::Payment.new(self)
           @Plan = Invoiced::Plan.new(self)
+          @Refund = Invoiced::Refund.new(self)
           @Subscription = Invoiced::Subscription.new(self)
-          @Transaction = Invoiced::Transaction.new(self)
+          @Task = Invoiced::Task.new(self)
+          @TaxRate = Invoiced::TaxRate.new(self)
         end
 
         def request(method, endpoint, params={}, opts={})

data/lib/invoiced/bank_account.rb

@@ -0,0 +1,6 @@
+module Invoiced
+  class BankAccount < PaymentSourceObject
+
+    OBJECT_NAME = 'bank_account'
+  end
+end

data/lib/invoiced/card.rb

@@ -0,0 +1,6 @@
+module Invoiced
+  class Card < PaymentSourceObject
+
+    OBJECT_NAME = 'card'
+  end
+end

data/lib/invoiced/charge.rb

@@ -0,0 +1,12 @@
+module Invoiced
+    class Charge < Object
+        OBJECT_NAME = 'charge'
+
+        def create(body={}, opts={})
+            response = @client.request(:post, endpoint(), body, opts)
+
+            payment = Payment.new(@client)
+            Util.convert_to_object(payment, response[:body])
+        end
+    end
+end

data/lib/invoiced/{catalog_item.rb → coupon.rb}

@@ -1,10 +1,10 @@
 module Invoiced
-    class CatalogItem < Object
+    class Coupon < Object
         include Invoiced::Operations::List
         include Invoiced::Operations::Create
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
-        OBJECT_NAME = 'catalog_item'
+        OBJECT_NAME = 'coupon'
     end
 end

data/lib/invoiced/credit_balance_adjustment.rb

@@ -0,0 +1,10 @@
+module Invoiced
+    class CreditBalanceAdjustment < Object
+        include Invoiced::Operations::List
+        include Invoiced::Operations::Create
+        include Invoiced::Operations::Update
+        include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'credit_balance_adjustment'
+    end
+end

data/lib/invoiced/credit_note.rb

@@ -35,5 +35,13 @@ module Invoiced
 
             return attachments, metadata
         end
+
+        def void()
+            response = @client.request(:post, "#{self.endpoint()}/void", {})
+
+            refresh_from(response[:body].dup.merge({:id => self.id}))
+
+            return response[:code] == 200
+        end
     end
 end

data/lib/invoiced/customer.rb

@@ -15,6 +15,22 @@ module Invoiced
             Util.build_objects(email, response[:body])
         end
 
+        def send_statement_sms(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/text_messages", params, opts)
+
+            # build text message objects
+            text_message = TextMessage.new(@client)
+            Util.build_objects(text_message, response[:body])
+        end
+
+        def send_statement_letter(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/letters", params, opts)
+
+            # build letter objects
+            letter = Letter.new(@client)
+            Util.build_objects(letter, response[:body])
+        end
+
         def balance
             response = @client.request(:get, "#{self.endpoint()}/balance")
 
@@ -26,11 +42,21 @@ module Invoiced
             contact.set_endpoint_base(self.endpoint())
         end
 
+        def payment_sources()
+            source = PaymentSource.new(@client)
+            source.set_endpoint_base(self.endpoint())
+        end
+
         def line_items()
             line = LineItem.new(@client)
             line.set_endpoint_base(self.endpoint())
         end
 
+        def list_notes()
+            note = Note.new(@client)
+            note.set_endpoint_base(self.endpoint())
+        end
+
         def invoice(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/invoices", params, opts)
 
@@ -38,5 +64,13 @@ module Invoiced
             invoice = Invoice.new(@client)
             Util.convert_to_object(invoice, response[:body])
         end
+
+        def consolidate_invoices(params={})
+            response = @client.request(:post, "#{self.endpoint()}/consolidate_invoices", params)
+
+            # build invoice object
+            invoice = Invoice.new(@client)
+            Util.convert_to_object(invoice, response[:body])
+        end
     end
 end

data/lib/invoiced/estimate.rb

@@ -43,5 +43,13 @@ module Invoiced
 
             return attachments, metadata
         end
+        
+        def void()
+            response = @client.request(:post, "#{self.endpoint()}/void", {})
+
+            refresh_from(response[:body].dup.merge({:id => self.id}))
+
+            return response[:code] == 200
+        end
     end
 end

data/lib/invoiced/invoice.rb

@@ -15,6 +15,23 @@ module Invoiced
             Util.build_objects(email, response[:body])
         end
 
+        def send_sms(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/text_messages", params, opts)
+
+            # build text message objects
+            text_message = TextMessage.new(@client)
+            Util.build_objects(text_message, response[:body])
+        end
+
+        def send_letter(params={}, opts={})
+            response = @client.request(:post, "#{self.endpoint()}/letters", params, opts)
+
+            # build letter objects
+
+            letter = Letter.new(@client)
+            Util.build_objects(letter, response[:body])
+        end
+
         def pay(opts={})
             response = @client.request(:post, "#{self.endpoint()}/pay", {}, opts)
 
@@ -33,7 +50,7 @@ module Invoiced
                 if !attachment.has_key?(:id)
                     attachment[:id] = attachment[:file][:id]
                 end
-            end
+        end
 
             # build objects
             attachment = Attachment.new(@client)
@@ -49,5 +66,18 @@ module Invoiced
             paymentPlan = PaymentPlan.new(@client)
             paymentPlan.set_endpoint_base(self.endpoint())
         end
+
+        def notes()
+            note = Note.new(@client)
+            note.set_endpoint_base(self.endpoint())
+        end
+
+        def void()
+            response = @client.request(:post, "#{self.endpoint()}/void", {})
+
+            refresh_from(response[:body].dup.merge({:id => self.id}))
+
+            return response[:code] == 200
+        end
     end
 end

data/lib/invoiced/item.rb

@@ -0,0 +1,10 @@
+module Invoiced
+    class Item < Object
+        include Invoiced::Operations::List
+        include Invoiced::Operations::Create
+        include Invoiced::Operations::Update
+        include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'item'
+    end
+end

data/lib/invoiced/letter.rb

@@ -0,0 +1,5 @@
+module Invoiced
+    class Letter < Object
+        OBJECT_NAME = 'letter'
+    end
+end

data/lib/invoiced/note.rb

@@ -0,0 +1,10 @@
+module Invoiced
+    class Note < Object
+        include Invoiced::Operations::List
+        include Invoiced::Operations::Create
+        include Invoiced::Operations::Update
+        include Invoiced::Operations::Delete
+
+        OBJECT_NAME = 'note'
+    end
+end

data/lib/invoiced/object.rb

@@ -46,7 +46,7 @@ module Invoiced
                 raise ArgumentError.new("Missing ID.")
             end
 
-            response = @client.request(:get, "#{self.endpoint()}/#{id}", params)
+            response = @client.request(:get, "#{endpoint()}/#{id}", params)
 
             Util.convert_to_object(self, response[:body])
         end
@@ -57,7 +57,7 @@ module Invoiced
 
         def inspect
             id_string = (!@id.nil?) ? " id=#{@id}" : ""
-            "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
+            "#<#{self.class}:0x#{object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
         end
 
         def refresh_from(values)

data/lib/invoiced/operations/create.rb

@@ -2,7 +2,7 @@ module Invoiced
     module Operations
         module Create
             def create(body={}, opts={})
-                response = @client.request(:post, self.endpoint(), body, opts)
+                response = @client.request(:post, endpoint(), body, opts)
 
                 Util.convert_to_object(self, response[:body])
             end

data/lib/invoiced/{transaction.rb → payment.rb}

@@ -1,11 +1,11 @@
 module Invoiced
-    class Transaction < Object
+    class Payment < Object
         include Invoiced::Operations::List
         include Invoiced::Operations::Create
         include Invoiced::Operations::Update
         include Invoiced::Operations::Delete
 
-        OBJECT_NAME = 'transaction'
+        OBJECT_NAME = 'payment'
 
         def send(params={}, opts={})
             response = @client.request(:post, "#{self.endpoint()}/emails", params, opts)
@@ -14,11 +14,5 @@ module Invoiced
             email = Email.new(@client)
             Util.build_objects(email, response[:body])
         end
-
-        def refund(params={}, opts={})
-            response = @client.request(:post, "#{self.endpoint()}/refunds", params, opts)
-
-            Util.convert_to_object(self, response[:body])
-        end
     end
 end

data/lib/invoiced/payment_source.rb

@@ -0,0 +1,8 @@
+module Invoiced
+  class PaymentSource < Object
+    include Invoiced::Operations::Create
+    include Invoiced::Operations::List
+
+    OBJECT_NAME = 'payment_source'
+  end
+end

data/lib/invoiced/payment_source_object.rb

@@ -0,0 +1,5 @@
+module Invoiced
+    class PaymentSourceObject < Object
+        include Invoiced::Operations::Delete
+    end
+end

data/lib/invoiced/refund.rb

@@ -0,0 +1,11 @@
+module Invoiced
+    class Refund < Object
+        OBJECT_NAME = 'refund'
+
+        def create(chargeId, body={}, opts={})
+            response = @client.request(:post, @endpoint_base + "/charges/#{chargeId}/refunds", body, opts)
+
+            Util.convert_to_object(self, response[:body])
+        end
+    end
+end

data/lib/invoiced/subscription.rb

@@ -10,5 +10,11 @@ module Invoiced
         def cancel
             delete
         end
+
+        def preview(params={}, opts={})
+            response = @client.request(:post, "/subscriptions/preview", params, opts)
+
+            response[:body]
+        end
     end
 end