starkbank 2.5.0 → 2.7.0

data/lib/payment_preview/payment_preview.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+
+
+module StarkBank
+  # # PaymentPreview object
+  #
+  # A PaymentPreview is used to get information from a payment code before confirming the payment.
+  # This resource can be used to preview BR Codes and bar codes of boleto, tax and utility payments
+  #
+  # ## Parameters (required):
+  # - id [string]: Main identification of the payment. This should be the BR Code for Pix payments and lines or bar codes for payment slips. ex: '34191.09008 63571.277308 71444.640008 5 81960000000062', '00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A'
+  #
+  # ## Parameters (optional):
+  # - scheduled [DateTime or string]: intended payment date. Right now, this parameter only has effect on BrcodePreviews. ex: '2020-04-30'
+  #
+  # ## Attributes (return-only):
+  # - type [string]: Payment type. ex: 'brcode-payment', 'boleto-payment', 'utility-payment' or 'tax-payment'
+  # - payment [BrcodePreview, BoletoPreview, UtilityPreview or TaxPreview]: Information preview of the informed payment.
+  class PaymentPreview < StarkCore::Utils::Resource
+    attr_reader :id, :scheduled, :type, :payment
+    def initialize(id: nil, scheduled: nil, type: nil, payment: nil)
+      super(id)
+      @scheduled = StarkCore::Utils::Checks.check_date(scheduled)
+      @type = type
+      @payment = payment
+      return if type.nil?
+
+      resource = {
+        'brcode-payment': StarkBank::PaymentPreview::BrcodePreview.resource,
+        'boleto-payment': StarkBank::PaymentPreview::BoletoPreview.resource,
+        'tax-payment': StarkBank::PaymentPreview::TaxPreview.resource,
+        'utility-payment': StarkBank::PaymentPreview::UtilityPreview.resource
+      }[type.to_sym]
+
+      @payment = StarkCore::Utils::API.from_api_json(resource[:resource_maker], payment) unless resource.nil?
+    end
+
+    # # Create PaymentPreviews
+    #
+    # Send a list of PaymentPreviews objects for processing in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - previews [list of PaymentPreviews objects]: list of PaymentPreviews objects to be created in the API
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of PaymentPreviews objects with updated attributes
+    def self.create(previews, user: nil)
+      StarkBank::Utils::Rest.post(entities: previews, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'PaymentPreview',
+        resource_maker: proc { |json|
+          PaymentPreview.new(
+            id: json['id'],
+            scheduled: json['scheduled'],
+            type: json['type'],
+            payment: json['payment']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/payment_preview/tax_preview.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+
+
+module StarkBank
+  class PaymentPreview
+    # # TaxPreview object
+    #
+    # A TaxPreview is used to get information from a Tax Payment you received before confirming the payment.
+    #
+    # ## Attributes (return-only):
+    # - amount [int]: final amount to be paid. ex: 23456 (= R$ 234.56)
+    # - name [string]: beneficiary full name. ex: "Iron Throne"
+    # - description [string]: tax payment description. ex: "ISS Payment - Iron Throne"
+    # - line [string]: Number sequence that identifies the payment. ex: "85660000006 6 67940064007 5 41190025511 7 00010601813 8"
+    # - bar_code [string]: Bar code number that identifies the payment. ex: "85660000006679400640074119002551100010601813"
+    class TaxPreview < StarkCore::Utils::SubResource
+      attr_reader :amount, :name, :description, :line, :bar_code
+      def initialize(amount:, name:, description:, line:, bar_code:)
+        @amount = amount
+        @name = name
+        @description = description
+        @line = line
+        @bar_code = bar_code
+      end
+
+      def self.resource
+        {
+          resource_name: 'TaxPreview',
+          resource_maker: proc { |json|
+            TaxPreview.new(
+              amount: json['amount'],
+              name: json['name'],
+              description: json['description'],
+              line: json['line'],
+              bar_code: json['bar_code']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/payment_preview/utility_preview.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+
+
+module StarkBank
+  class PaymentPreview
+    # # UtilityPreview object
+    #
+    # A UtilityPreview is used to get information from a Utility Payment you received before confirming the payment.
+    #
+    # ## Attributes (return-only):
+    # - amount [int]: final amount to be paid. ex: 23456 (= R$ 234.56)
+    # - name [string]: beneficiary full name. ex: "Light Company"
+    # - description [string]: utility payment description. ex: "Utility Payment - Light Company"
+    # - line [string]: Number sequence that identifies the payment. ex: "82660000002 8 44361143007 7 41190025511 7 00010601813 8"
+    # - bar_code [string]: Bar code number that identifies the payment. ex: "82660000002443611430074119002551100010601813"
+    class UtilityPreview < StarkCore::Utils::SubResource
+      attr_reader :amount, :name, :description, :line, :bar_code
+      def initialize(amount:, name:, description:, line:, bar_code:)
+        @amount = amount
+        @name = name
+        @description = description
+        @line = line
+        @bar_code = bar_code
+      end
+
+      def self.resource
+        {
+          resource_name: 'UtilityPreview',
+          resource_maker: proc { |json|
+            UtilityPreview.new(
+              amount: json['amount'],
+              name: json['name'],
+              description: json['description'],
+              line: json['line'],
+              bar_code: json['bar_code']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/payment_request/payment_request.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require('starkcore')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
+
 
 module StarkBank
   # # PaymentRequest object
+  #
   # A PaymentRequest is an indirect request to access a specific cash-out service
   # (such as Transfer, BrcodePayments, etc.) which goes through the cost center
   #  approval flow on our website. To emit a PaymentRequest, you must direct it to
@@ -16,24 +17,27 @@ module StarkBank
   # - center_id [String]: target cost center ID. ex: '5656565656565656'
   # - payment [Transfer, BrcodePayment, BoletoPayment, UtilityPayment, Transaction or dictionary]: payment entity that should be approved and executed.
   #
-  # ## Parameters (optional):
+  # ## Parameters (conditionally required):
   # - type [String]: payment type, inferred from the payment parameter if it is not a dictionary. ex: 'transfer', 'brcode-payment'
+  #
+  # ## Parameters (optional):
   # - due [Date, DateTime, Time or string]: Payment target date in ISO format. ex: 2020-12-31
   # - tags [list of strings]: list of strings for tagging
   #
   # ## Attributes (return-only):
   # - id [String]: unique id returned when PaymentRequest is created. ex: '5656565656565656'
-  # - amount [integer, default nil]: PaymentRequest amount. ex: 100000 = R$1.000,00
-  # - status [string, default nil]: current PaymentRequest status.ex: 'pending' or 'approved'
-  # - actions [list of dictionaries, default nil]: list of actions that are affecting this PaymentRequest. ex: [{'type': 'member', 'id': '56565656565656, 'action': 'requested'}]
-  # - updated [DateTime, default nil]: latest update datetime for the PaymentRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - created [DateTime, default nil]: creation datetime for the PaymentRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - amount [integer]: PaymentRequest amount. ex: 100000 = R$1.000,00
+  # - description [string]: payment request description. ex: "Tony Stark's Suit"
+  # - status [string]: current PaymentRequest status.ex: 'pending' or 'approved'
+  # - actions [list of dictionaries]: list of actions that are affecting this PaymentRequest. ex: [{'type': 'member', 'id': '56565656565656, 'action': 'requested'}]
+  # - updated [DateTime]: latest update datetime for the PaymentRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - created [DateTime]: creation datetime for the PaymentRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   #
-  class PaymentRequest < StarkBank::Utils::Resource
-    attr_reader :center_id, :payment, :type, :due, :tags, :amount, :status, :actions, :updated, :created
+  class PaymentRequest < StarkCore::Utils::Resource
+    attr_reader :center_id, :payment, :type, :due, :tags, :amount, :description, :status, :actions, :updated, :created
     def initialize(
       payment:, center_id:, id: nil, type: nil, due: nil, tags: nil, amount: nil, status: nil,
-      actions: nil, updated: nil, created: nil
+      description: nil, actions: nil, updated: nil, created: nil
     )
       super(id)
       @center_id = center_id
@@ -42,6 +46,7 @@ module StarkBank
       @amount = amount
       @status = status
       @actions = actions
+      @description = description
       @updated = updated
       @created = created
 
@@ -82,8 +87,8 @@ module StarkBank
     # ## Return:
     # - generator of PaymentRequest objects with updated attributes
     def self.query(center_id:, limit: nil, after: nil, before: nil, status: nil, type: nil, sort: nil, tags: nil, ids: nil, user: nil)
-      after = StarkBank::Utils::Checks.check_date(after)
-      before = StarkBank::Utils::Checks.check_date(before)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
       StarkBank::Utils::Rest.get_stream(
         center_id: center_id,
         limit: limit,
@@ -117,8 +122,8 @@ module StarkBank
     # ## Return:
     # - list of PaymentRequest objects with updated attributes and cursor to retrieve the next page of PaymentRequest objects
     def self.page(cursor: nil, center_id:, limit: nil, after: nil, before: nil, status: nil, type: nil, sort: nil, tags: nil, ids: nil, user: nil)
-      after = StarkBank::Utils::Checks.check_date(after)
-      before = StarkBank::Utils::Checks.check_date(before)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
       return StarkBank::Utils::Rest.get_page(
         cursor: cursor,
         center_id: center_id,
@@ -156,7 +161,7 @@ module StarkBank
         'darf-payment': StarkBank::DarfPayment.resource
       }[type.to_sym]
 
-      payment = StarkBank::Utils::API.from_api_json(resource[:resource_maker], payment) unless resource.nil?
+      payment = StarkCore::Utils::API.from_api_json(resource[:resource_maker], payment) unless resource.nil?
 
       [payment, type]
     end
@@ -173,6 +178,7 @@ module StarkBank
             tags: json['tags'],
             amount: json['amount'],
             status: json['status'],
+            description: json['description'],
             actions: json['actions'],
             updated: json['updated'],
             created: json['created']

data/lib/starkbank.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative('key')
-require_relative('user/project')
-require_relative('user/organization')
 require_relative('workspace/workspace')
 require_relative('balance/balance')
 require_relative('transaction/transaction')
@@ -10,10 +7,11 @@ require_relative('invoice/invoice')
 require_relative('invoice/log')
 require_relative('invoice/payment')
 require_relative('dict_key/dict_key')
+require_relative('dynamic_brcode/dynamic_brcode')
 require_relative('deposit/deposit')
 require_relative('deposit/log')
-require_relative('brcode_preview/brcode_preview')
 require_relative('brcode_payment/brcode_payment')
+require_relative('brcode_payment/rule')
 require_relative('brcode_payment/log')
 require_relative('boleto/boleto')
 require_relative('boleto/log')
@@ -21,6 +19,7 @@ require_relative('boleto_holmes/boleto_holmes')
 require_relative('boleto_holmes/log')
 require_relative('transfer/transfer')
 require_relative('transfer/log')
+require_relative('transfer/rule')
 require_relative('boleto_payment/boleto_payment')
 require_relative('boleto_payment/log')
 require_relative('utility_payment/utility_payment')
@@ -33,11 +32,28 @@ 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
+
+  API_VERSION = 'v2'
+  SDK_VERSION = '2.7.0'
+  HOST = "bank"
+  public_constant :API_VERSION, :SDK_VERSION, :HOST;
+
   @user = nil
   @language = 'en-US'
-  class << self; attr_accessor :user, :language; end
+  @timeout = 15
+  class << self; attr_accessor :user, :language, :timeout; end
+
+  Project = StarkCore::Project
+  Organization = StarkCore::Organization
+  Key = StarkCore::Key
+
 end

data/lib/tax_payment/log.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require('starkcore')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
 require_relative('tax_payment')
 
+
 module StarkBank
   class TaxPayment
     # # TaxPayment::Log object
@@ -14,20 +14,20 @@ module StarkBank
     # user, but it can be retrieved to check additional information
     # on the TaxPayment.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - 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
+    class Log < StarkCore::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)
+        @created = StarkCore::Utils::Checks.check_datetime(created)
       end
 
       # # Retrieve a specific Log
@@ -61,8 +61,8 @@ module StarkBank
       # ## 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)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
         StarkBank::Utils::Rest.get_stream(
           limit: limit,
           after: after,
@@ -91,8 +91,8 @@ module StarkBank
       # ## 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)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
         return StarkBank::Utils::Rest.get_page(
           cursor: cursor,
           limit: limit,
@@ -115,7 +115,7 @@ module StarkBank
               created: json['created'],
               type: json['type'],
               errors: json['errors'],
-              payment: StarkBank::Utils::API.from_api_json(tax_payment_maker, json['payment'])
+              payment: StarkCore::Utils::API.from_api_json(tax_payment_maker, json['payment'])
             )
           }
         }

data/lib/tax_payment/tax_payment.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require('starkcore')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
+
 
 module StarkBank
   # # TaxPayment object
@@ -23,31 +23,33 @@ module StarkBank
   # - 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
+  # - id [string]: unique id returned when payment is created. ex: '5656565656565656'
+  # - type [string]: tax type. ex: 'das'
+  # - status [string]: current payment status. ex: 'success' or 'failed'
+  # - amount [int]: amount automatically calculated from line or bar_code. ex: 23456 (= R$ 234.56)
+  # - fee [integer]: fee charged when tax payment is created. ex: 200 (= R$ 2.00)
+  # - transaction_ids [list of strings]: ledger transaction ids linked to this TaxPayment. ex: ["19827356981273"]
+  # - created [DateTime]: creation datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class TaxPayment < StarkCore::Utils::Resource
+    attr_reader :id, :line, :bar_code, :description, :tags, :scheduled, :status, :amount, :fee, :type, :transaction_ids, :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
+      status: nil, amount: nil, fee: nil, transaction_ids: 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)
+      @scheduled = StarkCore::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)
+      @transaction_ids = transaction_ids
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      @created = StarkCore::Utils::Checks.check_datetime(created)
     end
 
     # # Create TaxPayments
@@ -115,8 +117,8 @@ module StarkBank
     # ## 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)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
       StarkBank::Utils::Rest.get_stream(
         limit: limit,
         after: after,
@@ -147,8 +149,8 @@ module StarkBank
     # ## 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)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
       return StarkBank::Utils::Rest.get_page(
         cursor: cursor,
         limit: limit,
@@ -193,6 +195,7 @@ module StarkBank
             amount: json['amount'],
             fee: json['fee'],
             type: json['type'],
+            transaction_ids: json['transaction_ids'],
             updated: json['updated'],
             created: json['created']
           )

data/lib/transaction/transaction.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require('starkcore')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
+
 
 module StarkBank
   # # Transaction object
@@ -26,12 +26,12 @@ module StarkBank
   #
   # ## Attributes (return-only):
   # - sender_id [string]: unique id of the sending workspace. ex: '5656565656565656'
-  # - source [string, default nil]: locator of the entity that generated the transaction. ex: 'charge/1827351876292', 'transfer/92873912873/chargeback'
-  # - id [string, default nil]: unique id returned when Transaction is created. ex: '7656565656565656'
-  # - fee [integer, default nil]: fee charged when transaction is created. ex: 200 (= R$ 2.00)
-  # - balance [integer, default nil]: account balance after transaction was processed. ex: 100000000 (= R$ 1,000,000.00)
-  # - created [DateTime, default nil]: creation datetime for the boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  class Transaction < StarkBank::Utils::Resource
+  # - source [string]: locator of the entity that generated the transaction. ex: 'charge/1827351876292', 'transfer/92873912873/chargeback'
+  # - id [string]: unique id returned when Transaction is created. ex: '7656565656565656'
+  # - fee [integer]: fee charged when transaction is created. ex: 200 (= R$ 2.00)
+  # - balance [integer]: account balance after transaction was processed. ex: 100000000 (= R$ 1,000,000.00)
+  # - created [DateTime]: creation datetime for the boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class Transaction < StarkCore::Utils::Resource
     attr_reader :amount, :description, :external_id, :receiver_id, :sender_id, :tags, :id, :fee, :created, :source
     def initialize(amount:, description:, external_id:, receiver_id:, sender_id: nil, tags: nil, id: nil, fee: nil, source: nil, balance: nil, created: nil)
       super(id)
@@ -44,7 +44,7 @@ module StarkBank
       @fee = fee
       @source = source
       @balance = balance
-      @created = StarkBank::Utils::Checks.check_datetime(created)
+      @created = StarkCore::Utils::Checks.check_datetime(created)
     end
 
     # # Create Transactions
@@ -95,8 +95,8 @@ module StarkBank
     # ## 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)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
       StarkBank::Utils::Rest.get_stream(
         limit: limit,
         after: after,
@@ -127,8 +127,8 @@ module StarkBank
     # ## 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)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
       return StarkBank::Utils::Rest.get_page(
         cursor: cursor,
         limit: limit,

data/lib/transfer/log.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require('starkcore')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
 require_relative('transfer')
 
+
 module StarkBank
   class Transfer
     # # Transfer::Log object
@@ -13,20 +13,20 @@ module StarkBank
     # is generated for the entity. This log is never generated by the
     # user.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
     # - transfer [Transfer]: Transfer entity to which the log refers to.
     # - errors [list of strings]: list of errors linked to this BoletoPayment event.
     # - type [string]: type of the Transfer event which triggered the log creation. ex: 'processing' or 'success'
     # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-    class Log < StarkBank::Utils::Resource
+    class Log < StarkCore::Utils::Resource
       attr_reader :id, :created, :type, :errors, :transfer
       def initialize(id:, created:, type:, errors:, transfer:)
         super(id)
         @type = type
         @errors = errors
         @transfer = transfer
-        @created = StarkBank::Utils::Checks.check_datetime(created)
+        @created = StarkCore::Utils::Checks.check_datetime(created)
       end
 
       # # Retrieve a specific Log
@@ -60,8 +60,8 @@ module StarkBank
       # ## 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)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
         StarkBank::Utils::Rest.get_stream(
           limit: limit,
           after: after,
@@ -90,8 +90,8 @@ module StarkBank
       # ## 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)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
         return StarkBank::Utils::Rest.get_page(
           cursor: cursor,
           limit: limit,
@@ -114,7 +114,7 @@ module StarkBank
               created: json['created'],
               type: json['type'],
               errors: json['errors'],
-              transfer: StarkBank::Utils::API.from_api_json(transfer_maker, json['transfer'])
+              transfer: StarkCore::Utils::API.from_api_json(transfer_maker, json['transfer'])
             )
           }
         }

data/lib/transfer/rule.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+
+
+module StarkBank
+  class Transfer
+    # # Transfer::Rule object
+    #
+    # The Transfer::Rule object modifies the behavior of Transfer objects when passed as an argument upon their creation.
+    #
+    # ## Parameters (required):
+    # - key [string]: Rule to be customized, describes what Transfer behavior will be altered. ex: "resendingLimit"
+    # - value [integer]: Value of the rule. ex: 5
+    class Rule < StarkCore::Utils::SubResource
+      attr_reader :key, :value
+      def initialize(key:, value:)
+        @key = key
+        @value = value
+      end
+
+      def self.parse_rules(rules)
+        resource_maker = StarkBank::Transfer::Rule.resource[:resource_maker]
+        return rules if rules.nil?
+
+        parsed_rules = []
+        rules.each do |rule|
+          unless rule.is_a? Rule
+            rule = StarkCore::Utils::API.from_api_json(resource_maker, rule)
+          end
+          parsed_rules << rule
+        end
+        return parsed_rules
+      end
+
+      def self.resource
+      {
+        resource_name: 'Rule',
+        resource_maker: proc { |json|
+          Rule.new(
+            key: json['key'],
+            value: json['value']
+          )
+        }
+      }
+      end
+    end
+  end
+end