starkbank 2.11.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9571bfbacd93d4716d5e3b0135d3db8ec76caa565938f602f44e43ab717c7dff
-  data.tar.gz: 288fedf58500ee29541406ede7b9c102063ca4967138a09a81f017ceaf52ba03
+  metadata.gz: 67f10a9398cc6eeb3b8cafe747a1fb3ce21dfab6bf316dd85cbca71394cb5443
+  data.tar.gz: e5f917774479128c4e1d8120d5cefeed03dbff224e70090c849bc911fd759d05
 SHA512:
-  metadata.gz: e98c7542080e894d92dfbcd88dbaefd08823bb5339f5b5957e2d32760a92f06c8a2f04f816b78ed5f1cddd0de1a2c53d6093efea11f9a11d98ab61982c28278c
-  data.tar.gz: 94df51cee5a7b90b7ed502882aaf7ad5c373255c0db7f5744fe20ba8ff9f73089574d90e7081f29670241f2ea6684cd97a0657dcc461b20a4dff60fa850465e6
+  metadata.gz: 0fab179a722aeea47d6635217805b68d8fbdf6ceb58b44f1d2dcb3a4aa7c7b76e71657bcc1585ba78c36335dd6dfd52c723ffda41373c896525960d53ac0887c
+  data.tar.gz: 1395aca4a6a05c445b8dcc43b87d69a2e60fabd88ee76f783351325137986d845270172c02946a57af07a078ab9cdc0419995f51215f0abfc5dd6cbc3f47b09c

data/lib/deposit/deposit.rb

@@ -131,6 +131,23 @@ module StarkBank
       )
     end
 
+    # # Update Deposit entity
+    #
+    # Update the Deposit by passing its id to be partially or fully reversed.
+    #
+    # ## Parameters (required):
+    # - id [string]: Deposit unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - amount [string, nil]: The new amount of the Deposit. If the amount = 0 the Deposit will be fully reversed
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call 
+    #
+    # ## Return:
+    # - target Deposit with updated attributes
+    def self.update(id, amount: nil, user: nil)
+      StarkBank::Utils::Rest.patch_id(id: id, amount: amount, user: user, **resource)
+    end
+
     def self.resource
       {
         resource_name: 'Deposit',

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/invoice/invoice.rb

@@ -221,6 +221,7 @@ module StarkBank
     # - 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
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - updated Invoice object

data/lib/request/request.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+require_relative('../utils/parse')
+
+module StarkBank
+
+    class Request
+
+        # # Retrieve any StarkBank resource
+        #
+        # Receive a json of resources previously created in StarkBank's API
+        #
+        # Parameters (required):
+        #
+        # - path [string]: StarkBank resource's route. ex: "/invoice/"
+        # - query [json, default None]: Query parameters. ex: {"limit": 1, "status": paid}
+        #
+        # Parameters (optional):
+        #
+        # - user [Organization/Project object, default None]: Organization or Project object. Not necessary if StarkBank.user
+        #     was set before function call
+        #
+        # Return:
+        # - json of StarkBank objects with updated attributes
+
+        def self.get(path:, query: nil, user: nil)
+            content = StarkBank::Utils::Rest.get_raw(
+                path: path,
+                query: query,
+                user: user,
+                prefix: "Joker",
+                raiseException: false
+            )
+        end
+
+        # # Create any StarkBank resource
+        #
+        # Send a json to create StarkBank resources
+        #
+        # Parameters (required):
+        #
+        # - path [string]: StarkBank resource's route. ex: "/invoice/"
+        # - body [json]: request parameters. ex: {"invoices": [{"amount": 100, "name": "Iron Bank S.A.", "taxId": "20.018.183/0001-80"}]}
+        #
+        # Parameters (optional):
+        #
+        # - user [Organization/Project object, default None]: Organization or Project object. Not necessary if StarkBank.user
+        #     was set before function call
+        # - query [json, default None]: Query parameters. ex: {"limit": 1, "status": paid}
+        #
+        # Return:
+        #
+        # - list of resources jsons with updated attributes
+
+        def self.post(path:, payload:, query: nil, user: nil)
+            content = StarkBank::Utils::Rest.post_raw(
+                path: path,
+                query: query,
+                payload: payload,
+                user: user,
+                prefix: "Joker",
+                raiseException: false
+            )
+        end
+
+        # # Update any StarkBank resource
+        #
+        # Send a json with parameters of StarkBank resources to update them
+        #
+        # Parameters (required):
+        #
+        # - path [string]: StarkBank resource's route. ex: "/invoice/5699165527090460"
+        # - body [json]: request parameters. ex: {"amount": 100}
+        #
+        # Parameters (optional):
+        #
+        # - user [Organization/Project object, default None]: Organization or Project object. Not necessary if StarkBank.user
+        #     was set before function call
+        #
+        # Return:
+        # - json of the resource with updated attributes
+
+        def self.patch(path:, payload:, query: nil, user: nil)
+            content = StarkBank::Utils::Rest.patch_raw(
+                path: path,
+                query: query,
+                payload: payload,
+                user: user,
+                prefix: "Joker",
+                raiseException: false
+            )
+        end
+
+        # # Put any StarkBank resource
+        #
+        # Send a json with parameters of a StarkBank resources to create them. 
+        # If the resource already exists, you will update it.
+        #
+        # Parameters (required):
+        #
+        # - path [string]: StarkBank resource's route. ex: "/split-profile"
+        # - body [json]: request parameters. ex: {"profiles": [{"interval": day, "delay": "1"}]}
+        #
+        # Parameters (optional):
+        #
+        # - user [Organization/Project object, default None]: Organization or Project object. Not necessary if StarkBank.user
+        #     was set before function call
+        #
+        # Return:
+        # - json of the resource with updated attributes
+
+        def self.put(path:, payload:, query: nil, user: nil)
+            content = StarkBank::Utils::Rest.put_raw(
+                path: path,
+                query: query,
+                payload: payload,
+                user: user,
+                prefix: "Joker",
+                raiseException: false
+            )
+        end
+
+        # # Delete any StarkBank resource
+        #
+        # Send parameters of StarkBank resources and delete them
+        #
+        # Parameters (required):
+        #
+        # - path [string]: StarkBank resource's route. ex: "/transfer/5699165527090460"
+        #
+        # Parameters (optional):
+        #
+        # - user [Organization/Project object, default None]: Organization or Project object. Not necessary if StarkBank.user
+        #     was set before function call
+        #
+        # Return:
+        # - json of the resource with updated attributes
+        
+        def self.delete(path:, query: nil, user: nil)
+            content = StarkBank::Utils::Rest.delete_raw(
+                path: path,
+                query: query,
+                user: user,
+                prefix: "Joker",
+                raiseException: false
+            )
+        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')
@@ -54,12 +55,13 @@ require_relative('payment_preview/boleto_preview')
 require_relative('payment_preview/tax_preview')
 require_relative('payment_preview/utility_preview')
 require_relative('institution/institution')
+require_relative('request/request')
 
 # SDK to facilitate Ruby integrations with Stark Bank
 module StarkBank
 
   API_VERSION = 'v2'
-  SDK_VERSION = '2.11.0'
+  SDK_VERSION = '2.13.0'
   HOST = "bank"
   public_constant :API_VERSION, :SDK_VERSION, :HOST;
 

data/lib/utils/rest.rb

@@ -126,20 +126,6 @@ module StarkBank
         )
       end
 
-      def self.post_raw(path:, payload:, user:, **query)
-        return StarkCore::Utils::Rest.post_raw(
-          host: StarkBank::HOST,
-          sdk_version: StarkBank::SDK_VERSION,
-          user: user ? user : StarkBank.user,
-          path: path,
-          payload: payload,
-          api_version: StarkBank::API_VERSION,
-          language: StarkBank.language,
-          timeout: StarkBank.timeout,
-          **query,
-        )
-      end
-
       def self.delete_id(resource_name:, resource_maker:, user:, id:)
         return StarkCore::Utils::Rest.delete_id(
           resource_name: resource_name,
@@ -168,6 +154,85 @@ module StarkBank
           **payload
         )
       end
+
+      def self.get_raw(path:, prefix: nil, raiseException: nil, user: nil, query: nil)
+        return StarkCore::Utils::Rest.get_raw(
+          host: StarkBank::HOST,
+          sdk_version: StarkBank::SDK_VERSION,
+          user: user ? user : StarkBank.user,
+          path: path,
+          api_version: StarkBank::API_VERSION,
+          language: StarkBank.language,
+          timeout: StarkBank.timeout, 
+          prefix: prefix,
+          raiseException: raiseException,
+          query: query
+        )
+      end
+
+      def self.post_raw(path:, payload:, query: nil, prefix: nil, raiseException: nil, user:)
+
+        return StarkCore::Utils::Rest.post_raw(
+          host: StarkBank::HOST,
+          sdk_version: StarkBank::SDK_VERSION,
+          user: user ? user : StarkBank.user,
+          path: path,
+          payload: payload,
+          api_version: StarkBank::API_VERSION,
+          language: StarkBank.language,
+          timeout: StarkBank.timeout,
+          query: query,
+          prefix: prefix,
+          raiseException: raiseException
+        )
+      end
+
+      def self.patch_raw(path:, payload:, query: nil, prefix: nil, raiseException: nil, user: nil)
+        return StarkCore::Utils::Rest.patch_raw(
+          host: StarkBank::HOST,
+          sdk_version: StarkBank::SDK_VERSION,
+          user: user ? user : StarkBank.user,
+          path: path,
+          payload: payload,
+          api_version: StarkBank::API_VERSION,
+          language: StarkBank.language,
+          timeout: StarkBank.timeout,
+          query: query,
+          prefix: prefix,
+          raiseException: raiseException
+        )
+      end
+
+      def self.put_raw(path:, payload:, query: nil, prefix: nil, raiseException: nil, user: nil)
+        return StarkCore::Utils::Rest.put_raw(
+          host: StarkBank::HOST,
+          sdk_version: StarkBank::SDK_VERSION,
+          user: user ? user : StarkBank.user,
+          path: path,
+          payload: payload,
+          api_version: StarkBank::API_VERSION,
+          language: StarkBank.language,
+          timeout: StarkBank.timeout,
+          query: query,
+          prefix: prefix,
+          raiseException: raiseException
+        )
+      end
+
+      def self.delete_raw(path:, query: nil, prefix: nil, raiseException: nil, user: nil)
+        return StarkCore::Utils::Rest.delete_raw(
+          host: StarkBank::HOST,
+          sdk_version: StarkBank::SDK_VERSION,
+          user: user ? user : StarkBank.user,
+          path: path,
+          api_version: StarkBank::API_VERSION,
+          language: StarkBank.language,
+          timeout: StarkBank.timeout,
+          query: query,
+          prefix: prefix,
+          raiseException: raiseException
+        )
+      end
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.13.0
 platform: ruby
 authors:
 - starkbank
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: starkcore
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -117,6 +115,7 @@ files:
 - lib/payment_preview/tax_preview.rb
 - lib/payment_preview/utility_preview.rb
 - lib/payment_request/payment_request.rb
+- lib/request/request.rb
 - lib/starkbank.rb
 - lib/tax_payment/log.rb
 - lib/tax_payment/tax_payment.rb
@@ -134,7 +133,6 @@ homepage: https://github.com/starkbank/sdk-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -149,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.2
 specification_version: 4
 summary: SDK to facilitate Ruby integrations with Stark Bank
 test_files: []