starkinfra 0.5.0 → 0.6.0

data/lib/pix_fraud/log.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('pix_fraud')
+require_relative('../utils/rest')
+
+module StarkInfra
+  class PixFraud
+    # # PixFraud::Log object
+    #
+    # Every time a PixFraud entity is modified, a corresponding PixFraud::Log
+    # is generated for the entity. This log is never generated by the
+    # user.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - fraud [PixFraud]: PixFraud entity to which the log refers to.
+    # - type [string]: type of the PixFraud event which triggered the log creation. ex: 'created', 'failed', 'registered', 'canceled'
+    # - errors [list of strings]: list of errors linked to this PixFraud event.
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkCore::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :fraud
+      def initialize(id:, created:, type:, errors:, fraud:)
+        super(id)
+        @fraud = fraud
+        @type = type
+        @errors = errors
+        @created = StarkCore::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific PixFraud::Log
+      #
+      # Receive a single PixFraud::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:
+      # - PixFraud::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve PixFraud::Logs
+      #
+      # Receive a generator of PixFraud::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 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. ex: ['created', 'failed', 'registered', 'canceled']
+      # - fraud_ids [list of strings, default nil]: list of PixFraud ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter PixFraud Logs. ex: ['5656565656565656']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - list of PixFraud::Log objects with updated attributes
+      def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, fraud_ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          fraud_ids: fraud_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged PixFraud::Logs
+      #
+      # Receive a list of up to 100 PixFraud::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 frauds.
+      #
+      # ## 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 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. ex: ['created', 'failed', 'registered', 'canceled']
+      # - fraud_ids [list of strings, default nil]: list of PixFraud ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter PixFraud Logs. ex: ['5656565656565656']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - list of PixFraud::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, fraud_ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_page(
+          cursor: cursor,
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          fraud_ids: fraud_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        fraud_maker = StarkInfra::PixFraud.resource[:resource_maker]
+        {
+          resource_name: 'PixFraudLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              fraud: StarkCore::Utils::API.from_api_json(fraud_maker, json['fraud']),
+              type: json['type'],
+              errors: json['errors'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/pix_fraud/pix_fraud.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+
+module StarkInfra
+  # # PixFraud object
+  #
+  # PixFrauds are used to report a PixKey or taxId when a fraud
+  # has been confirmed.
+  # When you initialize a PixFraud, 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):
+  # - external_id [string]: end_to_end_id or return_id of the transaction being reported. ex: 'E20018183202201201450u34sDGd19lz'
+  # - type [string]: type of PixFraud. Options: 'identity', 'mule', 'scam', 'other'
+  # - tax_id [string]: user tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  #
+  # ## Parameters (optional):
+  # - key_id [string, default nil]: marked PixKey id. ex: '+5511989898989'
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['fraudulent']
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the PixFraud is created. ex: '5656565656565656'
+  # - bacen_id [string]: unique transaction id returned from Central Bank. ex: 'ccf9bd9c-e99d-999e-bab9-b999ca999f99'
+  # - status [string]: current PixFraud status. Options: 'created', 'failed', 'registered', 'canceled'.
+  # - created [DateTime]: creation datetime for the PixFraud. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the PixFraud. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class PixFraud < StarkCore::Utils::Resource
+    attr_reader :external_id, :type, :tax_id, :key_id, :tags, :id, :bacen_id, :status, :created, :updated
+    def initialize(
+      external_id:, type:, tax_id:, key_id: nil, tags: nil,
+      id: nil, bacen_id: nil, status: nil, created: nil, updated: nil
+    )
+      super(id)
+      @external_id = external_id
+      @type = type
+      @tax_id = tax_id
+      @key_id = key_id
+      @tags = tags
+      @bacen_id = bacen_id
+      @status = status
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create PixFrauds
+    #
+    # Send a list of PixFraud objects for creation in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - frauds [list of PixFraud objects]: list of PixFraud objects 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:
+    # - list of PixFraud objects with updated attributes
+    def self.create(frauds, user: nil)
+      StarkInfra::Utils::Rest.post(entities: frauds, user: user, **resource)
+    end
+
+    # # Retrieve a specific PixFraud
+    #
+    # Receive a single PixFraud 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:
+    # - PixFraud object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve PixFrauds
+    #
+    # Receive a generator of PixFraud 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 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 [list of strings, default nil]: filter for status of retrieved objects. Options: 'created', 'failed', 'registered', 'canceled'.
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - tags [list of strings, default nil]: list of strings for tagging. ex: ['fraudulent']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of PixFraud objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, ids: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        ids: ids,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged PixFrauds
+    #
+    # Receive a list of up to 100 PixFraud 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 frauds.
+    #
+    # ## 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 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 [list of strings, default nil]: filter for status of retrieved objects. Options: 'created', 'failed', 'registered', 'canceled'.
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - tags [list of strings, default nil]: list of strings for tagging. ex: ['fraudulent']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of PixFraud objects with updated attributes
+    # - cursor to retrieve the next page of PixFraud objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, ids: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        ids: ids,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Cancel a PixFraud entity
+    #
+    # Cancel a PixFraud entity previously created in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - id [string]: PixFraud 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 PixFraud object
+    def self.cancel(id, user: nil)
+      StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'PixFraud',
+        resource_maker: proc { |json|
+          PixFraud.new(
+            id: json['id'],
+            external_id: json['external_id'],
+            type: json['type'],
+            tax_id: json['tax_id'],
+            key_id: json['key_id'],
+            tags: json['tags'],
+            bacen_id: json['bacen_id'],
+            status: json['status'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/{pixinfraction → pix_infraction}/log.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require('starkcore')
-require_relative('pixinfraction')
+require_relative('pix_infraction')
 require_relative('../utils/rest')
 
 module StarkInfra

data/lib/{pixinfraction/pixinfraction.rb → pix_infraction/pix_infraction.rb}

@@ -15,6 +15,8 @@ module StarkInfra
   # ## 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'
+  # - operator_email [string]: contact email of the operator responsible for the PixInfraction. ex: 'ruby-sdk@starkinfra.com'
+  # - operator_phone [string]: contact phone number of the operator responsible for the PixInfraction. ex: '+5511999999999'
   #
   # ## Parameters (optional):
   # - description [string, default nil]: description for any details that can help with the infraction investigation.
@@ -29,18 +31,24 @@ module StarkInfra
   # - 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'.
+  # - amount [integer]: amount in cents of the reported transaction. ex: 11234 (= R$ 112.34)
+  # - dispute_id [string]: id of the PixDispute associated with the PixInfraction. ex: '5656565656565656'
   # - 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 < StarkCore::Utils::Resource
-    attr_reader :reference_id, :type, :description, :tags, :id, :credited_bank_code, :flow, :analysis,
-                :debited_bank_code, :reported_by, :result, :status, :created, :updated
+    attr_reader :reference_id, :type, :operator_email, :operator_phone, :description, :tags, :id, :credited_bank_code,
+                :flow, :analysis, :debited_bank_code, :reported_by, :result, :status, :amount, :dispute_id,
+                :created, :updated
     def initialize(
-      reference_id:, type:, description: nil, id: nil, tags: nil, credited_bank_code: nil, debited_bank_code: nil,
-      flow: nil, analysis: nil, reported_by: nil, result: nil, status: nil, created: nil, updated: nil
+      reference_id:, type:, operator_email:, operator_phone:, description: nil, id: nil, tags: nil,
+      credited_bank_code: nil, debited_bank_code: nil, flow: nil, analysis: nil, reported_by: nil, result: nil,
+      status: nil, amount: nil, dispute_id: nil, created: nil, updated: nil
     )
       super(id)
       @reference_id = reference_id
       @type = type
+      @operator_email = operator_email
+      @operator_phone = operator_phone
       @description = description
       @tags = tags
       @credited_bank_code = credited_bank_code
@@ -50,6 +58,8 @@ module StarkInfra
       @reported_by = reported_by
       @result = result
       @status = status
+      @amount = amount
+      @dispute_id = dispute_id
       @created = StarkCore::Utils::Checks.check_datetime(created)
       @updated = StarkCore::Utils::Checks.check_datetime(updated)
     end
@@ -200,6 +210,8 @@ module StarkInfra
             id: json['id'],
             reference_id: json['reference_id'],
             type: json['type'],
+            operator_email: json['operator_email'],
+            operator_phone: json['operator_phone'],
             description: json['description'],
             tags: json['tags'],
             credited_bank_code: json['credited_bank_code'],
@@ -209,6 +221,8 @@ module StarkInfra
             reported_by: json['reported_by'],
             result: json['result'],
             status: json['status'],
+            amount: json['amount'],
+            dispute_id: json['dispute_id'],
             created: json['created'],
             updated: json['updated']
           )

data/lib/pix_internal_transaction_report/log.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('pix_internal_transaction_report')
+require_relative('../utils/rest')
+
+
+module StarkInfra
+  class PixInternalTransactionReport
+    # # PixInternalTransactionReport::Log object
+    #
+    # Every time a PixInternalTransactionReport entity is updated, a corresponding
+    # PixInternalTransactionReport::Log is generated for the entity. This log is
+    # never generated by the user.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - report [PixInternalTransactionReport object]: PixInternalTransactionReport entity to which the log refers to.
+    # - type [string]: type of the PixInternalTransactionReport event which triggered the log creation. ex: 'created', 'failed', 'sent' or 'success'
+    # - errors [list of strings]: list of errors linked to this PixInternalTransactionReport event.
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkCore::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :report
+      def initialize(id:, created:, type:, errors:, report:)
+        super(id)
+        @created = StarkCore::Utils::Checks.check_datetime(created)
+        @type = type
+        @errors = errors
+        @report = report
+      end
+
+      # # Retrieve a specific PixInternalTransactionReport::Log
+      #
+      # Receive a single PixInternalTransactionReport::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:
+      # - PixInternalTransactionReport::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve PixInternalTransactionReport::Logs
+      #
+      # Receive a generator of PixInternalTransactionReport::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 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'
+      # - report_ids [list of strings, default nil]: list of PixInternalTransactionReport ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter retrieved objects. ex: ['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 PixInternalTransactionReport::Log objects with updated attributes
+      def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, report_ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          report_ids: report_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged PixInternalTransactionReport::Logs
+      #
+      # Receive a list of up to 100 PixInternalTransactionReport::Log objects previously created in the Stark Infra API and the cursor to the next page.
+      # Use this function instead of query if you want to manually page your logs.
+      #
+      # ## Parameters (optional):
+      # - 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, default nil]: filter retrieved objects by types. ex: 'success' or 'failed'
+      # - report_ids [list of strings, default nil]: list of PixInternalTransactionReport ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter retrieved objects. ex: ['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 PixInternalTransactionReport::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, report_ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_page(
+          cursor: cursor,
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          report_ids: report_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        report_maker = StarkInfra::PixInternalTransactionReport.resource[:resource_maker]
+        {
+          resource_name: 'PixInternalTransactionReportLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              report: StarkCore::Utils::API.from_api_json(report_maker, json['report']),
+              type: json['type'],
+              errors: json['errors'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end