starkinfra 0.0.2 → 0.0.3

data/lib/pixdomain/certificate.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+
+module StarkInfra
+  # # PixDomain::Certificate object
+  #
+  # The Certificate object displays the certificate information from a specific domain.
+  #
+  # ## Attributes (return-only):
+  # - content [string]: certificate of the Pix participant in PEM format.
+  class Certificate < StarkInfra::Utils::SubResource
+    attr_reader :content
+    def initialize(content: nil)
+      @content = content
+    end
+
+    def self.resource
+      {
+        resource_name: 'Certificate',
+        resource_maker: proc { |json|
+          Certificate.new(
+            content: json['content']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/pixdomain/pixdomain.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('certificate')
+
+module StarkInfra
+  # # PixDomain object
+  #
+  # The PixDomain object displays the domain name and the QR Code
+  # domain certificate of Pix participants.
+  # All certificates must be registered with the Central Bank.
+  #
+  # ## Attributes (return-only):
+  # - certificates [list of PixDomain::Certificate objects]: certificate information of the Pix participant.
+  # - name [string]: current active domain (URL) of the Pix participant.
+  class PixDomain < StarkInfra::Utils::SubResource
+    attr_reader :certificates, :name
+    def initialize(certificates: nil, name: nil)
+      @certificates = certificates
+      @name = name
+    end
+
+    # # Retrieve PixDomains
+    #
+    # Receive a generator of PixDomain objects registered at the Central Bank.
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of PixDomain objects with updated attributes
+    def self.query(user: nil)
+      StarkInfra::Utils::Rest.get_stream(user: user, **resource)
+    end
+
+    def self._parse_certificates(certificates)
+      certificate_maker = StarkInfra::Certificate.resource[:resource_maker]
+      parsed_certificates = []
+      certificates.each do |certificate|
+        parsed_certificates << StarkInfra::Utils::API.from_api_json(certificate_maker, certificate)
+      end
+      parsed_certificates
+    end
+
+    def self.resource
+      {
+        resource_name: 'PixDomain',
+        resource_maker: proc { |json|
+          PixDomain.new(
+            name: json['name'],
+            certificates: _parse_certificates(json['certificates'])
+          )
+        }
+      }
+    end
+  end
+end

data/lib/pixinfraction/log.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('pixinfraction')
+
+module StarkInfra
+  class PixInfraction
+    # # PixInfraction::Log object
+    #
+    # Every time a PixInfraction entity is modified, a corresponding PixInfraction::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 PixInfraction event which triggered the log creation. Options: 'created', 'failed', 'delivering', 'delivered', 'closed', 'canceled'
+    # - errors [list of strings]: list of errors linked to this PixInfraction event.
+    # - infraction [PixInfraction]: PixInfraction entity to which the log refers to.
+    class Log < StarkInfra::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :infraction
+      def initialize(id:, created:, type:, errors:, infraction:)
+        super(id)
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
+        @type = type
+        @errors = errors
+        @infraction = infraction
+      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 PixInfraction Logs. ex: ['5656565656565656']
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - types [list of strings, default nil]: filter retrieved objects by their types. Options: 'created', 'failed', 'delivering', 'delivered', 'closed', 'canceled'
+      # - infraction_ids [list of strings, default nil]: list of PixInfraction 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
+      def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, infraction_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,
+          infraction_ids: infraction_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 infractions.
+      #
+      # ## Parameters (optional):
+      # - cursor [string, default nil]: cursor returned on the previous page function call
+      # - ids [list of strings, default nil]: Log ids to filter PixInfraction Logs. ex: ['5656565656565656']
+      # - 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 their types. Options: 'created', 'failed', 'delivering', 'delivered', 'closed', 'canceled'
+      # - infraction_ids [list of strings, default nil]: list of PixInfraction 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, infraction_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,
+          infraction_ids: infraction_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        infraction_maker = StarkInfra::PixInfraction.resource[:resource_maker]
+        {
+          resource_name: 'PixInfractionLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              infraction: StarkInfra::Utils::API.from_api_json(infraction_maker, json['infraction'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

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