starkbank 2.6.0 → 2.8.0

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')
@@ -42,7 +41,19 @@ require_relative('institution/institution')
 
 # SDK to facilitate Ruby integrations with Stark Bank
 module StarkBank
+
+  API_VERSION = 'v2'
+  SDK_VERSION = '2.8.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

data/lib/transfer/transfer.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
   # # Transfer object
@@ -15,7 +15,7 @@ module StarkBank
   # - amount [integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34)
   # - name [string]: receiver full name. ex: 'Anthony Edward Stark'
   # - tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
-  # - bank_code [string]: code of the receiver bank institution in Brazil. If an ISPB (8 digits) is informed, a PIX transfer will be created, else a TED will be issued. ex: '20018183' or '260'
+  # - bank_code [string]: code of the receiver bank institution in Brazil. If an ISPB (8 digits) is informed, a Pix transfer will be created, else a TED will be issued. ex: '20018183' or '260'
   # - branch_code [string]: receiver bank account branch. Use '-' in case there is a verifier digit. ex: '1357-9'
   # - account_number [string]: receiver bank account number. Use '-' before the verifier digit. ex: '876543-2'
   #
@@ -25,17 +25,19 @@ module StarkBank
   # - scheduled [string, default now]: datetime when the transfer will be processed. May be pushed to next business day if necessary. ex: DateTime.new(2020, 3, 11, 8, 13, 12, 11)
   # - description [string, default nil]: optional description to override default description to be shown in the bank statement. ex: 'Payment for service #1234'
   # - tags [list of strings]: list of strings for reference when searching for transfers. ex: ['employees', 'monthly']
+  # - rules [list of Transfer::Rules, default []]: list of Transfer::Rule objects for modifying transfer behavior. ex: [Transfer::Rule(key: "resendingLimit", value: 5)]
   #
   # ## Attributes (return-only):
-  # - id [string, default nil]: unique id returned when Transfer is created. ex: '5656565656565656'
-  # - fee [integer, default nil]: fee charged when transfer is created. ex: 200 (= R$ 2.00)
-  # - status [string, default nil]: current transfer status. ex: 'success' or 'failed'
-  # - transaction_ids [list of strings, default nil]: ledger transaction ids linked to this transfer (if there are two, second is the chargeback). ex: ['19827356981273']
-  # - created [DateTime, default nil]: creation datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - updated [DateTime, default nil]: latest update datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  class Transfer < StarkBank::Utils::Resource
-    attr_reader :amount, :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :external_id, :scheduled, :description, :transaction_ids, :fee, :tags, :status, :id, :created, :updated
-    def initialize(amount:, name:, tax_id:, bank_code:, branch_code:, account_number:, account_type: nil, external_id: nil, scheduled: nil, description: nil, transaction_ids: nil, fee: nil, tags: nil, status: nil, id: nil, created: nil, updated: nil)
+  # - id [string]: unique id returned when Transfer is created. ex: '5656565656565656'
+  # - fee [integer]: fee charged when transfer is created. ex: 200 (= R$ 2.00)
+  # - status [string]: current transfer status. ex: 'success' or 'failed'
+  # - transaction_ids [list of strings]: ledger transaction ids linked to this transfer (if there are two, second is the chargeback). ex: ['19827356981273']
+  # - metadata [dictionary object]: dictionary object used to store additional information about the Transfer object.
+  # - created [DateTime]: creation datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class Transfer < StarkCore::Utils::Resource
+    attr_reader :amount, :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :external_id, :scheduled, :description, :transaction_ids, :metadata, :fee, :tags, :rules, :status, :id, :created, :updated
+    def initialize(amount:, name:, tax_id:, bank_code:, branch_code:, account_number:, account_type: nil, external_id: nil, scheduled: nil, description: nil, transaction_ids: nil, metadata: nil, fee: nil, tags: nil, rules: nil, status: nil, id: nil, created: nil, updated: nil)
       super(id)
       @amount = amount
       @name = name
@@ -45,14 +47,16 @@ module StarkBank
       @account_number = account_number
       @account_type = account_type
       @external_id = external_id
-      @scheduled = StarkBank::Utils::Checks.check_date_or_datetime(scheduled)
+      @scheduled = StarkCore::Utils::Checks.check_date_or_datetime(scheduled)
       @description = description
-      @transaction_ids = transaction_ids
-      @fee = fee
       @tags = tags
+      @rules = StarkBank::Transfer::Rule.parse_rules(rules)
+      @fee = fee
       @status = status
-      @created = StarkBank::Utils::Checks.check_datetime(created)
-      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+      @transaction_ids = transaction_ids
+      @metadata = metadata
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
     end
 
     # # Create Transfers
@@ -138,8 +142,8 @@ module StarkBank
     # ## Return:
     # - generator of Transfer objects with updated attributes
     def self.query(limit: nil, after: nil, before: nil, transaction_ids: nil, status: nil, tax_id: 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(
         limit: limit,
         after: after,
@@ -173,8 +177,8 @@ module StarkBank
     # ## Return:
     # - list of Transfer objects with updated attributes and cursor to retrieve the next page of Transfer objects
     def self.page(cursor: nil, limit: nil, after: nil, before: nil, transaction_ids: nil, status: nil, tax_id: 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,
         limit: limit,
@@ -196,7 +200,6 @@ module StarkBank
         resource_name: 'Transfer',
         resource_maker: proc { |json|
           Transfer.new(
-            id: json['id'],
             amount: json['amount'],
             name: json['name'],
             tax_id: json['tax_id'],
@@ -207,10 +210,13 @@ module StarkBank
             external_id: json['external_id'],
             scheduled: json['scheduled'],
             description: json['description'],
-            transaction_ids: json['transaction_ids'],
-            fee: json['fee'],
             tags: json['tags'],
+            rules: json['rules'],
+            id: json['id'],
+            fee: json['fee'],
             status: json['status'],
+            transaction_ids: json['transaction_ids'],
+            metadata: json['metadata'],
             created: json['created'],
             updated: json['updated']
           )