invoicexpress 0.0.0

data/lib/invoicexpress/client/debit_notes.rb

@@ -0,0 +1,129 @@
+require 'invoicexpress/models'
+
+module Invoicexpress
+  class Client
+    module DebitNotes
+      
+      # Returns all your debit notes
+      #
+      # @option options [Integer] page (1) You can ask a specific page of debit notes
+      #
+      # @return [Invoicexpress::Models::DebitNotes] A struct with results (pagination) and all the debit notes
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      def debit_notes(options={})
+        params = { :page => 1, :klass => Invoicexpress::Models::DebitNote }
+
+        get("debit_notes.xml", params.merge(options))
+      end
+
+      # Returns all the information about a debit note:
+      # - Basic information (date, status, sequence number)
+      # - Client
+      # - Document items
+      # - Document timeline
+      # Document timeline is composed by:
+      # - Date, time and the user who created it
+      # - Type of the event
+      # The complete list of timeline events is:
+      # - create
+      # - edited
+      # - send_email
+      # - canceled
+      # - deleted
+      # - settled
+      # - second_copy
+      # - archived
+      # - unarchived
+      # - comment
+      #
+      # @param debit_note_id [String] Requested debit note id
+      # @return [Invoicexpress::Models::DebitNote] The requested debit note
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::NotFound When the debit_note doesn't exist
+      def debit_note(debit_note_id, options={})
+        params = { :klass => Invoicexpress::Models::DebitNote }
+
+        get("debit_notes/#{debit_note_id}.xml", params.merge(options))
+      end
+
+      # Creates a new debit note. Also allows to create a new client and/or new items in the same request.
+      # If the client name does not exist a new one is created.
+      # If items do not exist with the given names, new ones will be created.
+      # If item name  already exists, the item is updated with the new values.
+      # Regarding item taxes, if the tax name is not found, no tax is applyed to that item.
+      # Portuguese accounts should also send the IVA exemption reason if the invoice contains exempt items(IVA 0%)
+      #
+      # @param debit_note [Invoicexpress::Models::DebitNote] The debit note to create
+      # @return [Invoicexpress::Models::DebitNote] The created debit note
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      def create_debit_note(debit_note, options={})
+        raise(ArgumentError, "debit note has the wrong type") unless debit_note.is_a?(Invoicexpress::Models::DebitNote)
+
+        params = { :klass => Invoicexpress::Models::DebitNote, :body  => debit_note }
+        post("debit_notes.xml", params.merge(options))
+      end
+
+      # Updates a debit note
+      # It also allows you to create a new client and/or items in the same request.
+      # If the client name does not exist a new client is created.
+      # Regarding item taxes, if the tax name is not found, no tax will be applied to that item.
+      # If item does not exist with the given name, a new one will be created.
+      # If item exists it will be updated with the new values
+      # Be careful when updating the document items, any missing items from the original document will be deleted.
+      #
+      # @param debit_note [Invoicexpress::Models::DebitNote] The cash debit note to update
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the debit note doesn't exist
+      def update_debit_note(debit_note, options={})
+        raise(ArgumentError, "debit note has the wrong type") unless debit_note.is_a?(Invoicexpress::Models::DebitNote)
+
+        if !debit_note.id
+          raise ArgumentError, "DebitNote ID is required"
+        end
+        params = { :klass => Invoicexpress::Models::DebitNote, :body => debit_note.to_core }
+        put("debit_notes/#{debit_note.id}.xml", params.merge(options))
+      end
+
+      # Changes the state of a debit note.
+      # Possible state transitions:
+      # - draft to final – finalized
+      # - draft to deleted – deleted
+      # - settled to final – unsettled
+      # - final to second copy – second_copy
+      # - final or second copy to canceled – canceled
+      # - final or second copy to settled – settled
+      # Any other transitions will fail.
+      # When canceling a debit note you must specify a reason.
+      #
+      # @param debit_note_id [String] The debit note id to change
+      # @param debit_note_state [Invoicexpress::Models::InvoiceState] The new state
+      # @return [Invoicexpress::Models::DebitNote] The updated debit note
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the debit note doesn't exist
+      def update_debit_note_state(debit_note_id, debit_note_state, options={})
+        raise(ArgumentError, "debit note state has the wrong type") unless debit_note_state.is_a?(Invoicexpress::Models::InvoiceState)
+
+        params = { :klass => Invoicexpress::Models::DebitNote, :body => debit_note_state }
+        put("debit_notes/#{debit_note_id}/change-state.xml", params.merge(options))
+      end
+
+      # Sends the debit note through email
+      #
+      # @param debit_note_id [String] The debit note id to send
+      # @param message [Invoicexpress::Models::Message] The message to send
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the debit note doesn't exist
+      def debit_note_mail(debit_note_id, message, options={})
+        raise(ArgumentError, "message has the wrong type") unless message.is_a?(Invoicexpress::Models::Message)
+
+        params = { :body => message, :klass => Invoicexpress::Models::DebitNote }
+        put("debit_notes/#{debit_note_id}/email-document.xml", params.merge(options))
+      end
+
+    end
+  end
+end

data/lib/invoicexpress/client/invoices.rb

@@ -0,0 +1,107 @@
+require 'invoicexpress/models'
+
+module Invoicexpress
+  class Client
+    module Invoices
+      
+      # Returns all your invoices
+      #
+      # @option options [Integer] page (1) You can ask a specific page of invoices
+      #
+      # @return [Array<Invoicexpress::Models::Invoice>] An array with all your invoices
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      def invoices(options={})
+        params = { :page => 1, :klass => Invoicexpress::Models::Invoices }
+
+        get("invoices.xml", params.merge(options))
+      end
+
+      # Returns a specific invoice
+      #
+      # @param invoice_id [String] Requested invoice id
+      # @return [Invoicexpress::Models::Invoice] The requested invoice
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::NotFound When the invoice doesn't exist
+      def invoice(invoice_id, options={})
+        params = { :klass => Invoicexpress::Models::Invoice }
+
+        get("invoices/#{invoice_id}.xml", params.merge(options))
+      end
+
+      # Creates a new invoice. Also allows to create a new client and/or new items in the same request.
+      # If the client name does not exist a new one is created.
+      # If items do not exist with the given names, new ones will be created.
+      # If item name  already exists, the item is updated with the new values.
+      # Regarding item taxes, if the tax name is not found, no tax is applyed to that item.
+      # Portuguese accounts should also send the IVA exemption reason if the invoice contains exempt items(IVA 0%)
+      #
+      # @param invoice [Invoicexpress::Models::Invoice] The invoice to create
+      # @return [Invoicexpress::Models::Invoice] The created invoice
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      def create_invoice(invoice, options={})
+        raise(ArgumentError, "invoice has the wrong type") unless invoice.is_a?(Invoicexpress::Models::Invoice)
+
+        params = { :klass => Invoicexpress::Models::Invoice, :body  => invoice }
+        post("invoices.xml", params.merge(options))
+      end
+
+      # Updates an invoice
+      # It also allows you to create a new client and/or items in the same request.
+      # If the client name does not exist a new client is created.
+      # Regarding item taxes, if the tax name is not found, no tax will be applied to that item.
+      # If item does not exist with the given name, a new one will be created.
+      # If item exists it will be updated with the new values
+      # Be careful when updating the document items, any missing items from the original document will be deleted.
+      #
+      # @param invoice [Invoicexpress::Models::Invoice] The invoice to update
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the invoice doesn't exist
+      def update_invoice(invoice, options={})
+        raise(ArgumentError, "invoice has the wrong type") unless invoice.is_a?(Invoicexpress::Models::Invoice)
+
+        params = { :klass => Invoicexpress::Models::Invoice, :body  => invoice.to_core }
+        put("invoices/#{invoice.id}.xml", params.merge(options))
+      end
+
+      # Changes the state of an invoice.
+      # Possible state transitions:
+      # - draft to final – finalized
+      # - final to second copy – second_copy
+      # - final or second copy to canceled – canceled
+      # - final or second copy to settled – settled
+      # - settled to final – unsettled
+      # Any other transitions will fail.
+      # When canceling an invoice you must specify a reason.
+      #
+      # @param invoice_id [String] The invoice id to change
+      # @param invoice_state [Invoicexpress::Models::InvoiceState] The new state
+      # @return [Invoicexpress::Models::Invoice] The updated invoice
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the invoice doesn't exist
+      def update_invoice_state(invoice_id, invoice_state, options={})
+        raise(ArgumentError, "invoice_state has the wrong type") unless invoice_state.is_a?(Invoicexpress::Models::InvoiceState)
+
+        params = { :klass => Invoicexpress::Models::Invoice, :body => invoice_state }
+        put("invoices/#{invoice_id}/change-state.xml", params.merge(options))
+      end
+
+      # Sends the invoice by email
+      #
+      # @param invoice_id [String] The invoice id to change
+      # @param message [Invoicexpress::Models::Message] The message to send
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the invoice doesn't exist
+      def invoice_mail(invoice_id, message, options={})
+        raise(ArgumentError, "message has the wrong type") unless message.is_a?(Invoicexpress::Models::Message)
+
+        params = { :body => message, :klass => Invoicexpress::Models::Invoice }
+        put("invoices/#{invoice_id}/email-invoice.xml", params.merge(options))
+      end
+
+    end
+  end
+end

data/lib/invoicexpress/client/items.rb

@@ -0,0 +1,82 @@
+require 'invoicexpress/models'
+
+module Invoicexpress
+  class Client
+    module Items
+
+      # Returns a list of all your items. 
+      #
+      # @return [Array<Invoicexpress::Models::Item>] An array with all your items
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      def items(options = {})
+        params = { :klass => Invoicexpress::Models::Item }
+
+        get("items.xml", params.merge(options))
+      end
+
+      # Returns a specific item.
+      #
+      # @param item [Invoicexpress::Models::Item, String] The item or item ID
+      # @return [Invoicexpress::Models::Item] The item
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::NotFound When the item doesn't exist
+      def item(item, options={})
+        params = { :klass => Invoicexpress::Models::Item }
+
+        get("items/#{id_from_item(item)}.xml", params.merge(options))
+      end
+
+      # Creates a new item.
+      # Regarding item taxes, if the tax name is not found, no tax is applied to that item.
+      #
+      # @param item [Invoicexpress::Models::Item] The item to create
+      # @return [Invoicexpress::Models::Item] The created item
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      def create_item(item, options={})
+        raise(ArgumentError, "item has the wrong type") unless item.is_a?(Invoicexpress::Models::Item)
+
+        params = { :klass => Invoicexpress::Models::Item, :body => item }
+        post("items.xml", params.merge(options))
+      end
+
+      # Updates an item. 
+      #
+      # @param item [Invoicexpress::Models::Item] The item to update
+      # @return [Invoicexpress::Models::Item] The updated item
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::NotFound When the item doesn't exist
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      def update_item(item, options={})
+        raise(ArgumentError, "item has the wrong type") unless item.is_a?(Invoicexpress::Models::Item)
+        
+        params = { :klass => Invoicexpress::Models::Item, :body => item }
+        put("items/#{item.id}.xml", params.merge(options))
+      end
+
+      # Deletes an item.
+      #
+      # @param item [Invoicexpress::Models::Item, String] The item or item id
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::NotFound When the item doesn't exist
+      def delete_item(item, options={})
+        params = { :klass => Invoicexpress::Models::Item }
+        delete("items/#{id_from_item(item)}.xml", params.merge(options))
+      end
+
+      private
+      def id_from_item(item)
+        if item.is_a?(Invoicexpress::Models::Item)
+          item.id
+        elsif item.is_a?(String)
+          item
+        elsif item.is_a?(Integer)
+          item.to_s
+        else
+          raise ArgumentError, "Cannot get item id from #{item}"
+        end
+      end
+
+    end
+  end
+end

data/lib/invoicexpress/client/purchase_orders.rb

@@ -0,0 +1,126 @@
+require 'invoicexpress/models'
+module Invoicexpress
+  class Client
+    module PurchaseOrders
+
+      # Returns all your purchase orders.
+      # @option options [Integer] page (1) You can ask a specific page of PurchaseOrders
+      #
+      # @return [Array<Invoicexpress::Models::PurchaseOrder>] An array with all the PurchaseOrders
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      def purchase_orders(options = {})
+        params = { :page => 1, :klass => Invoicexpress::Models::PurchaseOrder }
+
+        get("purchase_orders.xml", params.merge(options))
+      end
+      
+      #Creates a new purchase order.
+      #Creates a new purchase order. Also allows to create a new supplier and/or new items in the same request.
+      #If the supplier name does not exist a new one is created.
+      #If items do not exist with the given names, new ones will be created.
+      #If item name already exists, the item is updated with the new values.
+      #Regarding item taxes, if the tax name is not found, no tax is applyed to that item.
+      # 
+      # @param purchase_order [Invoicexpress::Models::PurchaseOrder] The PurchaseOrder to create
+      # @return Invoicexpress::Models::PurchaseOrder The PurchaseOrder
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      def create_purchase_order(purchase_order, options={})
+        raise(ArgumentError, "purchase order has the wrong type") unless purchase_order.is_a?(Invoicexpress::Models::PurchaseOrder)
+
+        params = { :klass => Invoicexpress::Models::PurchaseOrder, :body => purchase_order }
+        post("purchase_orders.xml", params.merge(options))
+      end
+      
+      # Returns a specific purchase order. 
+      #
+      # @param purchase_order [Invoicexpress::Models::PurchaseOrder, String] The purchase order or purchase orderID
+      # @return Invoicexpress::Models::PurchaseOrder The PurchaseOrder
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::NotFound When the purchase_order doesn't exist
+      def purchase_order(purchase_order, options={})
+        params = { :klass => Invoicexpress::Models::PurchaseOrder }
+
+        get("purchase_orders/#{id_from_purchase_order(purchase_order)}.xml", params.merge(options))
+      end
+ 
+      # Updates a purchase order
+      #Updates a purchase order. Also allows to create a new supplier and/or new items in the same request.
+      #If the supplier name does not exist a new one is created.
+      #If items do not exist with the given names, new ones will be created.
+      #If item name already exists, the item is updated with the new values.
+      #Regarding item taxes, if the tax name is not found, no tax is applyed to that item.
+      #Be careful when updating the invoice items, any missing items from the original invoice will be deleted.
+      #
+      # @param purchase_order [Invoicexpress::Models::PurchaseOrder] The Purchase Order to update
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the credit note doesn't exist
+      def update_purchase_order(purchase_order, options={})
+        raise(ArgumentError, "purchase order has the wrong type") unless purchase_order.is_a?(Invoicexpress::Models::PurchaseOrder)
+
+        if !purchase_order.id
+          raise ArgumentError, "Purchase Order ID is required"
+        end
+        params = { :klass => Invoicexpress::Models::PurchaseOrder, :body => purchase_order.to_core_purchase_order }
+        put("purchase_orders/#{purchase_order.id}.xml", params.merge(options))
+      end
+
+      # Changes the state of a purchase order.
+      #Possible state transitions:
+      #- draft to final – finalized
+      #- draft to deleted – deleted
+      #- final to second_copy – second_copy
+      #- final to accepted – accepted
+      #- final to refused – refused
+      #- final to canceled – canceled
+      #- second_copy to canceled – canceled
+      #- accepted to refused – refused
+      #- accepted to completed – completed
+      #- refused to canceled – canceled
+      #- refused to accepted – accepted
+      #Any other transitions will fail.
+      #When canceling an purchase order you must specify a reason.
+      #
+      # @param purchase_order_id [String] The purchase order id to change
+      # @param purchase_order_state [Invoicexpress::Models::InvoiceState] The new state
+      # @return [Invoicexpress::Models::PurchaseOrder] The updated Purchase Order
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the credit note doesn't exist
+      def update_purchase_order_state(purchase_order_id, purchase_order_state, options={})
+        raise(ArgumentError, "purchase_order_state has the wrong type") unless purchase_order_state.is_a?(Invoicexpress::Models::InvoiceState)
+
+        params = { :klass => Invoicexpress::Models::PurchaseOrder, :body => purchase_order_state }
+        put("purchase_orders/#{purchase_order_id}/change-state.xml", params.merge(options))
+      end
+
+      # Sends the purchase order by email
+      #
+      # @param purchase_order_id [String] The credit note id to send
+      # @param message [Invoicexpress::Models::Message] The message to send
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the credit note doesn't exist
+      def purchase_order_mail(purchase_order_id, message, options={})
+        raise(ArgumentError, "message has the wrong type") unless message.is_a?(Invoicexpress::Models::Message)
+
+        params = { :body => message, :klass => Invoicexpress::Models::PurchaseOrder }
+        put("purchase_orders/#{purchase_order_id}/email-document.xml", params.merge(options))
+      end
+
+      private
+      def id_from_purchase_order(item)
+        if item.is_a?(Invoicexpress::Models::PurchaseOrder)
+          item.id
+        elsif item.is_a?(String)
+          item
+        elsif item.is_a?(Integer)
+          item.to_s
+        else
+          raise ArgumentError, "Cannot get Purchase Order id from #{item}"
+        end
+      end
+    end
+  end
+end

data/lib/invoicexpress/client/schedules.rb

@@ -0,0 +1,110 @@
+require 'invoicexpress/models'
+module Invoicexpress
+  class Client
+    module Schedules
+
+      # Returns all your schedules.
+      #
+      # @return [Array<Invoicexpress::Models::Schedule>] An array with all the schedules
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      def schedules(options = {})
+        params = { :klass => Invoicexpress::Models::Schedule }
+
+        get("schedules.xml", params.merge(options))
+      end
+      
+      # Creates a new schedule.
+      # It also allows you to create a new client and/or items in the same request.
+      # If the client name does not exist a new one is created.
+      # Regarding item taxes, if the tax name is not found, it is ignored and no tax is applied to that item.
+      # If no item exists with the given name a new one will be created.
+      # If the item exists it will be updated with the new values.
+      # Be careful when updating the schedule items, as any missing items from the original invoice are deleted.
+      #
+      # @param schedule [Invoicexpress::Models::Schedule] The schedule to create
+      # @return Invoicexpress::Models::Schedule The schedule
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      def create_schedule(schedule, options={})
+        raise(ArgumentError, "schedule has the wrong type") unless schedule.is_a?(Invoicexpress::Models::Schedule)
+
+        params = { :klass => Invoicexpress::Models::Schedule, :body => schedule }
+        post("schedules.xml", params.merge(options))
+      end
+      
+      # Returns a specific schedule. 
+      #
+      # @param schedule [Invoicexpress::Models::Schedule, String] The schedule or schedule ID
+      # @return Invoicexpress::Models::Schedule The schedule
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::NotFound When the schedule doesn't exist
+      def schedule(schedule, options={})
+        params = { :klass => Invoicexpress::Models::Schedule }
+        get("schedules/#{id_from_schedule(schedule)}.xml", params.merge(options))
+      end
+
+      # Updates a schedule.
+      # It also allows you to create a new client and/or items in the same request.
+      # If the client name does not exist a new one is created.
+      # Regarding item taxes, if the tax name is not found, it is ignored and no tax is applied to that item.
+      # If no item exists with the given name a new one will be created.
+      # If the item exists it will be updated with the new values.
+      # Be careful when updating the schedule items, as any missing items from the original invoice are deleted.
+      #
+      # @param schedule [Invoicexpress::Models::Schedule] The schedule to update
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the invoice doesn't exist
+      def update_schedule(schedule, options={})
+        raise(ArgumentError, "schedule has the wrong type") unless schedule.is_a?(Invoicexpress::Models::Schedule)
+        if !schedule.id
+          raise ArgumentError, "Schedule's ID is required"
+        end
+        params = { :klass => Invoicexpress::Models::Schedule, :body  => schedule.to_core_schedule() }
+        put("schedules/#{schedule.id}.xml", params.merge(options))
+      end
+      
+
+
+      # Activates a previously deactivated schedule
+      #
+      # @param schedule [Schedule] The schedule to change
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the invoice doesn't exist
+      def activate_schedule(schedule, options={})
+        raise(ArgumentError, "schedule has the wrong type") unless schedule.is_a?(Invoicexpress::Models::Schedule)
+
+        params = { :body => schedule, :klass => Invoicexpress::Models::Schedule }
+        put("schedules/#{id_from_schedule(schedule)}/activate", params.merge(options))
+      end
+
+
+      # Deactivates a schedule. No invoices are created while the schedule is deactivated
+      #
+      # @param schedule [Schedule] The schedule to change
+      # @raise Invoicexpress::Unauthorized When the client is unauthorized
+      # @raise Invoicexpress::UnprocessableEntity When there are errors on the submission
+      # @raise Invoicexpress::NotFound When the invoice doesn't exist
+      def deactivate_schedule(schedule, options={})
+        raise(ArgumentError, "schedule has the wrong type") unless schedule.is_a?(Invoicexpress::Models::Schedule)
+
+        params = { :body => schedule, :klass => Invoicexpress::Models::Schedule }
+        put("schedules/#{id_from_schedule(schedule)}/deactivate", params.merge(options))
+      end
+
+      private
+      def id_from_schedule(item)
+        if item.is_a?(Invoicexpress::Models::Schedule)
+          item.id
+        elsif item.is_a?(String)
+          item
+        elsif item.is_a?(Integer)
+          item.to_s
+        else
+          raise ArgumentError, "Cannot get schedule id from #{item}"
+        end
+      end
+    end
+  end
+end