starkinfra 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 407cfd041d62916d22344d376a24ff392b4ef1fcf38cf3ae1c6ab38f01916e3a
-  data.tar.gz: 29d6b4e29af482ce49862a6e77eb72c570bad1844e66fcf1171f6148497179ec
+  metadata.gz: 84494554057a87004d3c53122b4212049553964d4aae5a06b7045c104debbe61
+  data.tar.gz: 227df256622a80f1e2e827c8aef4b7363a0307abb2f727b9ee82876dc942cef1
 SHA512:
-  metadata.gz: d4a549b1f028df0b976c790587c5f7c3989a5290f356e93816aa6051537241f6a490617c5cd19fabf6755ec31ec9a085b1049907d2b6df35d342def6e0b065b8
-  data.tar.gz: 22556e362fb270328d57d12875797961ecb06bf87f2e19a15fa6a37b598c4d37fe76209f0a9be93289ce68c0e6c82f63fc6156745b93eb662403bb73671f618a
+  metadata.gz: 7f077615c40b5066952932e8b771838665c203d6d4d238486abd4e2d07eba832da4a69b9610e086f525d7c38f499e1613275bdc7944d9d340d7d489fa2472637
+  data.tar.gz: 0e646b2ec34f440339c48dd368e761d30e26a1edea765ee034b89816888135465e11d49b66bb812cb458520117d67af57356f41cfd33f2f0dbc50d8a2b2be8a7

data/lib/brcodepreview/brcodepreview.rb

@@ -10,12 +10,12 @@ module StarkInfra
   #
   # A BrcodePreview is used to get information from a BR Code you received to check the information before paying it.
   #
-  # When you initialize a BrcodePreview, 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):
+  # Parameters (required):
   # - id [string]: BR Code string for the Pix payment. This is also de information directly encoded in a QR Code. ex: '00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A'
+  # - payer_id [string]: tax id (CPF/CNPJ) of the individual or business requesting the PixKey information. This id is used by the Central Bank to limit request rates. ex: "20.018.183/0001-80"
+  #
+  # Parameters (optional):
+  # - end_to_end_id [string]: central bank's unique transaction ID. ex: "E79457883202101262140HHX553UPqeq"
   #
   # Attributes (return-only):
   # - account_number [string]: Payment receiver account number. ex: '1234567'
@@ -39,16 +39,18 @@ module StarkInfra
   # - status [string]: Payment status. ex: 'active', 'paid', 'canceled' or 'unknown'
   # - tax_id [string]: Payment receiver tax ID. ex: '012.345.678-90'
   class BrcodePreview < StarkInfra::Utils::Resource
-    attr_reader :id, :account_number, :account_type, :amount, :amount_type, :bank_code, :branch_code, :cash_amount,
+    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, :tax_id
     def initialize(
-      id:, account_number: nil, account_type: nil, amount: nil, amount_type: nil, bank_code: nil,
+      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, tax_id: nil
     )
       super(id)
+      @payer_id = payer_id
+      @end_to_end_id = end_to_end_id
       @account_number = account_number
       @account_type = account_type
       @amount = amount
@@ -60,8 +62,8 @@ module StarkInfra
       @cashier_type = cashier_type
       @discount_amount = discount_amount
       @fine_amount = fine_amount
-      @key_id = key_id
       @interest_amount = interest_amount
+      @key_id = key_id
       @name = name
       @nominal_amount = nominal_amount
       @reconciliation_id = reconciliation_id
@@ -93,6 +95,8 @@ module StarkInfra
         resource_maker: proc { |json|
           BrcodePreview.new(
             id: json['id'],
+            payer_id: json['payer_id'],
+            end_to_end_id: json['end_to_end_id'],
             account_number: json['account_number'],
             account_type: json['account_type'],
             amount: json['amount'],

data/lib/cardmethod/cardmethod.rb

@@ -27,7 +27,7 @@ module StarkInfra
     # Receive a generator of CardMethod objects available in the Stark Infra API
     #
     # ## Parameters (optional):
-    # - search [string, default nil]: keyword to search for code, name, number or short_code. ex: 'token'
+    # - search [string, default nil]: keyword to search for code, name, number or short_code
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
     #
     # ## Return:

data/lib/creditholmes/creditholmes.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+require_relative('../utils/parse')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
+
+module StarkInfra
+  # # CreditHolmes object
+  #
+  # CreditHolmes are used to obtain debt information on your customers.
+  # Before you create a CreditHolmes, make sure you have your customer's express
+  # authorization to verify their information in the Central Bank's SCR.
+  #
+  # When you initialize a CreditHolmes, 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):
+  # - tax_id [string]: customer's tax ID (CPF or CNPJ) for whom the credit operations will be verified. ex: "20.018.183/0001-80"
+  #
+  # ## Parameters (optional):
+  # - competence [string, default 'two months before current date']: competence month of the operation verification, format: "YYYY-MM". ex: "2021-04"
+  # - tags [list of strings, default []]: list of strings for reference when searching for CreditHolmes. ex: ["credit", "operation"]
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the CreditHolmes is created. ex: "5656565656565656"
+  # - result [dictionary]: result of the investigation after the case is solved.
+  # - status [string]: current status of the CreditHolmes. ex: "created", "failed", "success"
+  # - created [DateTime]: creation datetime for the CreditHolmes. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the CreditHolmes. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class CreditHolmes < StarkInfra::Utils::Resource
+    attr_reader :tax_id, :competence, :tags, :id, :result, :status, :updated, :created
+    def initialize(tax_id:, competence: nil, tags: nil, id: nil, result: nil, status: nil, updated: nil, created: nil)
+      super(id)
+      @tax_id = tax_id
+      @competence = competence
+      @tags = tags
+      @id = id
+      @result = result
+      @status = status
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create CreditHolmes
+    #
+    # Send a list of CreditHolmes objects for creation at the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - holmes [list of CreditHolmes objects]: list of CreditHolmes 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 CreditHolmes object with updated attributes
+    def self.create(holmes, user: nil)
+      StarkInfra::Utils::Rest.post(entities: holmes, user: user, **resource)
+    end
+
+    # # Retrieve a specific CreditHolmes
+    #
+    # Receive a single CreditHolmes 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:
+    # - CreditHolmes object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve CreditHolmes
+    #
+    # Receive a generator of CreditHolmes 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", "failed", "success"
+    # - 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 CreditHolmes objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil)
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve CreditHolmes
+    #
+    # Receive a list of up to 100 CreditHolmes 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)
+    # - status [list of strings, default nil]: filter for status of retrieved objects. ex: "created", "failed", "success"
+    # - 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 CreditHolmes objects with updated attributes
+    # - cursor to retrieve the next page of CreditHolmes objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil)
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'CreditHolmes',
+        resource_maker: proc { |json|
+          CreditHolmes.new(
+            tax_id: json['tax_id'],
+            competence: json['competence'],
+            tags: json['tags'],
+            id: json['id'],
+            result: json['result'],
+            status: json['status'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/creditnote/creditnote.rb

@@ -22,7 +22,6 @@ module StarkInfra
   # - template_id [string]: ID of the contract template on which the credit note will be based. ex: '0123456789101112'
   # - 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'
-  # - 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)
   # - invoices [list of CreditNote::Invoice objects]: list of Invoice objects to be created and sent to the credit receiver. ex: [Invoice.new(), Invoice.new()]
   # - payment [CreditNote::Transfer object]: payment entity to be created and sent to the credit receiver. ex: Transfer.new()
@@ -37,6 +36,8 @@ module StarkInfra
   #
   # ## Parameters (conditionally required):
   # - payment_type [string]: payment type, inferred from the payment parameter if it is not a hash. ex: 'transfer'
+  # - nominal_amount [integer]: CreditNote value in cents. The nominal_amount parameter is required when amount is not sent. ex: 1234 (= R$ 12.34)
+  # - amount [integer]: amount in cents transferred to the credit receiver, before deductions. The amount parameter is required when nominal_amount is not sent. ex: 1234 (= R$ 12.34)
   #
   # ## Parameters (optional):
   # - rebate_amount [integer, default nil]: credit analysis fee deducted from lent amount. ex: 11234 (= R$ 112.34)
@@ -45,7 +46,6 @@ module StarkInfra
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the CreditNote is created. ex: '5656565656565656'
-  # - amount [integer]: CreditNote value in cents. ex: 1234 (= R$ 12.34)
   # - document_id [string]: ID of the signed document to execute this CreditNote. ex: '4545454545454545'
   # - status [string]: current status of the CreditNote. ex: 'canceled', 'created', 'expired', 'failed', 'processing', 'signed', 'success'
   # - transaction_ids [list of strings]: ledger transaction ids linked to this CreditNote. ex: ['19827356981273']
@@ -56,14 +56,14 @@ module StarkInfra
   # - 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 < StarkInfra::Utils::Resource
-    attr_reader :template_id, :name, :tax_id, :nominal_amount, :scheduled, :invoices, :payment, :signers, :external_id,
-                :street_line_1, :street_line_2, :district, :city, :state_code, :zip_code, :payment_type, :rebate_amount,
-                :tags, :expiration, :id, :amount, :document_id, :status, :transaction_ids, :workspace_id, :tax_amount,
-                :nominal_interest, :interest, :created, :updated
+    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
     def initialize(
-      template_id:, name:, tax_id:, nominal_amount:, scheduled:, invoices:, payment:,
-      signers:, external_id:, street_line_1:, street_line_2:, district:, city:, state_code:, zip_code:,
-      payment_type: nil, rebate_amount: nil, tags: nil, expiration: nil, id: nil, amount: nil,
+      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,
       document_id: nil, status: nil, transaction_ids: nil, workspace_id: nil, tax_amount: nil,
       nominal_interest: nil, interest: nil, created: nil, updated: nil
     )
@@ -71,7 +71,6 @@ module StarkInfra
       @template_id = template_id
       @name = name
       @tax_id = tax_id
-      @nominal_amount = nominal_amount
       @scheduled = scheduled
       @invoices = Invoice.parse_invoices(invoices)
       @signers = CreditSigner.parse_signers(signers)
@@ -82,9 +81,10 @@ module StarkInfra
       @city = city
       @state_code = state_code
       @zip_code = zip_code
+      @nominal_amount = nominal_amount
+      @amount = amount
       @rebate_amount = rebate_amount
       @tags = tags
-      @amount = amount
       @expiration = expiration
       @document_id = document_id
       @status = status
@@ -141,7 +141,7 @@ module StarkInfra
     # - 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 [string, default nil]: filter for status of retrieved objects. ex: 'success' or 'failed'
+    # - status [string, default nil]: filter for status of retrieved objects. ex: ["canceled", "created", "expired", "failed", "processing", "signed", "success"]
     # - 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
@@ -173,7 +173,7 @@ module StarkInfra
     # - 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)
-    # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
+    # - status [string, default nil]: filter for status of retrieved objects. ex: ["canceled", "created", "expired", "failed", "processing", "signed", "success"]
     # - 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
@@ -197,9 +197,9 @@ module StarkInfra
       )
     end
 
-    # # Cancel a specific CreditNote
+    # # Cancel a CreditNote entity
     #
-    # Cancel a single CreditNote object previously created in the Stark Infra API by passing its id
+    # Cancel a CreditNote entity previously created in the Stark Infra API
     #
     # ## Parameters (required):
     # - id [string]: object unique id. ex: '5656565656565656'
@@ -208,7 +208,7 @@ module StarkInfra
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - canceled CreditNote object with updated attributes
+    # - canceled CreditNote object
     def self.cancel(id, user: nil)
       StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
     end
@@ -245,7 +245,6 @@ module StarkInfra
             template_id: json['template_id'],
             name: json['name'],
             tax_id: json['tax_id'],
-            nominal_amount: json['nominal_amount'],
             scheduled: json['scheduled'],
             invoices: json['invoices'],
             payment: json['payment'],
@@ -258,15 +257,17 @@ module StarkInfra
             state_code: json['state_code'],
             zip_code: json['zip_code'],
             payment_type: json['payment_type'],
+            nominal_amount: json['nominal_amount'],
+            amount: json['amount'],
             rebate_amount: json['rebate_amount'],
             tags: json['tags'],
             expiration: json['expiration'],
-            amount: json['amount'],
             document_id: json['document_id'],
             status: json['status'],
             transaction_ids: json['transaction_ids'],
             workspace_id: json['workspace_id'],
             tax_amount: json['tax_amount'],
+            nominal_interest: json['nominal_interest'],
             interest: json['interest'],
             created: json['created'],
             updated: json['updated']

data/lib/creditnote/invoice/discount.rb

@@ -11,7 +11,7 @@ module StarkInfra
   # Invoice discount information.
   #
   # ## Parameters (required):
-  # - percentage [float]: percentage of discount applied until specified due date. ex: 2.5
+  # - percentage [float]: percentage of discount applied until specified due date.
   # - due [DateTime or string]: due datetime for the discount. ex: '2020-03-10T10:30:00.000000+00:00' or DateTime.new(2020, 3, 10, 10, 30, 0, 0).
   class Discount < StarkInfra::Utils::SubResource
     attr_reader :percentage, :due

data/lib/creditnote/invoice/invoice.rb

@@ -7,15 +7,16 @@ require_relative('../../utils/sub_resource')
 module StarkInfra
 
   # CreditNote::Invoice object
-  # Invoice object to be issued after contract signature and paid by the credit receiver.
+  #
+  # Invoice issued after the contract is signed, to be paid by the credit receiver.
   #
   # ## Parameters (required):
   # - amount [integer]: Invoice value in cents. Minimum = 1 (any value will be accepted). ex: 1234 (= R$ 12.34)
   #
   # ## Parameters (optional):
   # - due [DateTime, Date or string, default now + 2 days]: Invoice due date in UTC ISO format. DateTime.new(2020, 3, 10, 10, 30, 0, 0) for immediate invoices and '2020-10-28' for scheduled invoices
-  # - expiration [integer, default 604800]: time interval in seconds between scheduled date and expiration date. ex 123456789
-  # - tags [list of strings, default nil]: list of strings for tagging. ex: tags=['employees', 'monthly']
+  # - expiration [integer, default 604800]: time interval in seconds between scheduled date and expiration date. ex: 123456789
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['employees', 'monthly']
   # - descriptions [list of CreditNote::Invoice::Description objects or hash, default nil]: list Description objects. ex: [Description.new()]
   #
   # ## Attributes (return-only):

data/lib/creditnote/log.rb

@@ -13,25 +13,25 @@ module StarkInfra
     # is generated for the entity. This log is never generated by the
     # user.
     #
-    # ## Attributes:
+    # ## 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 CreditNote event which triggered the log creation. Options: 'canceled', 'created', 'expired', 'failed', 'refunded', 'registered', 'sending', 'sent', 'signed', 'success'
-    # - errors [list of strings]: list of errors linked to this CreditNote event.
     # - note [CreditNote]: CreditNote entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this CreditNote event.
+    # - type [string]: type of the CreditNote event which triggered the log creation. Options: 'canceled', 'created', 'expired', 'failed', 'refunded', 'registered', 'sending', 'sent', 'signed', 'success'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
     class Log < StarkInfra::Utils::Resource
       attr_reader :id, :created, :type, :errors, :note
       def initialize(id:, created:, type:, errors:, note:)
         super(id)
-        @created = StarkInfra::Utils::Checks.check_datetime(created)
-        @type = type
-        @errors = errors
         @note = note
+        @errors = errors
+        @type = type
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific CreditNote::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single CreditNote::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -45,12 +45,11 @@ module StarkInfra
         StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
-      # # Retrieve Logs
+      # # Retrieve CreditNote::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of CreditNote::Log objects previously created in the Stark Infra API
       #
       # ## Parameters (optional):
-      # - ids [list of strings, default nil]: Log ids to filter PixKey Logs. ex: ['5656565656565656']
       # - 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)
@@ -74,9 +73,9 @@ module StarkInfra
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged CreditNote::Logs
       #
-      # Receive a list of up to 100 Log objects previously created in the Stark Infra API and the cursor to the next page.
+      # Receive a list of up to 100 CreditNote::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 notes.
       #
       # ## Parameters (optional):
@@ -113,10 +112,10 @@ module StarkInfra
           resource_maker: proc { |json|
             Log.new(
               id: json['id'],
-              created: json['created'],
-              type: json['type'],
+              note: StarkInfra::Utils::API.from_api_json(note_maker, json['note']),
               errors: json['errors'],
-              note: StarkInfra::Utils::API.from_api_json(note_maker, json['note'])
+              type: json['type'],
+              created: json['created']
             )
           }
         }

data/lib/creditpreview/creditpreview.rb

@@ -10,15 +10,9 @@ module StarkInfra
   # A CreditPreview is used to get information from a credit before taking it.
   # This resource can be used to preview credit notes.
   #
-  # When you initialize a CreditPreview, 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):
-  # - credit [CreditNotePreview object or hash]: Information preview of the informed credit.
-  #
-  # ## Parameters (conditionally required):
-  # - type [string]: Credit type, inferred from the payment parameter if it is not a dictionary. ex: 'credit-note'
+  # - credit [CreditNotePreview object]: Information preview of the informed credit.
+  # - type [string]: Credit type. ex: "credit-note"
   class CreditPreview < StarkInfra::Utils::SubResource
     attr_reader :credit, :type
     def initialize(credit:, type: nil)

data/lib/dynamicbrcode/dynamicbrcode.rb

@@ -61,7 +61,7 @@ module StarkInfra
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
     #
     # ## Return:
-    # - DynamicBrcode object with updated attributes
+    # - list of DynamicBrcode objects with updated attributes
     def self.create(brcodes, user: nil)
       StarkInfra::Utils::Rest.post(entities: brcodes, user: user, **resource)
     end
@@ -167,9 +167,9 @@ module StarkInfra
     # - receiver_city [string]: receiver's address city name. ex: "Sao Paulo"
     # - receiver_state_code [string]: receiver's address state code. ex: "SP"
     # - receiver_zip_code [string]: receiver's address zip code. ex: "01234-567"
-    # - expiration [integer]: time in seconds counted from the creation datetime until the DynamicBrcode expires. After expiration, the BR Code cannot be paid anymore.
     #
     # ## Parameters (optional):
+    # - expiration [integer]: time in seconds counted from the creation datetime until the DynamicBrcode expires. After expiration, the BR Code cannot be paid anymore.
     # - sender_tax_id [string, default nil]: sender's CPF (11 digits formatted or unformatted) or CNPJ (14 digits formatted or unformatted). ex: '01.001.001/0001-01'
     # - receiver_tax_id [string, default nil]: receiver's CPF (11 digits formatted or unformatted) or CNPJ (14 digits formatted or unformatted). ex: '012.345.678-90'
     # - fine [float, default 2.0]: Percentage charged if the sender pays after the due datetime. ex. 2.0
@@ -225,13 +225,13 @@ module StarkInfra
     # - status [string]: BR Code status. Options: 'created', 'overdue', 'paid', 'canceled' or 'expired'
     # - reconciliation_id [string]: id to be used for conciliation of the resulting Pix transaction. This id must have from to 26 to 35 alphanumeric characters' ex: "cd65c78aeb6543eaaa0170f68bd741ee"
     # - amount [integer]: positive integer that represents the amount in cents of the resulting Pix transaction. ex: 1234 (= R$ 12.34)
-    # - expiration [integer]: time in seconds counted from the creation datetime until the DynamicBrcode expires. After expiration, the BR Code cannot be paid anymore. ex: 123456789
     #
     # ## Parameters (required):
     # - cashier_type [string, default nil]: cashier's type. Required if the cashAmount is different from 0. Options: 'merchant', 'participant' and 'other'
     # - cashier_bank_code [string, default nil]: cashier's bank code. Required if the cash_amount is different from 0. ex: '20018183'
     #
     # ## Parameters (optional):
+    # - expiration [integer, default nil]: time in seconds counted from the creation datetime until the DynamicBrcode expires. After expiration, the BR Code cannot be paid anymore. ex: 123456789
     # - cash_amount [integer, default nil]: amount to be withdrawn from the cashier in cents. ex: 1000 (= R$ 10.00)
     # - sender_name [string, default nil]: sender's full name. ex: 'Anthony Edward Stark'
     # - sender_tax_id [string, default nil]: sender's CPF (11 digits formatted or unformatted) or CNPJ (14 digits formatted or unformatted). ex: '01.001.001/0001-01'

data/lib/event/attempt.rb

@@ -12,7 +12,7 @@ module StarkInfra
     # When an Event delivery fails, an event attempt will be registered.
     # It carries information meant to help you debug event reception issues.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - id [string]: unique id that identifies the delivery attempt. ex: '5656565656565656'
     # - code [string]: delivery error code. ex: badHttpStatus, badConnection, timeout
     # - message [string]: delivery error full description. ex: 'HTTP POST request returned status 404'

data/lib/event/event.rb

@@ -18,7 +18,7 @@ module StarkInfra
   # Events cannot be created, but may be retrieved from the Stark Infra API to
   # list all generated updates on entities.
   #
-  # ## Attributes:
+  # ## Attributes (return-only):
   # - id [string]: unique id returned when the event is created. ex: '5656565656565656'
   # - log [Log]: a Log object from one the subscription services (PixRequestLog, PixReversalLog)
   # - created [DateTime]: creation datetime for the notification event. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)