Contents

module Ecommerce
  module Resources
    #
    # A wrapper to Ecommerce orders invoice API
    #
    # [API]
    #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/index.html
    #
    class InvoiceOrder < Base
      attr_reader :redeemed_adjustments, :order_url, :url, :created_at, :activated_at, :number, :user_data,
                  :amount_with_adjustments, :amount, :paid, :payment_method, :plan_data, :charge_date,
                  :next_payment_date

      #
      # Lists all invoice of an orders and return a collection of invoice with
      # pagination information (represented by Ecommerce::Resources::InvoiceOrderCollection)
      #
      # [API]
      #   Method: <tt>GET /api/orders/:slug/:id/invoices/ </tt>
      #
      #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/orders.html#listagem-das-ordens-de-compra-de-uma-conta
      #
      def self.find_all(order_id, slug, page = 1, limit = 20)
        body = { page: page, limit: limit }
        client.get("/api/orders/#{slug}/#{order_id}/invoices/", body: body) do |response|
          Ecommerce::Resources::InvoiceOrderCollection.build(response)
        end
      end

      #
      # Finds an invoice of an order
      #
      # [API]
      #   Method: <tt>GET /api/orders/:slug/:order_id/invoices/:id/</tt>
      #
      #   Documentation: http://myfreecomm.github.io/passaporte-web/ecommerce/api/orders.html#listagem-das-ordens-de-compra-de-uma-conta
      #
      def self.find(invoice_order_id, order_id, slug)
        client.get("/api/orders/#{slug}/#{order_id}/invoices/#{invoice_order_id}/") do |response|
          build_invoice(response)
        end
      end

      private

      def self.build_invoice(response)
        invoice_attributes = parsed_body(response)
        invoice_attributes.empty? ? {} : new(invoice_attributes)
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
ecommerce-client-0.0.5	lib/ecommerce/resources/invoice_order.rb
ecommerce-client-0.0.4	lib/ecommerce/resources/invoice_order.rb
ecommerce-client-0.0.3	lib/ecommerce/resources/invoice_order.rb