starkbank 2.2.0.beta2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 766b123365232a3f071a9a12072eaf8fc2f30021a72ed0f4a41b54726fca81c5
-  data.tar.gz: 5c8349015b1ee06624223bdeb28ca9f3765e92bba3d62ebe04e76656a0ec14e8
+  metadata.gz: e965f06caeae2a43c2fc9baaba12d8e809e4d72cf3b3a1290fde4b6667b99af0
+  data.tar.gz: 909f49d2384c4195d8090a7632d072c5670685c0108f50f6831aa263ae9e485c
 SHA512:
-  metadata.gz: b397a9af3581435b2398b7d0e19ff6e252c73024b7bad74d1f49e909f1eda18c95b89b4a95741340e6519aab69d7c1247bfcdb5b05dca5ecf589bb2c404ce743
-  data.tar.gz: 1bf497cdc47b95a04bba1b3dc199ffda07cff053c9b4aeced2feb82538ad2d0183b8d5049b677068a4cc2bdbdc63d6f5f4d1ec64f615d602be27678f41b77514
+  metadata.gz: dd47fb09e160dda9118f8e7909ab032454e976fbac17fd8e72b6e27855def6371f923f965ba581b686519d5bc99549b47ecf37a067da687cc2e6b5b4b16daa99
+  data.tar.gz: 4c9c9efc45a25b3383d9979df7531e7d94b9aaf594196b499a305a84988fbb03648f9581fd23faf5026fe0db35de231c9e49fd642ea243e7ad56e041b706f897

data/lib/boleto/boleto.rb

@@ -115,12 +115,13 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - layout [string]: Layout specification. Available options are "default" and "booklet"
+    # - hidden_fields [list of strings, default nil]: List of string fields to be hidden in Boleto pdf. ex: ["customerAddress"]
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Boleto pdf file
-    def self.pdf(id, layout: nil, user: nil)
-      StarkBank::Utils::Rest.get_pdf(id: id, layout: layout, user: user, **resource)
+    def self.pdf(id, layout: nil, hidden_fields: nil, user: nil)
+      StarkBank::Utils::Rest.get_pdf(id: id, layout: layout, hidden_fields: hidden_fields, user: user, **resource)
     end
 
     # # Retrieve Boletos

data/lib/boleto_payment/log.rb

@@ -54,7 +54,7 @@ module StarkBank
       # - 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 retrieved objects by event types. ex: 'paid' or 'registered'
+      # - types [list of strings, default nil]: filter retrieved objects by event types. ex: 'success' or 'failed'
       # - payment_ids [list of strings, default nil]: list of BoletoPayment 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
       #

data/lib/brcode_payment/brcode_payment.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # BrcodePayment object
+  #
+  # When you initialize a BrcodePayment, the entity will not be automatically
+  # created in the Stark Bank API. The 'create' function sends the objects
+  # to the Stark Bank API and returns the list of created objects.
+  #
+  # ## Parameters (required):
+  # - brcode [string]: String loaded directly from the QRCode or copied from the invoice. ex: "00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A"
+  # - tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
+  # - description [string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC"
+  #
+  # ## Parameters (conditionally required):
+  # - amount [int, default nil]: If the BRCode does not provide an amount, this parameter is mandatory, else it is optional. ex: 23456 (= R$ 234.56)
+  #
+  # ## Parameters (optional):
+  # - scheduled [datetime.date, datetime.datetime or string, default now]: payment scheduled date or datetime. ex: datetime.datetime(2020, 3, 10, 15, 17, 3)
+  # - tags [list of strings, default nil]: list of strings for tagging
+  #
+  # ## Attributes (return-only):
+  # - id [string, default nil]: unique id returned when payment is created. ex: "5656565656565656"
+  # - status [string, default nil]: current payment status. ex: "success" or "failed"
+  # - type [string, default nil]: brcode type. ex: "static" or "dynamic"
+  # - fee [integer, default nil]: fee charged when the brcode payment is created. ex: 200 (= R$ 2.00)
+  # - updated [datetime.datetime, default nil]: latest update datetime for the payment. ex: datetime.datetime(2020, 3, 10, 10, 30, 0, 0)
+  # - created [datetime.datetime, default nil]: creation datetime for the payment. ex: datetime.datetime(2020, 3, 10, 10, 30, 0, 0)
+  class BrcodePayment < StarkBank::Utils::Resource
+    attr_reader :brcode, :tax_id, :description, :amount, :scheduled, :tags, :id, :status, :type, :fee, :updated, :created
+    def initialize(brcode:, tax_id:, description:, amount: nil, scheduled: nil, tags: nil, id: nil, status: nil, type: nil, fee: nil, updated: nil, created: nil)
+      super(id)
+      @brcode = brcode
+      @tax_id = tax_id
+      @description = description
+      @amount = amount
+      @scheduled = StarkBank::Utils::Checks.check_date_or_datetime(scheduled)
+      @tags = tags
+      @status = status
+      @type = type
+      @fee = fee
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create BrcodePayments
+    #
+    # Send a list of BrcodePayment objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - payments [list of BrcodePayment objects]: list of BrcodePayment 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 BrcodePayment objects with updated attributes
+    def self.create(payments, user: nil)
+      StarkBank::Utils::Rest.post(entities: payments, user: user, **resource)
+    end
+
+    # # Retrieve a specific BrcodePayment
+    #
+    # Receive a single BrcodePayment 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:
+    # - BrcodePayment object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve a specific BrcodePayment pdf file
+    #
+    # Receive a single BrcodePayment 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:
+    # - BrcodePayment pdf file
+    def self.pdf(id, user: nil)
+      StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
+    end
+
+    # # Update a BrcodePayment entity
+    #
+    # Update a BrcodePayment entity previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - id [string]: BrcodePayment unique id. ex: '5656565656565656'
+    # - status [string, nil]: You may cancel the payment by passing 'canceled' in the status
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - updated BrcodePayment object
+    def self.update(id, status: nil, user: nil)
+      StarkBank::Utils::Rest.patch_id(id: id, status: status, user: user, **resource)
+    end
+
+    # # Retrieve BrcodePayments
+    #
+    # Receive a generator of BrcodePayment 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)
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - ids [list of strings, default nil]: list of strings to get specific entities by ids. ex: ['12376517623', '1928367198236']
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid'
+    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of BrcodePayment objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, tags: 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(
+        user: user,
+        limit: limit,
+        after: after,
+        before: before,
+        tags: tags,
+        ids: ids,
+        status: status,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'BrcodePayment',
+        resource_maker: proc { |json|
+          BrcodePayment.new(
+            brcode: json['brcode'],
+            tax_id: json['tax_id'],
+            description: json['description'],
+            amount: json['amount'],
+            scheduled: json['scheduled'],
+            tags: json['tags'],
+            id: json['id'],
+            status: json['status'],
+            type: json['type'],
+            fee: json['fee'],
+            updated: json['updated'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/brcode_payment/log.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('brcode_payment')
+
+module StarkBank
+  class BrcodePayment
+    # # BrcodePayment::Log object
+    #
+    # Every time a BrcodePayment entity is modified, a corresponding BrcodePayment::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 BrcodePayment.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - payment [BrcodePayment]: BrcodePayment entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this BrcodePayment event.
+    # - type [string]: type of the BrcodePayment event which triggered the log creation. ex: 'processing' or 'success'
+    # - 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, :payment
+      def initialize(id:, created:, type:, errors:, payment:)
+        super(id)
+        @type = type
+        @errors = errors
+        @payment = payment
+        @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 retrieved objects by event types. ex: 'success' or 'failed'
+      # - payment_ids [list of strings, default nil]: list of BrcodePayment 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:
+      # - list of Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, payment_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,
+          payment_ids: payment_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        payment_maker = StarkBank::BrcodePayment.resource[:resource_maker]
+        {
+          resource_name: 'BrcodePaymentLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              payment: StarkBank::Utils::API.from_api_json(payment_maker, json['payment'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -10,6 +10,8 @@ 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')
@@ -38,6 +40,8 @@ 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

@@ -32,15 +32,16 @@ module StarkBank
   # - 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, :due, :tax_id, :name, :expiration, :fine, :interest, :discounts, :tags, :descriptions, :nominal_amount, :fine_amount, :interest_amount, :discount_amount, :id, :brcode, :status, :created, :updated
+    attr_reader :amount, :due, :tax_id, :name, :expiration, :fine, :interest, :discounts, :tags, :descriptions, :nominal_amount, :fine_amount, :interest_amount, :discount_amount, :id, :brcode, :fee, :status, :created, :updated
     def initialize(
       amount:, due:, tax_id:, name:, 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, status: nil, created: nil, updated: nil
+      discount_amount: nil, id: nil, brcode: nil, fee: nil, status: nil, created: nil, updated: nil
     )
       super(id)
       @amount = amount
@@ -58,6 +59,7 @@ module StarkBank
       @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)
@@ -95,6 +97,38 @@ module StarkBank
       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
@@ -133,10 +167,13 @@ module StarkBank
     # - id [string]: Invoice unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - 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:
-    # - deleted Invoice object
+    # - 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
@@ -162,6 +199,7 @@ module StarkBank
             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'],

data/lib/invoice/log.rb

@@ -9,7 +9,7 @@ module StarkBank
   class Invoice
     # # Invoice::Log object
     #
-    # Every time a Invoice entity is updated, a corresponding Invoice::Log
+    # Every time an Invoice entity is updated, a corresponding Invoice::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 Invoice.

data/lib/starkbank.rb

@@ -6,6 +6,12 @@ require_relative('balance/balance')
 require_relative('transaction/transaction')
 require_relative('invoice/invoice')
 require_relative('invoice/log')
+require_relative('dict_key/dict_key')
+require_relative('deposit/deposit')
+require_relative('deposit/log')
+require_relative('brcode_preview/brcode_preview')
+require_relative('brcode_payment/brcode_payment')
+require_relative('brcode_payment/log')
 require_relative('boleto/boleto')
 require_relative('boleto/log')
 require_relative('boleto_holmes/boleto_holmes')

data/lib/transfer/transfer.rb

@@ -15,13 +15,13 @@ module StarkBank
   # - amount [integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34)
   # - name [string]: receiver full name. ex: 'Anthony Edward Stark'
   # - tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
-  # - bank_code [string]: 1 to 3 digits of the receiver bank institution in Brazil. ex: '200' or '341'
+  # - bank_code [string]: code of the receiver bank institution in Brazil. If an ISPB (8 digits) is informed, a PIX transfer will be created, else a TED will be issued. ex: '20018183' or '260'
   # - branch_code [string]: receiver bank account branch. Use '-' in case there is a verifier digit. ex: '1357-9'
   # - account_number [string]: Receiver Bank Account number. Use '-' before the verifier digit. ex: '876543-2'
   #
   # ## Parameters (optional):
   # - tags [list of strings]: list of strings for reference when searching for transfers. ex: ['employees', 'monthly']
-  # - scheduled [string, default now]: datetime when the transfer will be processed. May be pushed to next business day if necessary. ex: DateTime.new(2020, 3, 11, 8, 0, 0, 0)
+  # - scheduled [string, default now]: datetime when the transfer will be processed. May be pushed to next business day if necessary. ex: DateTime.new(2020, 3, 11, 8, 13, 12, 11)
   #
   # ## Attributes (return-only):
   # - id [string, default nil]: unique id returned when Transfer is created. ex: '5656565656565656'
@@ -40,7 +40,7 @@ module StarkBank
       @bank_code = bank_code
       @branch_code = branch_code
       @account_number = account_number
-      @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
+      @scheduled = StarkBank::Utils::Checks.check_date_or_datetime(scheduled)
       @transaction_ids = transaction_ids
       @fee = fee
       @tags = tags

data/lib/utils/api.rb

@@ -64,6 +64,7 @@ module StarkBank
         base = last_name(resource_name)
 
         return base if base[-1].eql?('s')
+        return "#{base}s" if base[-2..-1].eql?('ey')
         return "#{base[0...-1]}ies" if base[-1].eql?('y')
 
         "#{base}s"

data/lib/utils/checks.rb

@@ -39,6 +39,17 @@ module StarkBank
         raise(ArgumentError, 'Private-key must be a valid secp256k1 ECDSA string in pem format')
       end
 
+      def self.check_date_or_datetime(data)
+        return if data.nil?
+
+        return data if data.is_a?(Time) || data.is_a?(DateTime)
+
+        return data if data.is_a?(Date)
+
+        data, type = check_datetime_string(data)
+        type == 'date' ? Date.new(data.year, data.month, data.day) : data
+      end
+
       def self.check_datetime(data)
         return if data.nil?
 

data/lib/utils/request.rb

@@ -61,7 +61,7 @@ module StarkBank
         req['Access-Time'] = access_time
         req['Access-Signature'] = signature
         req['Content-Type'] = 'application/json'
-        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.2.0.beta2"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.2.0"
         req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }

data/lib/utils/rest.rb

@@ -56,6 +56,15 @@ module StarkBank
         ).content
       end
 
+      def self.get_qrcode(resource_name:, resource_maker:, id:, user: nil, **query)
+        StarkBank::Utils::Request.fetch(
+          method: 'GET',
+          path: "#{StarkBank::Utils::API.endpoint(resource_name)}/#{id}/qrcode",
+          query: StarkBank::Utils::API.cast_json_to_api_format(query),
+          user: user
+        ).content
+      end
+
       def self.post(resource_name:, resource_maker:, entities:, user: nil)
         jsons = []
         entities.each do |entity|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 2.2.0.beta2
+  version: 2.2.0
 platform: ruby
 authors:
 - starkbank
@@ -79,6 +79,12 @@ files:
 - lib/boleto_holmes/log.rb
 - lib/boleto_payment/boleto_payment.rb
 - lib/boleto_payment/log.rb
+- lib/brcode_payment/brcode_payment.rb
+- lib/brcode_payment/log.rb
+- lib/brcode_preview/brcode_preview.rb
+- lib/deposit/deposit.rb
+- lib/deposit/log.rb
+- lib/dict_key/dict_key.rb
 - lib/error.rb
 - lib/event/event.rb
 - lib/invoice/invoice.rb
@@ -118,9 +124,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: