starkbank 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d65ed1998822eddbae0c884f2ab425848c2a05711b680fed40a245fa5538d98
+  data.tar.gz: 34bc16683bbc9a2c3cfb8dcc3c3877ba2cd63be33553497e458d76052e0ba00d
+SHA512:
+  metadata.gz: e7013c769d56db0763f01d385b0f5e5d58b606d00efe7253537aaa738d0e20234c25daf5871cea0d18c0cca5ae0546597234d8d970b29e847c895280629445da
+  data.tar.gz: 6a71ddbe5114747fedc06ec97390a390c0017f2f7c4aae4637636595191a560aba3e266f66e48a883a987427b496a46d0395e5f45d984a375ec8d398cea69e43

data/lib/boleto/boleto.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # Boleto object
+  #
+  # When you initialize a Boleto, 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]: Boleto value in cents. Minimum = 200 (R$2,00). ex: 1234 (= R$ 12.34)
+  # - name [string]: payer full name. ex: "Anthony Edward Stark"
+  # - tax_id [string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
+  # - street_line_1 [string]: payer main address. ex: Av. Paulista, 200
+  # - street_line_2 [string]: payer address complement. ex: Apto. 123
+  # - district [string]: payer address district / neighbourhood. ex: Bela Vista
+  # - city [string]: payer address city. ex: Rio de Janeiro
+  # - state_code [string]: payer address state. ex: GO
+  # - zip_code [string]: payer address zip code. ex: 01311-200
+  # - due [Date, default today + 2 days]: Boleto due date in ISO format. ex: 2020-04-30
+  #
+  # ## Parameters (optional):
+  # - fine [float, default 0.0]: Boleto fine for overdue payment in %. ex: 2.5
+  # - interest [float, default 0.0]: Boleto monthly interest for overdue payment in %. ex: 5.2
+  # - overdue_limit [integer, default 59]: limit in days for automatic Boleto cancellation after due date. ex: 7 (max: 59)
+  # - descriptions [list of dictionaries, default nil]: list of dictionaries with "text":string and (optional) "amount":int pairs
+  # - tags [list of strings]: list of strings for tagging
+  #
+  # ## Attributes (return-only):
+  # - id [string, default nil]: unique id returned when Boleto is created. ex: "5656565656565656"
+  # - fee [integer, default nil]: fee charged when Boleto is paid. ex: 200 (= R$ 2.00)
+  # - line [string, default nil]: generated Boleto line for payment. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062"
+  # - bar_code [string, default nil]: generated Boleto bar-code for payment. ex: "34195819600000000621090063571277307144464000"
+  # - status [string, default nil]: current Boleto status. ex: "registered" or "paid"
+  # - created [DateTime, default nil]: creation datetime for the Boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class Boleto < StarkBank::Utils::Resource
+    attr_reader :amount, :name, :tax_id, :street_line_1, :street_line_2, :district, :city, :state_code, :zip_code, :due, :fine, :interest, :overdue_limit, :tags, :descriptions, :id, :fee, :line, :bar_code, :status, :created
+    def initialize(
+      amount:, name:, tax_id:, street_line_1:, street_line_2:, district:, city:, state_code:, zip_code:,
+      due: nil, fine: nil, interest: nil, overdue_limit: nil, tags: nil, descriptions: nil, id: nil, fee: nil, line: nil,
+      bar_code: nil, status: nil, created: nil
+    )
+      super(id)
+      @amount = amount
+      @name = name
+      @tax_id = tax_id
+      @street_line_1 = street_line_1
+      @street_line_2 = street_line_2
+      @district = district
+      @city = city
+      @state_code = state_code
+      @zip_code = zip_code
+      @due = due
+      @fine = fine
+      @interest = interest
+      @overdue_limit = overdue_limit
+      @tags = tags
+      @descriptions = descriptions
+      @fee = fee
+      @line = line
+      @bar_code = bar_code
+      @status = status
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create Boletos
+    #
+    # Send a list of Boleto objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - boletos [list of Boleto objects]: list of Boleto 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 Boleto objects with updated attributes
+    def self.create(boletos:, user: nil)
+      StarkBank::Utils::Rest.post(entities: boletos, user: user, **resource)
+    end
+
+    # # Retrieve a specific Boleto
+    #
+    # Receive a single Boleto 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:
+    # - Boleto object with updated attributes
+    def self.get(id:, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve a specific Boleto pdf file
+    #
+    # Receive a single Boleto 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:
+    # - Boleto pdf file
+    def self.pdf(id:, user: nil)
+      StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
+    end
+
+    # # Retrieve Boletos
+    #
+    # Receive a generator of Boleto 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
+    # - 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"]
+    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of Boleto objects with updated attributes
+    def self.query(limit: nil, status: nil, tags: nil, ids: nil, after: nil, before: 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, status: status, tags: tags, ids: ids, after: after, before: before, **resource)
+    end
+
+    # # Delete a Boleto entity
+    #
+    # Delete a Boleto entity previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - id [string]: Boleto unique id. ex: "5656565656565656"
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - deleted Boleto with updated attributes
+    def self.delete(id:, user: nil)
+      StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'Boleto',
+        resource_maker: proc { |json|
+          Boleto.new(
+            amount: json['amount'],
+            name: json['name'],
+            tax_id: json['tax_id'],
+            street_line_1: json['street_line_1'],
+            street_line_2: json['street_line_2'],
+            district: json['district'],
+            city: json['city'],
+            state_code: json['state_code'],
+            zip_code: json['zip_code'],
+            due: json['due'],
+            fine: json['fine'],
+            interest: json['interest'],
+            overdue_limit: json['overdue_limit'],
+            tags: json['tags'],
+            descriptions: json['descriptions'],
+            id: json['id'],
+            fee: json['fee'],
+            line: json['line'],
+            bar_code: json['bar_code'],
+            status: json['status'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/boleto/log.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('boleto')
+
+module StarkBank
+  class Boleto
+    # # Boleto::Log object
+    #
+    # Every time a Boleto entity is updated, a corresponding Boleto::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 Boleto.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: "5656565656565656"
+    # - boleto [Boleto]: Boleto entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this Boleto event
+    # - type [string]: type of the Boleto event which triggered the log creation. ex: "registered" or "paid"
+    # - created [DateTime]: creation datetime for the boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkBank::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :boleto
+      def initialize(id:, created:, type:, errors:, boleto:)
+        super(id)
+        @type = type
+        @errors = errors
+        @boleto = boleto
+        @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
+      # - boleto_ids [list of strings, default nil]: list of Boleto ids to filter logs. ex: ["5656565656565656", "4545454545454545"]
+      # - types [list of strings, default nil]: filter for log event types. ex: "paid" or "registered"
+      # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+      # - 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, boleto_ids: nil, types: nil, after: nil, before: 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, boleto_ids: boleto_ids, types: types, after: after, before: before, **resource)
+      end
+
+      def self.resource
+        boleto_maker = StarkBank::Boleto.resource[:resource_maker]
+        {
+          resource_name: 'BoletoLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              boleto: StarkBank::Utils::API.from_api_json(boleto_maker, json['boleto'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/error.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require('json')
+
+module StarkBank
+  module Error
+    class Error < StandardError
+      attr_reader :code, :message
+      def initialize(code, message)
+        @code = code
+        @message = message
+        super("#{code}: #{message}")
+      end
+    end
+
+    class InputErrors < StandardError
+      attr_reader :errors
+      def initialize(content)
+        errors = []
+        content.each do |error|
+          errors << Error.new(error['code'], error['message'])
+        end
+        @errors = errors
+
+        super(content.to_json)
+      end
+    end
+
+    class InternalServerError < StandardError
+      def initialize(message = 'Houston, we have a problem.')
+        super(message)
+      end
+    end
+
+    class UnknownError < StandardError
+      def initialize(message)
+        super("Unknown exception encountered: #{message}")
+      end
+    end
+
+    class InvalidSignatureError < StandardError
+    end
+  end
+end

data/lib/key.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require('starkbank-ecdsa')
+
+module StarkBank
+  module Key
+    # # Generate a new key pair
+    # Generates a secp256k1 ECDSA private/public key pair to be used in the API
+    # authentications
+    #
+    # ## Parameters (optional):
+    # - path [string]: path to save the keys .pem files. No files will be saved if this parameter isn't provided
+    #
+    # ## Return:
+    # - private and public key pems
+    def self.create(path = nil)
+      private_key = PrivateKey.new
+      public_key = private_key.publicKey
+
+      private_key_pem = private_key.toPem
+      public_key_pem = public_key.toPem
+
+      unless path.nil?
+        FileUtils.mkdir_p(path)
+        File.write(File.join(path, 'private.pem'), private_key_pem)
+        File.write(File.join(path, 'public.pem'), public_key_pem)
+      end
+
+      [private_key_pem, public_key_pem]
+    end
+  end
+end

data/lib/ledger/balance.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # Balance object
+  #
+  # The Balance object displays the current balance of the workspace,
+  # which is the result of the sum of all transactions within this
+  # workspace. The balance is never generated by the user, but it
+  # can be retrieved to see the available information.
+  #
+  # ## Attributes (return-only):
+  # - id [string, default nil]: unique id returned when Boleto is created. ex: "5656565656565656"
+  # - amount [integer, default nil]: current balance amount of the workspace in cents. ex: 200 (= R$ 2.00)
+  # - currency [string, default nil]: currency of the current workspace. Expect others to be added eventually. ex: "BRL"
+  # - updated [DateTime, default nil]: update datetime for the balance. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class Balance < StarkBank::Utils::Resource
+    attr_reader :amount, :currency, :updated
+    def initialize(amount:, currency:, updated:, id:)
+      super(id)
+      @amount = amount
+      @currency = currency
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Retrieve the Balance object
+    #
+    # Receive the Balance object linked to your workspace in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - Balance object with updated attributes
+    def self.get(user: nil)
+      StarkBank::Utils::Rest.get_list(user: user, **resource).next
+    end
+
+    class << self
+      private
+
+      def resource
+        {
+          resource_name: 'Balance',
+          resource_maker: proc { |json|
+            Balance.new(
+              amount: json['amount'],
+              currency: json['currency'],
+              updated: json['updated'],
+              id: json['id']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/ledger/transaction.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # Transaction object
+  #
+  # A Transaction is a transfer of funds between workspaces inside Stark Bank.
+  # Transactions created by the user are only for internal transactions.
+  # Other operations (such as transfer or charge-payment) will automatically
+  # create a transaction for the user which can be retrieved for the statement.
+  # When you initialize a Transaction, 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):
+  # - amount [integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34)
+  # - description [string]: text to be displayed in the receiver and the sender statements (Min. 10 characters). ex: "funds redistribution"
+  # - external_id [string]: unique id, generated by user, to avoid duplicated transactions. ex: "transaction ABC 2020-03-30"
+  # - received_id [string]: unique id of the receiving workspace. ex: "5656565656565656"
+  #
+  # ## Parameters (optional):
+  # - tags [list of strings]: list of strings for reference when searching transactions (may be empty). ex: ["abc", "test"]
+  #
+  # ## Attributes (return-only):
+  # - source [string, default nil]: locator of the entity that generated the transaction. ex: "charge/1827351876292", "transfer/92873912873/chargeback"
+  # - id [string, default nil]: unique id returned when Transaction is created. ex: "7656565656565656"
+  # - fee [integer, default nil]: fee charged when transfer is created. ex: 200 (= R$ 2.00)
+  # - created [DateTime, default nil]: creation datetime for the boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class Transaction < StarkBank::Utils::Resource
+    attr_reader :amount, :description, :external_id, :receiver_id, :tags, :id, :fee, :created, :source
+    def initialize(amount:, description:, external_id:, receiver_id:, tags: nil, id: nil, fee: nil, created: nil, source: nil)
+      super(id)
+      @amount = amount
+      @description = description
+      @external_id = external_id
+      @receiver_id = receiver_id
+      @tags = tags
+      @fee = fee
+      @source = source
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create Transactions
+    #
+    # Send a list of Transaction objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - transactions [list of Transaction objects]: list of Transaction 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 Transaction objects with updated attributes
+    def self.create(transactions:, user: nil)
+      StarkBank::Utils::Rest.post(entities: transactions, user: user, **resource)
+    end
+
+    # # Retrieve a specific Transaction
+    #
+    # Receive a single Transaction 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:
+    # - Transaction object with updated attributes
+    def self.get(id:, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve Transactions
+    #
+    # Receive a generator of Transaction 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
+    # - external_ids [list of strings, default nil]: list of external ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
+    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of Transaction objects with updated attributes
+    def self.query(limit: nil, external_ids: nil, after: nil, before: 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, external_ids: external_ids, after: after, before: before, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'Transaction',
+        resource_maker: proc { |json|
+          Transaction.new(
+            amount: json['amount'],
+            description: json['description'],
+            external_id: json['external_id'],
+            receiver_id: json['receiver_id'],
+            tags: json['tags'],
+            id: json['id'],
+            fee: json['fee'],
+            created: json['created'],
+            source: json['source']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/payment/boleto/boleto.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require_relative('../../utils/resource')
+require_relative('../../utils/rest')
+require_relative('../../utils/checks')
+
+module StarkBank
+  # # BoletoPayment object
+  #
+  # When you initialize a BoletoPayment, 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 (conditionally required):
+  # - line [string, default nil]: Number sequence that describes the payment. Either 'line' or 'bar_code' parameters are required. If both are sent, they must match. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062"
+  # - bar_code [string, default nil]: Bar code number that describes the payment. Either 'line' or 'barCode' parameters are required. If both are sent, they must match. ex: "34195819600000000621090063571277307144464000"
+  #
+  # ## Parameters (required):
+  # - 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 (optional):
+  # - scheduled [Date, default today]: payment scheduled date. ex: Date.new(2020, 3, 10)
+  # - tags [list of strings]: 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: "registered" or "paid"
+  # - amount [int, default nil]: amount automatically calculated from line or bar_code. ex: 23456 (= R$ 234.56)
+  # - fee [integer, default nil]: fee charged when boleto payment is created. ex: 200 (= R$ 2.00)
+  # - created [DateTime, default nil]: creation datetime for the payment. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class BoletoPayment < StarkBank::Utils::Resource
+    attr_reader :tax_id, :description, :line, :bar_code, :scheduled, :tags, :id, :status, :amount, :fee, :created
+    def initialize(tax_id:, description:, line: nil, bar_code: nil, scheduled: nil, tags: nil, id: nil, status: nil, amount: nil, fee: nil, created: nil)
+      super(id)
+      @tax_id = tax_id
+      @description = description
+      @line = line
+      @bar_code = bar_code
+      @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
+      @tags = tags
+      @status = status
+      @amount = amount
+      @fee = fee
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create BoletoPayments
+    #
+    # Send a list of BoletoPayment objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - payments [list of BoletoPayment objects]: list of BoletoPayment 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 BoletoPayment objects with updated attributes
+    def self.create(payments:, user: nil)
+      StarkBank::Utils::Rest.post(entities: payments, user: user, **resource)
+    end
+
+    # # Retrieve a specific BoletoPayment
+    #
+    # Receive a single BoletoPayment 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:
+    # - BoletoPayment object with updated attributes
+    def self.get(id:, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve a specific BoletoPayment pdf file
+    #
+    # Receive a single BoletoPayment pdf file generated in the Stark Bank API by passing its id.
+    # Only valid for boleto payments with "success" status.
+    #
+    # ## 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:
+    # - BoletoPayment pdf file
+    def self.pdf(id:, user: nil)
+      StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
+    end
+
+    # # Retrieve BoletoPayments
+    #
+    # Receive a generator of BoletoPayment 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
+    # - status [string, default nil]: filter for status of retrieved objects. ex: "paid"
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ["tony", "stark"]
+    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of BoletoPayment objects with updated attributes
+    def self.query(limit: nil, status: nil, tags: nil, ids: nil, after: nil, before: 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, status: status, tags: tags, ids: ids, after: after, before: before, **resource)
+    end
+
+    # # Delete a BoletoPayment entity
+    #
+    # Delete a BoletoPayment entity previously created in the Stark Bank API
+    #
+    # Parameters (required):
+    # - id [string]: BoletoPayment unique id. ex: "5656565656565656"
+    # Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # Return:
+    # - deleted BoletoPayment with updated attributes
+    def self.delete(id:, user: nil)
+      StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'BoletoPayment',
+        resource_maker: proc { |json|
+          BoletoPayment.new(
+            id: json['id'],
+            tax_id: json['tax_id'],
+            description: json['description'],
+            line: json['line'],
+            bar_code: json['bar_code'],
+            scheduled: json['scheduled'],
+            tags: json['tags'],
+            status: json['status'],
+            amount: json['amount'],
+            fee: json['fee'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end