vindi 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6324f066d5adb684494d274974aa86e071128aab06ad39014a483a88ef0c1fd6
-  data.tar.gz: ae3e8560d9ba75e01538a1b976146314f10fe0d3e4b5cbd4bd4b66edecc9b192
+  metadata.gz: ec90b5b7e8c591e845d1d94c592ee8b6a4654778fc93e56c086990a803e8e5a6
+  data.tar.gz: 9333a081b85a19c5df77eeb6197e71047de2f140a4d5435dbee5369b0e615aff
 SHA512:
-  metadata.gz: a777cac742e07701ff22fe1f7bb6d60f852e60f572dce5efbec0d66c2b10d91b802a94661c6a11d3d2dde7a6b2f5dcdd853daa5d587702c35ffc3714e81c1853
-  data.tar.gz: 56b6a34da4b7bfc956a1cd347a82a8b5a4b5401a94b72342486e0be37470cf9f323b130de45c20a85a227ba18fab81f08485a9a7214720da5e1e8fb084c8c317
+  metadata.gz: 04a57614618954a3f987aebf61a6f70863b7bd235a07d7822f78de9925ead17efe207e972a5ea5e73ac99df6c795f8ec4d3aea15ca36e416d0bcdda1a8ffecfa
+  data.tar.gz: 03a3e7224f6f06f3c1d4d5c9dfdf6299770a7f65e549332b35115245c7dd520a13cccc3746836847f5fad6fdcb8a7004824fb046f185a4fd96ba1d518c225029

data/README.md

@@ -30,7 +30,20 @@ Ou instale você mesmo:
 Os métodos da API estão disponíveis atraves dos métodos da instancia de um cliente
 
 ```ruby
-  client = Vindi::Client.new(key: 'VINDI_KEY')
+  client = Vindi::Client.new(key: '<sua_vindi_api_key>')
+```
+
+Para testar no ambiente Sandbox, use o endpoint da API para efetuar requisições:
+
+```ruby
+  client = Vindi::Client.new(key: '<sua_vindi_api_key>', api_endpoint: 'https://sandbox-app.vindi.com.br/api/v1')
+```
+
+Caso prefira utilizar variáveis de ambiente para prover credenciais de acesso:
+
+```
+export VINDI_KEY="<sua_vindi_api_key>"
+export VINDI_API_ENDPOINT="https://sandbox-app.vindi.com.br/api/v1"
 ```
 
 ### Consumindo recursos

data/lib/vindi/error.rb

@@ -30,6 +30,9 @@ module Vindi
     # Raised when Vindi returns a 5xx HTTP status code
     ServerError = Class.new(self)
 
+    # Raised when Vindi returns the HTTP status code 500
+    InternalServerError = Class.new(ServerError)
+
     # Raised when Vindi returns the HTTP status code 502
     BadGateway = Class.new(ServerError)
 

data/lib/vindi/rest.rb

@@ -22,6 +22,7 @@ module Vindi
     include Vindi::Rest::Invoice
     include Vindi::Rest::Message
     include Vindi::Rest::ImportBatch
+    include Vindi::Rest::ExportBatch
     include Vindi::Rest::Notification
     include Vindi::Rest::Issue
     include Vindi::Rest::Merchant

data/lib/vindi/rest/charge.rb

@@ -11,7 +11,8 @@ module 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
@@ -89,6 +90,19 @@ module Vindi
       def delete_charge(charge_id, options = {})
         delete("charges/#{charge_id}", options)[:charge]
       end
+
+
+      # Capture 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/POST_version_charges_id_capture_format
+      # @example Capture charge #2
+      #   client.capture_charge(2)
+      def capture_charge(charge_id, options = {})
+        post("charges/#{charge_id}/capture", options)[:charge]
+      end
     end
   end
 end

data/lib/vindi/rest/customer.rb

@@ -11,7 +11,7 @@ module 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
@@ -24,9 +24,9 @@ module Vindi
       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 
+      # @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')
@@ -56,6 +56,19 @@ module Vindi
       def delete_customer(customer_id, options = {})
         delete("customers/#{customer_id}", options)[:customer]
       end
+
+
+      # Unarchive 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/POST_version_customers_id_unarchive_format
+      # @example Unarchive customer #2
+      #   client.unarchive_customer(2)
+      def unarchive_customer(customer_id, options = {})
+        post("customers/#{customer_id}/unarchive", options)[:customer]
+      end
     end
   end
 end

data/lib/vindi/rest/export_batch.rb

@@ -0,0 +1,52 @@
+module Vindi
+  module Rest
+
+    # Methods for the export_batches API
+    # @see https://vindi.github.io/api-docs/dist/#!/export_batches
+    module ExportBatch
+
+      # List export batches for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of export batches for a merchant.
+      # @example Get all export batches from merchant vindi
+      def list_export_batches(options = {})
+        get('export_batches', options)[:export_batches]
+      end
+
+      # Get a single export batch from a merchant
+      #
+      # @param export_batch_id [Integer] ID of the export batch
+      # @return [Hash] The export batch you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/export_batches/GET_version_export_batches_id_format
+      # @example Get export batch #154 from vindi
+      #   client.export_batch(154)
+      def export_batch(export_batch_id, options = {})
+        get("export_batches/#{export_batch_id}", options)[:export_batch]
+      end
+
+      # Create an export batch for a merchant vindi
+      #
+      # @option options [Hash] :options export_batch attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/export_batches/POST_version_export_batches_format
+      # @return [Hash] The export batch created
+      # @example Create an export batch for a merchant vindi
+      #   client.create_export_batch({ "payment_method_code": 2, "payment_company_code": "itau" })
+      def create_export_batch(options = {})
+        post('export_batches', options)[:export_batch]
+      end
+
+
+      # Approve an export batch for a merchant vindi
+      #
+      # @option options [Hash] :options export_batch attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/export_batches/POST_version_export_batches_id_approve_format
+      # @return [Hash] The export batch approved
+      # @example Approve an export batch for a merchant vindi
+      #   client.approve_export_batch(2)
+      def approve_export_batch(export_batch_id, options = {})
+        post("export_batches/#{export_batch_id}/approve", options)[:export_batch]
+      end
+    end
+  end
+end

data/lib/vindi/rest/import_batch.rb

@@ -5,7 +5,7 @@ module Vindi
     # @see https://vindi.github.io/api-docs/dist/#!/import_batches
     module ImportBatch
 
-      # List import_batchs for the authenticate user
+      # List import_batches 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.

data/lib/vindi/rest/invoice.rb

@@ -38,13 +38,23 @@ module 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
+
+      # Retry 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/postV1InvoicesIdRetry
+      # @example Retry a invoice from merchant vindi
+      #   client.retry_invoice(108)
+      def retry_invoice(invoice_id, options = {})
+        post("invoices/#{invoice_id}/retry", options)[:invoice]
+      end
     end
   end
 end

data/lib/vindi/rest/period.rb

@@ -47,6 +47,18 @@ module Vindi
       def update_period(period_id, options = {})
         put("periods/#{period_id}", options)[:period]
       end
+
+      # List period usages
+      #
+      # @params period_id [Integer] ID of the period
+      # @option options [Integer] :page (1) Page number.
+      # @return [Array<Hash>] A list of usages for a period.
+      # @see https://vindi.github.io/api-docs/dist/#/periods/getV1PeriodsIdUsages
+      # @example List period usages
+      #   client.list_period_usages(2)
+      def list_period_usages(period_id, options = {})
+        get("periods/#{period_id}/usages", options)[:usages]
+      end
     end
   end
 end

data/lib/vindi/rest/subscription.rb

@@ -80,6 +80,16 @@ module Vindi
       def delete_subscription(subscription_id, options = {})
         delete("subscriptions/#{subscription_id}", options)[:subscription]
       end
+
+      # List product items for a subscription
+      #
+      # @params subscription_id
+      # @see https://vindi.github.io/api-docs/dist/#!/subscriptions/GET_version_subscriptions_id_product_items_format
+      # @example List subscription product items #2
+      #   client.list_subscription_product_items(2)
+      def list_subscription_product_items(subscription_id, options = {})
+        get("subscriptions/#{subscription_id}/product_items", options)[:product_items]
+      end
     end
   end
 end

data/lib/vindi/version.rb

@@ -1,3 +1,3 @@
 module Vindi
-  VERSION = '0.0.3'
+  VERSION = '0.0.8'
 end

data/vindi.gemspec

@@ -15,7 +15,8 @@ Gem::Specification.new do |spec|
   spec.files        +=  Dir.glob("lib/**/*.rb")
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday', '~> 0.13.1'
+
+  spec.add_dependency 'faraday', '~> 0.13'
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vindi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Vindi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-12 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +74,7 @@ files:
 - lib/vindi/rest/charge.rb
 - lib/vindi/rest/customer.rb
 - lib/vindi/rest/discount.rb
+- lib/vindi/rest/export_batch.rb
 - lib/vindi/rest/import_batch.rb
 - lib/vindi/rest/invoice.rb
 - lib/vindi/rest/issue.rb
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the Vindi API