starkbank 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cde164881e744d7dd89ef1890e4793bb3b00b176309fd68878154562204f0fa
-  data.tar.gz: f216ff9ab2526f9807d13e3599412a3c8439d3b20e1ba7396df1aa7b50b75a8b
+  metadata.gz: e965f06caeae2a43c2fc9baaba12d8e809e4d72cf3b3a1290fde4b6667b99af0
+  data.tar.gz: 909f49d2384c4195d8090a7632d072c5670685c0108f50f6831aa263ae9e485c
 SHA512:
-  metadata.gz: 2abcedf46bd193107cbafb446461199d573c72ef8fdf2c9182479e0ee897396f16298debb9d19920fba358babc1247c3f48a2bd8e9b80155d6f7a867de22987e
-  data.tar.gz: 2d95dd80a1fd990aa4d1a71dc32c01674c7c52471e7d8369db5787faf382e3c3043300762bc9d85d15a597e31399e7084eb3a25e943603176ea8503c0b258082
+  metadata.gz: dd47fb09e160dda9118f8e7909ab032454e976fbac17fd8e72b6e27855def6371f923f965ba581b686519d5bc99549b47ecf37a067da687cc2e6b5b4b16daa99
+  data.tar.gz: 4c9c9efc45a25b3383d9979df7531e7d94b9aaf594196b499a305a84988fbb03648f9581fd23faf5026fe0db35de231c9e49fd642ea243e7ad56e041b706f897

data/lib/boleto/boleto.rb

@@ -58,7 +58,7 @@ module StarkBank
       @city = city
       @state_code = state_code
       @zip_code = zip_code
-      @due = due
+      @due = StarkBank::Utils::Checks.check_date(due)
       @fine = fine
       @interest = interest
       @overdue_limit = overdue_limit
@@ -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_holmes/boleto_holmes.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # BoletoHolmes object
+  #
+  # When you initialize a BoletoHolmes, 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):
+  # - boleto_id [string]: investigated boleto entity ID. ex: '5656565656565656'
+  #
+  # ## Parameters (optional):
+  # - tags [list of strings]: list of strings for tagging
+  #
+  # ## Attributes (return-only):
+  # - id [string, default nil]: unique id returned when holmes is created. ex: '5656565656565656'
+  # - status [string, default nil]: current holmes status. ex: 'solving' or 'solved'
+  # - result [string, default nil]: result of boleto status investigation. ex: 'paid' or 'cancelled'
+  # - created [DateTime, default nil]: creation datetime for the Boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime, default nil]: latest update datetime for the holmes. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class BoletoHolmes < StarkBank::Utils::Resource
+    attr_reader :boleto_id, :tags, :id, :status, :result, :created, :updated
+    def initialize(
+      boleto_id:, tags: nil, id: nil, status: nil, result: nil, created: nil, updated: nil
+    )
+      super(id)
+      @boleto_id = boleto_id
+      @tags = tags
+      @status = status
+      @result = result
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create BoletoHolmes
+    #
+    # Send a list of BoletoHolmes objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - holmes [list of BoletoHolmes objects]: list of BoletoHolmes 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 BoletoHolmes objects with updated attributes
+    def self.create(holmes, user: nil)
+      StarkBank::Utils::Rest.post(entities: holmes, user: user, **resource)
+    end
+
+    # # Retrieve a specific BoletoHolmes
+    #
+    # Receive a single BoletoHolmes 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:
+    # - BoletoHolmes object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve BoletoHolmes
+    #
+    # Receive a generator of BoletoHolmes 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: 'solved'
+    # - 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']
+    # - boleto_id [string, default nil]: filter for holmes that investigate a specific boleto by its ID. ex: '5656565656565656'
+    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of BoletoHolmes objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, boleto_id: 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,
+        boleto_id: boleto_id,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'BoletoHolmes',
+        resource_maker: proc { |json|
+          BoletoHolmes.new(
+            boleto_id: json['boleto_id'],
+            tags: json['tags'],
+            id: json['id'],
+            status: json['status'],
+            result: json['result'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/boleto_holmes/log.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('boleto_holmes')
+
+module StarkBank
+  class BoletoHolmes
+    # # BoletoHolmes::Log object
+    #
+    # Every time a BoletoHolmes entity is modified, a corresponding BoletoHolmes::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 BoletoHolmes.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - holmes [BoletoHolmes]: BoletoHolmes entity to which the log refers to.
+    # - type [string]: type of the Boleto event which triggered the log creation. ex: 'registered' 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, :holmes, :type, :created
+      def initialize(id:, holmes:, type:, created:)
+        super(id)
+        @holmes = holmes
+        @type = type
+        @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 'registered'
+      # - holmes_ids [list of strings, default nil]: list of BoletoHolmes 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, holmes_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,
+          holmes_ids: holmes_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        holmes_maker = StarkBank::BoletoHolmes.resource[:resource_maker]
+        {
+          resource_name: 'BoletoHolmesLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              holmes: StarkBank::Utils::API.from_api_json(holmes_maker, json['holmes']),
+              type: json['type'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/boleto_payment/boleto_payment.rb

@@ -37,7 +37,7 @@ module StarkBank
       @description = description
       @line = line
       @bar_code = bar_code
-      @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
+      @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
       @tags = tags
       @status = status
       @amount = amount

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