starkbank 0.0.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4a8806c80a8e9dbc2e9a5a4bae7a2e6896f26965c9dbc49b89c696bfffe6d39
-  data.tar.gz: f262f62c95a8b4f6c96c324bbce27132ab6ca53a82bd288bb03241b5c113d352
+  metadata.gz: bf5488ddd0ee3f98ef2a890f8f3432ce3b80b5bba5344da16d4f99339e4f2aa3
+  data.tar.gz: cafd89743d269f83769f250b7651bf4eecebb88c7997fdd4bf4e66ae532dd735
 SHA512:
-  metadata.gz: fb86b4fed4b17b56328c23291cc228349efed8c37cd76c556162c6b13f8f205786c6091d209b7953a9aa99a575c2d3e864660e0ae3554925586bb13c1925288f
-  data.tar.gz: 5bd3b78074da5436482dd0dbddb0fa3a63cdd4921e04063aa1d0559c442f58702748722e9f90602822a25ae6e9b3da8946ac5fcd75f6f7e1d533977379179e5f
+  metadata.gz: 987f82173290c1dd081326dd3955a8978aabe38115b0d1885570e81eb73df3f2e381def15bdcfd726ccfca255e4b8531e096c761da563d886f1fc2334a1b938b
+  data.tar.gz: 730698a7e8c425c430b1b3652003c9acf54070f1e791e288b452f5e308ecc3fd7b9d42accb329a3ba5ccdde41cb95fbed4bd5c3440ea89738c50cd780f5ca71f

data/lib/{ledger → balance}/balance.rb

@@ -13,9 +13,9 @@ module StarkBank
   # can be retrieved to see the available information.
   #
   # ## Attributes (return-only):
-  # - id [string, default nil]: unique id returned when Boleto is created. ex: "5656565656565656"
+  # - id [string, default nil]: unique id returned when Balance is created. ex: '5656565656565656'
   # - amount [integer, default nil]: current balance amount of the workspace in cents. ex: 200 (= R$ 2.00)
-  # - currency [string, default nil]: currency of the current workspace. Expect others to be added eventually. ex: "BRL"
+  # - currency [string, default nil]: currency of the current workspace. Expect others to be added eventually. ex:'BRL'
   # - updated [DateTime, default nil]: update datetime for the balance. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class Balance < StarkBank::Utils::Resource
     attr_reader :amount, :currency, :updated

data/lib/boleto/boleto.rb

@@ -13,36 +13,40 @@ module StarkBank
   #
   # ## Parameters (required):
   # - amount [integer]: Boleto value in cents. Minimum = 200 (R$2,00). ex: 1234 (= R$ 12.34)
-  # - name [string]: payer full name. ex: "Anthony Edward Stark"
-  # - tax_id [string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
+  # - name [string]: payer full name. ex: 'Anthony Edward Stark'
+  # - tax_id [string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
   # - street_line_1 [string]: payer main address. ex: Av. Paulista, 200
   # - street_line_2 [string]: payer address complement. ex: Apto. 123
   # - district [string]: payer address district / neighbourhood. ex: Bela Vista
   # - city [string]: payer address city. ex: Rio de Janeiro
   # - state_code [string]: payer address state. ex: GO
   # - zip_code [string]: payer address zip code. ex: 01311-200
-  # - due [Date, default today + 2 days]: Boleto due date in ISO format. ex: 2020-04-30
   #
   # ## Parameters (optional):
+  # - due [Date, DateTime, Time or string, default today + 2 days]: Boleto due date in ISO format. ex: '2020-04-30'
   # - fine [float, default 0.0]: Boleto fine for overdue payment in %. ex: 2.5
   # - interest [float, default 0.0]: Boleto monthly interest for overdue payment in %. ex: 5.2
-  # - overdue_limit [integer, default 59]: limit in days for automatic Boleto cancellation after due date. ex: 7 (max: 59)
-  # - descriptions [list of dictionaries, default nil]: list of dictionaries with "text":string and (optional) "amount":int pairs
+  # - overdue_limit [integer, default 59]: limit in days for payment after due date. ex: 7 (max: 59)
+  # - receiver_name [string]: receiver (Sacador Avalista) full name. ex: 'Anthony Edward Stark'
+  # - receiver_tax_id [string]: receiver (Sacador Avalista) tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  # - descriptions [list of dictionaries, default nil]: list of dictionaries with 'text':string and (optional) 'amount':int pairs
+  # - discounts [list of dictionaries, default nil]: list of dictionaries with 'percentage':float and 'date':Date or string pairs
   # - tags [list of strings]: list of strings for tagging
   #
   # ## Attributes (return-only):
-  # - id [string, default nil]: unique id returned when Boleto is created. ex: "5656565656565656"
+  # - id [string, default nil]: unique id returned when Boleto is created. ex: '5656565656565656'
   # - fee [integer, default nil]: fee charged when Boleto is paid. ex: 200 (= R$ 2.00)
-  # - line [string, default nil]: generated Boleto line for payment. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062"
-  # - bar_code [string, default nil]: generated Boleto bar-code for payment. ex: "34195819600000000621090063571277307144464000"
-  # - status [string, default nil]: current Boleto status. ex: "registered" or "paid"
+  # - line [string, default nil]: generated Boleto line for payment. ex: '34191.09008 63571.277308 71444.640008 5 81960000000062'
+  # - bar_code [string, default nil]: generated Boleto bar-code for payment. ex: '34195819600000000621090063571277307144464000'
+  # - status [string, default nil]: current Boleto status. ex: 'registered' or 'paid'
   # - created [DateTime, default nil]: creation datetime for the Boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class Boleto < StarkBank::Utils::Resource
-    attr_reader :amount, :name, :tax_id, :street_line_1, :street_line_2, :district, :city, :state_code, :zip_code, :due, :fine, :interest, :overdue_limit, :tags, :descriptions, :id, :fee, :line, :bar_code, :status, :created
+    attr_reader :amount, :name, :tax_id, :street_line_1, :street_line_2, :district, :city, :state_code, :zip_code, :due, :fine, :interest, :overdue_limit, :receiver_name, :receiver_tax_id, :tags, :descriptions, :discounts, :id, :fee, :line, :bar_code, :status, :created
     def initialize(
       amount:, name:, tax_id:, street_line_1:, street_line_2:, district:, city:, state_code:, zip_code:,
-      due: nil, fine: nil, interest: nil, overdue_limit: nil, tags: nil, descriptions: nil, id: nil, fee: nil, line: nil,
-      bar_code: nil, status: nil, created: nil
+      due: nil, fine: nil, interest: nil, overdue_limit: nil, receiver_name: nil, receiver_tax_id: nil,
+      tags: nil, descriptions: nil, discounts: nil, id: nil, fee: nil, line: nil, bar_code: nil,
+      status: nil, created: nil
     )
       super(id)
       @amount = amount
@@ -58,8 +62,11 @@ module StarkBank
       @fine = fine
       @interest = interest
       @overdue_limit = overdue_limit
+      @receiver_name = receiver_name
+      @receiver_tax_id = receiver_tax_id
       @tags = tags
       @descriptions = descriptions
+      @discounts = discounts
       @fee = fee
       @line = line
       @bar_code = bar_code
@@ -79,7 +86,7 @@ module StarkBank
     #
     # ## Return:
     # - list of Boleto objects with updated attributes
-    def self.create(boletos:, user: nil)
+    def self.create(boletos, user: nil)
       StarkBank::Utils::Rest.post(entities: boletos, user: user, **resource)
     end
 
@@ -88,14 +95,14 @@ module StarkBank
     # Receive a single Boleto object previously created in the Stark Bank API by passing its id
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - 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:
     # - Boleto object with updated attributes
-    def self.get(id:, user: nil)
+    def self.get(id, user: nil)
       StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
@@ -104,15 +111,16 @@ module StarkBank
     # Receive a single Boleto pdf file generated in the Stark Bank API by passing its id.
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
+    # - layout [string]: Layout specification. Available options are "default" and "booklet"
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Boleto pdf file
-    def self.pdf(id:, user: nil)
-      StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
+    def self.pdf(id, layout: nil, user: nil)
+      StarkBank::Utils::Rest.get_pdf(id: id, layout: layout, user: user, **resource)
     end
 
     # # Retrieve Boletos
@@ -121,19 +129,28 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - 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"]
-    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, default nil] date filter for objects 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)
+    # - 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 [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - generator of Boleto objects with updated attributes
-    def self.query(limit: nil, status: nil, tags: nil, ids: nil, after: nil, before: nil, user: nil)
+    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_list(user: user, limit: limit, status: status, tags: tags, ids: ids, after: after, before: before, **resource)
+      StarkBank::Utils::Rest.get_list(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
     end
 
     # # Delete a Boleto entity
@@ -141,14 +158,14 @@ module StarkBank
     # Delete a Boleto entity previously created in the Stark Bank API
     #
     # ## Parameters (required):
-    # - id [string]: Boleto unique id. ex: "5656565656565656"
+    # - id [string]: Boleto unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted Boleto with updated attributes
-    def self.delete(id:, user: nil)
+    def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end
 
@@ -170,8 +187,11 @@ module StarkBank
             fine: json['fine'],
             interest: json['interest'],
             overdue_limit: json['overdue_limit'],
+            receiver_name: json['receiver_name'],
+            receiver_tax_id: json['receiver_tax_id'],
             tags: json['tags'],
             descriptions: json['descriptions'],
+            discounts: json['discounts'],
             id: json['id'],
             fee: json['fee'],
             line: json['line'],

data/lib/boleto/log.rb

@@ -15,11 +15,11 @@ module StarkBank
     # on the Boleto.
     #
     # ## Attributes:
-    # - id [string]: unique id returned when the log is created. ex: "5656565656565656"
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
     # - boleto [Boleto]: Boleto entity to which the log refers to.
     # - errors [list of strings]: list of errors linked to this Boleto event
-    # - type [string]: type of the Boleto event which triggered the log creation. ex: "registered" or "paid"
-    # - created [DateTime]: creation datetime for the boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    # - 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, :created, :type, :errors, :boleto
       def initialize(id:, created:, type:, errors:, boleto:)
@@ -35,14 +35,14 @@ module StarkBank
       # 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"
+      # - 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)
+      def self.get(id, user: nil)
         StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
@@ -52,18 +52,26 @@ module StarkBank
       #
       # ## Parameters (optional):
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - boleto_ids [list of strings, default nil]: list of Boleto ids to filter logs. ex: ["5656565656565656", "4545454545454545"]
-      # - types [list of strings, default nil]: filter for log event types. ex: "paid" or "registered"
-      # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date, default nil] date filter for objects 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 for log event types. ex: 'paid' or 'registered'
+      # - boleto_ids [list of strings, default nil]: list of Boleto 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, boleto_ids: nil, types: nil, after: nil, before: nil, user: nil)
+      def self.query(limit: nil, after: nil, before: nil, types: nil, boleto_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, boleto_ids: boleto_ids, types: types, after: after, before: before, **resource)
+        StarkBank::Utils::Rest.get_list(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          boleto_ids: boleto_ids,
+          user: user,
+          **resource
+        )
       end
 
       def self.resource

data/lib/{payment/boleto/boleto.rb → boleto_payment/boleto_payment.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../../utils/resource')
-require_relative('../../utils/rest')
-require_relative('../../utils/checks')
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
 
 module StarkBank
   # # BoletoPayment object
@@ -12,22 +12,22 @@ module StarkBank
   # 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: "34191.09008 63571.277308 71444.640008 5 81960000000062"
-  # - 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: "34195819600000000621090063571277307144464000"
+  # - 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: '34191.09008 63571.277308 71444.640008 5 81960000000062'
+  # - 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: '34195819600000000621090063571277307144464000'
   #
   # ## Parameters (required):
-  # - tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
-  # - description [string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC"
+  # - tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  # - description [string]: Text to be displayed in your statement (min. 10 characters). ex: 'payment ABC'
   #
   # ## Parameters (optional):
-  # - scheduled [Date, default today]: payment scheduled date. ex: Date.new(2020, 3, 10)
+  # - scheduled [Date, DateTime, Time or string, default today]: payment scheduled date. ex: Date.new(2020, 3, 10)
   # - tags [list of strings]: list of strings for tagging
   #
   # ## Attributes (return-only):
-  # - id [string, default nil]: unique id returned when payment is created. ex: "5656565656565656"
-  # - status [string, default nil]: current payment status. ex: "registered" or "paid"
+  # - id [string, default nil]: unique id returned when payment is created. ex: '5656565656565656'
+  # - 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 boleto payment is created. ex: 200 (= R$ 2.00)
+  # - fee [integer, default nil]: fee charged when the boleto payment is created. ex: 200 (= R$ 2.00)
   # - created [DateTime, default nil]: creation datetime for the payment. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class BoletoPayment < StarkBank::Utils::Resource
     attr_reader :tax_id, :description, :line, :bar_code, :scheduled, :tags, :id, :status, :amount, :fee, :created
@@ -57,7 +57,7 @@ module StarkBank
     #
     # ## Return:
     # - list of BoletoPayment objects with updated attributes
-    def self.create(payments:, user: nil)
+    def self.create(payments, user: nil)
       StarkBank::Utils::Rest.post(entities: payments, user: user, **resource)
     end
 
@@ -66,31 +66,31 @@ module StarkBank
     # Receive a single BoletoPayment object previously created by the Stark Bank API by passing its id
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - 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:
     # - BoletoPayment object with updated attributes
-    def self.get(id:, user: nil)
+    def self.get(id, user: nil)
       StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
     # # Retrieve a specific BoletoPayment pdf file
     #
     # Receive a single BoletoPayment pdf file generated in the Stark Bank API by passing its id.
-    # Only valid for boleto payments with "success" status.
+    # Only valid for boleto payments with 'success' status.
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - 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:
     # - BoletoPayment pdf file
-    def self.pdf(id:, user: nil)
+    def self.pdf(id, user: nil)
       StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
     end
 
@@ -100,18 +100,28 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - status [string, default nil]: filter for status of retrieved objects. ex: "paid"
-    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ["tony", "stark"]
-    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, default nil] date filter for objects 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']
+    # - ids [list of strings, default nil]: list of strings to get specific entities by ids. ex: ['12376517623', '1928367198236']
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid'
     # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - generator of BoletoPayment objects with updated attributes
-    def self.query(limit: nil, status: nil, tags: nil, ids: nil, after: nil, before: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, tags: nil, ids: nil, status: 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, status: status, tags: tags, ids: ids, after: after, before: before, **resource)
+      StarkBank::Utils::Rest.get_list(
+        user: user,
+        limit: limit,
+        after: after,
+        before: before,
+        tags: tags,
+        ids: ids,
+        status: status,
+        **resource
+      )
     end
 
     # # Delete a BoletoPayment entity
@@ -119,12 +129,12 @@ module StarkBank
     # Delete a BoletoPayment entity previously created in the Stark Bank API
     #
     # Parameters (required):
-    # - id [string]: BoletoPayment unique id. ex: "5656565656565656"
+    # - id [string]: BoletoPayment unique id. ex: '5656565656565656'
     # Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     # Return:
     # - deleted BoletoPayment with updated attributes
-    def self.delete(id:, user: nil)
+    def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end
 

data/lib/{payment/boleto → boleto_payment}/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../../utils/resource')
-require_relative('../../utils/rest')
-require_relative('../../utils/checks')
-require_relative('boleto')
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('boleto_payment')
 
 module StarkBank
   class BoletoPayment
@@ -15,11 +15,11 @@ module StarkBank
     # on the BoletoPayment.
     #
     # ## Attributes:
-    # - id [string]: unique id returned when the log is created. ex: "5656565656565656"
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
     # - payment [BoletoPayment]: BoletoPayment entity to which the log refers to.
     # - errors [list of strings]: list of errors linked to this BoletoPayment event.
-    # - type [string]: type of the BoletoPayment event which triggered the log creation. ex: "registered" or "paid"
-    # - created [DateTime]: creation datetime for the payment. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    # - type [string]: type of the BoletoPayment 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
       attr_reader :id, :created, :type, :errors, :payment
       def initialize(id:, created:, type:, errors:, payment:)
@@ -35,14 +35,14 @@ module StarkBank
       # 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"
+      # - 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)
+      def self.get(id, user: nil)
         StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
@@ -52,18 +52,26 @@ module StarkBank
       #
       # ## Parameters (optional):
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
-      # - payment_ids [list of strings, default nil]: list of BoletoPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
-      # - types [list of strings, default nil]: filter retrieved objects by event types. ex: "paid" or "registered"
+      # - 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 event types. ex: 'paid' or 'registered'
+      # - payment_ids [list of strings, default nil]: list of BoletoPayment 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:
       # - list of Log objects with updated attributes
-      def self.query(limit: nil, after: nil, before: nil, payment_ids: nil, types: nil, user: nil)
+      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_list(user: user, limit: limit, after: after, before: before, payment_ids: payment_ids, types: types, **resource)
+        StarkBank::Utils::Rest.get_list(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          payment_ids: payment_ids,
+          user: user,
+          **resource
+        )
       end
 
       def self.resource