starkinfra 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b2d73527c71a16d43d7ca77550b2587761a4b798b5209b968fba9372965aa63
+  data.tar.gz: 913fc4e725a905872303de82eae3f9a78b43af6b2670c9112dc07ab8baf2e6e7
+SHA512:
+  metadata.gz: 4fc841538399331ccc143aa5b58dcc7cf9ee9715f7eb1133bc21abeff44937b4e41cb42a8467fa497cb58f407bb1e1df1cd67d8bf1b88dd70e0b96c70d02d2a4
+  data.tar.gz: 6d9ab720be52e7ce5789c377eff8d5b9ecf5e51ce4fb90e2c7a8faf73b8baca551e46421daf38af005bf4e165e96d29e6dacbdd158ffbd91f5f8321ac602b2d7

data/lib/error.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require('json')
+
+module StarkInfra
+  module Error
+    class StarkInfraError < StandardError
+      attr_reader :message
+      def initialize(message)
+        @message = message
+        super(message)
+      end
+    end
+
+    class Error < StarkInfraError
+      attr_reader :code, :message
+      def initialize(code, message)
+        @code = code
+        @message = message
+        super("#{code}: #{message}")
+      end
+    end
+
+    class InputErrors < StarkInfraError
+      attr_reader :errors
+      def initialize(content)
+        errors = []
+        content.each do |error|
+          errors << Error.new(error['code'], error['message'])
+        end
+        @errors = errors
+
+        super(content.to_json)
+      end
+    end
+
+    class InternalServerError < StarkInfraError
+      def initialize(message = 'Houston, we have a problem.')
+        super(message)
+      end
+    end
+
+    class UnknownError < StarkInfraError
+      def initialize(message)
+        super("Unknown exception encountered: #{message}")
+      end
+    end
+
+    class InvalidSignatureError < StarkInfraError
+    end
+  end
+end

data/lib/event/event.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require('json')
+require('starkbank-ecdsa')
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('../utils/cache')
+require_relative('../error')
+require_relative('../pixrequest/log')
+require_relative('../pixreversal/log')
+require_relative('../utils/parse')
+
+
+module StarkInfra
+  # # Webhook Event object
+  #
+  # An Event is the notification received from the subscription to the Webhook.
+  # Events cannot be created, but may be retrieved from the Stark Infra API to
+  # list all generated updates on entities.
+  #
+  # ## Attributes:
+  # - id [string]: unique id returned when the event is created. ex: '5656565656565656'
+  # - log [Log]: a Log object from one the subscription services (TransferLog, InvoiceLog, BoletoLog, BoletoPaymentlog or UtilityPaymentLog)
+  # - created [DateTime]: creation datetime for the notification event. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - is_delivered [bool]: true if the event has been successfully delivered to the user url. ex: False
+  # - workspace_id [string]: ID of the Workspace that generated this event. Mostly used when multiple Workspaces have Webhooks registered to the same endpoint. ex: '4545454545454545'
+  # - subscription [string]: service that triggered this event. ex: 'pix-request.in', 'pix-request.out'
+  class Event < StarkInfra::Utils::Resource
+    attr_reader :id, :log, :created, :is_delivered, :workspace_id, :subscription
+    def initialize(id:, log:, created:, is_delivered:, workspace_id:, subscription:)
+      super(id)
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @is_delivered = is_delivered
+      @workspace_id = workspace_id
+      @subscription = subscription
+
+      resource = {
+        'pix-request.in': StarkInfra::PixRequest::Log.resource,
+        'pix-request.out': StarkInfra::PixRequest::Log.resource,
+        'pix-reversal.in': StarkInfra::PixReversal::Log.resource,
+        'pix-reversal.out': StarkInfra::PixReversal::Log.resource,
+      }[subscription.to_sym]
+
+      @log = log
+      @log = StarkInfra::Utils::API.from_api_json(resource[:resource_maker], log) unless resource.nil?
+    end
+
+    # # Create single notification Event from a content string
+    #
+    # Create a single Event object received from event listening at 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]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - Parsed Event object
+    def self.parse(content:, signature:, user: nil)
+      return StarkInfra::Utils::Parse.parse_and_verify(content: content, signature: signature, user: user, resource: resource, key: 'event')
+    end
+    
+    class << self
+      private
+
+      def resource
+        {
+          resource_name: 'Event',
+          resource_maker: proc { |json|
+            Event.new(
+              id: json['id'],
+              log: json['log'],
+              created: json['created'],
+              is_delivered: json['is_delivered'],
+              workspace_id: json['workspace_id'],
+              subscription: json['subscription']
+            )
+          }
+        }
+      end
+    end
+  end
+end
+

data/lib/key.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require('fileutils')
+require('starkbank-ecdsa')
+
+module StarkInfra
+  module Key
+    # # Generate a new key pair
+    # Generates a secp256k1 ECDSA private/public key pair to be used in the API
+    # authentications
+    #
+    # ## Parameters (optional):
+    # - path [string]: path to save the keys .pem files. No files will be saved if this parameter isn't provided
+    #
+    # ## Return:
+    # - private and public key pems
+    def self.create(path = nil)
+      private_key = EllipticCurve::PrivateKey.new
+      public_key = private_key.publicKey
+
+      private_key_pem = private_key.toPem
+      public_key_pem = public_key.toPem
+
+      unless path.nil?
+        FileUtils.mkdir_p(path)
+        File.write(File.join(path, 'private.pem'), private_key_pem)
+        File.write(File.join(path, 'public.pem'), public_key_pem)
+      end
+
+      [private_key_pem, public_key_pem]
+    end
+  end
+end

data/lib/pixbalance/pixbalance.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkInfra
+    # # PixBalance object
+    #
+    # The PixBalance object displays the current balance of the workspace,
+    # which is the result of the sum of all transactions within this
+    # workspace. The balance is never generated by the user, but it
+    # can be retrieved to see the available information.
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when Balance is created. ex: "5656565656565656"
+    # - amount [integer]: current balance amount of the workspace in cents. ex: 200 (= R$ 2.00)
+    # - currency [string]: currency of the current workspace. Expect others to be added eventually. ex: "BRL"
+    # - updated [Datetime]: latest update datetime for the balance. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+
+  class PixBalance < StarkInfra::Utils::Resource
+    attr_reader :amount, :currency, :updated, :id
+    def initialize(amount: nil, currency: nil, updated: nil, id: nil)
+      super(id)
+      @amount = amount
+      @currency = currency
+      @updated = updated
+    end
+
+    # # Retrieve PixBalance
+    #
+    # Receive the PixBalance object linked to your workspace in the Stark Infra API
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - PixBalance object with updated attributes
+    def self.get(user: nil)
+      StarkInfra::Utils::Rest.get_stream(user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'PixBalance',
+        resource_maker: proc { |json|
+          PixBalance.new(
+            amount: json['amount'],
+            currency: json['currency'],
+            updated: json['updated'],
+            id: json['id'],
+          )
+        }
+      }
+    end
+  end
+end

data/lib/pixrequest/log.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('pixrequest')
+
+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.
+    #
+    # ## 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.
+    class Log < StarkInfra::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :request
+      def initialize(id:, created:, type:, errors:, request:)
+        super(id)
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
+        @type = type
+        @errors = errors
+        @request = request
+      end
+
+      # # Retrieve a specific Log
+      #
+      # Receive a single Log object previously created by 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
+      #
+      # ## Return:
+      # - Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve Logs
+      #
+      # Receive a generator of Log objects previously created in the Stark Infra API
+      #
+      # ## Parameters (optional):
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - after [Date, 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)
+      # - 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
+      #
+      # ## Return:
+      # - list 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)
+        StarkInfra::Utils::Rest.get_stream(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          request_ids: request_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # 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.
+      #
+      # ## 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)
+      # - 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
+      #
+      # ## Return:
+      # - 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, 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(
+          cursor: cursor,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          request_ids: request_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        request_maker = StarkInfra::PixRequest.resource[:resource_maker]
+        {
+          resource_name: 'PixRequestLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              request: StarkInfra::Utils::API.from_api_json(request_maker, json['request'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/pixrequest/pixrequest.rb

@@ -0,0 +1,259 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('../utils/parse')
+
+module StarkInfra
+  # # PixRequest object
+  #
+  # 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.
+  #
+  # ## 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"
+  #
+  # ## 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"
+  # - 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]: 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)
+
+  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
+    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
+    )
+      super(id)
+      @amount = amount
+      @external_id = external_id
+      @sender_name = sender_name
+      @sender_tax_id = sender_tax_id
+      @sender_branch_code = sender_branch_code
+      @sender_account_number = sender_account_number
+      @sender_account_type = sender_account_type
+      @receiver_name = receiver_name
+      @receiver_tax_id = receiver_tax_id
+      @receiver_bank_code = receiver_bank_code
+      @receiver_account_number = receiver_account_number
+      @receiver_branch_code = receiver_branch_code
+      @receiver_account_type = receiver_account_type
+      @end_to_end_id = end_to_end_id
+      @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
+      @status = status
+      @flow = flow
+      @sender_bank_code = sender_bank_code
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create PixRequests
+    #
+    # Send a list of PixRequest objects for creation in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - 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
+    #
+    # ## Return:
+    # - list of PixRequest objects with updated attributes
+    def self.create(requests, user: nil)
+      StarkInfra::Utils::Rest.post(entities: requests, user: user, **resource)
+    end
+
+    # # Retrieve a specific PixRequest
+    #
+    # Receive a single PixRequest 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
+    #
+    # ## Return:
+    # - PixRequest object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve PixRequests
+    #
+    # Receive a generator of PixRequest 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
+    # - 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)
+    # - 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
+    #
+    # ## 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)
+      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,
+        status: status,
+        tags: tags,
+        ids: ids,
+        end_to_end_ids: end_to_end_ids,
+        external_ids: external_ids,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged PixRequests
+    #
+    # Receive a list of up to 100 PixRequest objects previously created in the Stark infra API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call
+    # - limit [integer, default 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)
+    # - 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
+    #
+    # ## 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)
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      return StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        fields: fields,
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        tags: tags,
+        ids: ids,
+        end_to_end_ids: end_to_end_ids,
+        external_ids: external_ids,
+        user: user,
+        **resource
+      )
+    end
+
+    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      
+
+    def self.resource
+      {
+        resource_name: 'PixRequest',
+        resource_maker: proc { |json|
+          PixRequest.new(
+            id: json['id'],
+            amount: json['amount'],
+            external_id: json['external_id'],
+            sender_name: json['sender_name'],
+            sender_tax_id: json['sender_tax_id'],
+            sender_branch_code: json['sender_branch_code'],
+            sender_account_number: json['sender_account_number'],
+            sender_account_type: json['sender_account_type'],
+            receiver_name: json['receiver_name'],
+            receiver_tax_id: json['receiver_tax_id'],
+            receiver_bank_code: json['receiver_bank_code'],
+            receiver_account_number: json['receiver_account_number'],
+            receiver_branch_code: json['receiver_branch_code'],
+            receiver_account_type: json['receiver_account_type'],
+            end_to_end_id: json['end_to_end_id'],
+            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'],
+            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'],
+          )
+        }
+      }
+    end
+  end
+end