starkinfra 0.6.0 → 0.7.0

data/lib/ledger/log.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+require_relative('ledger')
+
+module StarkInfra
+  class Ledger
+    # # Ledger::Log object
+    #
+    # Every time a Ledger entity is updated, a corresponding Ledger::Log
+    # is generated for the entity. This log is never generated by the
+    # user, but it can be retrieved to check additional information
+    # on the Ledger.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    # - type [string]: type of the Ledger event which triggered the log creation. ex: 'created', 'updated'
+    # - ledger [Ledger]: Ledger entity to which the log refers to.
+    class Log < StarkCore::Utils::Resource
+      attr_reader :id, :created, :type, :ledger
+      def initialize(id:, created:, type:, ledger:)
+        super(id)
+        @type = type
+        @ledger = ledger
+        @created = StarkCore::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific Ledger::Log
+      #
+      # Receive a single Ledger::Log object previously created by the Stark Infra API by its id
+      #
+      # ## Parameters (required):
+      # - id [string]: object unique id. ex: '5656565656565656'
+      #
+      # ## Parameters (optional):
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - Ledger::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve Ledger::Logs
+      #
+      # Receive a generator of Ledger::Log objects previously created in the Stark Infra API
+      #
+      # ## Parameters (optional):
+      # - ids [list of strings, default nil]: list of LedgerLog ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - ledger_id [string, default nil]: filter logs by Ledger id. ex: '5656565656565656'
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - generator of Ledger::Log objects with updated attributes
+      def self.query(ids: nil, limit: nil, after: nil, before: nil, ledger_id: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          ledger_id: ledger_id,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged Ledger::Logs
+      #
+      # Receive a list of up to 100 Ledger::Log objects previously created in the Stark Infra API and the cursor to the next page.
+      # Use this function instead of query if you want to manually page your requests.
+      #
+      # ## Parameters (optional):
+      # - ids [list of strings, default nil]: list of LedgerLog ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
+      # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - ledger_id [string, default nil]: filter logs by Ledger id. ex: '5656565656565656'
+      # - cursor [string, default nil]: cursor returned on the previous page function call
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - list of Ledger::Log objects with updated attributes
+      # - cursor to retrieve the next page of Ledger::Log objects
+      def self.page(ids: nil, limit: nil, after: nil, before: nil, ledger_id: nil, cursor: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_page(
+          cursor: cursor,
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          ledger_id: ledger_id,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        request_maker = StarkInfra::Ledger.resource[:resource_maker]
+        {
+          resource_name: 'LedgerLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              ledger: StarkCore::Utils::API.from_api_json(request_maker, json['ledger'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/ledger/rule.rb

@@ -0,0 +1,55 @@
+require_relative('../utils/rest')
+
+module StarkInfra
+  class Ledger
+    # # Ledger::Rule object
+    #
+    # The Ledger::Rule object modifies the behavior of Ledger objects when passed as an argument upon their creation or update.
+    #
+    # ## Parameters (required):
+    # - key [string]: Rule to be customized, describes what Ledger behavior will be altered. ex: 'minimumBalance', 'maximumBalance'
+    # - value [integer]: Value of the rule. ex: 1000
+    class Rule < StarkCore::Utils::SubResource
+      attr_reader :key, :value
+      def initialize(key:, value:)
+        @key = key
+        @value = value
+      end
+
+      # # Parse Ledger::Rules
+      #
+      # Converts a list of hashes (or Rule objects) received from the API into a list of Ledger::Rule objects.
+      #
+      # ## Parameters (required):
+      # - rules [list of hashes or Ledger::Rule objects]: list to be parsed.
+      #
+      # ## Return:
+      # - list of parsed Ledger::Rule objects
+      def self.parse_rules(rules)
+        resource_maker = StarkInfra::Ledger::Rule.resource[:resource_maker]
+        return rules if rules.nil?
+
+        parsed_rules = []
+        rules.each do |rule|
+          unless rule.is_a? Rule
+            rule = StarkCore::Utils::API.from_api_json(resource_maker, rule)
+          end
+          parsed_rules << rule
+        end
+        return parsed_rules
+      end
+
+      def self.resource
+      {
+        resource_name: 'Rule',
+        resource_maker: proc { |json|
+          Rule.new(
+            key: json['key'],
+            value: json['value']
+          )
+        }
+      }
+      end
+    end
+  end
+end

data/lib/ledger_transaction/ledger_transaction.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+require_relative('../ledger/rule')
+
+module StarkInfra
+  # # LedgerTransaction object
+  #
+  # LedgerTransactions are used to track the balance of a given amount by inserting LedgerTransactions to them.
+  # They can represent a bank account, a digital wallet, an inventory product, etc.
+  #
+  # ## Parameters (required):
+  # - amount [integer]: amount of the transaction. ex: 11234
+  # - ledger_id [string]: id of the Ledger containing the transaction. ex: '5656565656565656'
+  # - external_id [string]: string that must be unique among all your LedgerTransactions in a single Ledger. ex: 'my-internal-id-123456'
+  # - source [string]: source of the LedgerTransaction. ex: 'bank-transfer/123'
+  #
+  # ## Parameters (optional):
+  # - fee [integer]: fee applied to the LedgerTransaction. ex: 100
+  # - rules [list of Ledger::Rule objects, default []]: list of Rule objects linked to the LedgerTransaction. Rules are used to overwrite the Ledger's rules for this transaction. ex: [Ledger::Rule.new(key: 'minimumBalance', value: 0)]
+  # - metadata [dictionary, default {}]: dictionary object used to store additional information about the LedgerTransaction object. ex: { 'orderId': '123', 'orderType': 'purchase' }
+  # - tags [list of strings, default []]: list of strings for reference when searching for LedgerTransactions. ex: ['transfer/123', 'savings']
+  # - created [DateTime or string, default nil]: datetime to backdate the transaction, used to import existing transaction history. Cannot be in the future; when creating multiple transactions in one request, their created values must be in chronological order. Defaults to the current datetime when omitted.
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the LedgerTransaction is created. ex: '5656565656565656'
+  # - balance [integer]: Ledger's balance after the transaction. ex: 11234
+  class LedgerTransaction < StarkCore::Utils::Resource
+    attr_reader :amount, :ledger_id, :external_id, :source, :id, :balance, :fee, :rules, :metadata, :tags, :created
+    def initialize(
+      amount:, ledger_id:, external_id:, source:, id: nil, balance: nil, fee: nil, rules: nil,
+      metadata: nil, tags: nil, created: nil
+    )
+      super(id)
+      @amount = amount
+      @ledger_id = ledger_id
+      @external_id = external_id
+      @source = source
+      @balance = balance
+      @fee = fee
+      @rules = StarkInfra::Ledger::Rule.parse_rules(rules)
+      @metadata = metadata
+      @tags = tags
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create LedgerTransactions
+    #
+    # Send a list of LedgerTransaction objects for creation at the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - transactions [list of LedgerTransaction objects]: list of LedgerTransaction objects to be created in the Stark Infra API. You can send up to 500 objects in a single request, targeting different ledgers if needed; each is applied to its Ledger in the order sent, and the resulting balance is returned for each one.
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of LedgerTransaction objects with updated attributes
+    def self.create(transactions, user: nil)
+      StarkInfra::Utils::Rest.post(entities: transactions, user: user, **resource)
+    end
+
+    # # Retrieve a specific LedgerTransaction
+    #
+    # Receive a single LedgerTransaction object previously created in the Stark Infra API by its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - LedgerTransaction object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve LedgerTransactions
+    #
+    # Receive a generator of LedgerTransaction objects previously created in the Stark Infra API
+    #
+    # ## Parameters (conditionally-required):
+    # - ledger_id [string, default nil]: id of the Ledger containing the transaction. Either ledger_id or ids must be provided. If both are sent, the query will be filtered by both. ex: '5656565656565656'
+    # - ids [list of strings, default nil]: list of LedgerTransaction ids to filter retrieved objects. Either ledger_id or ids must be provided. If both are sent, the query will be filtered by both. ex: ['5656565656565656', '4545454545454545']
+    #
+    # ## Parameters (optional):
+    # - flow [string, default nil]: direction of the transaction. ex: 'in' or 'out'
+    # - tags [list of strings, default nil]: list of tags to filter retrieved objects. ex: ['transfer/123', 'savings']
+    # - external_ids [list of strings, default nil]: list of LedgerTransaction external ids to filter retrieved objects. ex: ['my-internal-id-123456', 'my-internal-id-654321']
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - limit [integer, default 100, maximum 1000]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of LedgerTransaction objects with updated attributes
+    def self.query(ledger_id: nil, flow: nil, tags: nil, external_ids: nil, after: nil, before: nil,
+                    ids: nil, limit: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        ledger_id: ledger_id,
+        flow: flow,
+        tags: tags,
+        external_ids: external_ids,
+        after: after,
+        before: before,
+        ids: ids,
+        limit: limit,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged LedgerTransactions
+    #
+    # Receive a list of LedgerTransaction objects previously created in the Stark Infra API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (conditionally-required):
+    # - ledger_id [string, default nil]: id of the Ledger containing the transaction. Either ledger_id or ids must be provided. If both are sent, the query will be filtered by both. ex: '5656565656565656'
+    # - ids [list of strings, default nil]: list of LedgerTransaction ids to filter retrieved objects. Either ledger_id or ids must be provided. If both are sent, the query will be filtered by both. ex: ['5656565656565656', '4545454545454545']
+    #
+    # ## Parameters (optional):
+    # - flow [string, default nil]: direction of the transaction. ex: 'in' or 'out'
+    # - tags [list of strings, default nil]: list of tags to filter retrieved objects. ex: ['transfer/123', 'savings']
+    # - external_ids [list of strings, default nil]: list of LedgerTransaction external ids to filter retrieved objects. ex: ['my-internal-id-123456', 'my-internal-id-654321']
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - limit [integer, default 100, maximum 1000]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - cursor [string, default nil]: cursor returned on the previous page function call
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of LedgerTransaction objects with updated attributes
+    # - cursor to retrieve the next page of LedgerTransaction objects
+    def self.page(ledger_id: nil, flow: nil, tags: nil, external_ids: nil, after: nil, before: nil,
+                  ids: nil, limit: nil, cursor: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        ledger_id: ledger_id,
+        flow: flow,
+        tags: tags,
+        external_ids: external_ids,
+        after: after,
+        before: before,
+        ids: ids,
+        limit: limit,
+        cursor: cursor,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'LedgerTransaction',
+        resource_maker: proc { |json|
+          LedgerTransaction.new(
+            id: json['id'],
+            amount: json['amount'],
+            ledger_id: json['ledger_id'],
+            external_id: json['external_id'],
+            source: json['source'],
+            balance: json['balance'],
+            fee: json['fee'],
+            rules: json['rules'],
+            metadata: json['metadata'],
+            tags: json['tags'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/pix_balance/pix_balance.rb

@@ -12,7 +12,7 @@ module StarkInfra
   # can be retrieved to see the available information.
   #
   # ## Attributes (return-only):
-  # - id [string]: unique id returned when Balance is created. ex: '5656565656565656'
+  # - id [string]: identifier of the balance. Holds the participant bank code for direct participants, or the workspace id for indirect participants.
   # - amount [integer]: current balance amount of the workspace in cents. ex: 200 (= R$ 2.00)
   # - currency [string]: currency of the current workspace. Expect others to be added eventually. ex: 'BRL'
   # - updated [DateTime]: latest update datetime for the balance. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)

data/lib/pix_chargeback/pix_chargeback.rb

@@ -17,10 +17,10 @@ module StarkInfra
   # ## Parameters (required):
   # - amount [integer]: amount in cents to be reversed. ex: 11234 (= R$ 112.34)
   # - reference_id [string]: end_to_end_id or return_id of the transaction to be reversed. ex: 'E20018183202201201450u34sDGd19lz'
-  # - reason [string]: reason why the reversal was requested. Options: 'fraud', 'flaw', 'reversalChargeback'
+  # - reason [string]: reason why the reversal was requested. Options: 'flaw', 'fraud', 'subscriptionFlaw' (the API also assigns 'reversalChargeback' automatically when a chargeback stems from a closed Pix Infraction, but it cannot be passed on creation).
   #
   # ## Parameters (optional):
-  # - description [string, default nil]: description for the PixChargeback. ex: 'Payment for service #1234'
+  # - description [string, default nil]: description for the PixChargeback. Required when reason is 'flaw'. ex: 'Payment for service #1234'
   # - tags [list of strings, default nil]:  list of strings for tagging. ex: ['travel', 'food']
   #
   # ## Attributes (return-only):
@@ -42,16 +42,17 @@ module StarkInfra
   # - reversal_tax_id [string]: tax ID for the reversal transaction. ex: '01234567890'
   # - created [DateTime]: creation datetime for the PixChargeback. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime]: latest update datetime for the PixChargeback. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - bacen_id [string]: unique transaction id returned from Central Bank. ex: 'ccf9bd9c-e99d-999e-bab9-b999ca999f99'
   class PixChargeback < StarkCore::Utils::Resource
     attr_reader :amount, :reference_id, :reason, :description, :tags, :id, :analysis, :sender_bank_code,
                 :receiver_bank_code, :rejection_reason, :reversal_reference_id, :result, :flow, :status,
                 :dispute_id, :is_monitoring_required, :reversal_account_number, :reversal_account_type,
-                :reversal_bank_code, :reversal_branch_code, :reversal_tax_id, :created, :updated
+                :reversal_bank_code, :reversal_branch_code, :reversal_tax_id, :created, :updated, :bacen_id
     def initialize(
       amount:, reference_id:, reason:, description: nil, tags: nil, id: nil, analysis: nil, sender_bank_code: nil,
       receiver_bank_code: nil, rejection_reason: nil, reversal_reference_id: nil, result: nil, flow: nil, status: nil,
       dispute_id: nil, is_monitoring_required: nil, reversal_account_number: nil, reversal_account_type: nil,
-      reversal_bank_code: nil, reversal_branch_code: nil, reversal_tax_id: nil, created: nil, updated: nil
+      reversal_bank_code: nil, reversal_branch_code: nil, reversal_tax_id: nil, created: nil, updated: nil, bacen_id: nil
     )
       super(id)
       @amount = amount
@@ -76,6 +77,7 @@ module StarkInfra
       @reversal_tax_id = reversal_tax_id
       @created = StarkCore::Utils::Checks.check_datetime(created)
       @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      @bacen_id = bacen_id
     end
 
     # # Create PixChargebacks
@@ -184,10 +186,10 @@ module StarkInfra
     #
     # ## Parameters (required):
     # - id [string]: PixChargeback unique id. ex: '5656565656565656'
-    # - result [string]: result after the analysis of the PixChargeback. Options: 'rejected', 'accepted', 'partiallyAccepted'.
+    # - result [string]: result of the chargeback analysis to submit. Options: 'agreed', 'disagreed', 'partiallyAgreed'.
     #
     # ## Parameters (conditionally required):
-    # - rejection_reason [string, default nil]: if the PixChargeback is rejected a reason is required. Options: 'noBalance', 'accountClosed', 'unableToReverse',
+    # - rejection_reason [string, default nil]: if the PixChargeback's result is 'rejected', a reason is required. Options: 'other', 'noBalance', 'accountClosed', 'invalidRequest' ('unableToReverse' is not a valid value).
     # - reversal_reference_id [string, default nil]: return_id of the reversal transaction. ex: 'D20018183202201201450u34sDGd19lz'
     #
     # ## Parameters (optional):
@@ -251,7 +253,8 @@ module StarkInfra
             reversal_branch_code: json['reversal_branch_code'],
             reversal_tax_id: json['reversal_tax_id'],
             created: json['created'],
-            updated: json['updated']
+            updated: json['updated'],
+            bacen_id: json['bacen_id']
           )
         }
       }

data/lib/pix_claim/pix_claim.rb

@@ -8,6 +8,8 @@ module StarkInfra
   #
   # A Pix Claim is a request to transfer a Pix Key from an account hosted at another
   # Pix participant to an account under your bank code. Pix Claims must always be requested by the claimer.
+  # An 'ownership' claim changes the holder of a Pix Key and only applies to phone-type keys; a 'portability'
+  # claim changes the linked account without changing the holder, and applies to phone, email or taxId keys.
   #
   # When you initialize a PixClaim, the entity will not be automatically
   # created in the Stark Infra API. The 'create' function sends the objects
@@ -27,9 +29,10 @@ module StarkInfra
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the PixClaim is created. ex: '5656565656565656'
+  # - bacen_id [string]: unique transaction id returned from Central Bank. ex: 'ccf9bd9c-e99d-999e-bab9-b999ca999f99'
   # - status [string]: current PixClaim status. Options: 'created', 'failed', 'delivered', 'confirmed', 'success', 'canceled'
   # - type [string]: type of Pix Claim. Options: 'ownership', 'portability'.
-  # - key_type [string]: keyType of the claimed Pix Key. Options: 'CPF', 'CNPJ', 'phone' or 'email'
+  # - key_type [string]: keyType of the claimed Pix Key. Options: 'cpf', 'cnpj', 'phone', 'email', 'evp'.
   # - flow [string]: direction of the Pix Claim. Options: 'in' if you received the PixClaim or 'out' if you created the PixClaim.
   # - claimer_bank_code [string]: bank_code of the Pix participant that created the PixClaim. ex: '20018183'.
   # - claimed_bank_code [string]: bank_code of the account donating the PixClaim. ex: '20018183'.
@@ -37,11 +40,12 @@ module StarkInfra
   # - updated [DateTime]: update datetime for the PixClaim. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class PixClaim < StarkCore::Utils::Resource
     attr_reader :account_created, :account_number, :account_type, :branch_code, :name, :tax_id, :key_id,
-                :tags, :id, :status, :type, :key_type, :flow, :claimer_bank_code, :claimed_bank_code, :created, :updated
+                :tags, :id, :status, :type, :key_type, :flow, :claimer_bank_code, :claimed_bank_code, :created, :updated,
+                :bacen_id
     def initialize(
       account_created:, account_number:, account_type:, branch_code:, name:,
       tax_id:, key_id:, tags: nil, id: nil, status: nil, type: nil, key_type: nil, flow: nil,
-      claimer_bank_code: nil, claimed_bank_code: nil, created: nil, updated: nil
+      claimer_bank_code: nil, claimed_bank_code: nil, created: nil, updated: nil, bacen_id: nil
     )
       super(id)
       @account_created = account_created
@@ -60,6 +64,7 @@ module StarkInfra
       @claimed_bank_code = claimed_bank_code
       @created = StarkCore::Utils::Checks.check_datetime(created)
       @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      @bacen_id = bacen_id
     end
 
     # # Create a PixClaim object
@@ -183,11 +188,13 @@ module StarkInfra
 
     # # Update a PixClaim entity
     #
-    # Update a PixClaim parameters by passing id.
+    # Update a PixClaim by passing id. You must answer an inbound PixClaim within 7 days of its status
+    # changing to 'delivered' — if unanswered, a 'portability' claim is rejected by default and an
+    # 'ownership' claim is accepted by default, both with reason 'defaultBehavior'.
     #
     # ## Parameters (required):
     # - id [string]: PixClaim unique id. ex: '5656565656565656'
-    # - status [string]: patched status for Pix Claim. Options: 'confirmed' and 'canceled'
+    # - status [string]: patched status for the PixClaim. Options: 'confirmed' (only allowed from 'delivered' status; deletes the referenced PixKey from Stark Infra and the Central Bank) and 'canceled' (only allowed from 'delivered' or 'confirmed' status).
     #
     # ## Parameters (optional):
     # - reason [string, default 'userRequested']: reason why the PixClaim is being patched. Options: 'fraud', 'userRequested', 'accountClosure'.
@@ -226,7 +233,8 @@ module StarkInfra
             claimer_bank_code: json['claimer_bank_code'],
             claimed_bank_code: json['claimed_bank_code'],
             created: json['created'],
-            updated: json['updated']
+            updated: json['updated'],
+            bacen_id: json['bacen_id']
           )
         }
       }

data/lib/pix_director/pix_director.rb

@@ -23,7 +23,7 @@ module StarkInfra
   # - team_phones [list of strings]: list of phones of the team. ex: ['+5511988889999', '+5511988889998']
   #
   # ## Attributes (return-only):
-  # - status [string]: current PixDirector status. ex: 'success'
+  # - status [string]: current PixDirector status. Options: 'success', 'processing', 'failed'.
   class PixDirector < StarkCore::Utils::SubResource
     attr_reader :name, :tax_id, :phone, :email, :password, :team_email, :team_phones, :status
     def initialize(name:, tax_id:, phone:, email:, password:, team_email:, team_phones:, status: nil)

data/lib/pix_dispute/pix_dispute.rb

@@ -16,7 +16,7 @@ module StarkInfra
   #
   # ## Parameters (required):
   # - reference_id [string]: end_to_end_id of the transaction being reported. ex: 'E20018183202201201450u34sDGd19lz'
-  # - method [string]: method of the dispute. Options: 'scam', 'unauthorized', 'coercion', 'invasion', 'other'
+  # - method [string]: method of the dispute. Options: 'scam', 'unauthorized', 'coercion', 'invasion', 'other', 'unknown'.
   # - operator_email [string]: contact email of the operator responsible for the PixDispute. ex: 'ruby-sdk@starkinfra.com'
   # - operator_phone [string]: contact phone number of the operator responsible for the PixDispute. ex: '+5511999999999'
   #

data/lib/pix_dispute/transaction.rb

@@ -11,18 +11,18 @@ module StarkInfra
     #
     # ## Attributes (return-only):
     # - end_to_end_id [string]: central bank's unique transaction id. ex: 'E20018183202201201450u34sDGd19lz'
-    # - amount [integer]: refundable amount in cents. ex: 11234 (= R$ 112.34)
-    # - nominal_amount [integer]: transaction amount in cents. ex: 11234 (= R$ 112.34)
+    # - amount [integer]: transaction amount in cents. ex: 11234 (= R$ 112.34)
+    # - nominal_amount [integer]: refundable amount in cents of the transaction. ex: 11234 (= R$ 112.34)
     # - receiver_type [string]: receiver's type. Options: 'individual', 'business'
     # - receiver_tax_id_created [string]: receiver's taxId creation date (business type only).
     # - receiver_account_created [string]: receiver's account creation date.
     # - receiver_bank_code [string]: receiver's bank code. ex: '20018183'
-    # - receiver_id [string]: identifier of the accountholder in the graph.
+    # - receiver_id [string]: Bacen-generated pseudo ID for the receiver, used only for transaction-tracking context (not a real account identifier).
     # - sender_type [string]: sender's type. Options: 'individual', 'business'
     # - sender_tax_id_created [string]: sender's taxId creation date (business type only).
     # - sender_account_created [string]: sender's account creation date.
     # - sender_bank_code [string]: sender's bank code. ex: '20018183'
-    # - sender_id [string]: identifier of the accountholder in the graph.
+    # - sender_id [string]: Bacen-generated pseudo ID for the sender, used only for transaction-tracking context (not a real account identifier).
     # - settled [DateTime]: settled datetime of the transaction. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
     class Transaction < StarkCore::Utils::SubResource
       attr_reader :end_to_end_id, :amount, :nominal_amount, :receiver_type, :receiver_tax_id_created,

data/lib/pix_fraud/pix_fraud.rb

@@ -13,7 +13,7 @@ module StarkInfra
   # to the Stark Infra API and returns the created object.
   #
   # ## Parameters (required):
-  # - external_id [string]: end_to_end_id or return_id of the transaction being reported. ex: 'E20018183202201201450u34sDGd19lz'
+  # - external_id [string]: unique string to prevent duplicates among your PixFrauds. ex: 'my-internal-id-123456'
   # - type [string]: type of PixFraud. Options: 'identity', 'mule', 'scam', 'other'
   # - tax_id [string]: user tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
   #

data/lib/pix_infraction/pix_infraction.rb

@@ -21,6 +21,8 @@ module StarkInfra
   # ## Parameters (optional):
   # - description [string, default nil]: description for any details that can help with the infraction investigation.
   # - tags [list of strings, default nil]: list of strings for tagging. ex: ['travel', 'food']
+  # - fraud_type [string, default nil]: type of Pix Fraud. Options: 'identity', 'mule', 'scam', 'other', 'unknown'
+  # - method [string, default nil]: method of Pix Infraction. Options: 'scam', 'unauthorized', 'coercion', 'invasion', 'other', 'unknown'
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the PixInfraction is created. ex: '5656565656565656'
@@ -35,14 +37,17 @@ module StarkInfra
   # - dispute_id [string]: id of the PixDispute associated with the PixInfraction. ex: '5656565656565656'
   # - created [DateTime]: creation datetime for the PixInfraction. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime]: latest update datetime for the PixInfraction. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - bacen_id [string]: unique transaction id returned from Central Bank. ex: 'ccf9bd9c-e99d-999e-bab9-b999ca999f99'
+  # - fraud_id [string]: id of the Pix Fraud. ex: '5741774970552320'
   class PixInfraction < StarkCore::Utils::Resource
     attr_reader :reference_id, :type, :operator_email, :operator_phone, :description, :tags, :id, :credited_bank_code,
                 :flow, :analysis, :debited_bank_code, :reported_by, :result, :status, :amount, :dispute_id,
-                :created, :updated
+                :created, :updated, :bacen_id, :fraud_id, :fraud_type, :method
     def initialize(
       reference_id:, type:, operator_email:, operator_phone:, description: nil, id: nil, tags: nil,
       credited_bank_code: nil, debited_bank_code: nil, flow: nil, analysis: nil, reported_by: nil, result: nil,
-      status: nil, amount: nil, dispute_id: nil, created: nil, updated: nil
+      status: nil, amount: nil, dispute_id: nil, created: nil, updated: nil,
+      bacen_id: nil, fraud_id: nil, fraud_type: nil, method: nil
     )
       super(id)
       @reference_id = reference_id
@@ -62,6 +67,10 @@ module StarkInfra
       @dispute_id = dispute_id
       @created = StarkCore::Utils::Checks.check_datetime(created)
       @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      @bacen_id = bacen_id
+      @fraud_id = fraud_id
+      @fraud_type = fraud_type
+      @method = method
     end
 
     # # Create PixInfractions
@@ -176,14 +185,17 @@ module StarkInfra
     # - id [string]: PixInfraction unique id. ex: '5656565656565656'
     # - result [string]: result after the analysis of the PixInfraction. Options: 'agreed', 'disagreed'
     #
+    # ## Parameters (conditionally required):
+    # - fraud_type [string, default nil]: type of Pix Fraud, required only when result is 'agreed' (optional/ignored when result is 'disagreed'). Options: 'identity', 'mule', 'scam', 'other' — 'unknown' is not an accepted value.
+    #
     # ## Parameters (optional):
     # - analysis [string, nil]: analysis that led to the result.
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - PixInfraction object with updated attributes
-    def self.update(id, result:, analysis: nil, user: nil)
-      StarkInfra::Utils::Rest.patch_id(id: id, result: result, analysis: analysis, user: user, **resource)
+    def self.update(id, result:, fraud_type: nil, analysis: nil, user: nil)
+      StarkInfra::Utils::Rest.patch_id(id: id, result: result, fraud_type: fraud_type, analysis: analysis, user: user, **resource)
     end
 
     # # Cancel a PixInfraction entity
@@ -224,7 +236,11 @@ module StarkInfra
             amount: json['amount'],
             dispute_id: json['dispute_id'],
             created: json['created'],
-            updated: json['updated']
+            updated: json['updated'],
+            bacen_id: json['bacen_id'],
+            fraud_id: json['fraud_id'],
+            fraud_type: json['fraud_type'],
+            method: json['method']
           )
         }
       }

data/lib/pix_internal_transaction_report/pix_internal_transaction_report.rb

@@ -40,7 +40,7 @@ module StarkInfra
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the PixInternalTransactionReport is created. ex: '5656565656565656'
-  # - status [string]: current PixInternalTransactionReport status. ex: 'created', 'failed', 'sent' or 'success'
+  # - status [string]: current PixInternalTransactionReport status. Options: 'created', 'processing', 'success', 'failed'.
   # - updated [DateTime]: latest update datetime for the PixInternalTransactionReport. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class PixInternalTransactionReport < StarkCore::Utils::Resource
     attr_reader :amount, :created, :end_to_end_id, :method, :reference_type, :sender_account_number,

data/lib/pix_key/pix_key.rb

@@ -16,7 +16,7 @@ module StarkInfra
   # ## Parameters (required):
   # - account_created [DateTime or string]: opening Date or DateTime for the linked account. ex: '2020-03-10T10:30:00.000000+00:00' or DateTime.new(2020, 3, 10, 10, 30, 0, 0).
   # - account_number [string]: number of the linked account. ex: '76543'.
-  # - account_type [string]: type of the linked account. Options: 'checking', 'savings', 'salary' or 'payment'.
+  # - account_type [string]: type of the linked account. Options: 'checking', 'savings', 'salary', 'payment', 'other'.
   # - branch_code [string]: branch code of the linked account. ex: '1234'.
   # - name [string]: holder's name of the linked account. ex: 'Jamie Lannister'.
   # - tax_id [string]: holder's taxId (CPF/CNPJ) of the linked account. ex: '012.345.678-90'.