starkinfra 0.1.0 → 0.3.0

data/lib/pixkey/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require_relative('pixkey')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
-require_relative('pixkey')
+require_relative('../utils/resource')
 
 module StarkInfra
   class PixKey
@@ -12,25 +12,25 @@ module StarkInfra
     # Every time a PixKey entity is modified, a corresponding PixKey::Log 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)
+    # - key [PixKey]: PixKey entity to which the log refers to.
     # - type [string]: type of the PixKey event which triggered the log creation. Options: 'created', 'registered', 'updated', 'failed', 'canceling', 'canceled'.
     # - errors [list of strings]: list of errors linked to this PixKey event.
-    # - key [PixKey]: PixKey entity to which the log refers to.
+    # - 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, :key
       def initialize(id:, created:, type:, errors:, key:)
         super(id)
-        @created = StarkInfra::Utils::Checks.check_datetime(created)
+        @key = key
         @type = type
         @errors = errors
-        @key = key
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific PixKey::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single PixKey::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -39,26 +39,26 @@ module StarkInfra
       # - 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
+      # - PixKey::Log object with updated attributes
       def self.get(id, user: nil)
         StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
-      # # Retrieve Logs
+      # # Retrieve PixKey::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of PixKey::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)
       # - types [list of strings, default nil]: filter PixKey Logs by their types. Options: 'created', 'registered', 'updated', 'failed', 'canceling', 'canceled'.
-      # - key_ids [list of strings, default nil]: list of PixKey ids to filter retrieved objects. ex: %w[5656565656565656 4545454545454545]
+      # - key_ids [list of strings, default nil]: list of PixKey ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter PixKey Logs. ex: ['5656565656565656']
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
-      # - generator of Log objects with updated attributes
+      # - generator of PixKey::Log objects with updated attributes
       def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, key_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
@@ -74,23 +74,23 @@ module StarkInfra
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged PixKey::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 PixKey::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 keys.
       #
       # ## Parameters (optional):
-      # - ids [list of strings, default nil]: Log ids to filter PixKey Logs. ex: ['5656565656565656']
       # - cursor [string, default nil]: cursor returned on the previous page function call
       # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
       # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
       # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
-      # - types [list of strings]: filter PixKey Logs by their types. Options: 'created', 'registered', 'updated', 'failed', 'canceling', 'canceled'.
-      # - key_ids [list of strings, default nil]: list of PixKey ids to filter retrieved objects. ex: %w[5656565656565656 4545454545454545]
+      # - types [list of strings, default nil]: filter PixKey Logs by their types. Options: 'created', 'registered', 'updated', 'failed', 'canceling', 'canceled'.
+      # - key_ids [list of strings, default nil]: list of PixKey ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter PixKey Logs. ex: ['5656565656565656']
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
-      # - list of Log objects with updated attributes
+      # - list of PixKey::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, key_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
@@ -115,10 +115,10 @@ module StarkInfra
           resource_maker: proc { |json|
             Log.new(
               id: json['id'],
-              created: json['created'],
+              key: StarkInfra::Utils::API.from_api_json(key_maker, json['key']),
               type: json['type'],
               errors: json['errors'],
-              key: StarkInfra::Utils::API.from_api_json(key_maker, json['key'])
+              created: json['created']
             )
           }
         }

data/lib/pixkey/pixkey.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # PixKey object
+  #
   # PixKeys link bank account information to key ids.
   # Key ids are a convenient way to search and pass bank account information.
+  #
   # When you initialize a Pix Key, 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 created object.
   #
   # ## Parameters (required):
-  # - account_created [DateTime, Date or string]: opening Date or DateTime for the linked account. ex: '2022-01-01T12:00:00:00'.
+  # - account_created [DateTime or string]: opening Date or DateTime for the linked account. ex: '2020-03-10T10:30:00.000000+00:00' or DateTime.new(2020, 3, 10, 10, 30, 0, 0).
   # - account_number [string]: number of the linked account. ex: '76543'.
   # - account_type [string]: type of the linked account. Options: 'checking', 'savings', 'salary' or 'payment'.
   # - branch_code [string]: branch code of the linked account. ex: '1234'.
@@ -58,7 +60,7 @@ module StarkInfra
 
     # # Create a PixKey
     #
-    # Send a PixKey objects for creation in the Stark Infra API
+    # Create a PixKey linked to a specific account in the Stark Infra API
     #
     # ## Parameters (required):
     # - key [PixKey object]: PixKey object to be created in the API
@@ -77,7 +79,7 @@ module StarkInfra
     # Receive a single PixKey object previously created in the Stark Infra API by passing its id
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: '5656565656565656'
+    # - id [string]: object unique id. ex: '+5511989898989'
     # - 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):
@@ -106,7 +108,7 @@ module StarkInfra
     # - before [Date or string, default nil]: date filter for objects created or updated 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']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['+5511989898989', '+5511967676767']
     # - type [string, default nil]: filter for the type of retrieved PixKeys. Options: 'cpf', 'cnpj', 'phone', 'email' and 'evp'
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
@@ -140,7 +142,7 @@ module StarkInfra
     # - before [Date or string, default nil]: date filter for objects created or updated 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']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['+5511989898989', '+5511967676767']
     # - type [string, default nil]: filter for the type of retrieved PixKeys. Options: 'cpf', 'cnpj', 'phone', 'email' and 'evp'
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
@@ -166,14 +168,14 @@ module StarkInfra
 
     # # Update a PixKey entity
     #
-    # Respond to a received PixKey.
+    # Update a PixKey parameters by passing id.
     #
     # ## Parameters (required):
-    # - id [string]: PixKey unique id. ex: '5656565656565656'
+    # - id [string]: PixKey unique id. ex: '+5511989898989'
     # - reason [string]: reason why the PixKey is being patched. Options: 'branchTransfer', 'reconciliation' or 'userRequested'.
     #
     # ## Parameters (optional):
-    # - account_created [Date, DateTime or string, default nil]: opening Date or DateTime for the account to be linked. ex: '2022-01-01.
+    # - account_created [Date, DateTime or string, default nil]: opening Date or DateTime for the account to be linked. ex: '2022-01-01', Date.new(2020, 3, 10) or DateTime.new(2020, 3, 10, 10, 30, 0, 0)
     # - account_number [string, default nil]: number of the account to be linked. ex: '76543'.
     # - account_type [string, default nil]: type of the account to be linked. Options: 'checking', 'savings', 'salary' or 'payment'.
     # - branch_code [string, default nil]: branch code of the account to be linked. ex: 1234'.
@@ -181,7 +183,7 @@ module StarkInfra
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - updated PixKey object
+    # - PixKey object with updated attributes
     def self.update(id, reason:, account_created: nil, account_number: nil, account_type: nil, branch_code: nil, name: nil, user: nil)
       StarkInfra::Utils::Rest.patch_id(
         id: id,
@@ -201,7 +203,7 @@ module StarkInfra
     # Cancel a PixKey entity previously created in the Stark Infra API
     #
     # ## Parameters (required):
-    # - id [string]: PixKey unique id. ex: '5656565656565656'
+    # - id [string]: PixKey unique id. ex: '+5511989898989'
     #
     # ## Parameters (optional):
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
@@ -217,13 +219,13 @@ module StarkInfra
         resource_name: 'PixKey',
         resource_maker: proc { |json|
           PixKey.new(
+            id: json['id'],
             account_created: json['account_created'],
             account_number: json['account_number'],
             account_type: json['account_type'],
             branch_code: json['branch_code'],
             name: json['name'],
             tax_id: json['tax_id'],
-            id: json['id'],
             tags: json['tags'],
             owned: json['owned'],
             owner_type: json['owner_type'],

data/lib/pixrequest/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require_relative('pixrequest')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
-require_relative('pixrequest')
+require_relative('../utils/resource')
 
 module StarkInfra
   class PixRequest
@@ -12,12 +12,12 @@ module StarkInfra
     # Every time a PixRequest entity is modified, a corresponding PixRequest::Log 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 PixRequest event which triggered the log creation. ex: 'processing' or 'success'
-    # - errors [list of strings]: list of errors linked to this PixRequest event.
     # - request [PixRequest object]: PixRequest entity to which the log refers to.
+    # - type [string]: type of the PixRequest event which triggered the log creation. ex: "sent", "denied", "failed", "created", "success", "approved", "credited", "refunded", "processing"
+    # - errors [list of strings]: list of errors linked to this PixRequest event.
+    # - 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, :request
       def initialize(id:, created:, type:, errors:, request:)
@@ -28,9 +28,9 @@ module StarkInfra
         @request = request
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific PixRequest::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single PixRequest::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -39,27 +39,28 @@ module StarkInfra
       # - 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
+      # - PixRequest::Log object with updated attributes
       def self.get(id, user: nil)
         StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
-      # # Retrieve Logs
+      # # Retrieve PixRequest::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of PixRequest::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)
       # - types [list of strings, default nil]: filter retrieved objects by types. ex: 'success' or 'failed'
       # - request_ids [list of strings, default nil]: list of PixRequest ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - reconciliation_id [string, default nil]: PixRequest reconciliation id to filter retrieved objects. ex: "b77f5236-7ab9-4487-9f95-66ee6eaf1781"
+      # - ids [list of strings, default nil]: Log ids to filter PixKey Logs. ex: ['5656565656565656']
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
-      # - generator of Log objects with updated attributes
-      def self.query(limit: nil, after: nil, before: nil, types: nil, request_ids: nil, user: nil)
+      # - generator of PixRequest::Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, request_ids: nil, reconciliation_id: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
         StarkInfra::Utils::Rest.get_stream(
@@ -68,14 +69,15 @@ module StarkInfra
           before: before,
           types: types,
           request_ids: request_ids,
+          reconciliation_id: reconciliation_id,
           user: user,
           **resource
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged PixRequest::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 PixRequest::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 logs.
       #
       # ## Parameters (optional):
@@ -85,12 +87,13 @@ module StarkInfra
       # - 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'
       # - request_ids [list of strings, default nil]: list of PixRequest ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - reconciliation_id [string]: PixRequest reconciliation id to filter retrieved objects. ex: "b77f5236-7ab9-4487-9f95-66ee6eaf1781"
       # - 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
+      # - list of PixRequest::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, request_ids: nil, user: nil)
+      def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, request_ids: nil, reconciliation_id: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
         StarkInfra::Utils::Rest.get_page(
@@ -100,6 +103,7 @@ module StarkInfra
           before: before,
           types: types,
           request_ids: request_ids,
+          reconciliation_id: reconciliation_id,
           user: user,
           **resource
         )
@@ -112,10 +116,10 @@ module StarkInfra
           resource_maker: proc { |json|
             Log.new(
               id: json['id'],
-              created: json['created'],
+              request: StarkInfra::Utils::API.from_api_json(request_maker, json['request']),
               type: json['type'],
               errors: json['errors'],
-              request: StarkInfra::Utils::API.from_api_json(request_maker, json['request'])
+              created: json['created']
             )
           }
         }

data/lib/pixrequest/pixrequest.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
 require_relative('../utils/parse')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # PixRequest object
   #
+  # PixRequests are used to receive or send instant payments to accounts
+  # hosted in any Pix participant.
+  #
   # When you initialize a PixRequest, 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.
@@ -28,16 +31,18 @@ module StarkInfra
   # - 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 (conditionally-required):
+  # - cashier_type [string]: Cashier's type. Required if the cash_amount is different from 0. Options: 'merchant', 'participant' and 'other'
+  # - cashier_bank_code [string]: Cashier's bank code. Required if the cash_amount is different from 0. ex: '20018183'
+  #
   # ## Parameters (optional):
+  # - cash_amount [integer, default nil]: Amount to be withdrawal from the cashier in cents. ex: 1000 (= R$ 10.00)
   # - 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'
-  # - 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_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, default nil]: execution  method of creation of the PIX. ex: 'manual', 'payerQrcode', 'dynamicQrcode'.
+  # - method [string, default nil]: execution method of creation of the Pix. ex: 'manual', 'payerQrcode', 'dynamicQrcode'.
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the PixRequest is created. ex: '5656565656565656'
@@ -50,15 +55,15 @@ module StarkInfra
   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
+                :receiver_branch_code, :receiver_account_type, :end_to_end_id, :cashier_type,
+                :cashier_bank_code, :cash_amount, :receiver_key_id, :description, :reconciliation_id, :initiator_tax_id,
+                :tags, :method, :id, :fee, :status, :flow, :sender_bank_code, :created, :updated
     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:, 
-      receiver_branch_code:, receiver_account_type:, end_to_end_id:, receiver_key_id: nil, description: nil, 
-      reconciliation_id: nil, initiator_tax_id: nil, cash_amount: nil, cashier_bank_code: nil, cashier_type: nil, 
-      tags: nil, id: nil, fee: nil, status:nil, flow: nil, method: nil, sender_bank_code: nil, created: nil, updated: nil
+      receiver_branch_code:, receiver_account_type:, end_to_end_id:, cashier_type: nil, cashier_bank_code: nil,
+      cash_amount: nil, receiver_key_id: nil, description: nil, reconciliation_id: nil, initiator_tax_id: nil,
+      tags: nil, method: nil, id: nil, fee: nil, status:nil, flow: nil, sender_bank_code: nil, created: nil, updated: nil
     )
       super(id)
       @amount = amount
@@ -75,13 +80,13 @@ module StarkInfra
       @receiver_branch_code = receiver_branch_code
       @receiver_account_type = receiver_account_type
       @end_to_end_id = end_to_end_id
+      @cashier_type = cashier_type
+      @cashier_bank_code = cashier_bank_code
+      @cash_amount = cash_amount
       @receiver_key_id = receiver_key_id
       @description = description
       @reconciliation_id = reconciliation_id
       @initiator_tax_id = initiator_tax_id
-      @cash_amount = cash_amount
-      @cashier_bank_code = cashier_bank_code
-      @cashier_type = cashier_type
       @tags = tags
       @method = method
       @fee = fee
@@ -169,10 +174,10 @@ module StarkInfra
     # - 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 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']
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
@@ -212,7 +217,35 @@ module StarkInfra
     # ## Return:
     # - Parsed PixRequest object
     def self.parse(content:, signature:, user: nil)
-      StarkInfra::Utils::Parse.parse_and_verify(content: content, signature: signature, user: user, resource: resource)
+      request = StarkInfra::Utils::Parse.parse_and_verify(content: content, signature: signature, user: user, resource: resource)
+
+      !request.fee.nil? ? request.fee : 0
+      !request.tags.nil? ? request.tags : []
+      !request.external_id.nil?  ? request.external_id : ''
+      !request.description.nil?  ? request.description : ''
+
+      request
+    end
+
+    # Helps you respond to a PixRequest authorization
+    #
+    ## Parameters (required):
+    # - status [string]: response to the authorization. ex: 'approved' or 'denied'
+    #
+    ## Parameters (conditionally required):
+    # - reason [string, default nil]: denial reason. Options: 'invalidAccountNumber', 'blockedAccount', 'accountClosed', 'invalidAccountType', 'invalidTransactionType', 'taxIdMismatch', 'invalidTaxId', 'orderRejected', 'reversalTimeExpired', 'settlementFailed'
+    #
+    ## Return:
+    # - Dumped JSON string that must be returned to us
+    def self.response(status:, reason: nil)
+      response = {
+        authorization: {
+          status: status,
+          reason: reason
+        }
+      }.to_json
+
+      response
     end
 
     def self.resource
@@ -235,18 +268,18 @@ module StarkInfra
             receiver_branch_code: json['receiver_branch_code'],
             receiver_account_type: json['receiver_account_type'],
             end_to_end_id: json['end_to_end_id'],
+            cashier_type: json['cashier_type'],
+            cashier_bank_code: json['cashier_bank_code'],
+            cash_amount: json['cash_amount'],
             receiver_key_id: json['receiver_key_id'],
             description: json['description'],
             reconciliation_id: json['reconciliation_id'],
             initiator_tax_id: json['initiator_tax_id'],
-            cash_amount: json['cash_amount'],
-            cashier_bank_code: json['cashier_bank_code'],
-            cashier_type: json['cashier_type'],
             tags: json['tags'],
+            method: json['method'],
             fee: json['fee'],
             status: json['status'],
             flow: json['flow'],
-            method: json['method'],
             sender_bank_code: json['sender_bank_code'],
             created: json['created'],
             updated: json['updated']

data/lib/pixreversal/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require_relative('pixreversal')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
-require_relative('pixreversal')
+require_relative('../utils/resource')
 
 module StarkInfra
   class PixReversal
@@ -13,7 +13,7 @@ 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 PixReversal event which triggered the log creation. ex: 'processing' or 'success'