starkbank 2.12.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd9a69de2b18932531236001ae087424da0ee70dbe7bbcef98247700e2708802
-  data.tar.gz: bdc7087b33f13f85f9f1cc0d5bb257f3ececfbe128efc13bdd749d90062a8c54
+  metadata.gz: 6c363e43adca2efd6e97198b40c1a42e9a71de70188b59fe7561a2f93615f513
+  data.tar.gz: 21954b29ceea88e466182e97920c8d4f0c7df2779b4d8d5c82ec4996f52dd4b4
 SHA512:
-  metadata.gz: d1efd923d66ad145799e10bdf3c8866a30c9762334cc2c017ca6252c0440200a2beca5b9458b29eedd2487edb12f99f3424fc6bcc7c958e2293dbe9e5b34bdeb
-  data.tar.gz: e783927a5d21f7d417b90d01442143de64cef5808db8e7cebae36e15700e546897b84dc429a1e297a38eb4dcc4ab9087f839580d858ba96454fe2d61f4a7ccae
+  metadata.gz: aa3872b3bf62808684afac20937bc01d631fe4bf53e097bfcead428fdce52d3810ac5b377b0ff338c932953f6422808298f1e8801553656615bcff96b3306cdf
+  data.tar.gz: 7f1f9bd40722fb9104736896d4a5f1fedbbd0d6b50c70752d2466c71eb6ad2a0a52206a6ba1db5de248b5942f86806aa911b9eee93da547e62a8e6c72519b476

data/lib/dynamic_brcode/dynamic_brcode.rb

@@ -21,6 +21,8 @@ module StarkBank
   # ## Parameters (optional):
   # - expiration [integer, default 3600 (1 hour)]: time interval in seconds between due date and expiration date. ex 123456789
   # - tags [list of strings, default []]: list of strings for tagging, these will be passed to the respective DynamicBrcode resource when paid
+  # - display_description [string, default nil]: optional description to be shown in the receiver bank interface. ex: "Payment for service #1234" 
+  # - rules [list of Rules, default nil]: list of dynamic brcode rules to be applied to this brcode. ex: [StarkBank::DynamicBrcode::Rule.new(key: "allowedTaxIds", value: ["012.345.678-90"])]
   #
   # ## Attributes (return-only):
   # - id [string]: id returned on creation, this is the BR code. ex: "00020126360014br.gov.bcb.pix0114+552840092118152040000530398654040.095802BR5915Jamie Lannister6009Sao Paulo620705038566304FC6C"
@@ -31,7 +33,7 @@ module StarkBank
   class DynamicBrcode < StarkCore::Utils::Resource
     attr_reader :amount, :expiration, :tags, :id, :uuid, :picture_url, :updated, :created
     def initialize(
-      amount:, expiration: nil, tags: nil, id: nil, uuid: nil, picture_url: nil, updated: nil, created: nil
+      amount:, expiration: nil, tags: nil, id: nil, uuid: nil, picture_url: nil, display_description: nil, rules: nil, updated: nil, created: nil
     )
       super(id)
       @amount = amount
@@ -39,6 +41,8 @@ module StarkBank
       @tags = tags
       @uuid = uuid
       @picture_url = picture_url
+      @display_description = display_description
+      @rules = StarkBank::DynamicBrcode::Rule.parse_rules(rules)
       @created = StarkCore::Utils::Checks.check_datetime(created)
       @updated = StarkCore::Utils::Checks.check_datetime(updated)
     end
@@ -145,6 +149,8 @@ module StarkBank
             tags: json['tags'],
             uuid: json['uuid'],
             picture_url: json['picture_url'],
+            display_description: json['display_description'],
+            rules: json['rules'],
             created: json['created'],
             updated: json['updated']
           )

data/lib/dynamic_brcode/rule.rb

@@ -0,0 +1,46 @@
+require_relative('../utils/rest')
+
+module StarkBank
+  class DynamicBrcode
+    # # DynamicBrcode::Rule object
+    #
+    # The DynamicBrcode.Rule object modifies the behavior of DynamicBrcode objects when passed as an argument upon their creation.
+    #
+    # ## Parameters (required):
+    # - key [string]: Rule to be customized, describes what DynamicBrcode behavior will be altered. ex: "allowedTaxIds"
+    # - value [list of strings]: Value of the rule. ex: ["012.345.678-90", "45.059.493/0001-73"]
+    class Rule < StarkCore::Utils::SubResource
+      attr_reader :key, :value
+      def initialize(key:, value:)
+        @key = key
+        @value = value
+      end
+
+      def self.parse_rules(rules)
+        resource_maker = StarkBank::DynamicBrcode::Rule.resource[:resource_maker]
+        return rules if rules.nil?
+
+        parsed_rules = []
+        rules.each do |rule|
+          unless rule.is_a? Rule
+            rule = StarkCore::Utils::API.from_api_json(resource_maker, rule)
+          end
+          parsed_rules << rule
+        end
+        return parsed_rules
+      end
+
+      def self.resource
+      {
+        resource_name: 'Rule',
+        resource_maker: proc { |json|
+          Rule.new(
+            key: json['key'],
+            value: json['value']
+          )
+        }
+      }
+      end
+    end
+  end
+end

data/lib/starkbank.rb

@@ -9,6 +9,7 @@ require_relative('invoice/rule')
 require_relative('invoice/payment')
 require_relative('dict_key/dict_key')
 require_relative('dynamic_brcode/dynamic_brcode')
+require_relative('dynamic_brcode/rule')
 require_relative('deposit/deposit')
 require_relative('deposit/log')
 require_relative('card_method/cardmethod')
@@ -60,7 +61,7 @@ require_relative('request/request')
 module StarkBank
 
   API_VERSION = 'v2'
-  SDK_VERSION = '2.12.0'
+  SDK_VERSION = '2.14.0'
   HOST = "bank"
   public_constant :API_VERSION, :SDK_VERSION, :HOST;
 

data/lib/transfer/transfer.rb

@@ -24,6 +24,7 @@ module StarkBank
   # - external_id [string, default nil]: url safe string that must be unique among all your transfers. Duplicated external_ids will cause failures. By default, this parameter will block any transfer that repeats amount and receiver information on the same date. ex: 'my-internal-id-123456'
   # - 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)
   # - description [string, default nil]: optional description to override default description to be shown in the bank statement. ex: 'Payment for service #1234'
+  # - display_description [string, default nil]: optional description to be shown in the receiver bank interface. ex: 'Payment for service #1234'
   # - tags [list of strings]: list of strings for reference when searching for transfers. ex: ['employees', 'monthly']
   # - rules [list of Transfer::Rules, default []]: list of Transfer::Rule objects for modifying transfer behavior. ex: [Transfer::Rule(key: "resendingLimit", value: 5)]
   #
@@ -36,8 +37,8 @@ module StarkBank
   # - created [DateTime]: creation datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime]: latest update datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class Transfer < StarkCore::Utils::Resource
-    attr_reader :amount, :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :external_id, :scheduled, :description, :transaction_ids, :metadata, :fee, :tags, :rules, :status, :id, :created, :updated
-    def initialize(amount:, name:, tax_id:, bank_code:, branch_code:, account_number:, account_type: nil, external_id: nil, scheduled: nil, description: nil, transaction_ids: nil, metadata: nil, fee: nil, tags: nil, rules: nil, status: nil, id: nil, created: nil, updated: nil)
+    attr_reader :amount, :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :external_id, :scheduled, :description, :display_description, :transaction_ids, :metadata, :fee, :tags, :rules, :status, :id, :created, :updated
+    def initialize(amount:, name:, tax_id:, bank_code:, branch_code:, account_number:, account_type: nil, external_id: nil, scheduled: nil, description: nil, display_description: nil, transaction_ids: nil, metadata: nil, fee: nil, tags: nil, rules: nil, status: nil, id: nil, created: nil, updated: nil)
       super(id)
       @amount = amount
       @name = name
@@ -49,6 +50,7 @@ module StarkBank
       @external_id = external_id
       @scheduled = StarkCore::Utils::Checks.check_date_or_datetime(scheduled)
       @description = description
+      @display_description = display_description
       @tags = tags
       @rules = StarkBank::Transfer::Rule.parse_rules(rules)
       @fee = fee
@@ -210,6 +212,7 @@ module StarkBank
             external_id: json['external_id'],
             scheduled: json['scheduled'],
             description: json['description'],
+            display_description: json['display_description'],
             tags: json['tags'],
             rules: json['rules'],
             id: json['id'],

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.14.0
 platform: ruby
 authors:
 - starkbank
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: starkcore
@@ -66,8 +65,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.81'
-description: 
-email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -101,6 +98,7 @@ files:
 - lib/deposit/log.rb
 - lib/dict_key/dict_key.rb
 - lib/dynamic_brcode/dynamic_brcode.rb
+- lib/dynamic_brcode/rule.rb
 - lib/error.rb
 - lib/event/attempt.rb
 - lib/event/event.rb
@@ -135,7 +133,6 @@ homepage: https://github.com/starkbank/sdk-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -150,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: SDK to facilitate Ruby integrations with Stark Bank
 test_files: []