starkbank 2.1.0.beta1 → 2.2.1

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 [Project object]: 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 [Project object, default nil]: 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 [Project object]: 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 [Project object, default nil]: 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,

data/lib/invoice/invoice.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # Invoice object
+  #
+  # When you initialize an Invoice, the entity will not be automatically
+  # sent to the Stark Bank API. The 'create' function sends the objects
+  # to the Stark Bank API and returns the list of created objects.
+  #
+  # ## Parameters (required):
+  # - amount [integer]: Invoice value in cents. Minimum = 0 (any value will be accepted). ex: 1234 (= R$ 12.34)
+  # - tax_id [string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  # - name [string]: payer name. ex: 'Iron Bank S.A.'
+  #
+  # ## Parameters (optional):
+  # - due [DateTime or string, default now + 2 days]: Invoice due date in UTC ISO format. ex: '2020-10-28T17:59:26.249976+00:00'
+  # - expiration [integer, default 5097600 (59 days)]: time interval in seconds between due date and expiration date. ex 123456789
+  # - fine [float, default 0.0]: Invoice fine for overdue payment in %. ex: 2.5
+  # - interest [float, default 0.0]: Invoice monthly interest for overdue payment in %. ex: 5.2
+  # - discounts [list of hashes, default nil]: list of hashes with 'percentage':float and 'due':DateTime or string pairs
+  # - descriptions [list of hashes, default nil]: list of hashes with 'key':string and 'value':string pairs
+  # - tags [list of strings, default nil]: list of strings for tagging
+  #
+  # ## Attributes (return-only):
+  # - id [string, default nil]: unique id returned when Invoice is created. ex: '5656565656565656'
+  # - nominal_amount [integer, default nil]: Invoice emission value in cents (will change if invoice is updated, but not if it's paid). ex: 400000
+  # - fine_amount [integer, default nil]: Invoice fine value calculated over nominal_amount. ex: 20000
+  # - interest_amount [integer, default nil]: Invoice interest value calculated over nominal_amount. ex: 10000
+  # - discount_amount [integer, default nil]: Invoice discount value calculated over nominal_amount. ex: 3000
+  # - brcode [string, default nil]: BR Code for the Invoice payment. ex: '00020101021226800014br.gov.bcb.pix2558invoice.starkbank.com/f5333103-3279-4db2-8389-5efe335ba93d5204000053039865802BR5913Arya Stark6009Sao Paulo6220051656565656565656566304A9A0'
+  # - fee [integer, default nil]: fee charged by the Invoice. ex: 65 (= R$ 0.65)
+  # - status [string, default nil]: current Invoice status. ex: 'registered' or 'paid'
+  # - created [DateTime, default nil]: creation datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime, default nil]: latest update datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class Invoice < StarkBank::Utils::Resource
+    attr_reader :amount, :tax_id, :name, :due, :expiration, :fine, :interest, :discounts, :tags, :descriptions, :nominal_amount, :fine_amount, :interest_amount, :discount_amount, :id, :brcode, :fee, :status, :created, :updated
+    def initialize(
+      amount:, tax_id:, name:, due: nil, expiration: nil, fine: nil, interest: nil, discounts: nil,
+      tags: nil, descriptions: nil, nominal_amount: nil, fine_amount: nil, interest_amount: nil,
+      discount_amount: nil, id: nil, brcode: nil, fee: nil, status: nil, created: nil, updated: nil
+    )
+      super(id)
+      @amount = amount
+      @due = StarkBank::Utils::Checks.check_datetime(due)
+      @tax_id = tax_id
+      @name = name
+      @expiration = expiration
+      @fine = fine
+      @interest = interest
+      @discounts = discounts
+      @tags = tags
+      @descriptions = descriptions
+      @nominal_amount = nominal_amount
+      @fine_amount = fine_amount
+      @interest_amount = interest_amount
+      @discount_amount = discount_amount
+      @brcode = brcode
+      @fee = fee
+      @status = status
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create Invoices
+    #
+    # Send a list of Invoice objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - invoices [list of Invoice objects]: list of Invoice objects to be created in the API
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of Invoice objects with updated attributes
+    def self.create(invoices, user: nil)
+      StarkBank::Utils::Rest.post(entities: invoices, user: user, **resource)
+    end
+
+    # # Retrieve a specific Invoice
+    #
+    # Receive a single Invoice object previously created in the Stark Bank API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - Invoice object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve a specific Invoice pdf file
+    #
+    # Receive a single Invoice pdf file generated in the Stark Bank API by passing its id.
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - Invoice pdf file
+    def self.pdf(id, user: nil)
+      StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
+    end
+
+    # # Retrieve a specific Invoice QR Code file
+    #
+    # Receive a single Invoice QR Code png file generated in the Stark Bank API by passing its id.
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - Invoice QR Code png blob
+    def self.qrcode(id, user: nil)
+      StarkBank::Utils::Rest.get_qrcode(id: id, user: user, **resource)
+    end
+
+    # # Retrieve Invoices
+    #
+    # Receive a generator of Invoice 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'
+    # - 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 [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of Invoice objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: 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,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Update an Invoice entity
+    #
+    # Update an Invoice entity previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - id [string]: Invoice unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - status [string, nil]: You may cancel the invoice by passing 'canceled' in the status
+    # - amount [string, nil]: Nominal amount charged by the invoice. ex: 100 (R$1.00)
+    # - due [datetime.date or string, default nil]: Invoice due date in UTC ISO format. ex: DateTime.new(2020, 3, 10, 10, 30, 12, 21)
+    # - expiration [number, default nil]: time interval in seconds between the due date and the expiration date. ex 123456789
+    #
+    # ## Return:
+    # - updated Invoice object
+    def self.update(id, status: nil, amount: nil, due: nil, expiration: nil, user: nil)
+      StarkBank::Utils::Rest.patch_id(id: id, status: status, amount: amount, due: due, expiration: expiration, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'Invoice',
+        resource_maker: proc { |json|
+          Invoice.new(
+            id: json['id'],
+            amount: json['amount'],
+            due: json['due'],
+            tax_id: json['tax_id'],
+            name: json['name'],
+            expiration: json['expiration'],
+            fine: json['fine'],
+            interest: json['interest'],
+            discounts: json['discounts'],
+            tags: json['tags'],
+            descriptions: json['descriptions'],
+            nominal_amount: json['nominal_amount'],
+            fine_amount: json['fine_amount'],
+            interest_amount: json['interest_amount'],
+            discount_amount: json['discount_amount'],
+            brcode: json['brcode'],
+            fee: json['fee'],
+            status: json['status'],
+            updated: json['updated'],
+            created: json['created'],
+          )
+        }
+      }
+    end
+  end
+end