starkinfra 0.0.1 → 0.1.0

data/lib/pixrequest/pixrequest.rb

@@ -14,42 +14,45 @@ module StarkInfra
   #
   # ## Parameters (required):
   # - amount [integer]: amount in cents to be transferred. ex: 11234 (= R$ 112.34)
-  # - external_id [string]: url safe string that must be unique among all your PixRequests. Duplicated external ids will cause failures. By default, this parameter will block any PixRequests that repeats amount and receiver information on the same date. ex: "my-internal-id-123456"
-  # - sender_name [string]: sender full name. ex: "Anthony Edward Stark"
-  # - sender_tax_id [string]: sender tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
-  # - sender_branch_code [string]: sender bank account branch code. Use '-' in case there is a verifier digit. ex: "1357-9"
-  # - sender_account_number [string]: sender bank account number. Use '-' before the verifier digit. ex: "876543-2"
-  # - sender_account_type [string, default "checking"]: sender bank account type. ex: "checking", "savings", "salary" or "payment"
-  # - receiver_name [string]: receiver full name. ex: "Anthony Edward Stark"
-  # - receiver_tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
-  # - receiver_bank_code [string]: code of the receiver bank institution in Brazil. ex: "20018183" or "341"
-  # - receiver_account_number [string]: receiver bank account number. Use '-' before the verifier digit. ex: "876543-2"
-  # - receiver_branch_code [string]: receiver bank account branch code. Use '-' in case there is a verifier digit. ex: "1357-9"
-  # - receiver_account_type [string]: receiver bank account type. ex: "checking", "savings", "salary" or "payment"
-  # - end_to_end_id [string]: central bank's unique transaction ID. ex: "E79457883202101262140HHX553UPqeq"
+  # - external_id [string]: url safe string that must be unique among all your PixRequests. Duplicated external ids will cause failures. By default, this parameter will block any PixRequests that repeats amount and receiver information on the same date. ex: 'my-internal-id-123456'
+  # - sender_name [string]: sender full name. ex: 'Anthony Edward Stark'
+  # - sender_tax_id [string]: sender tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  # - sender_branch_code [string]: sender bank account branch code. Use '-' in case there is a verifier digit. ex: '1357-9'
+  # - sender_account_number [string]: sender bank account number. Use '-' before the verifier digit. ex: '876543-2'
+  # - sender_account_type [string, default 'checking']: sender bank account type. ex: 'checking', 'savings', 'salary' or 'payment'
+  # - receiver_name [string]: receiver full name. ex: 'Anthony Edward Stark'
+  # - receiver_tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  # - receiver_bank_code [string]: code of the receiver bank institution in Brazil. ex: '20018183' or '341'
+  # - receiver_account_number [string]: receiver bank account number. Use '-' before the verifier digit. ex: '876543-2'
+  # - receiver_branch_code [string]: receiver bank account branch code. Use '-' in case there is a verifier digit. ex: '1357-9'
+  # - receiver_account_type [string]: receiver bank account type. ex: 'checking', 'savings', 'salary' or 'payment'
+  # - end_to_end_id [string]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
   #
   # ## Parameters (optional):
   # - receiver_key_id [string, default nil]: Receiver's dict key. Example: tax id (CPF/CNPJ).
-  # - description [string, default nil]: optional description to override default description to be shown in the bank statement. ex: "Payment for service #1234"
-  # - reconciliation_id [string, default nil]: Reconciliation ID linked to this payment. ex: "b77f5236-7ab9-4487-9f95-66ee6eaf1781"
-  # - initiator_tax_id [string, default nil]: Payment initiator's tax id (CPF/CNPJ). ex: "01234567890" or "20.018.183/0001-80"
+  # - description [string, default nil]: optional description to override default description to be shown in the bank statement. ex: 'Payment for service #1234'
+  # - reconciliation_id [string, default nil]: Reconciliation ID linked to this payment. ex: 'b77f5236-7ab9-4487-9f95-66ee6eaf1781'
+  # - initiator_tax_id [string, default nil]: Payment initiator's tax id (CPF/CNPJ). ex: '01234567890' or '20.018.183/0001-80'
   # - cash_amount [integer, default nil]: Amount to be withdrawal from the cashier in cents. ex: 1000 (= R$ 10.00)
-  # - cashier_bank_code [string, default nil]: Cashier's bank code. ex: "00000000"
+  # - cashier_bank_code [string, default nil]: Cashier's bank code. ex: '00000000'
   # - cashier_type [string, default nil]: Cashier's type. ex: [merchant, other, participant]
-  # - tags [list of strings, default nil]: list of strings for reference when searching for PixRequests. ex: ["employees", "monthly"]
-  # - method [string]: execution  method of creation of the PIX. ex: "manual", "payerQrcode", "dynamicQrcode".
+  # - tags [list of strings, default nil]: list of strings for reference when searching for PixRequests. ex: ['employees', 'monthly']
+  # - method [string, default nil]: execution  method of creation of the PIX. ex: 'manual', 'payerQrcode', 'dynamicQrcode'.
   #
   # ## Attributes (return-only):
-  # - id [string, default nil]: unique id returned when the PixRequest is created. ex: "5656565656565656"
-  # - fee [integer, default nil]: fee charged when PixRequest is paid. ex: 200 (= R$ 2.00)
-  # - status [string]: current PixRequest status. ex: "registered" or "paid"
-  # - flow [string]: direction of money flow. ex: "in" or "out"
-  # - sender_bank_code [string]: code of the sender bank institution in Brazil. If an ISPB (8 digits) is informed. ex: "20018183" or "341"
-  # - created [Datetime, default nil]: creation datetime for the PixRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - updated [Datetime, default nil]: latest update datetime for the PixRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-
+  # - id [string]: unique id returned when the PixRequest is created. ex: '5656565656565656'
+  # - fee [integer]: fee charged when PixRequest is paid. ex: 200 (= R$ 2.00)
+  # - status [string]: current PixRequest status. ex: 'registered' or 'paid'
+  # - flow [string]: direction of money flow. ex: 'in' or 'out'
+  # - sender_bank_code [string]: code of the sender bank institution in Brazil. ex: '20018183'
+  # - created [DateTime]: creation datetime for the PixRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the PixRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class PixRequest < StarkInfra::Utils::Resource
-    attr_reader :amount, :external_id, :sender_name, :sender_tax_id, :sender_branch_code, :sender_account_number, :sender_account_type, :receiver_name, :receiver_tax_id, :receiver_bank_code, :receiver_account_number, :receiver_branch_code, :receiver_account_type, :end_to_end_id, :receiver_key_id, :sender_bank_code, :status, :reconciliation_id, :description, :flow, :initiator_tax_id, :cash_amount, :cashier_bank_code, :cashier_type, :tags, :created, :updated, :fee, :id
+    attr_reader :amount, :external_id, :sender_name, :sender_tax_id, :sender_branch_code, :sender_account_number,
+                :sender_account_type, :receiver_name, :receiver_tax_id, :receiver_bank_code, :receiver_account_number,
+                :receiver_branch_code, :receiver_account_type, :end_to_end_id, :receiver_key_id, :sender_bank_code,
+                :status, :reconciliation_id, :description, :flow, :initiator_tax_id, :cash_amount, :cashier_bank_code,
+                :cashier_type, :tags, :created, :updated, :fee, :id
     def initialize(
       amount:, external_id:, sender_name:, sender_tax_id:, sender_branch_code:, sender_account_number:, 
       sender_account_type:, receiver_name:, receiver_tax_id:, receiver_bank_code:, receiver_account_number:, 
@@ -97,7 +100,7 @@ module StarkInfra
     # - requests [list of PixRequest objects]: list of PixRequest objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - list of PixRequest objects with updated attributes
@@ -113,7 +116,7 @@ module StarkInfra
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - PixRequest object with updated attributes
@@ -127,23 +130,21 @@ module StarkInfra
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - fields [list of strings, default None]: parameters to be retrieved from PixRequest objects. ex: ["amount", "id"]
-    # - after [Date, DateTime, Time or string, default nil]: date filter for objects created or updated only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, DateTime, Time or string, default nil]: date filter for objects created or updated only before specified date. ex: Date.new(2020, 3, 10)
+    # - 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'
     # - 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']
-    # - end_to_end_ids [list of strings, default None]: central bank's unique transaction IDs. ex: ["E79457883202101262140HHX553UPqeq", "E79457883202101262140HHX553UPxzx"]
-    # - external_ids [list of strings, default None]: url safe strings that must be unique among all your PixRequests. Duplicated external IDs will cause failures. By default, this parameter will block any PixRequests that repeats amount and receiver information on the same date. ex: ["my-internal-id-123456", "my-internal-id-654321"]
-    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    # - end_to_end_ids [list of strings, default nil]: central bank's unique transaction IDs. ex: ['E79457883202101262140HHX553UPqeq', 'E79457883202101262140HHX553UPxzx']
+    # - external_ids [list of strings, default nil]: url safe strings that must be unique among all your PixRequests. Duplicated external IDs will cause failures. By default, this parameter will block any PixRequests that repeats amount and receiver information on the same date. ex: ['my-internal-id-123456', 'my-internal-id-654321']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - generator of PixRequest objects with updated attributes
-    def self.query(fields: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, end_to_end_ids: nil, external_ids: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, end_to_end_ids: nil, external_ids: nil, user: nil)
       after = StarkInfra::Utils::Checks.check_date(after)
       before = StarkInfra::Utils::Checks.check_date(before)
       StarkInfra::Utils::Rest.get_stream(
-        fields: fields,
         limit: limit,
         after: after,
         before: before,
@@ -164,26 +165,24 @@ module StarkInfra
     #
     # ## Parameters (optional):
     # - cursor [string, default nil]: cursor returned on the previous page function call
-    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - fields [list of strings, default None]: parameters to be retrieved from PixRequest objects. ex: ["amount", "id"]
-    # - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - 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'
     # - 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']
-    # - end_to_end_ids [list of strings, default None]: central bank's unique transaction IDs. ex: ["E79457883202101262140HHX553UPqeq", "E79457883202101262140HHX553UPxzx"]
-    # - external_ids [list of strings, default None]: url safe strings that must be unique among all your PixRequests. Duplicated external IDs will cause failures. By default, this parameter will block any PixRequests that repeats amount and receiver information on the same date. ex: ["my-internal-id-123456", "my-internal-id-654321"]
-    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    # - end_to_end_ids [list of strings, default nil]: central bank's unique transaction IDs. ex: ['E79457883202101262140HHX553UPqeq', 'E79457883202101262140HHX553UPxzx']
+    # - external_ids [list of strings, default nil]: url safe strings that must be unique among all your PixRequests. Duplicated external IDs will cause failures. By default, this parameter will block any PixRequests that repeats amount and receiver information on the same date. ex: ['my-internal-id-123456', 'my-internal-id-654321']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - list of PixRequest objects with updated attributes
-    # - Cursor to retrieve the next page of PixRequest objects
-    def self.page(cursor: nil, fields: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, end_to_end_ids: nil, external_ids: nil, user: nil)
+    # - cursor to retrieve the next page of PixRequest objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, end_to_end_ids: nil, external_ids: nil, user: nil)
       after = StarkInfra::Utils::Checks.check_date(after)
       before = StarkInfra::Utils::Checks.check_date(before)
-      return StarkInfra::Utils::Rest.get_page(
+      StarkInfra::Utils::Rest.get_page(
         cursor: cursor,
-        fields: fields,
         limit: limit,
         after: after,
         before: before,
@@ -197,24 +196,24 @@ module StarkInfra
       )
     end
 
+    # # Create single verified PixRequest object from a content string
+    #
+    # Create a single PixRequest object from a content string received from a handler listening at a subscribed user endpoint.
+    # If the provided digital signature does not check out with the StarkInfra public key, a
+    # StarkInfra.Error.InvalidSignatureError will be raised.
+    #
+    # ## Parameters (required):
+    # - content [string]: response content from request received at user endpoint (not parsed)
+    # - signature [string]: base-64 digital signature received at response header 'Digital-Signature'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - Parsed PixRequest object
     def self.parse(content:, signature:, user: nil)
-      # # Create single verified PixRequest object from a content string
-      # 
-      # Create a single PixRequest object from a content string received from a handler listening at a subscribed user endpoint.
-      # If the provided digital signature does not check out with the StarkInfra public key, a
-      # starkinfra.exception.InvalidSignatureException will be raised.
-      # 
-      # ## Parameters (required):
-      # - content [string]: response content from request received at user endpoint (not parsed)
-      # - signature [string]: base-64 digital signature received at response header "Digital-Signature"
-      # 
-      # ## Parameters (optional):
-      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
-      # 
-      # ## Return:
-      # - Parsed PixRequest object
-      return StarkInfra::Utils::Parse.parse_and_verify(content: content, signature: signature, user: user, resource: resource)
-    end      
+      StarkInfra::Utils::Parse.parse_and_verify(content: content, signature: signature, user: user, resource: resource)
+    end
 
     def self.resource
       {
@@ -250,7 +249,7 @@ module StarkInfra
             method: json['method'],
             sender_bank_code: json['sender_bank_code'],
             created: json['created'],
-            updated: json['updated'],
+            updated: json['updated']
           )
         }
       }

data/lib/pixreversal/log.rb

@@ -37,7 +37,7 @@ module StarkInfra
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -51,14 +51,14 @@ module StarkInfra
       #
       # ## Parameters (optional):
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - 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 retrieved objects by types. ex: 'success' or 'failed'
       # - reversal_ids [list of strings, default nil]: list of PixReversal ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
-      # - list of Log objects with updated attributes
+      # - generator of Log objects with updated attributes
       def self.query(limit: nil, after: nil, before: nil, types: nil, reversal_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
@@ -76,23 +76,24 @@ module StarkInfra
       # # Retrieve paged Logs
       #
       # Receive a list of up to 100 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.
+      # Use this function instead of query if you want to manually page your reversals.
       #
       # ## Parameters (optional):
       # - cursor [string, default nil]: cursor returned on the previous page function call
-      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - 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 retrieved objects by types. ex: 'success' or 'failed'
       # - reversal_ids [list of strings, default nil]: list of PixReversal ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
-      # - list of Log objects with updated attributes and cursor to retrieve the next page of Log objects
+      # - list of Log objects with updated attributes
+      # - cursor to retrieve the next page of Log objects
       def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, reversal_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
-        return StarkInfra::Utils::Rest.get_page(
+        StarkInfra::Utils::Rest.get_page(
           cursor: cursor,
           limit: limit,
           after: after,

data/lib/pixreversal/pixreversal.rb

@@ -5,35 +5,33 @@ require_relative('../utils/rest')
 require_relative('../utils/checks')
 require_relative('../utils/parse')
 
-
 module StarkInfra
   # # PixReversal object
   #
-  # When you initialize a PixReversal, 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.
+  # When you initialize a PixReversal, 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):
   # - amount [integer]: amount in cents to be reversed from PixRequest. ex: 1234 (= R$ 12.34)
-  # - external_id [string]: url safe string that must be unique among all your PixReversals. Duplicated external ids will cause failures. By default, this parameter will block any PixReversal that repeats amount and receiver information on the same date. ex: "my-internal-id-123456"
-  # - end_to_end_id [string]: central bank's unique transaction ID. ex: "E79457883202101262140HHX553UPqeq"
-  # - reason [string]: reason why the PixRequest is being reversed. Options are "bankError", "fraud", "pixWithdrawError", "refund3ByEndCustomer"
+  # - external_id [string]: url safe string that must be unique among all your PixReversals. Duplicated external ids will cause failures. By default, this parameter will block any PixReversal that repeats amount and receiver information on the same date. ex: 'my-internal-id-123456'
+  # - end_to_end_id [string]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
+  # - reason [string]: reason why the PixRequest is being reversed. Options are 'bankError', 'fraud', 'pixWithdrawError', 'refund3ByEndCustomer'
   #
   # ## Parameters (optional):
-  # - tags [string, default nill]: [list of strings]: list of strings for reference when searching for PixReversals. ex: ["employees", "monthly"]
+  # - tags [string, default nil]: [list of strings]: list of strings for reference when searching for PixReversals. ex: ['employees', 'monthly']
   #
   # ## Attributes (return-only):
-  # - id [string, default nil]: unique id returned when the PixReversal is created. ex: "5656565656565656".
-  # - return_id [string]: central bank's unique reversal transaction ID. ex: "D20018183202202030109X3OoBHG74wo".
-  # - bank_code [string]: code of the bank institution in Brazil. ex: "20018183" or "341"
+  # - id [string]: unique id returned when the PixReversal is created. ex: '5656565656565656'.
+  # - return_id [string]: central bank's unique reversal transaction ID. ex: 'D20018183202202030109X3OoBHG74wo'.
+  # - bank_code [string]: code of the bank institution in Brazil. ex: '20018183' or '341'
   # - fee [string]: fee charged by this PixReversal. ex: 200 (= R$ 2.00)
-  # - status [string]: current PixReversal status. ex: "registered" or "paid"
-  # - flow [string]: direction of money flow. ex: "in" or "out"
-  # - created [Datetime, default nil]: creation datetime for the PixReversal. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - updated [Datetime, default nil]: latest update datetime for the PixReversal. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-
+  # - status [string]: current PixReversal status. ex: 'registered' or 'paid'
+  # - flow [string]: direction of money flow. ex: 'in' or 'out'
+  # - created [DateTime]: creation datetime for the PixReversal. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the PixReversal. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class PixReversal < StarkInfra::Utils::Resource;
-    attr_reader :amount, :external_id, :end_to_end_id, :reason, :tags, :id, :return_id, :bank_code, :fee, :status, :flow, :created, :updated
+    attr_reader :amount, :external_id, :end_to_end_id, :reason, :tags, :id, :return_id, :bank_code, :fee,
+                :status, :flow, :created, :updated
     def initialize(
       amount:, external_id:, end_to_end_id:, reason:, tags: nil, id: nil, return_id: nil, bank_code: nil, fee: nil, 
       status: nil, flow: nil, created: nil, updated: nil
@@ -49,68 +47,68 @@ module StarkInfra
       @return_id = return_id
       @bank_code = bank_code
       @fee = fee
-      @staus = status
+      @status = status
       @flow = flow
       @created = created
       @updated = updated
     end
 
-    # # Create PixRversals
+    # # Create PixReversals
     #
-    # Send a list of PixRversal objects for creation in the Stark Infra API
+    # Send a list of PixReversal objects for creation in the Stark Infra API
     #
     # ## Parameters (required):
-    # - reversals [list of PixRversal objects]: list of PixRversal objects to be created in the API
+    # - reversals [list of PixReversal objects]: list of PixReversal objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - list of PixRversal objects with updated attributes
+    # - list of PixReversal objects with updated attributes
     def self.create(reversals, user: nil)
       StarkInfra::Utils::Rest.post(entities: reversals, user: user, **resource)
     end
 
-    # # Retrieve a specific PixRversal
+    # # Retrieve a specific PixReversal
     #
-    # Receive a single PixRversal object previously created in the Stark Bank API by passing its id
+    # Receive a single PixReversal object previously created in the Stark Infra API by passing its id
     #
     # ## Parameters (required):
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - PixRversal object with updated attributes
+    # - PixReversal object with updated attributes
     def self.get(id, user: nil)
       StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
-    # # Retrieve PixRversals
+    # # Retrieve PixReversals
     #
-    # Receive a generator of PixRversal objects previously created in the Stark Infra API
+    # Receive a generator of PixReversal objects previously created in the Stark Infra API
     #
     # ## Parameters (optional):
-    # - fields [list of strings, default None]: parameters to be retrieved from PixRequest objects. ex: ["amount", "id"]
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - after [Date, DateTime, Time or string, default nil]: date filter for objects created or updated only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, DateTime, Time or string, default nil]: date filter for objects created or updated only before specified date. ex: Date.new(2020, 3, 10)
+    # - 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'
     # - 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']
-    # - return_ids [list of strings, default None]: central bank's unique reversal transaction ID. ex: ["D20018183202202030109X3OoBHG74wo", "D20018183202202030109X3OoBHG72rd"].
-    # - external_ids [list of strings, default None]: url safe string that must be unique among all your PixReversals. Duplicated external IDs will cause failures. By default, this parameter will block any PixReversal that repeats amount and receiver information on the same date. ex: ["my-internal-id-123456", "my-internal-id-654321"]
-    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    # - return_ids [list of strings, default nil]: central bank's unique reversal transaction ID. ex: ['D20018183202202030109X3OoBHG74wo', 'D20018183202202030109X3OoBHG72rd'].
+    # - external_ids [list of strings, default nil]: url safe string that must be unique among all your PixReversals. Duplicated external IDs will cause failures. By default, this parameter will block any PixReversal that repeats amount and receiver information on the same date. ex: ['my-internal-id-123456', 'my-internal-id-654321']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - generator of PixRversal objects with updated attributes
-    def self.query(fields:nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, return_ids: nil, external_ids: nil, user: nil)
+    # - generator of PixReversal objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, return_ids: nil, external_ids: nil, user: nil)
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
       StarkInfra::Utils::Rest.get_stream(
-        fields: fields,
         limit: limit,
-        after: StarkInfra::Utils::Checks.check_date(after),
-        before: StarkInfra::Utils::Checks.check_date(before),
+        after: after,
+        before: before,
         status: status,
         tags: tags,
         ids: ids,
@@ -121,29 +119,28 @@ module StarkInfra
       )
     end
 
-    # # Retrieve paged PixRversals
+    # # Retrieve paged PixReversals
     #
-    # Receive a list of up to 100 PixRversal 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.
+    # Receive a list of up to 100 PixReversal 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 reversals.
     #
     # ## Parameters (optional):
     # - cursor [string, default nil]: cursor returned on the previous page function call
-    # - fields [list of strings, default None]: parameters to be retrieved from PixRequest objects. ex: ["amount", "id"]
-    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - 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'
     # - 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']
-    # - return_ids [list of strings, default None]: central bank's unique reversal transaction ID. ex: ["D20018183202202030109X3OoBHG74wo", "D20018183202202030109X3OoBHG72rd"].
-    # - external_ids [list of strings, default None]: url safe string that must be unique among all your PixReversals. Duplicated external IDs will cause failures. By default, this parameter will block any PixReversal that repeats amount and receiver information on the same date. ex: ["my-internal-id-123456", "my-internal-id-654321"]
-    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    # - return_ids [list of strings, default nil]: central bank's unique reversal transaction ID. ex: ['D20018183202202030109X3OoBHG74wo', 'D20018183202202030109X3OoBHG72rd'].
+    # - external_ids [list of strings, default nil]: url safe string that must be unique among all your PixReversals. Duplicated external IDs will cause failures. By default, this parameter will block any PixReversal that repeats amount and receiver information on the same date. ex: ['my-internal-id-123456', 'my-internal-id-654321']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - list of PixRversal objects with updated attributes and cursor to retrieve the next page of PixRversal objects
-    def self.page(cursor: nil, fields:nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, return_ids: nil, external_ids: nil, user: nil)
-      return StarkInfra::Utils::Rest.get_page(
-        fields: fields,
+    # - list of PixReversal objects with updated attributes
+    # - cursor to retrieve the next page of PixReversal objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, return_ids: nil, external_ids: nil, user: nil)
+      StarkInfra::Utils::Rest.get_page(
         cursor: cursor,
         limit: limit,
         after: StarkInfra::Utils::Checks.check_date(after),
@@ -158,24 +155,29 @@ module StarkInfra
       )
     end
 
+    # # Create single verified PixReversal object from a content string
+    #
+    # Create a single PixReversal object from a content string received from a handler listening at a subscribed user endpoint.
+    # If the provided digital signature does not check out with the StarkInfra public key, a
+    # StarkInfra.Error.InvalidSignatureError will be raised.
+    #
+    # ## Parameters (required):
+    # - content [string]: response content from reversal received at user endpoint (not parsed)
+    # - signature [string]: base-64 digital signature received at response header 'Digital-Signature'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - Parsed PixReversal object
     def self.parse(content:, signature:, user: nil)
-      # # Create single verified PixReversal object from a content string
-      # 
-      # Create a single PixReversal object from a content string received from a handler listening at a subscribed user endpoint.
-      # If the provided digital signature does not check out with the StarkInfra public key, a
-      # starkinfra.exception.InvalidSignatureException will be raised.
-      # 
-      # ## Parameters (required):
-      # - content [string]: response content from revrsal received at user endpoint (not parsed)
-      # - signature [string]: base-64 digital signature received at response header "Digital-Signature"
-      # 
-      # ## Parameters (optional):
-      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
-      # 
-      # ## Return:
-      # - Parsed PixReversal object
-      return StarkInfra::Utils::Parse.parse_and_verify(content: content, signature: signature, user: user, resource: resource)
-    end      
+      StarkInfra::Utils::Parse.parse_and_verify(
+        content: content,
+        signature: signature,
+        user: user,
+        resource: resource
+      )
+    end
 
     def self.resource
       {
@@ -194,7 +196,7 @@ module StarkInfra
             status: json['status'],
             flow: json['flow'],
             created: json['created'],
-            updated: json['updated'],
+            updated: json['updated']
           )
         }
       }