starkbank 2.2.1 → 2.6.0

data/lib/starkbank.rb

@@ -2,10 +2,13 @@
 
 require_relative('key')
 require_relative('user/project')
+require_relative('user/organization')
+require_relative('workspace/workspace')
 require_relative('balance/balance')
 require_relative('transaction/transaction')
 require_relative('invoice/invoice')
 require_relative('invoice/log')
+require_relative('invoice/payment')
 require_relative('dict_key/dict_key')
 require_relative('deposit/deposit')
 require_relative('deposit/log')
@@ -22,9 +25,20 @@ require_relative('boleto_payment/boleto_payment')
 require_relative('boleto_payment/log')
 require_relative('utility_payment/utility_payment')
 require_relative('utility_payment/log')
+require_relative('tax_payment/tax_payment')
+require_relative('tax_payment/log')
+require_relative('darf_payment/darf_payment')
+require_relative('darf_payment/log')
 require_relative('webhook/webhook')
 require_relative('event/event')
+require_relative('event/attempt')
 require_relative('payment_request/payment_request')
+require_relative('payment_preview/payment_preview')
+require_relative('payment_preview/brcode_preview')
+require_relative('payment_preview/boleto_preview')
+require_relative('payment_preview/tax_preview')
+require_relative('payment_preview/utility_preview')
+require_relative('institution/institution')
 
 # SDK to facilitate Ruby integrations with Stark Bank
 module StarkBank

data/lib/tax_payment/log.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('tax_payment')
+
+module StarkBank
+  class TaxPayment
+    # # TaxPayment::Log object
+    #
+    # Every time a TaxPayment entity is updated, a corresponding TaxPayment::Log
+    # is generated for the entity. This log is never generated by the
+    # user, but it can be retrieved to check additional information
+    # on the TaxPayment.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - payment [TaxPayment]: TaxPayment entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this TaxPayment event
+    # - type [string]: type of the TaxPayment event which triggered the log creation. ex: 'canceled' or 'paid'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkBank::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :payment
+      def initialize(id:, created:, type:, errors:, payment:)
+        super(id)
+        @type = type
+        @errors = errors
+        @payment = payment
+        @created = StarkBank::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific Log
+      #
+      # Receive a single Log object previously created by the Stark Bank API by passing its id
+      #
+      # ## Parameters (required):
+      # - id [string]: object unique id. ex: '5656565656565656'
+      #
+      # ## Parameters (optional):
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+      #
+      # ## Return:
+      # - Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve Logs
+      #
+      # Receive a generator of Log objects previously created in the Stark Bank API
+      #
+      # ## Parameters (optional):
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - types [list of strings, default nil]: filter for log event types. ex: 'paid' or 'canceled'
+      # - payment_ids [list of strings, default nil]: list of TaxPayment ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if Starkbank.user was set before function call
+      #
+      # ## Return:
+      # - list of Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, payment_ids: nil, user: nil)
+        after = StarkBank::Utils::Checks.check_date(after)
+        before = StarkBank::Utils::Checks.check_date(before)
+        StarkBank::Utils::Rest.get_stream(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          payment_ids: payment_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged Logs
+      #
+      # Receive a list of up to 100 Log objects previously created in the Stark Bank API and the cursor to the next page.
+      # Use this function instead of query if you want to manually page your requests.
+      #
+      # ## Parameters (optional):
+      # - cursor [string, default nil]: cursor returned on the previous page function call
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - types [list of strings, default nil]: filter for log event types. ex: 'paid' or 'canceled'
+      # - payment_ids [list of strings, default nil]: list of TaxPayment ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if Starkbank.user was set before function call
+      #
+      # ## Return:
+      # - list of Log objects with updated attributes and cursor to retrieve the next page of Log objects
+      def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, payment_ids: nil, user: nil)
+        after = StarkBank::Utils::Checks.check_date(after)
+        before = StarkBank::Utils::Checks.check_date(before)
+        return StarkBank::Utils::Rest.get_page(
+          cursor: cursor,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          payment_ids: payment_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        tax_payment_maker = StarkBank::TaxPayment.resource[:resource_maker]
+        {
+          resource_name: 'TaxPaymentLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              payment: StarkBank::Utils::API.from_api_json(tax_payment_maker, json['payment'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/tax_payment/tax_payment.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # TaxPayment object
+  #
+  # When you initialize a TaxPayment, the entity will not be automatically
+  # created in the Stark Bank API. The 'create' function sends the objects
+  # to the Stark Bank API and returns the list of created objects.
+  #
+  # ## Parameters (conditionally required):
+  # - line [string, default nil]: Number sequence that describes the payment. Either 'line' or 'bar_code' parameters are required. If both are sent, they must match. ex: '85800000003 0 28960328203 1 56072020190 5 22109674804 0'
+  # - bar_code [string, default nil]: Bar code number that describes the payment. Either 'line' or 'barCode' parameters are required. If both are sent, they must match. ex: '83660000001084301380074119002551100010601813'
+  #
+  # ## Parameters (required):
+  # - description [string]: Text to be displayed in your statement (min. 10 characters). ex: 'payment ABC'
+  #
+  # ## Parameters (optional):
+  # - scheduled [Date, DateTime, Time or string, default today]: payment scheduled date. ex: Date.new(2020, 3, 10)
+  # - tags [list of strings, default nil]: list of strings for tagging
+  #
+  # ## Attributes (return-only):
+  # - id [string, default nil]: unique id returned when payment is created. ex: '5656565656565656'
+  # - type [string, default nil]: tax type. ex: 'das'
+  # - status [string, default nil]: current payment status. ex: 'success' or 'failed'
+  # - amount [int, default nil]: amount automatically calculated from line or bar_code. ex: 23456 (= R$ 234.56)
+  # - fee [integer, default nil]: fee charged when tax payment is created. ex: 200 (= R$ 2.00)
+  # - created [DateTime, default nil]: creation datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime, default nil]: latest update datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class TaxPayment < StarkBank::Utils::Resource
+    attr_reader :id, :line, :bar_code, :description, :tags, :scheduled, :status, :amount, :fee, :type, :updated, :created
+    def initialize(
+      id: nil, line: nil, bar_code: nil, description:, tags: nil, scheduled: nil, 
+      status: nil, amount: nil, fee: nil, type: nil, updated: nil, created: nil
+    )
+      super(id)
+      @line = line
+      @bar_code = bar_code
+      @description = description
+      @tags = tags
+      @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
+      @status = status
+      @amount = amount
+      @fee = fee
+      @type = type
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create TaxPayments
+    #
+    # Send a list of TaxPayment objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - payments [list of TaxPayment objects]: list of TaxPayment objects to be created in the API
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of TaxPayment objects with updated attributes
+    def self.create(payments, user: nil)
+      StarkBank::Utils::Rest.post(entities: payments, user: user, **resource)
+    end
+
+    # # Retrieve a specific TaxPayment
+    #
+    # Receive a single TaxPayment object previously created by the Stark Bank API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - TaxPayment object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve a specific TaxPayment pdf file
+    #
+    # Receive a single TaxPayment pdf file generated in the Stark Bank API by passing its id.
+    # Only valid for tax payments with 'success' status.
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - TaxPayment pdf file
+    def self.pdf(id, user: nil)
+      StarkBank::Utils::Rest.get_content(id: id, user: user, sub_resource_name: 'pdf', **resource)
+    end
+
+    # # Retrieve TaxPayments
+    #
+    # Receive a generator of TaxPayment objects previously created in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date , DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of TaxPayment objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil)
+      after = StarkBank::Utils::Checks.check_date(after)
+      before = StarkBank::Utils::Checks.check_date(before)
+      StarkBank::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        tags: tags,
+        ids: ids,
+        status: status,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged Tax Payments
+    #
+    # Receive a list of up to 100 Tax Payment objects previously created in the Stark Bank API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date , DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of Tax Payment objects with updated attributes and cursor to retrieve the next page of Tax Payment objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil)
+      after = StarkBank::Utils::Checks.check_date(after)
+      before = StarkBank::Utils::Checks.check_date(before)
+      return StarkBank::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        after: after,
+        before: before,
+        tags: tags,
+        ids: ids,
+        status: status,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Delete a TaxPayment entity
+    #
+    # Delete a TaxPayment entity previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - id [string]: UtilityPayment unique id. ex:'5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - deleted TaxPayment object
+    def self.delete(id, user: nil)
+      StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'TaxPayment',
+        resource_maker: proc { |json|
+          TaxPayment.new(
+            id: json['id'],
+            line: json['line'],
+            bar_code: json['bar_code'],
+            description: json['description'],
+            tags: json['tags'],
+            scheduled: json['scheduled'],
+            status: json['status'],
+            amount: json['amount'],
+            fee: json['fee'],
+            type: json['type'],
+            updated: json['updated'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/transaction/transaction.rb

@@ -55,7 +55,7 @@ module StarkBank
     # - transactions [list of Transaction objects]: list of Transaction objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of Transaction objects with updated attributes
@@ -71,7 +71,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Transaction object with updated attributes
@@ -85,19 +85,52 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - external_ids [list of strings, default nil]: list of external ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
     # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - generator of Transaction objects with updated attributes
     def self.query(limit: nil, after: nil, before: nil, tags: nil, external_ids: nil, ids: nil, user: nil)
       after = StarkBank::Utils::Checks.check_date(after)
       before = StarkBank::Utils::Checks.check_date(before)
-      StarkBank::Utils::Rest.get_list(
+      StarkBank::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        tags: tags,
+        external_ids: external_ids,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+    
+    # # Retrieve paged Transactions
+    #
+    # Receive a list of up to 100 Transaction objects previously created in the Stark Bank API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of Transaction objects with updated attributes and cursor to retrieve the next page of Transaction objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, tags: nil, external_ids: nil, ids: nil, user: nil)
+      after = StarkBank::Utils::Checks.check_date(after)
+      before = StarkBank::Utils::Checks.check_date(before)
+      return StarkBank::Utils::Rest.get_page(
+        cursor: cursor,
         limit: limit,
         after: after,
         before: before,

data/lib/transfer/log.rb

@@ -37,7 +37,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -51,18 +51,49 @@ module StarkBank
       #
       # ## Parameters (optional):
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
       # - types [list of strings, default nil]: filter retrieved objects by types. ex: 'success' or 'failed'
       # - transfer_ids [list of strings, default nil]: list of Transfer ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes
       def self.query(limit: nil, after: nil, before: nil, types: nil, transfer_ids: nil, user: nil)
         after = StarkBank::Utils::Checks.check_date(after)
         before = StarkBank::Utils::Checks.check_date(before)
-        StarkBank::Utils::Rest.get_list(
+        StarkBank::Utils::Rest.get_stream(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          transfer_ids: transfer_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged Logs
+      #
+      # Receive a list of up to 100 Log objects previously created in the Stark Bank API and the cursor to the next page.
+      # Use this function instead of query if you want to manually page your requests.
+      #
+      # ## Parameters (optional):
+      # - cursor [string, default nil]: cursor returned on the previous page function call
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - types [list of strings, default nil]: filter retrieved objects by types. ex: 'success' or 'failed'
+      # - transfer_ids [list of strings, default nil]: list of Transfer ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+      #
+      # ## Return:
+      # - list of Log objects with updated attributes and cursor to retrieve the next page of Log objects
+      def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, transfer_ids: nil, user: nil)
+        after = StarkBank::Utils::Checks.check_date(after)
+        before = StarkBank::Utils::Checks.check_date(before)
+        return StarkBank::Utils::Rest.get_page(
+          cursor: cursor,
           limit: limit,
           after: after,
           before: before,