starkbank 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aa5336a1427970ca71e3d9ca7a68f7aa3402be6936ee27a701d0a6fba183ce2
-  data.tar.gz: 8c7d657462bbcb6d86e5771d6eb0dd0be71bee6be53eae6fc4c55dbc2d7c1557
+  metadata.gz: a04698bff84f2740a1ea3febaf6289e293feb7430ea580711ac166108b1633a3
+  data.tar.gz: 7298985a8eab4f23744f3125ef8b2c891c20fb650606e04ed76f9f05bf0863de
 SHA512:
-  metadata.gz: 80882aa5140ad914f1be8a0f069b07ef50806b7e0517fee3cf61f8cac63dce37de0c7f1ecb84d34fea25c862a38505b43ccfe7699a1d9c92ae3af1ac23795c1a
-  data.tar.gz: 8a47d333f417739b7b7ea59aa8a575b3539042809d99b84a8127e91eb6f453722b91b9d122f464c85d33e0e2ffdafd1d1b8f8c1c7f83475ed42a2939572f9f8d
+  metadata.gz: 1135e671f73fd00669b2f8b615303196ddd9525b59837fd77ecd35c3639e305591e72dd5023a1538e32abc32bcb5ce3917ea00b662ceeaaaf2ac4e1cd4a21edb
+  data.tar.gz: a00a59fd6d06dbca0b7a23b23faf050357aeb75e408e8e33ad8d9f392bff3c1b31e443c92b8c767bb2294b6dab7d0f45c774cf6588ae38e0f5406e8c568a7e21

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
@@ -88,7 +95,7 @@ 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
@@ -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,8 +129,8 @@ 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)
+    # - 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']
@@ -150,7 +158,7 @@ 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
@@ -179,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,7 +35,7 @@ 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
@@ -52,8 +52,8 @@ 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)
+      # - 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

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
@@ -66,7 +66,7 @@ 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
@@ -80,10 +80,10 @@ module StarkBank
     # # 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
@@ -100,8 +100,8 @@ 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)
+    # - 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'
@@ -129,7 +129,7 @@ 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:

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,7 +35,7 @@ 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
@@ -52,8 +52,8 @@ 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)
+      # - 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

data/lib/{webhook → event}/event.rb

@@ -9,8 +9,8 @@ require_relative('../utils/cache')
 require_relative('../error')
 require_relative('../boleto/log')
 require_relative('../transfer/log')
-require_relative('../payment/boleto/log')
-require_relative('../payment/utility/log')
+require_relative('../boleto_payment/log')
+require_relative('../utility_payment/log')
 
 module StarkBank
   # # Webhook Event object
@@ -20,11 +20,11 @@ module StarkBank
   # list all generated updates on entities.
   #
   # ## Attributes:
-  # - id [string]: unique id returned when the log is created. ex: "5656565656565656"
+  # - id [string]: unique id returned when the event is created. ex: '5656565656565656'
   # - log [Log]: a Log object from one the subscription services (TransferLog, BoletoLog, BoletoPaymentlog or UtilityPaymentLog)
   # - created [DateTime]: creation datetime for the notification event. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - is_delivered [bool]: true if the event has been successfully delivered to the user url. ex: False
-  # - subscription [string]: service that triggered this event. ex: "transfer", "utility-payment"
+  # - subscription [string]: service that triggered this event. ex: 'transfer', 'utility-payment'
   class Event < StarkBank::Utils::Resource
     attr_reader :id, :log, :created, :is_delivered, :subscription
     def initialize(id:, log:, created:, is_delivered:, subscription:)
@@ -48,7 +48,7 @@ module StarkBank
     # Receive a single notification Event 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
@@ -65,8 +65,8 @@ 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)
+    # - 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)
     # - is_delivered [bool, default nil]: bool to filter successfully delivered events. ex: True or False
     # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
     #
@@ -90,7 +90,7 @@ module StarkBank
     # Delete a of notification Event entity previously created in the Stark Bank API by its ID
     #
     # ## Parameters (required):
-    # - id [string]: Event unique id. ex: "5656565656565656"
+    # - id [string]: Event unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
@@ -107,7 +107,7 @@ module StarkBank
     # If is_delivered is True, the event will no longer be returned on queries with is_delivered=False.
     #
     # ## Parameters (required):
-    # - id [list of strings]: Event unique ids. ex: "5656565656565656"
+    # - id [list of strings]: Event unique ids. ex: '5656565656565656'
     # - is_delivered [bool]: If True and event hasn't been delivered already, event will be set as delivered. ex: True
     #
     # ## Parameters (optional):
@@ -127,7 +127,7 @@ module StarkBank
     #
     # ## Parameters (required):
     # - content [string]: response content from request received at user endpoint (not parsed)
-    # - signature [string]: base-64 digital signature received at response header "Digital-Signature"
+    # - signature [string]: base-64 digital signature received at response header 'Digital-Signature'
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
@@ -164,7 +164,7 @@ module StarkBank
       end
 
       def get_public_key_pem(user)
-        StarkBank::Utils::Request.fetch(method: 'GET', path: 'public-key', query: {limit: 1}, user: user).json['publicKeys'][0]['content']
+        StarkBank::Utils::Request.fetch(method: 'GET', path: 'public-key', query: { limit: 1 }, user: user).json['publicKeys'][0]['content']
       end
 
       def resource

data/lib/key.rb

@@ -15,7 +15,7 @@ module StarkBank
     # ## Return:
     # - private and public key pems
     def self.create(path = nil)
-      private_key = PrivateKey.new
+      private_key = EllipticCurve::PrivateKey.new
       public_key = private_key.publicKey
 
       private_key_pem = private_key.toPem

data/lib/starkbank.rb

@@ -2,21 +2,22 @@
 
 require_relative('key')
 require_relative('user/project')
-require_relative('ledger/balance')
-require_relative('ledger/transaction')
+require_relative('balance/balance')
+require_relative('transaction/transaction')
 require_relative('boleto/boleto')
 require_relative('boleto/log')
 require_relative('transfer/transfer')
 require_relative('transfer/log')
-require_relative('payment/boleto/boleto')
-require_relative('payment/boleto/log')
-require_relative('payment/utility/utility')
-require_relative('payment/utility/log')
+require_relative('boleto_payment/boleto_payment')
+require_relative('boleto_payment/log')
+require_relative('utility_payment/utility_payment')
+require_relative('utility_payment/log')
 require_relative('webhook/webhook')
-require_relative('webhook/event')
+require_relative('event/event')
 
 # SDK to facilitate Ruby integrations with Stark Bank
 module StarkBank
   @user = nil
-  class << self; attr_accessor :user; end
+  @language = 'en-US'
+  class << self; attr_accessor :user, :language; end
 end

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

@@ -28,11 +28,12 @@ module StarkBank
   # - 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 transfer is created. ex: 200 (= R$ 2.00)
+  # - 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
     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, created: nil, source: nil)
+    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)
       @amount = amount
       @description = description
@@ -42,6 +43,7 @@ module StarkBank
       @tags = tags
       @fee = fee
       @source = source
+      @balance = balance
       @created = StarkBank::Utils::Checks.check_datetime(created)
     end
 
@@ -66,7 +68,7 @@ module StarkBank
     # Receive a single Transaction 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
@@ -83,8 +85,8 @@ 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 created only before specified date. ex: Date.new(2020, 3, 10)
+    # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
     # - external_ids [list of strings, default nil]: list of external 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
     #
@@ -109,8 +111,9 @@ module StarkBank
             tags: json['tags'],
             id: json['id'],
             fee: json['fee'],
-            created: json['created'],
-            source: json['source']
+            source: json['source'],
+            balance: json['balance'],
+            created: json['created']
           )
         }
       }

data/lib/transfer/log.rb

@@ -14,11 +14,11 @@ module StarkBank
     # user.
     #
     # ## 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'
     # - 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 transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    # - 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
       attr_reader :id, :created, :type, :errors, :transfer
       def initialize(id:, created:, type:, errors:, transfer:)
@@ -34,7 +34,7 @@ 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
@@ -51,8 +51,8 @@ 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)
+      # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
       # - types [list of strings, default nil]: filter retrieved objects by types. ex: 'success' or 'failed'
       # - transfer_ids [list of strings, default nil]: list of Transfer ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
       # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call

data/lib/transfer/transfer.rb

@@ -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]: receiver 1 to 3 digits of the bank institution in Brazil. ex: '200' or '341'
+  # - bank_code [string]: 1 to 3 digits of the receiver bank institution in Brazil. ex: '200' or '341'
   # - 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,7 +25,7 @@ module StarkBank
   # ## 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 boleto status. ex: 'registered' or 'paid'
+  # - 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)
@@ -68,7 +68,7 @@ module StarkBank
     # Receive a single Transfer 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
@@ -82,10 +82,10 @@ module StarkBank
     # # Retrieve a specific Transfer pdf file
     #
     # Receive a single Transfer pdf receipt file generated in the Stark Bank API by passing its id.
-    # Only valid for transfers with "processing" and "success" status.
+    # Only valid for transfers with 'processing' and '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
@@ -102,16 +102,17 @@ 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)
+    # - after [Date, DateTime, Time or string, default nil] date filter for objects created or updated only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil] date filter for objects created or updated only before specified date. ex: Date.new(2020, 3, 10)
     # - transactionIds [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-    # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
+    # - 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']
     # - 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, 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, user: nil)
       after = StarkBank::Utils::Checks.check_date(after)
       before = StarkBank::Utils::Checks.check_date(before)
       StarkBank::Utils::Rest.get_list(
@@ -120,6 +121,7 @@ module StarkBank
         before: before,
         transaction_ids: transaction_ids,
         status: status,
+        tax_id: tax_id,
         sort: sort,
         tags: tags,
         user: user,

data/lib/{payment/utility → utility_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('utility')
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('utility_payment')
 
 module StarkBank
   class UtilityPayment
@@ -14,11 +14,11 @@ module StarkBank
     # be retrieved to check additional information on the UtilityPayment.
     #
     # ## 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 [UtilityPayment]: UtilityPayment entity to which the log refers to.
-    # - errors [list of strings]: list of errors linked to this BoletoPayment event.
-    # - type [string]: type of the UtilityPayment 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)
+    # - errors [list of strings]: list of errors linked to this UtilityPayment event.
+    # - type [string]: type of the UtilityPayment 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:)
@@ -34,7 +34,7 @@ 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
@@ -51,8 +51,8 @@ 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)
+      # - 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 UtilityPayment 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

data/lib/{payment/utility/utility.rb → utility_payment/utility_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
   # # UtilityPayment object
@@ -12,19 +12,19 @@ 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):
-  # - description [string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC"
+  # - 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 utility 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)
@@ -64,7 +64,7 @@ module StarkBank
     # Receive a single UtilityPayment 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
@@ -78,10 +78,10 @@ module StarkBank
     # # Retrieve a specific UtilityPayment pdf file
     #
     # Receive a single UtilityPayment pdf file generated in the Stark Bank API by passing its id.
-    # Only valid for utility payments with "success" status.
+    # Only valid for utility 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
@@ -98,8 +98,8 @@ 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)
+    # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid'
@@ -127,7 +127,7 @@ module StarkBank
     # Delete a UtilityPayment entity previously created in the Stark Bank API
     #
     # ## Parameters (required):
-    # - id [string]: UtilityPayment unique id. ex: "5656565656565656"
+    # - id [string]: UtilityPayment unique id. ex:'5656565656565656'
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call

data/lib/utils/api.rb

@@ -6,9 +6,13 @@ module StarkBank
   module Utils
     module API
       def self.api_json(entity)
-        entity_hash = {}
-        entity.instance_variables.each do |key|
-          entity_hash[key[1..-1]] = entity.instance_variable_get(key)
+        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)
+          end
         end
         cast_json_to_api_format(entity_hash)
       end
@@ -19,6 +23,15 @@ module StarkBank
           next if value.nil?
 
           value = value.is_a?(Date) || value.is_a?(DateTime) || value.is_a?(Time) ? value.strftime('%Y-%m-%d') : value
+
+          if value.is_a?(Array)
+            list = []
+            value.each do |v|
+              list << (v.is_a?(Hash) ? cast_json_to_api_format(v) : v)
+            end
+            value = list
+          end
+
           entity_hash[StarkBank::Utils::Case.snake_to_camel(key)] = value
         end
         entity_hash

data/lib/utils/checks.rb

@@ -17,6 +17,14 @@ module StarkBank
         user
       end
 
+      def self.check_language
+        language = StarkBank.language
+        accepted_languages = %w[en-US pt-BR]
+        raise(ArgumentError, "Select a valid language: #{accepted_languages.join(', ')}") unless accepted_languages.include?(language)
+
+        language
+      end
+
       def self.check_environment(environment)
         environments = StarkBank::Utils::Environment.constants(false).map { |c| StarkBank::Utils::Environment.const_get(c) }
         raise(ArgumentError, "Select a valid environment: #{environments.join(', ')}") unless environments.include?(environment)

data/lib/utils/request.rb

@@ -24,6 +24,7 @@ module StarkBank
 
       def self.fetch(method:, path:, payload: nil, query: nil, user: nil)
         user = Checks.check_user(user)
+        language = Checks.check_language
 
         base_url = {
           Environment::PRODUCTION => 'https://api.starkbank.com/',
@@ -60,7 +61,8 @@ module StarkBank
         req['Access-Time'] = access_time
         req['Access-Signature'] = signature
         req['Content-Type'] = 'application/json'
-        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-0.1.0"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-0.4.1"
+        req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }
 

data/lib/utils/rest.rb

@@ -47,10 +47,11 @@ module StarkBank
         StarkBank::Utils::API.from_api_json(resource_maker, entity)
       end
 
-      def self.get_pdf(resource_name:, resource_maker:, id:, user: nil)
+      def self.get_pdf(resource_name:, resource_maker:, id:, user: nil, **query)
         StarkBank::Utils::Request.fetch(
           method: 'GET',
           path: "#{StarkBank::Utils::API.endpoint(resource_name)}/#{id}/pdf",
+          query: StarkBank::Utils::API.cast_json_to_api_format(query),
           user: user
         ).content
       end

data/lib/webhook/webhook.rb

@@ -16,7 +16,7 @@ module StarkBank
   # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ['transfer', 'boleto-payment']
   #
   # ## Attributes:
-  # - id [string, default nil]: unique id returned when the log is created. ex: '5656565656565656'
+  # - id [string, default nil]: unique id returned when the webhook is created. ex: '5656565656565656'
   class Webhook < StarkBank::Utils::Resource
     attr_reader :url, :subscriptions, :id
     def initialize(url:, subscriptions:, id: nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - starkbank
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,21 +44,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/balance/balance.rb
 - lib/boleto/boleto.rb
 - lib/boleto/log.rb
+- lib/boleto_payment/boleto_payment.rb
+- lib/boleto_payment/log.rb
 - lib/error.rb
+- lib/event/event.rb
 - lib/key.rb
-- lib/ledger/balance.rb
-- lib/ledger/transaction.rb
-- lib/payment/boleto/boleto.rb
-- lib/payment/boleto/log.rb
-- lib/payment/utility/log.rb
-- lib/payment/utility/utility.rb
 - lib/starkbank.rb
+- lib/transaction/transaction.rb
 - lib/transfer/log.rb
 - lib/transfer/transfer.rb
 - lib/user/project.rb
 - lib/user/user.rb
+- lib/utility_payment/log.rb
+- lib/utility_payment/utility_payment.rb
 - lib/utils/api.rb
 - lib/utils/cache.rb
 - lib/utils/case.rb
@@ -68,7 +69,6 @@ files:
 - lib/utils/resource.rb
 - lib/utils/rest.rb
 - lib/utils/url.rb
-- lib/webhook/event.rb
 - lib/webhook/webhook.rb
 homepage: https://github.com/starkbank/sdk-ruby
 licenses: