starkinfra 0.0.1 → 0.1.0

data/lib/pixinfraction/pixinfraction.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkInfra
+  # # PixInfraction object
+  #
+  # PixInfractions are used to report transactions that are suspected of
+  # fraud, to request a refund or to reverse a refund.
+  # When you initialize a PixInfraction, 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):
+  # - reference_id [string]: end_to_end_id or return_id of the transaction being reported. ex: 'E20018183202201201450u34sDGd19lz'
+  # - type [string]: type of infraction report. Options: 'fraud', 'reversal', 'reversalChargeback'
+  #
+  # ## Parameters (optional):
+  # - description [string, default nil]: description for any details that can help with the infraction investigation.
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the PixInfraction is created. ex: '5656565656565656'
+  # - credited_bank_code [string]: bank_code of the credited Pix participant in the reported transaction. ex: '20018183'
+  # - debited_bank_code [string]: bank_code of the debited Pix participant in the reported transaction. ex: '20018183'
+  # - agent [string]: Options: 'reporter' if you created the PixInfraction, 'reported' if you received the PixInfraction.
+  # - analysis [string]: analysis that led to the result.
+  # - bacen_id [string]: central bank's unique UUID that identifies the infraction report.
+  # - reported_by [string]: agent that reported the PixInfraction. Options: 'debited', 'credited'.
+  # - result [string]: result after the analysis of the PixInfraction by the receiving party. Options: 'agreed', 'disagreed'
+  # - status [string]: current PixInfraction status. Options: 'created', 'failed', 'delivered', 'closed', 'canceled'.
+  # - created [DateTime]: creation datetime for the PixInfraction. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the PixInfraction. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class PixInfraction < StarkInfra::Utils::Resource
+    attr_reader :reference_id, :type, :description, :id, :credited_bank_code, :agent, :analysis, :bacen_id,
+                :debited_bank_code, :reported_by, :result, :status, :created, :updated
+    def initialize(
+      reference_id:, type:, description:, id: nil, credited_bank_code: nil, agent: nil, analysis: nil, bacen_id: nil,
+      debited_bank_code: nil, reported_by: nil, result: nil, status: nil, created: nil, updated: nil
+    )
+      super(id)
+      @reference_id = reference_id
+      @type = type
+      @description = description
+      @credited_bank_code = credited_bank_code
+      @agent = agent
+      @analysis = analysis
+      @bacen_id = bacen_id
+      @debited_bank_code = debited_bank_code
+      @reported_by = reported_by
+      @result = result
+      @status = status
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create PixInfractions
+    #
+    # Send a list of PixInfraction objects for creation in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - infractions [list of PixInfraction objects]: list of PixInfraction objects to be created in the API. ex: [PixInfraction.new()]
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of PixInfraction objects with updated attributes
+    def self.create(infractions, user: nil)
+      StarkInfra::Utils::Rest.post(entities: infractions, user: user, **resource)
+    end
+
+    # # Retrieve a specific PixInfraction
+    #
+    # Receive a single PixInfraction 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, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - PixInfraction object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve PixInfractions
+    #
+    # Receive a generator of PixInfraction 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'
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - type [string]: filter for the type of retrieved PixInfractions. Options: 'fraud', 'reversal', 'reversalChargeback'
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of PixInfraction objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: 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,
+        ids: ids,
+        type: type,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged PixInfractions
+    #
+    # Receive a list of up to 100 PixInfraction 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 infractions.
+    #
+    # ## 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'
+    # - 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 PixInfractions. Options: 'fraud', 'reversal', 'reversalChargeback'
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of PixInfraction objects with updated attributes
+    # - cursor to retrieve the next page of PixInfraction objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: 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,
+        ids: ids,
+        type: type,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Update a PixInfraction entity
+    #
+    # Respond to a received PixInfraction.
+    #
+    # ## Parameters (required):
+    # - id [string]: PixInfraction unique id. ex: '5656565656565656'
+    # - result [string]: result after the analysis of the PixInfraction. Options: 'agreed', 'disagreed'
+    #
+    # ## Parameters (optional):
+    # - analysis [string, nil]: analysis that led to the result.
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - updated PixInfraction object
+    def self.update(id, result:, analysis: nil, user: nil)
+      StarkInfra::Utils::Rest.patch_id(id: id, result: result, analysis: analysis, user: user, **resource)
+    end
+
+    # # Cancel a PixInfraction entity
+    #
+    # Cancel a PixInfraction entity previously created in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - id [string]: PixInfraction 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 PixInfraction object
+    def self.cancel(id, user: nil)
+      StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'PixInfraction',
+        resource_maker: proc { |json|
+          PixInfraction.new(
+            id: json['id'],
+            reference_id: json['reference_id'],
+            type: json['type'],
+            description: json['description'],
+            credited_bank_code: json['credited_bank_code'],
+            agent: json['agent'],
+            analysis: json['analysis'],
+            bacen_id: json['bacen_id'],
+            debited_bank_code: json['debited_bank_code'],
+            reported_by: json['reported_by'],
+            result: json['result'],
+            status: json['status'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/pixkey/log.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('pixkey')
+
+module StarkInfra
+  class PixKey
+    # # PixKey::Log object
+    #
+    # 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:
+    # - 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 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.
+    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)
+        @type = type
+        @errors = errors
+        @key = key
+      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, default nil]: 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):
+      # - 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]
+      # - 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(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)
+        StarkInfra::Utils::Rest.get_stream(
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          key_ids: key_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 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]
+      # - 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
+      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)
+        before = StarkInfra::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_page(
+          cursor: cursor,
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          key_ids: key_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        key_maker = StarkInfra::PixKey.resource[:resource_maker]
+        {
+          resource_name: 'PixKeyLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              key: StarkInfra::Utils::API.from_api_json(key_maker, json['key'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/pixkey/pixkey.rb

@@ -0,0 +1,240 @@
+# 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,