starkinfra 0.0.1 → 0.1.0

data/lib/pixclaim/pixclaim.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkInfra
+  # # PixClaim object
+  #
+  # PixClaims intend to transfer a PixClaim from one account to another.
+  # When you initialize a PixClaim, 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 [Date, DateTime or string]: opening Date or DateTime for the account claiming the PixClaim. ex: '2022-01-01'.
+  # - account_number [string]: number of the account claiming the PixClaim. ex: '76543'.
+  # - account_type [string]: type of the account claiming the PixClaim. Options: 'checking', 'savings', 'salary' or 'payment'.
+  # - branch_code [string]: branch code of the account claiming the PixClaim. ex: 1234'.
+  # - name [string]: holder's name of the account claiming the PixClaim. ex: 'Jamie Lannister'.
+  # - tax_id [string]: holder's taxId of the account claiming the PixClaim (CPF/CNPJ). ex: '012.345.678-90'.
+  # - key_id [string]: id of the registered Pix Key to be claimed. Allowed keyTypes are CPF, CNPJ, phone number or email. ex: '+5511989898989'.
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the PixClaim is created. ex: '5656565656565656'
+  # - status [string]: current PixClaim status. Options: 'created', 'failed', 'delivered', 'confirmed', 'success', 'canceled'
+  # - type [string]: type of Pix Claim. Options: 'ownership', 'portability'.
+  # - key_type [string]: keyType of the claimed Pix Key. Options: 'CPF', 'CNPJ', 'phone' or 'email'
+  # - agent [string]: Options: 'claimer' if you requested the PixClaim or 'claimed' if you received a PixClaim request.
+  # - bank_code [string]: bank_code of the account linked to the PixClaim being claimed. ex: '20018183'.
+  # - claimed_bank_code [string]: bank_code of the account donating the PixClaim. ex: '20018183'.
+  # - created [DateTime]: creation datetime for the PixClaim. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: update datetime for the PixClaim. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class PixClaim < StarkInfra::Utils::Resource
+    attr_reader :account_created, :account_number, :account_type, :branch_code, :name, :tax_id, :key_id,
+                :id, :status, :type, :key_type, :agent, :bank_code, :claimed_bank_code, :created, :updated
+    def initialize(
+      account_created:, account_number:, account_type:, branch_code:, name:,
+      tax_id:, key_id:, id: nil, status: nil, type: nil, key_type: nil, agent: nil,
+      bank_code: nil, claimed_bank_code: nil, created: nil, updated: 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
+      @key_id = key_id
+      @status = status
+      @type = type
+      @key_type = key_type
+      @agent = agent
+      @bank_code = bank_code
+      @claimed_bank_code = claimed_bank_code
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create a PixClaim
+    #
+    # Send a PixClaim object for creation in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - claim [PixClaim object]: PixClaim object to be created in the API. ex: PixClaim.new()
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - PixClaim object with updated attributes
+    def self.create(claim, user: nil)
+      StarkInfra::Utils::Rest.post_single(entity: claim, user: user, **resource)
+    end
+
+    # # Retrieve a specific PixClaim
+    #
+    # Receive a single PixClaim 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:
+    # - PixClaim object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve PixClaims
+    #
+    # Receive a generator of PixClaim 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. Options: 'created', 'failed', 'delivered', 'confirmed', 'success', 'canceled'
+    # - 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 PixClaims. Options: 'ownership' or 'portability'
+    # - agent [string, default nil]: filter for the agent of retrieved PixClaims. Options: 'claimer' or 'claimed'.
+    # - key_type [string, default nil]: filter for the PixKey type of retrieved PixClaims. Options: 'cpf', 'cnpj', 'phone', 'email' and 'evp',
+    # - key_id [string, default nil]: filter PixClaims linked to a specific PixKey id. Example: '+5511989898989'.
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of PixClaim objects with updated attributes
+    def self.query(
+      limit: nil, after: nil, before: nil, status: nil, ids: nil,
+      type: nil, agent: nil, key_type: nil, key_id: 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,
+        agent: agent,
+        key_type: key_type,
+        key_id: key_id,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged PixClaims
+    #
+    # Receive a list of up to 100 PixClaim 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 claims.
+    #
+    # ## 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. Options: 'created', 'failed', 'delivered', 'confirmed', 'success', 'canceled'
+    # - 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 PixClaims. Options: 'ownership' or 'portability'
+    # - agent [string, default nil]: filter for the agent of retrieved PixClaims. Options: 'claimer' or 'claimed'.
+    # - key_type [string, default nil]: filter for the PixKey type of retrieved PixClaims. Options: 'cpf', 'cnpj', 'phone', 'email' and 'evp',
+    # - key_id [string, default nil]: filter PixClaims linked to a specific PixKey id. Example: '+5511989898989'.
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of PixClaim objects with updated attributes
+    # - cursor to retrieve the next page of PixClaim objects
+    def self.page(
+      cursor: nil, limit: nil, after: nil, before: nil, status: nil, ids: nil,
+      type: nil, agent: nil, key_type: nil, key_id: 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,
+        agent: agent,
+        key_type: key_type,
+        key_id: key_id,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Update a PixClaim entity
+    #
+    # Respond to a received PixClaim.
+    #
+    # ## Parameters (required):
+    # - id [string]: PixClaim unique id. ex: '5656565656565656'
+    # - status [string]: patched status for Pix Claim. Options: 'confirmed' and 'canceled'
+    #
+    # ## Parameters (optional):
+    # - reason [string, default 'userRequested']: reason why the PixClaim is being patched. Options: 'fraud', 'userRequested', 'accountClosure'.
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - updated PixClaim object
+    def self.update(id, status:, reason: nil, user: nil)
+      StarkInfra::Utils::Rest.patch_id(
+        id: id,
+        status: status,
+        reason: reason,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'PixClaim',
+        resource_maker: proc { |json|
+          PixClaim.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'],
+            key_id: json['key_id'],
+            id: json['id'],
+            status: json['status'],
+            type: json['type'],
+            key_type: json['key_type'],
+            agent: json['agent'],
+            bank_code: json['bank_code'],
+            claimed_bank_code: json['claimed_bank_code'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/pixdirector/pixdirector.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+
+module StarkInfra
+  # # PixDirector object
+  #
+  # Mandatory data that must be registered within the Central Bank for
+  # emergency contact purposes. When you initialize a PixDirector,
+  # 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):
+  # - name [string]: name of the PixDirector. ex: 'Edward Stark'.
+  # - tax_id [string]: tax ID (CPF) of the PixDirector. ex: '012.345.678-90'
+  # - phone [string]: phone of the PixDirector. ex: '+551198989898'
+  # - email [string]: email of the PixDirector. ex: 'ned.stark@starkbank.com'
+  # - password [string]: password of the PixDirector. ex: '12345678'
+  # - team_email [string]: team email. ex: 'pix.team@company.com'
+  # - team_phones [list of strings]: list of phones of the team. ex: ['+5511988889999', '+5511988889998']
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the PixDirector is created. ex: '5656565656565656'
+  # - status [string]: current PixDirector status. ex: 'success'
+  class PixDirector < StarkInfra::Utils::Resource
+    attr_reader :name, :tax_id, :phone, :email, :password, :team_email, :team_phones, :id, :status
+    def initialize(name:, tax_id:, phone:, email:, password:, team_email:, team_phones:, id: nil, status: nil)
+      super(id)
+      @name = name
+      @tax_id = tax_id
+      @phone = phone
+      @email = email
+      @password = password
+      @team_email = team_email
+      @team_phones = team_phones
+      @status = status
+    end
+
+    # # Create a PixDirector
+    #
+    # Send a PixDirector object for creation in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - director [PixDirector object]: PixDirector object to be created in the API. ex: PixDirector.new()
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - PixDirector object with updated attributes.
+    def self.create(director, user: nil)
+      StarkInfra::Utils::Rest.post_single(entity: director, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'PixDirector',
+        resource_maker: proc { |json|
+          PixDirector.new(
+            id: json['id'],
+            name: json['name'],
+            tax_id: json['tax_id'],
+            phone: json['phone'],
+            email: json['email'],
+            password: json['password'],
+            team_email: json['team_email'],
+            team_phones: json['team_phones'],
+            status: json['status']
+          )
+        }
+      }
+    end
+  end
+end

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