vindi 0.0.1

data/lib/vindi/rest/bill.rb

@@ -0,0 +1,95 @@
+module Vindi
+  module Rest
+
+    # Methods for the bills API
+    # @see https://vindi.github.io/api-docs/dist/#!/bills
+    module Bill
+
+      # List bill for the authenticate user
+      # @return [Array<Hash>] A list of bills for a merchant.
+      # @example Get all bills from merchant vindi
+      def list_bills(options = {})
+        get('bills', options)[:bills]
+      end
+
+      # Get a single bill from a merchant
+      #
+      # @param bill_id [Integer] ID of the bill
+      # @return [Hash] The bill you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/bills/GET_version_bills_id_format
+      # @example Get bill #2 from vindi
+      #   client.bill(2)
+      def bill(bill_id, options = {})
+        get("bills/#{bill_id}", options)[:bill]
+      end
+
+      # Create a bill for a merchant vindi
+      #
+      # @option options [Hash] :options bill attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/bills/POST_version_bills_format
+      # @return [Hash] The bill created
+      # @example Create a bill for a merchant vindi
+      #   client.create_bill(customer_id: 2, payment_method_code: "credit_card",
+      #                      bill_items: [{ product_id: 26, amount: 1 }])
+      def create_bill(options = {})
+        post('bills', options)[:bill]
+      end
+
+      # Edit a bill
+      #
+      # @params bill_id [Integer] ID of the bill
+      # @option options [Hash] :options bill attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/bills/PUT_version_bills_id_format
+      # @example update bill #2
+      #   client.update_bill(2, payment_method_code: "debit_card")
+      def update_bill(bill_id, options = {})
+        put("bills/#{bill_id}", options)[:bill]
+      end
+
+      # Approve a bill
+      #
+      # @params bill_id [Integer] ID of the bill
+      # @option options [Hash] :options bill attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/bills/PUT_version_bills_id_format
+      # @example approve bill #2
+      #   client.approve_bill(2)
+      def approve_bill(bill_id, options = {})
+        post("bills/#{bill_id}/approve", options)[:bill]
+      end
+
+      # Charge a bill
+      #
+      # @params bill_id [Integer] ID of the bill
+      # @option options [Hash] :options bill attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/bills/PUT_version_bills_id_format
+      # @example charge bill #2
+      #   client.charge_bill(2)
+      def charge_bill(bill_id, options = {})
+        post("bills/#{bill_id}/charge", options)[:bill]
+      end
+
+      # Generate invoice from a bill
+      #
+      # @params bill_id [Integer] ID of the bill
+      # @option options [Hash] :options bill attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/bills/PUT_version_bills_id_format
+      # @example create  a invoice from bill #2
+      #   client.create_invoice_from_bill(2)
+      def create_invoice_from_bill(bill_id, options = {})
+        post("bills/#{bill_id}/invoice", options)[:invoices]
+      end
+
+      # Delete a bill from merchant vindi
+      #
+      # @params bill_id [Integer] ID of the bill
+      # @option options [Hash] :options bill attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/bills/DELETE_version_bills_id_format
+      # @example Delete bill #2
+      #   client.delete_bill(2)
+      def delete_bill(bill_id, options = {})
+        delete("bills/#{bill_id}", options)[:bill]
+      end
+    end
+  end
+end

data/lib/vindi/rest/bill_item.rb

@@ -0,0 +1,20 @@
+module Vindi
+  module Rest
+
+    # Methods for the bill_items API
+    # @see https://vindi.github.io/api-docs/dist/#!/bill_items
+    module BillItem
+      
+      # Get a single bill_item from a merchant
+      #
+      # @param bill_item_id [Integer] ID of the bill_item
+      # @return [Hash] The bill_item you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/bill_items/GET_version_bill_items_id_format
+      # @example Get bill_item #2 from vindi
+      #   client.bill_item(2)
+      def bill_item(bill_item_id, options = {})
+        get("bill_items/#{bill_item_id}", options)[:bill_item]
+      end
+    end
+  end
+end

data/lib/vindi/rest/charge.rb

@@ -0,0 +1,94 @@
+module Vindi
+  module Rest
+
+    # Methods for the charges API
+    # @see https://vindi.github.io/api-docs/dist/#!/charges
+    module Charge
+
+      # List charge for the authenticate user
+      # @return [Array<Hash>] A list of charges for a merchant.
+      # @example Get all charges from merchant vindi
+      def list_charges(options = {})
+        get('charges', options)[:charges]
+      end
+      
+      # Get a single charge from a merchant
+      #
+      # @param charge_id [Integer] ID of the charge
+      # @return [Hash] The charge you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/charges/GET_version_charges_id_format
+      # @example Get charge #2 from vindi
+      #   client.charge(2)
+      def charge(charge_id, options = {})
+        get("charges/#{charge_id}", options)[:charge]
+      end
+
+      # Edit a charge
+      #
+      # @params charge_id [Integer] ID of the charge
+      # @option options [Hash] :options charge attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/charges/PUT_version_charges_id_format
+      # @example update charge #2
+      #   client.update_charge(2, installments: 3)
+      def update_charge(charge_id, options = {})
+        put("charges/#{charge_id}", options)[:charge]
+      end
+
+      # Reissue a charge
+      #
+      # @params charge_id [Integer] ID of the charge
+      # @option options [Hash] :options charge attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/charges/PUT_version_charges_id_format
+      # @example reissue charge #2
+      #   client.reissue_charge(2, payment_method_code: 'debit_card')
+      def reissue_charge(charge_id, options = {})
+        post("charges/#{charge_id}/reissue", options)[:charge]
+      end
+
+      # Perform a charge
+      #
+      # @params charge_id [Integer] ID of the charge
+      # @option options [Hash] :options charge attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/charges/PUT_version_charges_id_format
+      # @example perform a charge #2
+      #   client.perform_charge(2)
+      def perform_charge(charge_id, options = {})
+        post("charges/#{charge_id}/charge", options)[:charge]
+      end
+
+      # Refund from a charge
+      #
+      # @params charge_id [Integer] ID of the charge
+      # @option options [Hash] :options charge attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/charges/PUT_version_charges_id_format
+      # @example refund from charge #2
+      #   client.refund_charge(2, amount: 50)
+      def refund_charge(charge_id, options = {})
+        post("charges/#{charge_id}/refund", options)[:charge]
+      end
+
+      # Perform fraud review
+      #
+      # @params charge_id [Integer] ID of the charge
+      # @option options [Hash] :options charge attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/charges/PUT_version_charges_id_format
+      # @example perform a fraud review charge #2
+      #   client.fraud_review_charge(2)
+      def fraud_review(charge_id, options = {})
+        post("charges/#{charge_id}/fraud_review", options)[:charge]
+      end
+
+      # Delete a charge from merchant vindi
+      #
+      # @params charge_id [Integer] ID of the charge
+      # @option options [Hash] :options charge attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/charges/DELETE_version_charges_id_format
+      # @example Delete charge #2
+      #   client.delete_charge(2)
+      def delete_charge(charge_id, options = {})
+        delete("charges/#{charge_id}", options)[:charge]
+      end
+    end
+  end
+end

data/lib/vindi/rest/customer.rb

@@ -0,0 +1,61 @@
+module Vindi
+  module Rest
+
+    # Methods for the Customers API
+    # @see https://vindi.github.io/api-docs/dist/#!/customers
+    module Customer
+
+      # List customer for the authenticate user
+      # @return [Array<Hash>] A list of customers for a merchant.
+      # @example Get all customers from merchant vindi
+      def list_customers(options = {})
+        get('customers', options)[:customers]
+      end
+      
+      # Get a single customer from a merchant
+      #
+      # @param customer_id [Integer] ID of the customer
+      # @return [Hash] The customer you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/customers/GET_version_customers_id_format
+      # @example Get customer #2 from vindi
+      #   client.customer(2)
+      def customer(customer_id, options = {})
+        get("customers/#{customer_id}", options)[:customer]
+      end
+
+      # Create a customer for a merchant vindi
+      # 
+      # @option options [Hash] :options customer attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/customers/POST_version_customers_format 
+      # @return [Hash] The customer created
+      # @example Create a customer for a merchant vindi
+      #   client.create_customer(name: 'John Doe', email: 'john.doe@mail.com')
+      def create_customer(options = {})
+        post('customers', options)[:customer]
+      end
+
+      # Edit a customer
+      #
+      # @params customer_id [Integer] ID of the customer
+      # @option options [Hash] :options customer attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/customers/PUT_version_customers_id_format
+      # @example update customer #2
+      #   client.update_customer(2, name: 'Joana Doe', email: 'johanadoes@mail.com')
+      def update_customer(customer_id, options = {})
+        put("customers/#{customer_id}", options)[:customer]
+      end
+
+      # Delete a customer from merchant vindi
+      #
+      # @params customer_id [Integer] ID of the customer
+      # @option options [Hash] :options customer attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/customers/DELETE_version_customers_id_format
+      # @example Delete customer #2
+      #   client.delete_customer(2)
+      def delete_customer(customer_id, options = {})
+        delete("customers/#{customer_id}", options)[:customer]
+      end
+    end
+  end
+end

data/lib/vindi/rest/discount.rb

@@ -0,0 +1,45 @@
+module Vindi
+  module Rest
+
+    # Methods for the discount API
+    # @see https://vindi.github.io/api-docs/dist/#!/discounts
+    module Discount
+
+      # Get a single discount from a merchant
+      #
+      # @param discount_id [Integer] ID of the discount
+      # @return [Hash] The discount you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/discounts/GET_version_discounts_id_format
+      # @example Get discount #2 from vindi
+      #   client.discount(2)
+      def discount(discount_id, options = {})
+        get("discounts/#{discount_id}", options)[:discount]
+      end
+
+      # Create a discount for a merchant vindi
+      # 
+      # @option options [Hash] :options discount attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/discounts/POST_version_discounts_format 
+      # @return [Hash] The discount created
+      # @example Create a discount for a merchant vindi
+      #   client.create_discount(product_item_id: 118,
+      #                          discount_type: "percentage", percentage: 10,
+      #                          amount: 1, quantity: 1, cycles: 1)
+      def create_discount(options = {})
+        post('discounts', options)[:discount]
+      end
+
+      # Delete a discount from merchant vindi
+      #
+      # @params discount_id [Integer] ID of the discount
+      # @option options [Hash] :options discount attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/discounts/DELETE_version_discounts_id_format
+      # @example Delete discount #2
+      #   client.delete_discount(2)
+      def delete_discount(discount_id, options = {})
+        delete("discounts/#{discount_id}", options)[:discount]
+      end
+    end
+  end
+end

data/lib/vindi/rest/import_batch.rb

@@ -0,0 +1,38 @@
+module Vindi
+  module Rest
+
+    # Methods for the Import Batch API
+    # @see https://vindi.github.io/api-docs/dist/#!/import_batches
+    module ImportBatch
+
+      # List import_batchs for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of imported batches for a merchant.
+      # @example Get all import_batches from merchant vindi
+      def list_import_batches(options = {})
+        get('import_batches', options)[:import_batches]
+      end
+
+      # Get a single import_batch from a merchant
+      #
+      # @param import_batch_id [Integer] ID of the import_batch
+      # @return [Hash] The import_batch you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/import_batches/GET_version_import_batches_id_format
+      # @example Get import_batch #2 from vindi
+      #   client.import_batch(2)
+      def import_batch(import_batch_id, options = {})
+        get("import_batches/#{import_batch_id}", options)[:import_batch]
+      end
+
+      # Create a import_batch for a merchant vindi
+      #
+      # @option options [Hash] :options import_batch attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/import_batches/POST_version_import_batches_format
+      # @return [Hash] The import_batch created
+      def create_import_batch(options = {})
+        post('import_batches', options)[:import_batch]
+      end
+    end
+  end
+end

data/lib/vindi/rest/invoice.rb

@@ -0,0 +1,50 @@
+module Vindi
+  module Rest
+
+    # Methods for the invoices API
+    # @see https://vindi.github.io/api-docs/dist/#!/invoices
+    module Invoice
+
+      # List invoice for the authenticate user
+      # @return [Array<Hash>] A list of invoices for a merchant.
+      # @example Get all invoices from merchant vindi
+      def list_invoices(options = {})
+        get('invoices', options)[:invoices]
+      end
+
+      # Get a single invoice from a merchant
+      #
+      # @param invoice_id [Integer] ID of the invoice
+      # @return [Hash] The invoice you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/invoices/GET_version_invoices_id_format
+      # @example Get invoice #108 from vindi
+      #   client.invoice(108)
+      def invoice(invoice_id, options = {})
+        get("invoices/#{invoice_id}", options)[:invoice]
+      end
+
+      # Create a invoice for a merchant vindi
+      #
+      # @option options [Hash] :options invoice attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/invoices/POST_version_invoices_format
+      # @return [Hash] The invoice created
+      # @example Create a invoice for a merchant vindi
+      #   client.create_invoice({ bill_id: 71, amount: 1 })
+      def create_invoice(options = {})
+        post('invoices', options)[:invoice]
+      end
+
+      # Delete a invoice from merchant vindi
+      #
+      # @params invoice_id [Integer] ID of the invoice
+      # @option options [Hash] :options invoice attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/invoices/DELETE_version_invoices_id_format
+      # @example Delete invoice #108
+      #   client.delete_invoice(108)
+      def delete_invoice(invoice_id, options = {})
+        delete("invoices/#{invoice_id}", options)[:invoice]
+      end
+    end
+  end
+end

data/lib/vindi/rest/issue.rb

@@ -0,0 +1,40 @@
+module Vindi
+  module Rest
+
+    # Methods for the issues API
+    # @see https://vindi.github.io/api-docs/dist/#!/issues
+    module Issue
+
+      # List issues for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of issues for a merchant.
+      # @example Get all issues from merchant vindi
+      def list_issues(options = {})
+        get('issues', options)[:issues]
+      end
+
+      # Get a single issue from a merchant
+      #
+      # @param issue_id [Integer] ID of the issue
+      # @return [Hash] The issue you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/issues/GET_version_issues_id_format
+      # @example Get issue #154 from vindi
+      #   client.issue(2)
+      def issue(issue_id, options = {})
+        get("issues/#{issue_id}", options)[:issue]
+      end
+
+      # Edit a issue
+      #
+      # @params issue_id [Integer] ID of the issue
+      # @option options [Hash] :options issue attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/issues/PUT_version_issues_id_format
+      # @example update issue #2
+      #   client.update_issue(2, status: "open")
+      def update_issue(issue_id, options = {})
+        put("issues/#{issue_id}", options)[:issue]
+      end
+    end
+  end
+end