starkinfra 0.5.2 → 0.7.0

data/lib/business_identity/log.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+require_relative('business_identity')
+
+module StarkInfra
+  class BusinessIdentity
+    # # BusinessIdentity::Log object
+    #
+    # Every time a BusinessIdentity entity is updated, a corresponding BusinessIdentity::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 BusinessIdentity.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - identity [BusinessIdentity]: BusinessIdentity entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this BusinessIdentity event
+    # - type [string]: type of the BusinessIdentity event which triggered the log creation. ex: "created", "updated", "canceled", "processing", "success", "failed"
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkCore::Utils::Resource
+      attr_reader :id, :identity, :errors, :type, :created
+      def initialize(id: nil, identity: nil, errors: nil, type: nil, created: nil)
+        super(id)
+        @identity = identity
+        @errors = errors
+        @type = type
+        @created = StarkCore::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific BusinessIdentity::Log
+      #
+      # Receive a single BusinessIdentity::Log object previously created by the Stark Infra API by passing 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:
+      # - BusinessIdentity::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve BusinessIdentity::Logs
+      #
+      # Receive a generator of BusinessIdentity::Log objects previously created in the Stark Infra API
+      #
+      # ## Parameters (optional):
+      # - 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)
+      # - types [list of strings, default nil]: filter for log event types. ex: "created", "updated", "canceled", "processing", "success", "failed"
+      # - identity_ids [list of strings, default nil]: list of identity ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter BusinessIdentity Logs. 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 BusinessIdentity::Log objects with updated attributes
+      def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, identity_ids: 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,
+          types: types,
+          identity_ids: identity_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged BusinessIdentity::Logs
+      #
+      # Receive a list of up to 100 BusinessIdentity::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 identities.
+      #
+      # ## Parameters (optional):
+      # - cursor [string, default nil]: cursor returned on the previous page function call
+      # - 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)
+      # - types [list of strings, default nil]: filter for log event types. ex: "created", "updated", "canceled", "processing", "success", "failed"
+      # - identity_ids [list of strings, default nil]: list of identity ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter BusinessIdentity Logs. ex: ['5656565656565656']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+      #
+      # ## Return:
+      # - list of BusinessIdentity::Log objects with updated attributes
+      # - cursor to retrieve the next page of Log objects
+      def self.page(cursor: nil, ids: nil, limit: nil, after: nil, before: nil, types: nil, identity_ids: 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,
+          types: types,
+          identity_ids: identity_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        request_maker = StarkInfra::BusinessIdentity.resource[:resource_maker]
+        {
+          resource_name: 'BusinessIdentityLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              identity: StarkCore::Utils::API.from_api_json(request_maker, json['identity']),
+              errors: json['errors'],
+              type: json['type'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/credit_holmes/credit_holmes.rb

@@ -42,7 +42,8 @@ module StarkInfra
 
     # # Create CreditHolmes
     #
-    # Send a list of CreditHolmes objects for creation at the Stark Infra API
+    # Send a list of CreditHolmes objects for creation at the Stark Infra API. You can create up to 100
+    # CreditHolmes in a single call.
     #
     # ## Parameters (required):
     # - holmes [list of CreditHolmes objects]: list of CreditHolmes objects to be created in the API.

data/lib/credit_holmes/log.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+require_relative('credit_holmes')
+
+module StarkInfra
+  class CreditHolmes
+    # # CreditHolmes::Log object
+    #
+    # Every time a CreditHolmes entity is updated, a corresponding CreditHolmes::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 CreditHolmes.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - holmes [CreditHolmes]: CreditHolmes entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this CreditHolmes event.
+    # - type [string]: type of the CreditHolmes event which triggered the log creation. ex: 'created', 'failed', 'success'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkCore::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :holmes
+      def initialize(id:, created:, type:, errors:, holmes:)
+        super(id)
+        @holmes = holmes
+        @errors = errors
+        @type = type
+        @created = StarkCore::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific CreditHolmes::Log
+      #
+      # Receive a single CreditHolmes::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:
+      # - CreditHolmes::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve CreditHolmes::Logs
+      #
+      # Receive a generator of CreditHolmes::Log objects previously created in the Stark Infra API
+      #
+      # ## Parameters (optional):
+      # - 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)
+      # - types [list of strings, default nil]: filter for log event types. ex: ['created', 'failed', 'success']
+      # - holmes_ids [list of strings, default nil]: list of CreditHolmes ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - generator of CreditHolmes::Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, holmes_ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          holmes_ids: holmes_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged CreditHolmes::Logs
+      #
+      # Receive a list of up to 100 CreditHolmes::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):
+      # - cursor [string, default nil]: cursor returned on the previous page function call
+      # - 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)
+      # - types [list of strings, default nil]: filter for log event types. ex: ['created', 'failed', 'success']
+      # - holmes_ids [list of strings, default nil]: list of CreditHolmes ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - list of CreditHolmes::Log objects with updated attributes
+      # - cursor to retrieve the next page of CreditHolmes::Log objects
+      def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, holmes_ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_page(
+          cursor: cursor,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          holmes_ids: holmes_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        holmes_maker = StarkInfra::CreditHolmes.resource[:resource_maker]
+        {
+          resource_name: 'CreditHolmesLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              holmes: StarkCore::Utils::API.from_api_json(holmes_maker, json['holmes']),
+              errors: json['errors'],
+              type: json['type'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/credit_note/credit_note.rb

@@ -22,9 +22,9 @@ module StarkInfra
   # - name [string]: credit receiver's full name. ex: 'Edward Stark'
   # - tax_id [string]: credit receiver's tax ID (CPF or CNPJ). ex: '20.018.183/0001-80'
   # - scheduled [DateTime, Date or string]: date of transfer execution. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - invoices [list of CreditNote::Invoice objects]: list of Invoice objects to be created and sent to the credit receiver. ex: [Invoice.new(), Invoice.new()]
+  # - invoices [list of up to 100 CreditNote::Invoice objects]: installments to be paid by the borrower. All invoices in the same CreditNote must share the same fine and interest. ex: [Invoice.new(), Invoice.new()]
   # - payment [CreditNote::Transfer object]: payment entity to be created and sent to the credit receiver. ex: Transfer.new()
-  # - signers [list of CreditSigner objects]: signer's name, contact and delivery method for the signature request. ex: [CreditSigner.new(), CreditSigner.new()]
+  # - signers [list of up to 10 CreditSigner objects]: signer's name, contact and delivery method for the signature request. ex: [CreditSigner.new(), CreditSigner.new()]
   # - external_id [string]: a string that must be unique among all your CreditNotes, used to avoid resource duplication. ex: 'my-internal-id-123456'
   # - street_line_1 [string]: credit receiver main address. ex: 'Av. Paulista, 200'
   # - street_line_2 [string]: credit receiver address complement. ex: 'Apto. 123'
@@ -42,6 +42,7 @@ module StarkInfra
   # - rebate_amount [integer, default nil]: credit analysis fee deducted from lent amount. ex: 11234 (= R$ 112.34)
   # - tags [list of strings, default nil]: list of strings for reference when searching for CreditNotes. ex: ['employees', 'monthly']
   # - expiration [integer, default 604800]: time interval in seconds between scheduled date and expiration date. ex: 123456789
+  # - rules [list of CreditNote::Rule, default []]: list of {key, value} rules modifying the credit note behavior. Currently available key: 'invoiceCreationMode', values 'scheduled' (default - invoice issued a few days before due date), 'instant' (issued as soon as disbursed) or 'never' (not issued automatically).
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the CreditNote is created. ex: '5656565656565656'
@@ -52,19 +53,20 @@ module StarkInfra
   # - tax_amount [integer]: tax amount included in the CreditNote. ex: 100
   # - nominal_interest [float]: yearly nominal interest rate of the CreditNote, in percentage. ex: 11.5
   # - interest [float]: yearly effective interest rate of the credit note, in percentage. ex: 12.5
+  # - debtor_workspace_id [string]: ID of the debtor's Workspace, when it differs from the Workspace that generated this CreditNote. ex: '4545454545454545'
   # - created [DateTime]: creation datetime for the CreditNote. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime]: latest update datetime for the CreditNote. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class CreditNote < StarkCore::Utils::Resource
     attr_reader :template_id, :name, :tax_id, :scheduled, :invoices, :payment, :signers, :external_id,
                 :street_line_1, :street_line_2, :district, :city, :state_code, :zip_code, :payment_type,
-                :nominal_amount, :amount, :rebate_amount, :tags, :expiration, :id,  :document_id, :status,
-                :transaction_ids, :workspace_id, :tax_amount, :nominal_interest, :interest, :created, :updated
+                :nominal_amount, :amount, :rebate_amount, :tags, :expiration, :rules, :id, :document_id, :status,
+                :transaction_ids, :workspace_id, :tax_amount, :nominal_interest, :interest, :debtor_workspace_id, :created, :updated
     def initialize(
       template_id:, name:, tax_id:, scheduled:, invoices:, payment:, signers:, external_id:,
       street_line_1:, street_line_2:, district:, city:, state_code:, zip_code:, payment_type: nil,
-      nominal_amount: nil, amount: nil, rebate_amount: nil, tags: nil, expiration: nil, id: nil,
+      nominal_amount: nil, amount: nil, rebate_amount: nil, tags: nil, expiration: nil, rules: nil, id: nil,
       document_id: nil, status: nil, transaction_ids: nil, workspace_id: nil, tax_amount: nil,
-      nominal_interest: nil, interest: nil, created: nil, updated: nil
+      nominal_interest: nil, interest: nil, debtor_workspace_id: nil, created: nil, updated: nil
     )
       super(id)
       @template_id = template_id
@@ -85,6 +87,7 @@ module StarkInfra
       @rebate_amount = rebate_amount
       @tags = tags
       @expiration = expiration
+      @rules = Rule.parse_rules(rules)
       @document_id = document_id
       @status = status
       @transaction_ids = transaction_ids
@@ -92,6 +95,7 @@ module StarkInfra
       @tax_amount = tax_amount
       @nominal_interest = nominal_interest
       @interest = interest
+      @debtor_workspace_id = debtor_workspace_id
       @created = StarkCore::Utils::Checks.check_datetime(created)
       @updated = StarkCore::Utils::Checks.check_datetime(updated)
 
@@ -102,7 +106,8 @@ module StarkInfra
 
     # # Create CreditNotes
     #
-    # Send a list of CreditNote objects for creation in the Stark Infra API
+    # Send a list of CreditNote objects for creation in the Stark Infra API. You can create up to 100
+    # CreditNotes in a single call.
     #
     # ## Parameters (required):
     # - notes [list of CreditNote objects]: list of CreditNote objects to be created in the API
@@ -198,7 +203,9 @@ module StarkInfra
 
     # # Cancel a CreditNote entity
     #
-    # Cancel a CreditNote entity previously created in the Stark Infra API
+    # Cancel a CreditNote entity previously created in the Stark Infra API. Only CreditNotes with status
+    # 'created', 'signed' or 'processing' are actually canceled (which also cancels the signing document);
+    # notes already 'success', 'failed', 'expired' or 'canceled' are returned unchanged.
     #
     # ## Parameters (required):
     # - id [string]: object unique id. ex: '5656565656565656'
@@ -212,6 +219,40 @@ module StarkInfra
       StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
     end
 
+    # # Retrieve a specific CreditNote pdf file
+    #
+    # Receive the CCB disbursement pdf file of a CreditNote previously created in the Stark Infra API by its id.
+    # Not available for canceled CreditNotes.
+    #
+    # ## Parameters (required):
+    # - id [string]: CreditNote 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:
+    # - CreditNote pdf file
+    def self.pdf(id, user: nil)
+      StarkInfra::Utils::Rest.get_content(id: id, user: user, sub_resource_name: 'pdf', **resource)
+    end
+
+    # # Retrieve a specific CreditNote payment pdf file
+    #
+    # Receive the CCB disbursement payment pdf file of a CreditNote previously created in the Stark Infra API by its id.
+    # Only CreditNotes with status "success" have a payment pdf.
+    #
+    # ## Parameters (required):
+    # - id [string]: CreditNote 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:
+    # - CreditNote payment pdf file
+    def self.payment(id, user: nil)
+      StarkInfra::Utils::Rest.get_content(id: id, user: user, sub_resource_name: 'payment/pdf', **resource)
+    end
+
     def self.parse_payment(payment, payment_type)
       resource_maker = { 'transfer' => Transfer.resource[:resource_maker] }
       if payment.is_a?(Hash)
@@ -261,6 +302,7 @@ module StarkInfra
             rebate_amount: json['rebate_amount'],
             tags: json['tags'],
             expiration: json['expiration'],
+            rules: json['rules'],
             document_id: json['document_id'],
             status: json['status'],
             transaction_ids: json['transaction_ids'],
@@ -268,6 +310,7 @@ module StarkInfra
             tax_amount: json['tax_amount'],
             nominal_interest: json['nominal_interest'],
             interest: json['interest'],
+            debtor_workspace_id: json['debtor_workspace_id'],
             created: json['created'],
             updated: json['updated']
           )

data/lib/credit_note/rule.rb

@@ -0,0 +1,55 @@
+require_relative('../utils/rest')
+
+module StarkInfra
+  class CreditNote
+    # # CreditNote::Rule object
+    #
+    # The CreditNote::Rule object modifies the behavior of CreditNote objects when passed as an argument upon their creation.
+    #
+    # ## Parameters (required):
+    # - key [string]: Rule to be customized, describes what CreditNote behavior will be altered. ex: 'invoiceCreationMode'
+    # - value [string]: value of the rule. ex: 'scheduled', 'instant' or 'never'
+    class Rule < StarkCore::Utils::SubResource
+      attr_reader :key, :value
+      def initialize(key:, value:)
+        @key = key
+        @value = value
+      end
+
+      # # Parse CreditNote::Rules
+      #
+      # Converts a list of hashes (or Rule objects) received from the API into a list of CreditNote::Rule objects.
+      #
+      # ## Parameters (required):
+      # - rules [list of hashes or CreditNote::Rule objects]: list to be parsed.
+      #
+      # ## Return:
+      # - list of parsed CreditNote::Rule objects
+      def self.parse_rules(rules)
+        resource_maker = StarkInfra::CreditNote::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/credit_note/transfer.rb

@@ -12,7 +12,7 @@ module StarkInfra
   # ## Parameters (required):
   # - 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]: code of the receiver bank institution in Brazil. ex: '20018183'
+  # - bank_code [string]: receiver institution ISPB code, 8 digits. ex: '20018183'
   # - 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'
   #

data/lib/credit_preview/credit_note_preview.rb

@@ -13,18 +13,26 @@ module StarkInfra
   # to the Stark Infra API and returns the list of created objects.
   #
   # ## Parameters (required):
-  # - type [string]: table type that defines the amortization system. Options: 'sac', 'price', 'american', 'bullet', 'custom'
+  # - type [string]: table type that defines the amortization system. Options: 'sac' (constant amortization), 'price' (fixed installments), 'american' (periodic interest and principal at maturity), 'bullet' (principal and interest at maturity), 'custom' (you provide the invoices and the rates are computed).
   # - nominal_amount [integer]: amount in cents transferred to the credit receiver, before deductions. ex: 11234 (= R$ 112.34)
   # - scheduled [DateTime, Date or string]: date of transfer execution. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - tax_id [string]: credit receiver's tax ID (CPF or CNPJ). ex: '20.018.183/0001-80'
   #
   # ## Parameters (conditionally required):
+  # - nominal_amount or amount [integer]: provide exactly one; the other is computed from the invoice schedule (not used for type 'custom').
+  # - count or initial_amount [integer]: for 'sac' and 'price' types, provide exactly one; the other is computed.
   # - invoices [list of CreditNote::Invoice objects]: list of CreditNote.Invoice objects to be created and sent to the credit receiver.
   # - nominal_interest [float]: yearly nominal interest rate of the credit note, in percentage. ex: 12.5
   # - initial_due [DateTime, Date or string]: date of the first invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0), Date.new(2020, 3, 10) or '2020-03-10'
   # - count [integer]: quantity of invoices for payment. ex: 12
   # - initial_amount [integer]: value of the first invoice in cents. ex: 1234 (= R$12.34)
-  # - interval [string]: interval between invoices. ex: 'year', 'month'
+  # - interval [string, default 'month']: interval between invoices. Options: 'day', 'week', 'month', 'quarter', 'semester', 'year'.
+  #
+  # ## Parameters (conditionally required, by type):
+  # - 'sac'/'price': nominal_interest, scheduled, initial_due, tax_id and one of count/initial_amount.
+  # - 'american': nominal_interest, scheduled, initial_due, count, tax_id.
+  # - 'bullet': nominal_interest, scheduled, initial_due, tax_id.
+  # - 'custom': scheduled, tax_id, invoices.
   #
   # ## Parameters (optional):
   # - rebate_amount [integer, default nil]: credit analysis fee deducted from lent amount. ex: 11234 (= R$ 112.34)

data/lib/credit_preview/credit_preview.rb

@@ -23,7 +23,8 @@ module StarkInfra
 
     # # Create CreditPreviews
     #
-    # Send a list of CreditPreview objects for processing in the Stark Infra API
+    # Send a list of CreditPreview objects for processing in the Stark Infra API. You can create up to 100
+    # previews in a single call.
     #
     # ## Parameters (required):
     # - previews [list of CreditPreview objects]: list of CreditPreview objects to be created in the API

data/lib/credit_signer/credit_signer.rb

@@ -9,8 +9,8 @@ module StarkInfra
   #
   # ## Parameters (required):
   # - name [string]: signer's name. ex: 'Tony Stark'
-  # - contact [string]: signer's contact information. ex: 'tony@starkindustries.com'
-  # - method [string]: delivery method for the contract. ex: 'link'
+  # - contact [string]: signer contact that receives the signing link or token. Can be an email, a phone number or, for the 'server' and 'organization' methods, a URL. ex: 'tony@starkindustries.com'
+  # - method [string]: signing method. Options: 'link' (signing link sent to the contact), 'token' (signing token sent to the contact), 'server' and 'organization' (automatic signatures over URL contacts).
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the CreditSigner is created. ex: '5656565656565656'
@@ -23,6 +23,31 @@ module StarkInfra
       @method = method
     end
 
+    # # Resend token to signer
+    #
+    # Resend token to a specific signer.
+    #
+    # ## Parameters (required):
+    # - id [string]: CreditSigner 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:
+    # - CreditSigner object with updated attributes
+    def self.resend_token(id, user: nil)
+      StarkInfra::Utils::Rest.patch_id(id: id, is_sent: false, user: user, **resource)
+    end
+
+    # # Parse CreditSigners
+    #
+    # Converts a list of hashes (or CreditSigner objects) received from the API into a list of CreditSigner objects.
+    #
+    # ## Parameters (required):
+    # - signers [list of hashes or CreditSigner objects]: list to be parsed.
+    #
+    # ## Return:
+    # - list of parsed CreditSigner objects
     def self.parse_signers(signers)
       resource_maker = StarkInfra::CreditSigner.resource[:resource_maker]
       return signers if signers.nil?

data/lib/dynamic_brcode/dynamic_brcode.rb

@@ -13,6 +13,9 @@ module StarkInfra
   # in the BR Code. Stark Infra will receive the GET request and forward it to your
   # registered endpoint with a GET request containing the UUID of the BR Code for
   # identification.
+  # The 'subscription', 'subscriptionAndInstant' and 'dueAndOrSubscription' types let a DynamicBrcode initiate
+  # a Pix Automático recurring authorization; subscription reads are answered through PixPullSubscription, not
+  # response_due/response_instant.
   #
   # When you initialize a DynamicBrcode, the entity will not be automatically
   # created in the Stark Infra API. The 'create' function sends the objects
@@ -24,7 +27,7 @@ module StarkInfra
   # - external_id [string]: string that must be unique among all your DynamicBrcodes. Duplicated external ids will cause failures. ex: 'my-internal-id-123456'
   #
   # ## Parameters (optional):
-  # - type [string, default 'instant']: type of the DynamicBrcode. Options: 'instant', 'due'
+  # - type [string, default 'instant']: type of the DynamicBrcode. Options: 'instant', 'due', 'subscription', 'subscriptionAndInstant', 'dueAndOrSubscription'.
   # - tags [list of strings, default nil]: list of strings for tagging. ex: ['travel', 'food']
   #
   # ## Attributes (return-only):
@@ -281,7 +284,7 @@ module StarkInfra
     # ## Return:
     # - verified Brcode's uuid.
     def self.verify(uuid:, signature:, user: nil)
-      StarkCore::Utils::Parse.verify(content: uuid, signature: signature, user: user)
+      StarkInfra::Utils::Parse.verify(content: uuid, signature: signature, user: user)
     end
 
     def self.resource

data/lib/event/event.rb

@@ -5,8 +5,12 @@ require('starkcore')
 require_relative('../error')
 require_relative('../utils/rest')
 require_relative('../utils/parse')
+require_relative('../pix_pull_request/log')
+require_relative('../pix_pull_subscription/log')
 require_relative('../pix_request/log')
 require_relative('../pix_reversal/log')
+require_relative('../pix_dispute/log')
+require_relative('../business_identity/log')
 
 module StarkInfra
   # # Webhook Event object
@@ -36,6 +40,9 @@ module StarkInfra
         'pix-claim': StarkInfra::PixClaim::Log.resource,
         'pix-chargeback': StarkInfra::PixChargeback::Log.resource,
         'pix-infraction': StarkInfra::PixInfraction::Log.resource,
+        'pix-dispute': StarkInfra::PixDispute::Log.resource,
+        'pix-pull-request': StarkInfra::PixPullRequest::Log.resource,
+        'pix-pull-subscription': StarkInfra::PixPullSubscription::Log.resource,
         'pix-request.in': StarkInfra::PixRequest::Log.resource,
         'pix-request.out': StarkInfra::PixRequest::Log.resource,
         'pix-reversal.in': StarkInfra::PixReversal::Log.resource,
@@ -44,6 +51,7 @@ module StarkInfra
         'issuing-invoice': StarkInfra::IssuingInvoice::Log.resource,
         'issuing-purchase': StarkInfra::IssuingPurchase::Log.resource,
         'credit-note': StarkInfra::CreditNote::Log.resource,
+        'business-identity': StarkInfra::BusinessIdentity::Log.resource,
       }[subscription.to_sym]
 
       @log = log
@@ -124,7 +132,7 @@ module StarkInfra
 
     # # Delete a notification Event
     #
-    # Delete a notification Event entity previously created in the Stark Infra API by its ID
+    # Delete a notification Event entity previously created in the Stark Infra API by its ID. This action cannot be undone.
     #
     # ## Parameters (required):
     # - id [string]: Event unique id. ex: '5656565656565656'
@@ -144,7 +152,7 @@ module StarkInfra
     # 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 [string]: Event unique id. ex: '5656565656565656'
     # - is_delivered [bool]: If true and event hasn't been delivered already, event will be set as delivered. ex: true
     #
     # ## Parameters (optional):