starkbank 0.4.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc0ef90a981378566198155d680a105ea7984c30c3b8ccb738af68bdeb4facb2
-  data.tar.gz: f9108a3e66d17bf8a639b76b92cc7bcdd14bfa4343f97c490c8dc83a05b3db77
+  metadata.gz: 21f296f6ce46e6451eb4650fcc5bd8f77b657184b10662daae70c79c4df26cc3
+  data.tar.gz: 2a0355e608aa51c1302ea55c8491741981afbfefd2bb86f56fb606fc4ab38c76
 SHA512:
-  metadata.gz: 11c46f92372727cfbed6afe6f5c72204f470cbda209db011ea354b554319644dc2e3c6a5f9c77aefee0cd155d4571ac4b06db0bec6e4b31dbee8bd59725ee1fe
-  data.tar.gz: 56a3d5bc265aa1c1a0f7395deab9ad4837391016e227784e1fae81bd5878f0a4a08755bf14c15089cb0b04a9a178747ade0bc6b51f7f3a5f09d9cb46ee567d36
+  metadata.gz: cce7c99b52dc834e4110caa9861a89dbb039d02d080d17631995666298798f6c1ca7024796958cc170d7f08d5a594a8f8ee4bb98078f8897e75a8455dad55987
+  data.tar.gz: 2e5c9d0a3d0f33b050f08b29e35453db3011190760145aec59a87a993a1086c038e9d430004cd8bdf7fe1ef657d08554d4eea4fec14d5e9d2692f57df71808c5

data/lib/boleto/boleto.rb

@@ -164,7 +164,7 @@ module StarkBank
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
-    # - deleted Boleto with updated attributes
+    # - deleted Boleto object
     def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end

data/lib/boleto_holmes/boleto_holmes.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # BoletoHolmes object
+  #
+  # When you initialize a BoletoHolmes, 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 (required):
+  # - boleto_id [string]: investigated boleto entity ID. ex: '5656565656565656'
+  #
+  # ## Parameters (optional):
+  # - tags [list of strings]: list of strings for tagging
+  #
+  # ## Attributes (return-only):
+  # - id [string, default nil]: unique id returned when holmes is created. ex: '5656565656565656'
+  # - status [string, default nil]: current holmes status. ex: 'solving' or 'solved'
+  # - result [string, default nil]: result of boleto status investigation. ex: 'paid' or 'cancelled'
+  # - created [DateTime, default nil]: creation datetime for the Boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime, default nil]: latest update datetime for the holmes. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class BoletoHolmes < StarkBank::Utils::Resource
+    attr_reader :boleto_id, :tags, :id, :status, :result, :created, :updated
+    def initialize(
+      boleto_id:, tags: nil, id: nil, status: nil, result: nil, created: nil, updated: nil
+    )
+      super(id)
+      @boleto_id = boleto_id
+      @tags = tags
+      @status = status
+      @result = result
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create BoletoHolmes
+    #
+    # Send a list of BoletoHolmes objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - holmes [list of BoletoHolmes objects]: list of BoletoHolmes objects to be created in the API
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of BoletoHolmes objects with updated attributes
+    def self.create(holmes, user: nil)
+      StarkBank::Utils::Rest.post(entities: holmes, user: user, **resource)
+    end
+
+    # # Retrieve a specific BoletoHolmes
+    #
+    # Receive a single BoletoHolmes object previously created by the Stark Bank API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - BoletoHolmes object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve BoletoHolmes
+    #
+    # Receive a generator of BoletoHolmes 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)
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'solved'
+    # - 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']
+    # - boleto_id [string, default nil]: filter for holmes that investigate a specific boleto by its ID. ex: '5656565656565656'
+    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of BoletoHolmes objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, boleto_id: nil, user: nil)
+      after = StarkBank::Utils::Checks.check_date(after)
+      before = StarkBank::Utils::Checks.check_date(before)
+      StarkBank::Utils::Rest.get_list(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        tags: tags,
+        ids: ids,
+        boleto_id: boleto_id,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'BoletoHolmes',
+        resource_maker: proc { |json|
+          BoletoHolmes.new(
+            boleto_id: json['boleto_id'],
+            tags: json['tags'],
+            id: json['id'],
+            status: json['status'],
+            result: json['result'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/boleto_holmes/log.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('boleto_holmes')
+
+module StarkBank
+  class BoletoHolmes
+    # # BoletoHolmes::Log object
+    #
+    # Every time a BoletoHolmes entity is modified, a corresponding BoletoHolmes::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 BoletoHolmes.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - holmes [BoletoHolmes]: BoletoHolmes entity to which the log refers to.
+    # - type [string]: type of the Boleto event which triggered the log creation. ex: 'registered' 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, :holmes, :type, :created
+      def initialize(id:, holmes:, type:, created:)
+        super(id)
+        @holmes = holmes
+        @type = type
+        @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 [Project object]: 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 'registered'
+      # - holmes_ids [list of strings, default nil]: list of BoletoHolmes ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - user [Project object, default nil]: 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, holmes_ids: nil, user: nil)
+        after = StarkBank::Utils::Checks.check_date(after)
+        before = StarkBank::Utils::Checks.check_date(before)
+        StarkBank::Utils::Rest.get_list(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          holmes_ids: holmes_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        holmes_maker = StarkBank::BoletoHolmes.resource[:resource_maker]
+        {
+          resource_name: 'BoletoHolmesLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              holmes: StarkBank::Utils::API.from_api_json(holmes_maker, json['holmes']),
+              type: json['type'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/boleto_payment/boleto_payment.rb

@@ -133,7 +133,7 @@ module StarkBank
     # Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     # Return:
-    # - deleted BoletoPayment with updated attributes
+    # - deleted BoletoPayment object
     def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end

data/lib/event/event.rb

@@ -8,6 +8,7 @@ require_relative('../utils/checks')
 require_relative('../utils/cache')
 require_relative('../error')
 require_relative('../boleto/log')
+require_relative('../boleto_holmes/log')
 require_relative('../transfer/log')
 require_relative('../boleto_payment/log')
 require_relative('../utility_payment/log')
@@ -37,7 +38,8 @@ module StarkBank
         'transfer': StarkBank::Transfer::Log.resource,
         'boleto': StarkBank::Boleto::Log.resource,
         'boleto-payment': StarkBank::BoletoPayment::Log.resource,
-        'utility-payment': StarkBank::UtilityPayment::Log.resource
+        'utility-payment': StarkBank::UtilityPayment::Log.resource,
+        'boleto-holmes': StarkBank::BoletoHolmes::Log.resource
       }[subscription.to_sym]
 
       @log = log
@@ -97,7 +99,7 @@ module StarkBank
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
-    # - deleted Event with updated attributes
+    # - deleted Event object
     def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end

data/lib/payment_request/payment_request.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+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, BoletoPayments, etc.) which goes through the cost center
+  #  approval flow on our website. To emit a PaymentRequest, you must direct it to
+  #  a specific cost center by its ID, which can be retrieved on our website at the
+  #  cost center page.
+  #
+  # ## Parameters (required):
+  # - center_id [String]: target cost center ID. ex: '5656565656565656'
+  # - payment [Transfer, BoletoPayment, UtilityPayment, Transaction or dictionary]: payment entity that should be approved and executed.
+  #
+  # ## Parameters (optional):
+  # - type [String]: payment type, inferred from the payment parameter if it is not a dictionary. ex: 'transfer', 'boleto-payment'
+  # - 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)
+  #
+  class PaymentRequest < StarkBank::Utils::Resource
+    attr_reader :center_id, :payment, :type, :due, :tags, :amount, :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
+    )
+      super(id)
+      @center_id = center_id
+      @due = due
+      @tags = tags
+      @amount = amount
+      @status = status
+      @actions = actions
+      @updated = updated
+      @created = created
+
+      @payment, @type = parse_payment(payment: payment, type: type)
+    end
+
+    ## Create PaymentRequests
+    # Sends a list of PaymentRequests objects for creating in the Stark Bank API
+    #
+    # ## Parameters
+    # - payment_requests [list of PaymentRequest objects]: list of PaymentRequest objects to be created in the API
+    # - user [Project object]: Project object. Not necessary if StarkBank.User.Default was set before function call
+    #
+    # ## Return
+    # - list of PaymentRequest objects with updated attributes
+    #
+    def self.create(payment_requests, user: nil)
+      StarkBank::Utils::Rest.post(entities: payment_requests, user: user, **resource)
+    end
+
+    # # Retrieve PaymentRequests
+    #
+    # Receive a generator of PaymentRequest objects previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - center_id [string]: target cost center ID. ex: '5656565656565656'
+    # ## 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)
+    # - status [string, default '-created']: sort order considered in response. Valid options are '-created' or '-due'.
+    # - type [string, default nil]: payment type, inferred from the payment parameter if it is not a dictionary. ex: 'transfer', 'boleto-payment'
+    # - sort [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - 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 [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## 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)
+      StarkBank::Utils::Rest.get_list(
+        center_id: center_id,
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        type: type,
+        sort: sort,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    def parse_payment(payment:, type:)
+      return [payment, 'transfer'] if payment.is_a?(StarkBank::Transfer)
+      return [payment, 'transaction'] if payment.is_a?(StarkBank::Transaction)
+      return [payment, 'boleto-payment'] if payment.is_a?(StarkBank::BoletoPayment)
+      return [payment, 'utility-payment'] if payment.is_a?(StarkBank::UtilityPayment)
+
+      raise(Exception('Payment must either be a Transfer, a Transaction, a BoletoPayment, a UtilityPayment or a hash.')) unless payment.is_a?(Hash)
+
+      resource = {
+        'transfer': StarkBank::Transfer.resource,
+        'transaction': StarkBank::Transaction.resource,
+        'boleto-payment': StarkBank::BoletoPayment.resource,
+        'utility-payment': StarkBank::UtilityPayment.resource
+      }[type.to_sym]
+
+      payment = StarkBank::Utils::API.from_api_json(resource[:resource_maker], payment) unless resource.nil?
+
+      [payment, type]
+    end
+
+    def self.resource
+      {
+        resource_name: 'PaymentRequest',
+        resource_maker: proc { |json|
+          PaymentRequest.new(
+            id: json['id'],
+            payment: json['payment'],
+            center_id: json['centerId'],
+            type: json['type'],
+            tags: json['tags'],
+            amount: json['amount'],
+            status: json['status'],
+            actions: json['actions'],
+            updated: json['updated'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/starkbank.rb

@@ -6,6 +6,8 @@ require_relative('balance/balance')
 require_relative('transaction/transaction')
 require_relative('boleto/boleto')
 require_relative('boleto/log')
+require_relative('boleto_holmes/boleto_holmes')
+require_relative('boleto_holmes/log')
 require_relative('transfer/transfer')
 require_relative('transfer/log')
 require_relative('boleto_payment/boleto_payment')
@@ -14,6 +16,7 @@ require_relative('utility_payment/utility_payment')
 require_relative('utility_payment/log')
 require_relative('webhook/webhook')
 require_relative('event/event')
+require_relative('payment_request/payment_request')
 
 # SDK to facilitate Ruby integrations with Stark Bank
 module StarkBank

data/lib/transaction/transaction.rb

@@ -87,15 +87,26 @@ module StarkBank
     # - 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']
     # - 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
     #
     # ## Return:
     # - generator of Transaction objects with updated attributes
-    def self.query(limit: nil, after: nil, before: nil, external_ids: nil, user: nil)
+    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(user: user, limit: limit, after: after, before: before, external_ids: external_ids, **resource)
+      StarkBank::Utils::Rest.get_list(
+        limit: limit,
+        after: after,
+        before: before,
+        tags: tags,
+        external_ids: external_ids,
+        ids: ids,
+        user: user,
+        **resource
+      )
     end
 
     def self.resource

data/lib/transfer/transfer.rb

@@ -21,6 +21,7 @@ module StarkBank
   #
   # ## Parameters (optional):
   # - tags [list of strings]: list of strings for reference when searching for transfers. ex: ['employees', 'monthly']
+  # - 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, 0, 0, 0)
   #
   # ## Attributes (return-only):
   # - id [string, default nil]: unique id returned when Transfer is created. ex: '5656565656565656'
@@ -30,8 +31,8 @@ module StarkBank
   # - 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, :transaction_ids, :fee, :tags, :status, :id, :created, :updated
-    def initialize(amount:, name:, tax_id:, bank_code:, branch_code:, account_number:, transaction_ids: nil, fee: nil, tags: nil, status: nil, id: nil, created: nil, updated: nil)
+    attr_reader :amount, :name, :tax_id, :bank_code, :branch_code, :account_number, :scheduled, :transaction_ids, :fee, :tags, :status, :id, :created, :updated
+    def initialize(amount:, name:, tax_id:, bank_code:, branch_code:, account_number:, scheduled: nil, transaction_ids: nil, fee: nil, tags: nil, status: nil, id: nil, created: nil, updated: nil)
       super(id)
       @amount = amount
       @name = name
@@ -39,6 +40,7 @@ module StarkBank
       @bank_code = bank_code
       @branch_code = branch_code
       @account_number = account_number
+      @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
       @transaction_ids = transaction_ids
       @fee = fee
       @tags = tags
@@ -79,6 +81,22 @@ module StarkBank
       StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
+    # # Delete a Transfer entity
+    #
+    # Delete a Transfer entity previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - id [string]: Transfer unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - deleted Transfer object
+    def self.delete(id, user: nil)
+      StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
     # # Retrieve a specific Transfer pdf file
     #
     # Receive a single Transfer pdf receipt file generated in the Stark Bank API by passing its id.
@@ -108,11 +126,12 @@ module StarkBank
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'success' or 'failed'
     # - tax_id [string, default nil]: filter for transfers sent to the specified tax ID. ex: "012.345.678-90"
     # - 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 [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## 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, user: nil)
+    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)
       StarkBank::Utils::Rest.get_list(
@@ -124,6 +143,7 @@ module StarkBank
         tax_id: tax_id,
         sort: sort,
         tags: tags,
+        ids: ids,
         user: user,
         **resource
       )
@@ -141,6 +161,7 @@ module StarkBank
             bank_code: json['bank_code'],
             branch_code: json['branch_code'],
             account_number: json['account_number'],
+            scheduled: json['scheduled'],
             transaction_ids: json['transaction_ids'],
             fee: json['fee'],
             tags: json['tags'],

data/lib/utility_payment/utility_payment.rb

@@ -133,7 +133,7 @@ module StarkBank
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
-    # - deleted UtilityPayment with updated attributes
+    # - deleted UtilityPayment object
     def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end

data/lib/utils/api.rb

@@ -5,16 +5,22 @@ require_relative('case')
 module StarkBank
   module Utils
     module API
-      def self.api_json(entity)
+      def self.build_entity_hash(entity)
         if entity.is_a?(Hash)
           entity_hash = entity
         else
           entity_hash = {}
           entity.instance_variables.each do |key|
-            entity_hash[key[1..-1]] = entity.instance_variable_get(key)
+            variable = entity.instance_variable_get(key)
+            entity_hash[key[1..-1]] = variable.is_a?(StarkBank::Utils::Resource) ? build_entity_hash(variable) : entity.instance_variable_get(key)
           end
         end
-        cast_json_to_api_format(entity_hash)
+        entity_hash
+      end
+
+      def self.api_json(entity)
+        built_hash = build_entity_hash(entity)
+        cast_json_to_api_format(built_hash)
       end
 
       def self.cast_json_to_api_format(hash)
@@ -30,6 +36,8 @@ module StarkBank
               list << (v.is_a?(Hash) ? cast_json_to_api_format(v) : v)
             end
             value = list
+          elsif value.is_a?(Hash)
+            value = cast_json_to_api_format(value)
           end
 
           entity_hash[StarkBank::Utils::Case.snake_to_camel(key)] = value
@@ -52,7 +60,12 @@ module StarkBank
       end
 
       def self.last_name_plural(resource_name)
-        "#{last_name(resource_name)}s"
+        base = last_name(resource_name)
+
+        return base if base[-1].eql?('s')
+        return "#{base[0...-1]}ies" if base[-1].eql?('y')
+
+        "#{base}s"
       end
 
       def self.last_name(resource_name)

data/lib/utils/request.rb

@@ -61,7 +61,7 @@ module StarkBank
         req['Access-Time'] = access_time
         req['Access-Signature'] = signature
         req['Content-Type'] = 'application/json'
-        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-0.4.2"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.1.0"
         req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }

data/lib/webhook/webhook.rb

@@ -83,7 +83,7 @@ module StarkBank
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
-    # - deleted Webhook with updated attributes
+    # - deleted Webhook object
     def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 2.1.0
 platform: ruby
 authors:
 - starkbank
@@ -75,11 +75,14 @@ files:
 - lib/balance/balance.rb
 - lib/boleto/boleto.rb
 - lib/boleto/log.rb
+- lib/boleto_holmes/boleto_holmes.rb
+- lib/boleto_holmes/log.rb
 - lib/boleto_payment/boleto_payment.rb
 - lib/boleto_payment/log.rb
 - lib/error.rb
 - lib/event/event.rb
 - lib/key.rb
+- lib/payment_request/payment_request.rb
 - lib/starkbank.rb
 - lib/transaction/transaction.rb
 - lib/transfer/log.rb