starkbank 2.1.0 → 2.4.0

data/lib/brcode_preview/brcode_preview.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # BrcodePreview object
+  #
+  # A BrcodePreview is used to get information from a BR Code you received to check the informations before paying it.
+  #
+  # ## Attributes (return-only):
+  # - status [string]: Payment status. ex: 'active', 'paid', 'canceled' or 'unknown'
+  # - name [string]: Payment receiver name. ex: 'Tony Stark'
+  # - tax_id [string]: Payment receiver tax ID. ex: '012.345.678-90'
+  # - bank_code [string]: Payment receiver bank code. ex: '20018183'
+  # - branch_code [string]: Payment receiver branch code. ex: '0001'
+  # - account_number [string]: Payment receiver account number. ex: '1234567'
+  # - account_type [string]: Payment receiver account type. ex: 'checking'
+  # - allow_change [bool]: If True, the payment is able to receive amounts that are diferent from the nominal one. ex: True or False
+  # - amount [integer]: Value in cents that this payment is expecting to receive. If 0, any value is accepted. ex: 123 (= R$1,23)
+  # - reconciliation_id [string]: Reconciliation ID linked to this payment. ex: 'txId', 'payment-123'
+  class BrcodePreview < StarkBank::Utils::Resource
+    attr_reader :status, :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :allow_change, :amount, :reconciliation_id
+    def initialize(status:, name:, tax_id:, bank_code:, branch_code:, account_number:, account_type:, allow_change:, amount:, reconciliation_id:)
+      @status = status
+      @name = name
+      @tax_id = tax_id
+      @bank_code = bank_code
+      @branch_code = branch_code
+      @account_number = account_number
+      @account_type = account_type
+      @allow_change = allow_change
+      @amount = amount
+      @reconciliation_id = reconciliation_id
+    end
+
+    # # Retrieve BrcodePreviews
+    #
+    # Receive a generator of BrcodePreview objects previously created in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - brcodes [list of strings]: List of brcodes to preview. ex: %w[00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A]
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
+    #
+    # ## Return:
+    # - generator of BrcodePreview objects with updated attributes
+    def self.query(limit: nil, brcodes: nil, user: nil)
+      StarkBank::Utils::Rest.get_list(
+        user: user,
+        limit: nil,
+        brcodes: brcodes,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'BrcodePreview',
+        resource_maker: proc { |json|
+          BrcodePreview.new(
+            status: json['status'],
+            name: json['name'],
+            tax_id: json['tax_id'],
+            bank_code: json['bank_code'],
+            branch_code: json['branch_code'],
+            account_number: json['account_number'],
+            account_type: json['account_type'],
+            allow_change: json['allow_change'],
+            amount: json['amount'],
+            reconciliation_id: json['reconciliation_id']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/deposit/deposit.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # Deposit object
+  #
+  # Deposits represent passive cash-in received by your account from external transfers
+  #
+  ## Attributes (return-only):
+  # - id [string]: unique id associated with a Deposit when it is created. ex: '5656565656565656'
+  # - name [string]: payer name. ex: 'Iron Bank S.A.'
+  # - tax_id [string]: payer tax ID (CPF or CNPJ). ex: '012.345.678-90' or '20.018.183/0001-80'
+  # - bank_code [string]: payer bank code in Brazil. ex: '20018183' or '341'
+  # - branch_code [string]: payer bank account branch. ex: '1357-9's
+  # - account_number [string]: payer bank account number. ex: '876543-2'
+  # - amount [integer]: Deposit value in cents. ex: 1234 (= R$ 12.34)
+  # - type [string]: Type of settlement that originated the deposit. ex: 'pix' or 'ted'
+  # - status [string]: current Deposit status. ex: 'created'
+  # - tags [list of strings]: list of strings that are tagging the deposit. ex: ['reconciliationId', 'txId']
+  # - fee [integer]: fee charged by this deposit. ex: 50 (= R$ 0.50)
+  # - transaction_ids [list of strings]: ledger transaction ids linked to this Deposit (if there are more than one, all but first are reversals). ex: ['19827356981273']
+  # - created [datetime.datetime]: creation datetime for the Deposit. ex: datetime.datetime(2020, 12, 10, 10, 30, 0, 0)
+  # - updated [datetime.datetime]: latest update datetime for the Deposit. ex: datetime.datetime(2020, 12, 10, 10, 30, 0, 0)
+  class Deposit < StarkBank::Utils::Resource
+    attr_reader :id, :name, :tax_id, :bank_code, :branch_code, :account_number, :amount, :type, :status, :tags, :fee, :transaction_ids, :created, :updated
+    def initialize(
+      id:, name:, tax_id:, bank_code:, branch_code:, account_number:, amount:, type:, status:, tags:, fee:,
+      transaction_ids:, created:, updated:
+    )
+      super(id)
+      @name = name
+      @tax_id = tax_id
+      @bank_code = bank_code
+      @branch_code = branch_code
+      @account_number = account_number
+      @amount = amount
+      @type = type
+      @status = status
+      @tags = tags
+      @fee = fee
+      @transaction_ids = transaction_ids
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Retrieve a specific Deposit
+    #
+    # Receive a single Deposit object previously created in the Stark Bank API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - Deposit object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve Deposits
+    #
+    # Receive a generator of Deposit objects previously created in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date , DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
+    # - sort [string, default '-created']: sort order considered in response. Valid options are 'created' or '-created'.
+    # - 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']
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
+    #
+    # ## Return:
+    # - generator of Deposit objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, sort: nil, tags: nil, ids: nil, user: nil)
+      after = StarkBank::Utils::Checks.check_date(after)
+      before = StarkBank::Utils::Checks.check_date(before)
+      StarkBank::Utils::Rest.get_list(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        sort: sort,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'Deposit',
+        resource_maker: proc { |json|
+          Deposit.new(
+            id: json['id'],
+            name: json['name'],
+            tax_id: json['tax_id'],
+            bank_code: json['bank_code'],
+            branch_code: json['branch_code'],
+            account_number: json['account_number'],
+            amount: json['amount'],
+            type: json['type'],
+            status: json['status'],
+            tags: json['tags'],
+            fee: json['fee'],
+            transaction_ids: json['transaction_ids'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/deposit/log.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('deposit')
+
+module StarkBank
+  class Deposit
+    # # Deposit::Log object
+    #
+    # Every time a Deposit entity is updated, a corresponding Deposit::Log
+    # is generated for the entity. This log is never generated by the
+    # user, but it can be retrieved to check additional information
+    # on the Deposit.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - deposit [Deposit]: Deposit entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this Deposit event
+    # - type [string]: type of the Deposit event which triggered the log creation. ex: 'canceled' or 'paid'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkBank::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :deposit
+      def initialize(id:, created:, type:, errors:, deposit:)
+        super(id)
+        @type = type
+        @errors = errors
+        @deposit = deposit
+        @created = StarkBank::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific Log
+      #
+      # Receive a single Log object previously created by the Stark Bank API by passing its id
+      #
+      # ## Parameters (required):
+      # - id [string]: object unique id. ex: '5656565656565656'
+      #
+      # ## Parameters (optional):
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+      #
+      # ## Return:
+      # - Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve Logs
+      #
+      # Receive a generator of Log objects previously created in the Stark Bank API
+      #
+      # ## Parameters (optional):
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - types [list of strings, default nil]: filter for log event types. ex: 'paid' or 'canceled'
+      # - deposit_ids [list of strings, default nil]: list of Deposit ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
+      #
+      # ## Return:
+      # - list of Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, deposit_ids: nil, user: nil)
+        after = StarkBank::Utils::Checks.check_date(after)
+        before = StarkBank::Utils::Checks.check_date(before)
+        StarkBank::Utils::Rest.get_list(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          deposit_ids: deposit_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        deposit_maker = StarkBank::Deposit.resource[:resource_maker]
+        {
+          resource_name: 'DepositLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              deposit: StarkBank::Utils::API.from_api_json(deposit_maker, json['deposit'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/dict_key/dict_key.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource.rb')
+require_relative('../utils/rest.rb')
+require_relative('../utils/checks.rb')
+
+module StarkBank
+  # # DictKey object
+  #
+  # DictKey represents a PIX key registered in Bacen's DICT system.
+  #
+  # ## Parameters (required):
+  # - id [string]: DictKey object unique id and PIX key itself. ex: 'tony@starkbank.com', '722.461.430-04', '20.018.183/0001-80', '+5511988887777', 'b6295ee1-f054-47d1-9e90-ee57b74f60d9'
+  #
+  # ## Attributes (return-only):
+  # - type [string, default nil]: DICT key type. ex: 'email', 'cpf', 'cnpj', 'phone' or 'evp'
+  # - name [string, default nil]: account owner full name. ex: 'Tony Stark'
+  # - tax_id [string, default nil]: key owner tax ID (CNPJ or masked CPF). ex: '***.345.678-**' or '20.018.183/0001-80'
+  # - owner_type [string, default nil]: DICT key owner type. ex 'naturalPerson' or 'legalPerson'
+  # - ispb [string, default nil]: bank ISPB associated with the DICT key. ex: '20018183'
+  # - branch_code [string, default nil]: bank account branch code associated with the DICT key. ex: '9585'
+  # - account_number [string, default nil]: bank account number associated with the DICT key. ex: '9828282578010513'
+  # - account_type [string, default nil]: bank account type associated with the DICT key. ex: 'checking', 'saving' e 'salary'
+  # - status [string, default nil]: current DICT key status. ex: 'created', 'registered', 'canceled' or 'failed'
+  # - account_created [DateTime or string, default nil]: creation datetime of the bank account associated with the DICT key. ex: '2020-11-05T14:55:08.812665+00:00'
+  # - owned [DateTime or string, default nil]: datetime since when the current owner hold this DICT key. ex : '2020-11-05T14:55:08.812665+00:00'
+  # - created [DateTime or string, default nil]: creation datetime for the DICT key. ex: '2020-03-10 10:30:00.000'
+  class DictKey < StarkBank::Utils::Resource
+    attr_reader :id, :type, :name, :tax_id, :owner_type, :ispb, :branch_code, :account_number, :account_type, :status, :account_created, :owned, :created
+    def initialize(
+      id:, type:, name:, tax_id:, owner_type:, ispb:, branch_code:, account_number:, account_type:,
+      status:, account_created:, owned:, created:
+    )
+      super(id)
+      @type = type
+      @name = name
+      @tax_id = tax_id
+      @owner_type = owner_type
+      @ispb = ispb
+      @branch_code = branch_code
+      @account_number = account_number
+      @account_type = account_type
+      @status = status
+      @account_created = StarkBank::Utils::Checks.check_datetime(account_created)
+      @owned = StarkBank::Utils::Checks.check_datetime(owned)
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+    end
+
+    # # Retrieve a specific DictKey
+    #
+    # Receive a single DictKey object by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: DictKey object unique id and PIX key itself. ex: 'tony@starkbank.com', '722.461.430-04', '20.018.183/0001-80', '+5511988887777', 'b6295ee1-f054-47d1-9e90-ee57b74f60d9'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - DictKey object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve DitcKeys
+    #
+    # Receive a generator of DitcKey objects previously created in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - type [string, default nil]: DictKey type. ex: 'cpf', 'cnpj', 'phone', 'email' or 'evp'
+    # - 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)
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'canceled', 'registered'
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
+    #
+    # ## Return:
+    # - generator of DitcKey objects with updated attributes
+    def self.query(limit: nil, type: nil, after: nil, before: nil, ids: nil, status: nil, user: nil)
+      after = StarkBank::Utils::Checks.check_date(after)
+      before = StarkBank::Utils::Checks.check_date(before)
+      StarkBank::Utils::Rest.get_list(
+        limit: limit,
+        type: type,
+        after: after,
+        before: before,
+        ids: ids,
+        status: status,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'DictKey',
+        resource_maker: proc { |json|
+          DictKey.new(
+            id: json['id'],
+            account_type: json['account_type'],
+            name: json['name'],
+            tax_id: json['tax_id'],
+            owner_type: json['owner_type'],
+            ispb: json['ispb'],
+            branch_code: json['branch_code'],
+            account_number: json['account_number'],
+            type: json['type'],
+            status: json['status'],
+            account_created: json['account_created'],
+            owned: json['owned'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/event/event.rb

@@ -9,6 +9,9 @@ require_relative('../utils/cache')
 require_relative('../error')
 require_relative('../boleto/log')
 require_relative('../boleto_holmes/log')
+require_relative('../invoice/log')
+require_relative('../deposit/log')
+require_relative('../brcode_payment/log')
 require_relative('../transfer/log')
 require_relative('../boleto_payment/log')
 require_relative('../utility_payment/log')
@@ -22,7 +25,7 @@ module StarkBank
   #
   # ## Attributes:
   # - id [string]: unique id returned when the event is created. ex: '5656565656565656'
-  # - log [Log]: a Log object from one the subscription services (TransferLog, BoletoLog, BoletoPaymentlog or UtilityPaymentLog)
+  # - log [Log]: a Log object from one the subscription services (TransferLog, InvoiceLog, BoletoLog, BoletoPaymentlog or UtilityPaymentLog)
   # - created [DateTime]: creation datetime for the notification event. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - is_delivered [bool]: true if the event has been successfully delivered to the user url. ex: False
   # - subscription [string]: service that triggered this event. ex: 'transfer', 'utility-payment'
@@ -36,6 +39,9 @@ module StarkBank
 
       resource = {
         'transfer': StarkBank::Transfer::Log.resource,
+        'invoice': StarkBank::Invoice::Log.resource,
+        'deposit': StarkBank::Deposit::Log.resource,
+        'brcode-payment': StarkBank::BrcodePayment::Log.resource,
         'boleto': StarkBank::Boleto::Log.resource,
         'boleto-payment': StarkBank::BoletoPayment::Log.resource,
         'utility-payment': StarkBank::UtilityPayment::Log.resource,
@@ -54,7 +60,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Event object with updated attributes
@@ -71,7 +77,7 @@ module StarkBank
     # - 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)
     # - is_delivered [bool, default nil]: bool to filter successfully delivered events. ex: True or False
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of Event objects with updated attributes
@@ -96,7 +102,7 @@ module StarkBank
     # - id [string]: Event unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted Event object
@@ -114,7 +120,7 @@ module StarkBank
     # - is_delivered [bool]: If True and event hasn't been delivered already, event will be set as delivered. ex: True
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - target Event with updated attributes
@@ -133,7 +139,7 @@ module StarkBank
     # - signature [string]: base-64 digital signature received at response header 'Digital-Signature'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Parsed Event object