starkinfra 0.0.2 → 0.0.3

data/lib/pixkey/pixkey.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+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_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'.
+  # - name [string]: holder's name of the linked account. ex: 'Jamie Lannister'.
+  # - tax_id [string]: holder's taxId (CPF/CNPJ) of the linked account. ex: '012.345.678-90'.
+  #
+  # ## Parameters (optional):
+  # - id [string, default nil]: id of the registered PixKey. Allowed types are: CPF, CNPJ, phone number or email. If this parameter is not passed, an EVP will be created. ex: '+5511989898989'
+  # - tags [list of strings, default nil]: list of strings for reference when searching for PixKeys. ex: ['employees', 'monthly']
+  #
+  # ## Attributes (return-only):
+  # - owned [DateTime]: datetime when the key was owned by the holder. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - owner_type [string]: type of the owner of the PixKey. Options: 'business' or 'individual'.
+  # - status [string]: current PixKey status. Options: 'created', 'registered', 'canceled', 'failed'
+  # - bank_code [string]: bank_code of the account linked to the Pix Key. ex: '20018183'.
+  # - bank_name [string]: name of the bank that holds the account linked to the PixKey. ex: 'StarkBank'
+  # - type [string]: type of the PixKey. Options: 'cpf', 'cnpj', 'phone', 'email' and 'evp',
+  # - created [DateTime]: creation datetime for the PixKey. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class PixKey < StarkInfra::Utils::Resource
+    attr_reader :account_created, :account_number, :account_type, :branch_code, :name, :tax_id, :id, :tags, :owned, :owner_type, :status, :bank_code, :bank_name, :type, :created
+    def initialize(
+      account_created:, account_number:, account_type:, branch_code:, name:, tax_id:, id: nil, tags: nil, owned: nil,
+      owner_type: nil, status: nil, bank_code: nil, bank_name: nil, type: nil, created: nil
+    )
+      super(id)
+      @account_created = account_created
+      @account_number = account_number
+      @account_type = account_type
+      @branch_code = branch_code
+      @name = name
+      @tax_id = tax_id
+      @tags = tags
+      @owned = StarkInfra::Utils::Checks.check_datetime(owned)
+      @owner_type = owner_type
+      @status = status
+      @bank_code = bank_code
+      @bank_name = bank_name
+      @type = type
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create a PixKey
+    #
+    # Send a PixKey objects for creation in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - key [PixKey object]: PixKey object 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:
+    # - PixKey object with updated attributes
+    def self.create(key, user: nil)
+      StarkInfra::Utils::Rest.post_single(entity: key, user: user, **resource)
+    end
+
+    # # Retrieve a specific PixKey
+    #
+    # 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'
+    # - 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, default nil]: central bank's unique transaction id. If the request results in the creation of a PixRequest, the same end_to_end_id should be used. If this parameter is not passed, one end_to_end_id will be automatically created. Example: 'E00002649202201172211u34srod19le'
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - PixKey object with updated attributes
+    def self.get(id, payer_id:, end_to_end_id: nil, user: nil)
+      StarkInfra::Utils::Rest.get_id(
+        id: id,
+        payer_id: payer_id,
+        end_to_end_id: end_to_end_id,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve PixKeys
+    #
+    # Receive a generator of PixKey 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 or updated only after specified date. ex: Date.new(2020, 3, 10)
+    # - 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']
+    # - 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
+    #
+    # ## Return:
+    # - generator of PixKey objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, type: 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,
+        type: type,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged PixKeys
+    #
+    # Receive a list of up to 100 PixKey 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):
+    # - 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 or updated only after specified date. ex: Date.new(2020, 3, 10)
+    # - 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']
+    # - 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
+    #
+    # ## Return:
+    # - list of PixKey objects with updated attributes
+    # - cursor to retrieve the next page of PixKey objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, type: 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,
+        type: type,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Update a PixKey entity
+    #
+    # Respond to a received PixKey.
+    #
+    # ## Parameters (required):
+    # - id [string]: PixKey unique id. ex: '5656565656565656'
+    # - 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_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'.
+    # - name [string, default nil]: holder's name of the account to be linked. ex: 'Jamie Lannister'.
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - updated PixKey object
+    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,
+        reason: reason,
+        account_created: account_created,
+        account_number: account_number,
+        account_type: account_type,
+        branch_code: branch_code,
+        name: name,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Cancel a PixKey entity
+    #
+    # Cancel a PixKey entity previously created in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - id [string]: PixKey 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:
+    # - canceled PixKey object
+    def self.cancel(id, user: nil)
+      StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'PixKey',
+        resource_maker: proc { |json|
+          PixKey.new(
+            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'],
+            status: json['status'],
+            bank_code: json['bank_code'],
+            bank_name: json['bank_name'],
+            type: json['type'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/pixrequest/log.rb

@@ -9,16 +9,15 @@ module StarkInfra
   class PixRequest
     # # PixRequest::Log object
     #
-    # Every time a PixRequest entity is modified, a corresponding PixRequest::Log
-    # is generated for the entity. This log is never generated by the
-    # user.
+    # 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:
     # - 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]: PixRequest entity to which the log refers to.
+    # - request [PixRequest object]: PixRequest entity to which the log refers to.
     class Log < StarkInfra::Utils::Resource
       attr_reader :id, :created, :type, :errors, :request
       def initialize(id:, created:, type:, errors:, request:)
@@ -37,7 +36,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
@@ -50,15 +49,16 @@ module StarkInfra
       # Receive a generator of 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, 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'
       # - request_ids [list of strings, default nil]: list of PixRequest 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, request_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
@@ -76,24 +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 logs.
       #
       # ## 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'
       # - request_ids [list of strings, default nil]: list of PixRequest 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
-      # - Cursor to retrieve the next page of Log objects
+      # - 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)
         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/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,