starkbank 2.5.0 → 2.7.0

data/lib/error.rb

@@ -1,52 +1,19 @@
 # frozen_string_literal: true
 
-require('json')
+require('starkcore')
 
 module StarkBank
   module Error
-    class StarkBankError < StandardError
-      attr_reader :message
-      def initialize(message)
-        @message = message
-        super(message)
-      end
-    end
+    StarkBankError = StarkCore::Error::StarkCoreError
 
-    class Error < StarkBankError
-      attr_reader :code, :message
-      def initialize(code, message)
-        @code = code
-        @message = message
-        super("#{code}: #{message}")
-      end
-    end
+    Error = StarkCore::Error::Error
 
-    class InputErrors < StarkBankError
-      attr_reader :errors
-      def initialize(content)
-        errors = []
-        content.each do |error|
-          errors << Error.new(error['code'], error['message'])
-        end
-        @errors = errors
+    InputErrors = StarkCore::Error::InputErrors
 
-        super(content.to_json)
-      end
-    end
+    InternalServerError = StarkCore::Error::InternalServerError
 
-    class InternalServerError < StarkBankError
-      def initialize(message = 'Houston, we have a problem.')
-        super(message)
-      end
-    end
+    UnknownError = StarkCore::Error::UnknownError
 
-    class UnknownError < StarkBankError
-      def initialize(message)
-        super("Unknown exception encountered: #{message}")
-      end
-    end
-
-    class InvalidSignatureError < StarkBankError
-    end
+    InvalidSignatureError = StarkCore::Error::InvalidSignatureError
   end
 end

data/lib/event/attempt.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require('starkcore')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
 require_relative('event')
 
+
 module StarkBank
   class Event
     # # Event::Attempt object
@@ -12,14 +12,14 @@ module StarkBank
     # When an Event delivery fails, an event attempt will be registered.
     # It carries information meant to help you debug event reception issues.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - id [string]: unique id that identifies the delivery attempt. ex: "5656565656565656"
     # - code [string]: delivery error code. ex: badHttpStatus, badConnection, timeout
     # - message [string]: delivery error full description. ex: "HTTP POST request returned status 404"
     # - event_id [string]: ID of the Event whose delivery failed. ex: "4848484848484848"
     # - webhook_id [string]: ID of the Webhook that triggered this event. ex: "5656565656565656"
     # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-    class Attempt < StarkBank::Utils::Resource
+    class Attempt < StarkCore::Utils::Resource
       attr_reader :id, :code, :message, :event_id, :webhook_id, :created
       def initialize(id:, code:, message:, event_id:, webhook_id:, created:)
         super(id)
@@ -27,7 +27,7 @@ module StarkBank
         @message = message
         @event_id = event_id
         @webhook_id = webhook_id
-        @created = StarkBank::Utils::Checks.check_datetime(created)
+        @created = StarkCore::Utils::Checks.check_datetime(created)
       end
 
       # # Retrieve a specific Event::Attempt
@@ -61,8 +61,8 @@ module StarkBank
       # ## Return:
       # - generator of Event::Attempt objects with updated attributes
       def self.query(limit: nil, after: nil, before: nil, event_ids: nil, webhook_ids: nil, user: nil)
-        after = StarkBank::Utils::Checks.check_date(after)
-        before = StarkBank::Utils::Checks.check_date(before)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
         StarkBank::Utils::Rest.get_stream(
           limit: limit,
           after: after,
@@ -91,8 +91,8 @@ module StarkBank
       # ## Return:
       # - list of Attempt objects with updated attributes and cursor to retrieve the next page of Attempt objects
       def self.page(cursor: nil, limit: nil, after: nil, before: nil, event_ids: nil, webhook_ids: nil, user: nil)
-        after = StarkBank::Utils::Checks.check_date(after)
-        before = StarkBank::Utils::Checks.check_date(before)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
         return StarkBank::Utils::Rest.get_page(
           cursor: cursor,
           limit: limit,

data/lib/event/event.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
 require('json')
-require('starkbank-ecdsa')
-require_relative('../utils/resource')
+require('starkcore')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
-require_relative('../utils/cache')
+require_relative('../utils/parse')
 require_relative('../error')
 require_relative('../boleto/log')
 require_relative('../boleto_holmes/log')
@@ -25,18 +23,18 @@ module StarkBank
   # Events cannot be created, but may be retrieved from the Stark Bank API to
   # list all generated updates on entities.
   #
-  # ## Attributes:
+  # ## Attributes (return-only):
   # - id [string]: unique id returned when the event is created. ex: '5656565656565656'
   # - log [Log]: a Log object from one the subscription services (TransferLog, InvoiceLog, 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
   # - workspace_id [string]: ID of the Workspace that generated this event. Mostly used when multiple Workspaces have Webhooks registered to the same endpoint. ex: '4545454545454545'
   # - subscription [string]: service that triggered this event. ex: 'transfer', 'utility-payment'
-  class Event < StarkBank::Utils::Resource
+  class Event < StarkCore::Utils::Resource
     attr_reader :id, :log, :created, :is_delivered, :workspace_id, :subscription
     def initialize(id:, log:, created:, is_delivered:, workspace_id:, subscription:)
       super(id)
-      @created = StarkBank::Utils::Checks.check_datetime(created)
+      @created = StarkCore::Utils::Checks.check_datetime(created)
       @is_delivered = is_delivered
       @workspace_id = workspace_id
       @subscription = subscription
@@ -55,7 +53,7 @@ module StarkBank
       }[subscription.to_sym]
 
       @log = log
-      @log = StarkBank::Utils::API.from_api_json(resource[:resource_maker], log) unless resource.nil?
+      @log = StarkCore::Utils::API.from_api_json(resource[:resource_maker], log) unless resource.nil?
     end
 
     # # Retrieve a specific notification Event
@@ -88,8 +86,8 @@ module StarkBank
     # ## Return:
     # - generator of Event objects with updated attributes
     def self.query(limit: nil, after: nil, before: nil, is_delivered: nil, user: nil)
-      after = StarkBank::Utils::Checks.check_date(after)
-      before = StarkBank::Utils::Checks.check_date(before)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
       StarkBank::Utils::Rest.get_stream(
         user: user,
         limit: limit,
@@ -116,8 +114,8 @@ module StarkBank
     # ## Return:
     # - list of Event objects with updated attributes and cursor to retrieve the next page of Event objects
     def self.page(cursor: nil, limit: nil, after: nil, before: nil, is_delivered: nil, user: nil)
-      after = StarkBank::Utils::Checks.check_date(after)
-      before = StarkBank::Utils::Checks.check_date(before)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
       return StarkBank::Utils::Rest.get_page(
         cursor: cursor,
         limit: limit,
@@ -179,53 +177,29 @@ module StarkBank
     # ## Return:
     # - Parsed Event object
     def self.parse(content:, signature:, user: nil)
-      event = StarkBank::Utils::API.from_api_json(resource[:resource_maker], JSON.parse(content)['event'])
-
-      begin
-        signature = EllipticCurve::Signature.fromBase64(signature)
-      rescue
-        raise(StarkBank::Error::InvalidSignatureError, 'The provided signature is not valid')
-      end
-
-      return event if verify_signature(content: content, signature: signature, user: user)
-
-      return event if verify_signature(content: content, signature: signature, user: user, refresh: true)
-
-      raise(StarkBank::Error::InvalidSignatureError, 'The provided signature and content do not match the Stark Bank public key')
+      StarkBank::Utils::Parse.parse_and_verify(
+        content: content,
+        signature: signature,
+        user: user,
+        resource: resource,
+        key: 'event'
+      )
     end
 
-    class << self
-      private
-
-      def verify_signature(content:, signature:, user:, refresh: false)
-        public_key = StarkBank::Utils::Cache.starkbank_public_key
-        if public_key.nil? || refresh
-          pem = get_public_key_pem(user)
-          public_key = EllipticCurve::PublicKey.fromPem(pem)
-          StarkBank::Utils::Cache.starkbank_public_key = public_key
-        end
-        EllipticCurve::Ecdsa.verify(content, signature, public_key)
-      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']
-      end
-
-      def resource
-        {
-          resource_name: 'Event',
-          resource_maker: proc { |json|
-            Event.new(
-              id: json['id'],
-              log: json['log'],
-              created: json['created'],
-              is_delivered: json['is_delivered'],
-              workspace_id: json['workspace_id'],
-              subscription: json['subscription']
-            )
-          }
+    def self.resource
+      {
+        resource_name: 'Event',
+        resource_maker: proc { |json|
+          Event.new(
+            id: json['id'],
+            log: json['log'],
+            created: json['created'],
+            is_delivered: json['is_delivered'],
+            workspace_id: json['workspace_id'],
+            subscription: json['subscription']
+          )
         }
-      end
+      }
     end
   end
 end

data/lib/institution/institution.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require_relative('../utils/sub_resource')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
+
 
 module StarkBank
   # # Institution object
@@ -17,7 +16,7 @@ module StarkBank
   # - name [string]: full version of the institution name. ex: 'Stark Bank S.A.'
   # - spi_code [string]: SPI code used to identify the institution on Pix transactions. ex: '20018183'
   # - str_code [string]: STR code used to identify the institution on TED transactions. ex: '123'
-  class Institution < StarkBank::Utils::SubResource
+  class Institution < StarkCore::Utils::SubResource
     attr_reader :display_name, :name, :spi_code, :str_code
     def initialize(display_name: nil, name: nil, spi_code: nil, str_code: nil)
       @display_name = display_name

data/lib/invoice/invoice.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require('starkcore')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
+
 
 module StarkBank
   # # Invoice object
@@ -10,6 +10,8 @@ module StarkBank
   # When you initialize an Invoice, the entity will not be automatically
   # sent to the Stark Bank API. The 'create' function sends the objects
   # to the Stark Bank API and returns the list of created objects.
+  # To create scheduled Invoices, which will display the discount, interest, etc. on the final users banking interface,
+  # use dates instead of datetimes on the "due" and "discounts" fields.
   #
   # ## Parameters (required):
   # - amount [integer]: Invoice value in cents. Minimum = 0 (any value will be accepted). ex: 1234 (= R$ 12.34)
@@ -26,19 +28,20 @@ module StarkBank
   # - tags [list of strings, default nil]: list of strings for tagging
   #
   # ## Attributes (return-only):
-  # - pdf [string, default nil]: public Invoice PDF URL. ex: 'https://invoice.starkbank.com/pdf/d454fa4e524441c1b0c1a729457ed9d8'
-  # - link [string, default nil]: public Invoice webpage URL. ex: 'https://my-workspace.sandbox.starkbank.com/invoicelink/d454fa4e524441c1b0c1a729457ed9d8'
-  # - id [string, default nil]: unique id returned when Invoice is created. ex: '5656565656565656'
-  # - nominal_amount [integer, default nil]: Invoice emission value in cents (will change if invoice is updated, but not if it's paid). ex: 400000
-  # - fine_amount [integer, default nil]: Invoice fine value calculated over nominal_amount. ex: 20000
-  # - interest_amount [integer, default nil]: Invoice interest value calculated over nominal_amount. ex: 10000
-  # - discount_amount [integer, default nil]: Invoice discount value calculated over nominal_amount. ex: 3000
-  # - brcode [string, default nil]: BR Code for the Invoice payment. ex: '00020101021226800014br.gov.bcb.pix2558invoice.starkbank.com/f5333103-3279-4db2-8389-5efe335ba93d5204000053039865802BR5913Arya Stark6009Sao Paulo6220051656565656565656566304A9A0'
-  # - fee [integer, default nil]: fee charged by the Invoice. ex: 65 (= R$ 0.65)
-  # - status [string, default nil]: current Invoice status. ex: 'registered' or 'paid'
-  # - created [DateTime, default nil]: creation datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - updated [DateTime, default nil]: latest update datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  class Invoice < StarkBank::Utils::Resource
+  # - pdf [string]: public Invoice PDF URL. ex: 'https://invoice.starkbank.com/pdf/d454fa4e524441c1b0c1a729457ed9d8'
+  # - link [string]: public Invoice webpage URL. ex: 'https://my-workspace.sandbox.starkbank.com/invoicelink/d454fa4e524441c1b0c1a729457ed9d8'
+  # - id [string]: unique id returned when Invoice is created. ex: '5656565656565656'
+  # - nominal_amount [integer]: Invoice emission value in cents (will change if invoice is updated, but not if it's paid). ex: 400000
+  # - fine_amount [integer]: Invoice fine value calculated over nominal_amount. ex: 20000
+  # - interest_amount [integer]: Invoice interest value calculated over nominal_amount. ex: 10000
+  # - discount_amount [integer]: Invoice discount value calculated over nominal_amount. ex: 3000
+  # - brcode [string]: BR Code for the Invoice payment. ex: '00020101021226800014br.gov.bcb.pix2558invoice.starkbank.com/f5333103-3279-4db2-8389-5efe335ba93d5204000053039865802BR5913Arya Stark6009Sao Paulo6220051656565656565656566304A9A0'
+  # - fee [integer]: fee charged by the Invoice. ex: 65 (= R$ 0.65)
+  # - transaction_ids [list of strings]: ledger transaction ids linked to this Invoice (if there are more than one, all but the first are reversals or failed reversal chargebacks). ex: ["19827356981273"]
+  # - status [string]: current Invoice status. ex: 'registered' or 'paid'
+  # - created [DateTime]: creation datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class Invoice < StarkCore::Utils::Resource
     attr_reader :amount, :tax_id, :name, :due, :expiration, :fine, :interest, :discounts, :tags, :pdf, :link, :descriptions, :nominal_amount, :fine_amount, :interest_amount, :discount_amount, :id, :brcode, :fee, :status, :transaction_ids, :created, :updated
     def initialize(
       amount:, tax_id:, name:, due: nil, expiration: nil, fine: nil, interest: nil, discounts: nil,
@@ -47,13 +50,12 @@ module StarkBank
     )
       super(id)
       @amount = amount
-      @due = StarkBank::Utils::Checks.check_datetime(due)
+      @due = StarkCore::Utils::Checks.check_date_or_datetime(due)
       @tax_id = tax_id
       @name = name
       @expiration = expiration
       @fine = fine
       @interest = interest
-      @discounts = discounts
       @tags = tags
       @pdf = pdf
       @link = link
@@ -66,8 +68,16 @@ module StarkBank
       @fee = fee
       @status = status
       @transaction_ids = transaction_ids
-      @updated = StarkBank::Utils::Checks.check_datetime(updated)
-      @created = StarkBank::Utils::Checks.check_datetime(created)
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+      if !discounts.nil?
+        checked_discounts = []
+        discounts.each do |discount|
+          discount["due"] = StarkCore::Utils::Checks.check_date_or_datetime(discount["due"])
+          checked_discounts.push(discount)
+        end
+        @discounts = checked_discounts
+      end
     end
 
     # # Create Invoices
@@ -150,8 +160,8 @@ module StarkBank
     # ## Return:
     # - generator of Invoice objects with updated attributes
     def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil)
-      after = StarkBank::Utils::Checks.check_date(after)
-      before = StarkBank::Utils::Checks.check_date(before)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
       StarkBank::Utils::Rest.get_stream(
         limit: limit,
         after: after,
@@ -182,8 +192,8 @@ module StarkBank
     # ## Return:
     # - list of Invoice objects with updated attributes and cursor to retrieve the next page of Invoice objects
     def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil)
-      after = StarkBank::Utils::Checks.check_date(after)
-      before = StarkBank::Utils::Checks.check_date(before)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
       return StarkBank::Utils::Rest.get_page(
         cursor: cursor,
         limit: limit,

data/lib/invoice/log.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require('starkcore')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
 require_relative('invoice')
 
+
 module StarkBank
   class Invoice
     # # Invoice::Log object
@@ -14,20 +14,20 @@ module StarkBank
     # user, but it can be retrieved to check additional information
     # on the Invoice.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
     # - invoice [Invoice]: Invoice entity to which the log refers to.
     # - errors [list of strings]: list of errors linked to this Invoice event
     # - type [string]: type of the Invoice event which triggered the log creation. ex: 'canceled' or 'paid'
     # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-    class Log < StarkBank::Utils::Resource
+    class Log < StarkCore::Utils::Resource
       attr_reader :id, :created, :type, :errors, :invoice
       def initialize(id:, created:, type:, errors:, invoice:)
         super(id)
         @type = type
         @errors = errors
         @invoice = invoice
-        @created = StarkBank::Utils::Checks.check_datetime(created)
+        @created = StarkCore::Utils::Checks.check_datetime(created)
       end
 
       # # Retrieve a specific Log
@@ -61,8 +61,8 @@ module StarkBank
       # ## Return:
       # - list of Log objects with updated attributes
       def self.query(limit: nil, after: nil, before: nil, types: nil, invoice_ids: nil, user: nil)
-        after = StarkBank::Utils::Checks.check_date(after)
-        before = StarkBank::Utils::Checks.check_date(before)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
         StarkBank::Utils::Rest.get_stream(
           limit: limit,
           after: after,
@@ -91,8 +91,8 @@ module StarkBank
       # ## Return:
       # - list of Log objects with updated attributes and cursor to retrieve the next page of Log objects
       def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, invoice_ids: nil, user: nil)
-        after = StarkBank::Utils::Checks.check_date(after)
-        before = StarkBank::Utils::Checks.check_date(before)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
         return StarkBank::Utils::Rest.get_page(
           cursor: cursor,
           limit: limit,
@@ -131,7 +131,7 @@ module StarkBank
               created: json['created'],
               type: json['type'],
               errors: json['errors'],
-              invoice: StarkBank::Utils::API.from_api_json(invoice_maker, json['invoice'])
+              invoice: StarkCore::Utils::API.from_api_json(invoice_maker, json['invoice'])
             )
           }
         }

data/lib/invoice/payment.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative('../utils/sub_resource')
 require_relative('invoice')
 
 module StarkBank
@@ -20,7 +19,7 @@ module StarkBank
         # - account_type [string]: payer bank account type. ex: 'checking', 'savings', 'salary' or 'payment'
         # - end_to_end_id [string]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
         # - method [string]: payment method that was used. ex: 'pix'
-        class Payment < StarkBank::Utils::SubResource
+        class Payment < StarkCore::Utils::SubResource
             attr_reader :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :amount, :end_to_end_id, :method
             def initialize(name:, tax_id:, bank_code:, branch_code:, account_number:, account_type:, amount:, end_to_end_id:, method:)
                 @name = name

data/lib/payment_preview/boleto_preview.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+
+
+module StarkBank
+  class PaymentPreview
+    # # BoletoPreview object
+    #
+    # A BoletoPreview is used to get information from a Boleto payment you received before confirming the payment.
+    #
+    # ## Attributes (return-only):
+    # - status [string]: current boleto status. ex: 'active', 'expired' or 'inactive'
+    # - amount [int]: final amount to be paid. ex: 23456 (= R$ 234.56)
+    # - discount_amount [int]: discount amount to be paid. ex: 23456 (= R$ 234.56)
+    # - fine_amount [int]: fine amount to be paid. ex: 23456 (= R$ 234.56)
+    # - interest_amount [int]: interest amount to be paid. ex: 23456 (= R$ 234.56)
+    # - due [DateTime or string]: Boleto due date. ex: '2020-04-30'
+    # - expiration [DateTime or string]: Boleto expiration date. ex: '2020-04-30'
+    # - name [string]: beneficiary full name. ex: 'Anthony Edward Stark'
+    # - tax_id [string]: beneficiary tax ID (CPF or CNPJ). ex: '20.018.183/0001-80'
+    # - receiver_name [string]: receiver (Sacador Avalista) full name. ex: 'Anthony Edward Stark'
+    # - receiver_tax_id [string]: receiver (Sacador Avalista) tax ID (CPF or CNPJ). ex: '20.018.183/0001-80'
+    # - payer_name [string]: payer full name. ex: 'Anthony Edward Stark'
+    # - payer_tax_id [string]: payer tax ID (CPF or CNPJ). ex: '20.018.183/0001-80'
+    # - line [string]: Number sequence that identifies the payment. ex: '34191.09008 63571.277308 71444.640008 5 81960000000062'
+    # - bar_code [string]: Bar code number that identifies the payment. ex: '34195819600000000621090063571277307144464000'
+    class BoletoPreview < StarkCore::Utils::SubResource
+      attr_reader :status, :amount, :discount_amount, :fine_amount, :interest_amount, :due, :expiration, :name, :tax_id, :receiver_name, :receiver_tax_id, :payer_name, :payer_tax_id, :line, :bar_code
+      def initialize(status:, amount:, discount_amount:, fine_amount:, interest_amount:, due:, expiration:, name:, tax_id:, receiver_name:, receiver_tax_id:, payer_name:, payer_tax_id:, line:, bar_code:)
+        @status = status
+        @amount = amount
+        @discount_amount = discount_amount
+        @fine_amount = fine_amount
+        @interest_amount = interest_amount
+        @due = StarkCore::Utils::Checks.check_datetime(due)
+        @expiration = StarkCore::Utils::Checks.check_datetime(expiration)
+        @name = name
+        @tax_id = tax_id
+        @receiver_name = receiver_name
+        @receiver_tax_id = receiver_tax_id
+        @payer_name = payer_name
+        @payer_tax_id = payer_tax_id
+        @line = line
+        @bar_code = bar_code
+      end
+
+      def self.resource
+        {
+          resource_name: 'BoletoPreview',
+          resource_maker: proc { |json|
+            BoletoPreview.new(
+              status: json['status'],
+              amount: json['amount'],
+              discount_amount: json['discount_amount'],
+              fine_amount: json['fine_amount'],
+              interest_amount: json['interest_amount'],
+              due: json['due'],
+              expiration: json['expiration'],
+              name: json['name'],
+              tax_id: json['tax_id'],
+              receiver_name: json['receiver_name'],
+              receiver_tax_id: json['receiver_tax_id'],
+              payer_name: json['payer_name'],
+              payer_tax_id: json['payer_tax_id'],
+              line: json['line'],
+              bar_code: json['bar_code'],
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/payment_preview/brcode_preview.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+
+
+module StarkBank
+  class PaymentPreview
+    # # BrcodePreview object
+    #
+    # A BrcodePreview is used to get information from a BR Code you received before confirming the payment.
+    #
+    # ## Attributes (return-only):
+    # - status [string]: Payment status. ex: 'active', 'paid', 'canceled' or 'unknown'
+    # - name [string]: Payment receiver name. ex: 'Tony Stark'
+    # - tax_id [string]: Payment receiver tax ID. ex: '012.345.678-90'
+    # - bank_code [string]: Payment receiver bank code. ex: '20018183'
+    # - branch_code [string]: Payment receiver branch code. ex: '0001'
+    # - account_number [string]: Payment receiver account number. ex: '1234567'
+    # - account_type [string]: Payment receiver account type. ex: 'checking'
+    # - allow_change [bool]: If True, the payment is able to receive amounts that are different from the nominal one. ex: True or False
+    # - amount [integer]: Value in cents that this payment is expecting to receive. If 0, any value is accepted. ex: 123 (= R$1,23)
+    # - nominal_amount [integer]: Original value in cents that this payment was expecting to receive without the discounts, fines, etc.. If 0, any value is accepted. ex: 123 (= R$1,23)
+    # - interest_amount [integer]: Current interest value in cents that this payment is charging. If 0, any value is accepted. ex: 123 (= R$1,23)
+    # - fine_amount [integer]: Current fine value in cents that this payment is charging. ex: 123 (= R$1,23)
+    # - reduction_amount [integer]: Current value reduction value in cents that this payment is expecting. ex: 123 (= R$1,23)
+    # - discount_amount [integer]: Current discount value in cents that this payment is expecting. ex: 123 (= R$1,23)
+    # - reconciliation_id [string]: Reconciliation ID linked to this payment. ex: 'txId', 'payment-123'
+    class BrcodePreview < StarkCore::Utils::SubResource
+      attr_reader :status, :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :allow_change, :amount, :nominal_amount, :interest_amount, :fine_amount, :reduction_amount, :discount_amount, :reconciliation_id
+      def initialize(status:, name:, tax_id:, bank_code:, branch_code:, account_number:, account_type:, allow_change:, amount:, nominal_amount:, interest_amount:, fine_amount:, reduction_amount:, discount_amount:, reconciliation_id:)
+        @status = status
+        @name = name
+        @tax_id = tax_id
+        @bank_code = bank_code
+        @branch_code = branch_code
+        @account_number = account_number
+        @account_type = account_type
+        @allow_change = allow_change
+        @amount = amount
+        @nominal_amount = nominal_amount
+        @interest_amount = interest_amount
+        @fine_amount = fine_amount
+        @reduction_amount = reduction_amount
+        @discount_amount = discount_amount
+        @reconciliation_id = reconciliation_id
+      end
+
+      def self.resource
+        {
+          resource_name: 'BrcodePreview',
+          resource_maker: proc { |json|
+            BrcodePreview.new(
+              status: json['status'],
+              name: json['name'],
+              tax_id: json['tax_id'],
+              bank_code: json['bank_code'],
+              branch_code: json['branch_code'],
+              account_number: json['account_number'],
+              account_type: json['account_type'],
+              allow_change: json['allow_change'],
+              amount: json['amount'],
+              nominal_amount: json['nominal_amount'],
+              interest_amount: json['interest_amount'],
+              fine_amount: json['fine_amount'],
+              reduction_amount: json['reduction_amount'],
+              discount_amount: json['discount_amount'],
+              reconciliation_id: json['reconciliation_id']
+            )
+          }
+        }
+      end
+    end
+  end
+end