starkinfra 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61eb746142fdcedb5bb2668292aaee6995c898114b0abea9a545e49593a005ac
-  data.tar.gz: '04082c73ccc17fd54b98b81d3ff05672c05a9d674fc5585745167eafcbda2153'
+  metadata.gz: de90969ab57cda69ca0b44cfc730e700c09eb6946aa4a910c83e746a22d1352c
+  data.tar.gz: 215ddb0ea963f80ea88b68be867ea8df47cc123db8c7b7a81861ce23a165b12a
 SHA512:
-  metadata.gz: d61b4d1ab3e1569d5dd4ab63f18c94fe7f566cdb1486f4601d64e87be2f848026b1bcf7573592cefed3e73bc786fd11da776e0a860618f86b25456e4aaac8939
-  data.tar.gz: b57a0caaeb2a8c7c26330f18bca61a8e073186ffff1f83d95888c704bcc57919d76aa1a4a6c29d02a87c462a3e5bf41151802d52a5da80ee12584d449974c4ca
+  metadata.gz: 8b6abd55509addd3e4d07c155d3d679f0acfd681147b256771f9ed8ec785a1f05ebac12ea5ca97feb5fcefa4c9e15066a78fbabeb6e4d3c79eafde2938d55ee5
+  data.tar.gz: a5428b140f33babeb4f0d5e35fc98b8322770247ed9a30ac68a997d168d644a2dc924c89a543e01919e2f60fc311915e2cf30c9d80b163682dd2e346e72b6e78

data/lib/brcode_preview/brcode_preview.rb

@@ -13,12 +13,13 @@ module StarkInfra
   #
   # Parameters (optional):
   # - end_to_end_id [string]: central bank's unique transaction ID. ex: "E79457883202101262140HHX553UPqeq"
+  # - scheduled [Date or string, default nil]: date the payment is scheduled to be processed. Affects the preview values for due dynamic QR codes. ex: Date.new(2022, 1, 31)
   #
   # Attributes (return-only):
   # - account_number [string]: Payment receiver account number. ex: '1234567'
   # - account_type [string]: Payment receiver account type. ex: 'checking'
   # - amount [integer]: Value in cents that this payment is expecting to receive. If 0, any value is accepted. ex: 123 (= R$1,23)
-  # - amount_type [string]: amount type of the BR Code. If the amount type is 'custom' the BR Code's amount can be changed by the sender at the moment of payment. Options: 'fixed' or 'custom'
+  # - amount_type [string]: amount type of the BR Code. Options: 'fixed' or 'minimum'. ex: 'fixed'
   # - bank_code [string]: Payment receiver bank code. ex: '20018183'
   # - branch_code [string]: Payment receiver branch code. ex: '0001'
   # - cash_amount [integer]: Amount to be withdrawn from the cashier in cents. ex: 1000 (= R$ 10.00)
@@ -36,15 +37,22 @@ module StarkInfra
   # - status [string]: Payment status. ex: 'active', 'paid', 'canceled' or 'unknown'
   # - subscription [BrcodePreview::Subscription, default nil]: snapshot of the recurring-debit subscription attached to the BR Code, when present. Nil for one-shot BR Codes.
   # - tax_id [string]: Payment receiver tax ID. ex: '012.345.678-90'
+  # - data [list of hashes]: additional data of the dynamic QR code, in key/value pairs. ex: [{'key' => 'additional-info', 'value' => 'order #12345'}]
+  # - description [string]: description of the payment.
+  # - due [DateTime]: due date and time for payment of the dynamic QR code. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - expired [DateTime]: date and time after which the dynamic QR code is considered expired. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - jws [string]: JWS of the dynamic QR code. Returned only when 'jws' is passed in the expand query parameter. ex: 'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9...'
   class BrcodePreview < StarkCore::Utils::Resource
     attr_reader :id, :payer_id, :end_to_end_id, :account_number, :account_type, :amount, :amount_type, :bank_code, :branch_code, :cash_amount,
                 :cashier_bank_code, :cashier_type, :discount_amount, :fine_amount, :key_id, :interest_amount, :name,
-                :nominal_amount, :reconciliation_id, :reduction_amount, :scheduled, :status, :subscription, :tax_id
+                :nominal_amount, :reconciliation_id, :reduction_amount, :scheduled, :status, :subscription, :tax_id,
+                :data, :description, :due, :expired, :jws
     def initialize(
       id:, payer_id:, end_to_end_id: nil, account_number: nil, account_type: nil, amount: nil, amount_type: nil, bank_code: nil,
       branch_code: nil, cash_amount: nil, cashier_bank_code:nil, cashier_type:nil, discount_amount: nil,
       fine_amount: nil, key_id: nil, interest_amount: nil, name: nil, nominal_amount: nil,
-      reconciliation_id: nil, reduction_amount: nil, scheduled: nil, status: nil, subscription: nil, tax_id: nil
+      reconciliation_id: nil, reduction_amount: nil, scheduled: nil, status: nil, subscription: nil, tax_id: nil,
+      data: nil, description: nil, due: nil, expired: nil, jws: nil
     )
       super(id)
       @payer_id = payer_id
@@ -70,6 +78,11 @@ module StarkInfra
       @status = status
       @subscription = subscription
       @tax_id = tax_id
+      @data = data
+      @description = description
+      @due = due.to_s.empty? ? nil : StarkCore::Utils::Checks.check_datetime(due)
+      @expired = expired.to_s.empty? ? nil : StarkCore::Utils::Checks.check_datetime(expired)
+      @jws = jws
     end
 
     # # Retrieve BrcodePreviews
@@ -116,7 +129,12 @@ module StarkInfra
             scheduled: json['scheduled'],
             status: json['status'],
             subscription: BrcodePreview::Subscription.parse_subscription(json['subscription']),
-            tax_id: json['tax_id']
+            tax_id: json['tax_id'],
+            data: json['data'],
+            description: json['description'],
+            due: json['due'],
+            expired: json['expired'],
+            jws: json['jws']
           )
         }
       }

data/lib/brcode_preview/subscription.rb

@@ -14,14 +14,14 @@ module StarkInfra
     # BrcodePreview returned by the API.
     #
     # ## Attributes (return-only):
-    # - amount [integer]: amount in cents charged per cycle. nil for variable-amount subscriptions. ex: 1000 (= R$ 10.00)
+    # - amount [integer]: amount in cents charged per cycle. 0 for variable-amount subscriptions. ex: 1000 (= R$ 10.00)
     # - amount_min_limit [integer]: floor value for the maximum amount the sender can set when approving a variable-amount subscription. nil for fixed-amount subscriptions. ex: 500 (= R$ 5.00)
     # - bacen_id [string]: Central Bank's unique recurrency id for the subscription.
     # - created [DateTime]: creation datetime of the subscription. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
     # - description [string]: additional information delivered to the sender.
     # - installment_end [DateTime]: end datetime of settlements allowed for this subscription. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
     # - installment_start [DateTime]: start datetime of settlements allowed for this subscription. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-    # - interval [string]: cycle definition exposed verbatim from the server. ex: 'monthly'
+    # - interval [string]: billing interval of the subscription, translated from the Central Bank's periodicity code. Options: 'week', 'month', 'quarter', 'semester', 'year'.
     # - pull_retry_limit [integer]: max number of retries the receiver may issue for a single failed pull cycle.
     # - receiver_bank_code [string]: receiver's bank institution code.
     # - receiver_name [string]: receiver's full name.

data/lib/business_account_request/business_account_request.rb

@@ -0,0 +1,276 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+
+module StarkInfra
+  # # BusinessAccountRequest object
+  #
+  # Request to open a Stark Infra account for a company. Each of the company's owners completes an
+  # identity verification through an independent webview, delivered as the owner's validator_link. The
+  # API runs the approval flow asynchronously, moving the request through 'created' -> 'processing' ->
+  # ('approved' | 'denied'); 'failed' when the request could not be processed.
+  #
+  # When you initialize a BusinessAccountRequest, the entity will not be automatically
+  # created in the Stark Infra API. The 'create' function sends the objects
+  # to the Stark Infra API and returns the list of created objects.
+  #
+  # ## Parameters (required):
+  # - address [BusinessAccountRequest::Address object]: company's structured address. ex: StarkInfra::BusinessAccountRequest::Address.new(street: 'Av. Faria Lima', number: '2000', neighborhood: 'Itaim Bibi', city: 'Sao Paulo', state: 'SP', zip_code: '04538-132')
+  # - revenue [integer]: company's annual revenue in cents. ex: 100000000 (= R$ 1,000,000.00)
+  # - name [string]: company's legal name (minimum 5 characters). ex: 'Stark Bank S.A.'
+  # - tax_id [string]: company's tax ID (CNPJ). ex: '20.018.183/0001-80'
+  # - owners [list of BusinessAccountRequest::Owner objects]: list of 1 to 10 company owners. ex: [StarkInfra::BusinessAccountRequest::Owner.new(tax_id: '012.345.678-90', name: 'Jamie Lannister', role: 'partner')]
+  #
+  # ## Parameters (optional):
+  # - tags [list of strings, default nil]: list of strings for reference when searching for BusinessAccountRequests. ex: ['employees', 'monthly']
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the BusinessAccountRequest is created. ex: '5656565656565656'
+  # - account_type [string]: type of the account. ex: 'business'
+  # - flags [list of hashes]: flags that motivated the decision, populated when the request is denied. Each flag has a code and a message. ex: [{'code' => 'failedIdentityProof', 'message' => 'O representante: 012.345.678-90 falhou na verificação de identidade.'}]
+  # - status [string]: current status of the BusinessAccountRequest. Options: 'created', 'processing', 'approved', 'denied', 'failed'
+  # - created [DateTime]: creation datetime for the BusinessAccountRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the BusinessAccountRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class BusinessAccountRequest < StarkCore::Utils::Resource
+    attr_reader :address, :revenue, :name, :tax_id, :owners, :tags, :id, :account_type, :flags, :status, :created, :updated
+    def initialize(address:, revenue:, name:, tax_id:, owners:, tags: nil, id: nil, account_type: nil,
+                   flags: nil, status: nil, created: nil, updated: nil)
+      super(id)
+      @address = BusinessAccountRequest.parse_address(address)
+      @revenue = revenue
+      @name = name
+      @tax_id = tax_id
+      @owners = BusinessAccountRequest.parse_owners(owners)
+      @tags = tags
+      @account_type = account_type
+      @flags = flags
+      @status = status
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create BusinessAccountRequests
+    #
+    # Send a list of BusinessAccountRequest objects for creation at the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - requests [list of BusinessAccountRequest objects]: list of BusinessAccountRequest objects to be created in the API.
+    #
+    # ## 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 BusinessAccountRequest objects with updated attributes
+    def self.create(requests, user: nil)
+      StarkInfra::Utils::Rest.post(entities: requests, user: user, **resource)
+    end
+
+    # # Retrieve a specific BusinessAccountRequest
+    #
+    # Receive a single BusinessAccountRequest 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:
+    # - BusinessAccountRequest object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve BusinessAccountRequests
+    #
+    # Receive a generator of BusinessAccountRequest 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)
+    # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['created', 'processing', 'approved', 'denied', 'failed']
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of BusinessAccountRequest objects with updated attributes
+    def self.query(limit: nil, status: nil, tags: nil, ids: nil, after: nil, before: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        limit: limit,
+        status: status,
+        tags: tags,
+        ids: ids,
+        after: after,
+        before: before,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged BusinessAccountRequests
+    #
+    # Receive a list of up to 100 BusinessAccountRequest 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: 50
+    # - 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)
+    # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['created', 'processing', 'approved', 'denied', 'failed']
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - list of BusinessAccountRequest objects with updated attributes
+    # - cursor to retrieve the next page of BusinessAccountRequest objects
+    def self.page(cursor: nil, limit: nil, status: nil, tags: nil, ids: nil, after: nil, before: 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,
+        status: status,
+        tags: tags,
+        ids: ids,
+        after: after,
+        before: before,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.parse_address(address)
+      return nil if address.nil?
+      return address if address.is_a?(Address)
+
+      address_maker = Address.resource[:resource_maker]
+      StarkCore::Utils::API.from_api_json(address_maker, address)
+    end
+
+    def self.parse_owners(owners)
+      return nil if owners.nil?
+
+      owner_maker = Owner.resource[:resource_maker]
+      owners.map do |owner|
+        owner.is_a?(Owner) ? owner : StarkCore::Utils::API.from_api_json(owner_maker, owner)
+      end
+    end
+
+    def self.resource
+      {
+        resource_name: 'BusinessAccountRequest',
+        resource_maker: proc { |json|
+          BusinessAccountRequest.new(
+            id: json['id'],
+            address: json['address'],
+            revenue: json['revenue'],
+            name: json['name'],
+            tax_id: json['tax_id'],
+            owners: json['owners'],
+            tags: json['tags'],
+            account_type: json['account_type'],
+            flags: json['flags'],
+            status: json['status'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+
+    # # BusinessAccountRequest::Address object
+    #
+    # The Address object is the structured address of the company referenced by a
+    # BusinessAccountRequest. It is embedded on the parent's address field and has no endpoints of its own.
+    #
+    # ## Parameters (required):
+    # - street [string]: street name. ex: 'Av. Faria Lima'
+    # - number [string]: street number. ex: '2000'
+    # - neighborhood [string]: neighborhood / district. ex: 'Itaim Bibi'
+    # - city [string]: city. ex: 'Sao Paulo'
+    # - state [string]: state (BR 2-letter code). ex: 'SP'
+    # - zip_code [string]: ZIP code (BR CEP), formatted or digit-only. ex: '04538-132'
+    #
+    # ## Parameters (optional):
+    # - complement [string, default nil]: address complement. ex: 'Sala 42'
+    class Address < StarkCore::Utils::SubResource
+      attr_reader :street, :number, :neighborhood, :city, :state, :zip_code, :complement
+      def initialize(street:, number:, neighborhood:, city:, state:, zip_code:, complement: nil)
+        @street = street
+        @number = number
+        @neighborhood = neighborhood
+        @city = city
+        @state = state
+        @zip_code = zip_code
+        @complement = complement
+      end
+
+      def self.resource
+        {
+          resource_name: 'Address',
+          resource_maker: proc { |json|
+            Address.new(
+              street: json['street'],
+              number: json['number'],
+              neighborhood: json['neighborhood'],
+              city: json['city'],
+              state: json['state'],
+              zip_code: json['zip_code'],
+              complement: json['complement']
+            )
+          }
+        }
+      end
+    end
+
+    # # BusinessAccountRequest::Owner object
+    #
+    # The Owner object represents a company owner referenced by a BusinessAccountRequest. Each owner
+    # completes its own identity verification through an independent webview. It is embedded on the
+    # parent's owners field and has no endpoints of its own.
+    #
+    # ## Parameters (required):
+    # - tax_id [string]: owner's tax ID (CPF). ex: '012.345.678-90'
+    # - name [string]: owner's full name (minimum 5 characters). ex: 'Jamie Lannister'
+    # - role [string]: owner's role in the company. Options: 'partner', 'representative'
+    #
+    # ## Attributes (return-only):
+    # - identity_id [string]: unique id of the identity verification linked to this owner. ex: '5709594221805568'
+    # - validator_link [string]: webview link to be delivered to the owner to complete biometrics and document capture. Treat it as a credential: deliver it through a secure channel and never log it.
+    # - status [string]: current status of the owner verification. Options: 'created', 'approved', 'denied'
+    class Owner < StarkCore::Utils::SubResource
+      attr_reader :tax_id, :name, :role, :identity_id, :validator_link, :status
+      def initialize(tax_id:, name:, role:, identity_id: nil, validator_link: nil, status: nil)
+        @tax_id = tax_id
+        @name = name
+        @role = role
+        @identity_id = identity_id
+        @validator_link = validator_link
+        @status = status
+      end
+
+      def self.resource
+        {
+          resource_name: 'Owner',
+          resource_maker: proc { |json|
+            Owner.new(
+              tax_id: json['tax_id'],
+              name: json['name'],
+              role: json['role'],
+              identity_id: json['identity_id'],
+              validator_link: json['validator_link'],
+              status: json['status']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/{individual_document → business_account_request}/log.rb

@@ -2,34 +2,35 @@
 
 require('starkcore')
 require_relative('../utils/rest')
-require_relative('individual_document')
+require_relative('business_account_request')
 
 module StarkInfra
-  class IndividualDocument
-    # # IndividualDocument::Log object
+  class BusinessAccountRequest
+    # # BusinessAccountRequest::Log object
     #
-    # Every time an IndividualDocument entity is updated, a corresponding IndividualDocument::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 IndividualDocument.
+    # Every time a BusinessAccountRequest entity is modified, a corresponding BusinessAccountRequest::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 BusinessAccountRequest.
     #
     # ## Attributes (return-only):
     # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
-    # - document [IndividualDocument]: IndividualDocument entity to which the log refers to.
-    # - errors [list of strings]: list of errors linked to this IndividualDocument event
-    # - type [string]: type of the IndividualDocument event which triggered the log creation. ex: 'approved', 'canceled', 'confirmed', 'denied', 'reversed', 'voided'.
+    # - request [BusinessAccountRequest]: BusinessAccountRequest entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this BusinessAccountRequest event
+    # - type [string]: type of the BusinessAccountRequest event which triggered the log creation. ex: 'created', 'processing', 'approved', 'denied', '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, :document, :errors, :type, :created
-      def initialize(id: nil, document: nil, errors: nil, type: nil, created: nil)
+      attr_reader :id, :request, :errors, :type, :created
+      def initialize(id: nil, request: nil, errors: nil, type: nil, created: nil)
         super(id)
-        @document = document
+        @request = request
         @errors = errors
         @type = type
         @created = StarkCore::Utils::Checks.check_datetime(created)
       end
 
-      # # Retrieve a specific IndividualDocument::Log
+      # # Retrieve a specific BusinessAccountRequest::Log
       #
-      # Receive a single IndividualDocument::Log object previously created by the Stark Infra API by passing its id
+      # Receive a single BusinessAccountRequest::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -38,58 +39,57 @@ module StarkInfra
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
-      # - IndividualDocument::Log object with updated attributes
+      # - BusinessAccountRequest::Log object with updated attributes
       def self.get(id, user: nil)
         StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
-      # # Retrieve IndividualDocument::Logs
+      # # Retrieve BusinessAccountRequest::Logs
       #
-      # Receive a generator of IndividualDocument::Log objects previously created in the Stark Infra API
+      # Receive a generator of BusinessAccountRequest::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', 'canceled', 'processing', 'failed', 'success']
-      # - document_ids [list of strings, default nil]: list of IndividualDocument ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - types [list of strings, default nil]: filter for log event types. ex: ['created', 'processing', 'approved', 'denied', 'failed']
+      # - account_request_ids [list of strings, default nil]: list of BusinessAccountRequest 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 IndividualDocument::Log objects with updated attributes
-      def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, document_ids: nil, user: nil)
+      # - generator of BusinessAccountRequest::Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, account_request_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,
-          document_ids: document_ids,
+          account_request_ids: account_request_ids,
           user: user,
           **resource
         )
       end
 
-      # # Retrieve paged IndividualDocument::Logs
+      # # Retrieve paged BusinessAccountRequest::Logs
       #
-      # Receive a list of up to 100 IndividualDocument::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 documents.
+      # Receive a list of up to 100 BusinessAccountRequest::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
+      # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 50
       # - 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', 'canceled', 'processing', 'failed', 'success']
-      # - document_ids [list of strings, default nil]: list of document ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - types [list of strings, default nil]: filter for log event types. ex: ['created', 'processing', 'approved', 'denied', 'failed']
+      # - account_request_ids [list of strings, default nil]: list of BusinessAccountRequest 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 IndividualDocument::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, document_ids: nil, user: nil)
+      # - list of BusinessAccountRequest::Log objects with updated attributes
+      # - cursor to retrieve the next page of BusinessAccountRequest::Log objects
+      def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, account_request_ids: nil, user: nil)
         after = StarkCore::Utils::Checks.check_date(after)
         before = StarkCore::Utils::Checks.check_date(before)
         StarkInfra::Utils::Rest.get_page(
@@ -98,20 +98,20 @@ module StarkInfra
           after: after,
           before: before,
           types: types,
-          document_ids: document_ids,
+          account_request_ids: account_request_ids,
           user: user,
           **resource
         )
       end
 
       def self.resource
-        request_maker = StarkInfra::IndividualDocument.resource[:resource_maker]
+        request_maker = StarkInfra::BusinessAccountRequest.resource[:resource_maker]
         {
-          resource_name: 'IndividualDocumentLog',
+          resource_name: 'BusinessAccountRequestLog',
           resource_maker: proc { |json|
             Log.new(
               id: json['id'],
-              document: StarkCore::Utils::API.from_api_json(request_maker, json['document']),
+              request: StarkCore::Utils::API.from_api_json(request_maker, json['request']),
               errors: json['errors'],
               type: json['type'],
               created: json['created']

data/lib/business_attachment/business_attachment.rb

@@ -16,7 +16,7 @@ module StarkInfra
   #
   # ## Parameters (required):
   # - name [string]: name of the BusinessAttachment. ex: "articles-of-incorporation.pdf"
-  # - content [string]: Base64 data url of the file or its raw bytes. ex: data:application/pdf;base64,JVBERi0xLjQ...
+  # - content [string]: Base64 data url of the file or its raw bytes on creation; when retrieved via get, populated only when expand: ['content'] is passed, nil otherwise. ex: data:application/pdf;base64,JVBERi0xLjQ...
   # - business_identity_id [string]: Unique id of BusinessIdentity. ex: "5656565656565656"
   #
   # ## Parameters (optional):
@@ -52,7 +52,10 @@ module StarkInfra
 
     # # Create BusinessAttachments
     #
-    # Send a list of BusinessAttachment objects for creation at the Stark Infra API
+    # Send a list of BusinessAttachment objects for creation at the Stark Infra API. Limit of 1 attachment per
+    # request and 2 attachments per identity. Only PDF, JPG and PNG files are accepted, up to 8 MB each; name
+    # must be unique among the identity's other 'created' attachments; the identity must be in 'created'/'pending'
+    # status with fewer than 2 attachments already.
     #
     # ## Parameters (required):
     # - attachments [list of BusinessAttachment objects]: list of BusinessAttachment objects to be created in the API.
@@ -149,7 +152,7 @@ module StarkInfra
 
     # # Cancel a BusinessAttachment entity
     #
-    # Cancel a BusinessAttachment entity previously created in the Stark Infra API
+    # Cancel a BusinessAttachment entity previously created in the Stark Infra API. Only attachments in 'created' status can be canceled.
     #
     # ## Parameters (required):
     # - id [string]: BusinessAttachment unique id. ex: '5656565656565656'

data/lib/business_identity/business_identity.rb

@@ -26,7 +26,7 @@ module StarkInfra
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the BusinessIdentity is created. ex: "5656565656565656"
   # - name [string]: company's full name. ex: "Stark Bank S.A."
-  # - tax_id_status [string]: current status of the tax ID. ex: "active"
+  # - tax_id_status [string]: bureau status of the CNPJ, normalized from the Receita Federal value. Options: 'active' (ATIVA), 'blocked' (SUSPENSA), 'pending' (INAPTA), 'canceled' (BAIXADA), 'voided' (NULA).
   # - insight_tax_id [string]: tax ID returned by the validation insight. ex: "20018183000180"
   # - insight_document_type [string]: document type returned by the validation insight. ex: "cnpj"
   # - num_pages [integer]: number of pages of the attached documents. ex: 3
@@ -60,7 +60,9 @@ module StarkInfra
 
     # # Create BusinessIdentities
     #
-    # Send a list of BusinessIdentity objects for creation at the Stark Infra API
+    # Send a list of BusinessIdentity objects for creation at the Stark Infra API. Each entry is created in
+    # 'pending' status. The CNPJ must be valid, active in the official bureau, and return non-empty
+    # representatives (sócios), or the request fails.
     #
     # ## Parameters (required):
     # - identities [list of BusinessIdentity objects]: list of BusinessIdentity objects to be created in the API.
@@ -166,7 +168,7 @@ module StarkInfra
     # - id [string]: BusinessIdentity unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - status [string, default nil]: You may send BusinessAttachments to validation by passing 'processing' in the status
+    # - status [string, default nil]: only 'processing' is accepted, triggering the AI Model analysis. The identity must be in 'created'/'pending' status and already have at least one BusinessAttachment associated with it.
     # - tags [list of strings, default nil]: list of strings for reference when searching for BusinessIdentities. ex: ["employees", "monthly"]
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
     #
@@ -184,7 +186,8 @@ module StarkInfra
 
     # # Cancel a BusinessIdentity entity
     #
-    # Cancel a BusinessIdentity entity previously created in the Stark Infra API
+    # Cancel a BusinessIdentity entity previously created in the Stark Infra API. Only identities in 'created'
+    # or 'pending' status can be canceled.
     #
     # ## Parameters (required):
     # - id [string]: BusinessIdentity unique id. ex: '5656565656565656'

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.