starkbank 2.10.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b3c14df2e63024dc300445af57b93d5d7c03fbe7e40efc79f4b130684982118
-  data.tar.gz: 621f032aa81a0c42d8d8df9491d5c66dfa1938207a9f68920d0f4abe7356cdef
+  metadata.gz: dd9a69de2b18932531236001ae087424da0ee70dbe7bbcef98247700e2708802
+  data.tar.gz: bdc7087b33f13f85f9f1cc0d5bb257f3ececfbe128efc13bdd749d90062a8c54
 SHA512:
-  metadata.gz: 8e8317904c404ed9a8051169e0079d705224bbea35cf7c735b3f164c955cf212494c76fb3fbfbc74f0f75b89c7b55194ffac31e0efde0b2002ddb886029930b6
-  data.tar.gz: 6f9c6037b10ae646945aa1163b5e64fb7ac70303767a12976a91ffa167bd8453dd7b0f7b32fece994bc6b976632ee67a5860c24a215135129ea4b535d354cdff
+  metadata.gz: d1efd923d66ad145799e10bdf3c8866a30c9762334cc2c017ca6252c0440200a2beca5b9458b29eedd2487edb12f99f3424fc6bcc7c958e2293dbe9e5b34bdeb
+  data.tar.gz: e783927a5d21f7d417b90d01442143de64cef5808db8e7cebae36e15700e546897b84dc429a1e297a38eb4dcc4ab9087f839580d858ba96454fe2d61f4a7ccae

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

@@ -18,19 +18,13 @@ module StarkBank
   # - owner_type [string]: DICT key owner type. ex 'naturalPerson' or 'legalPerson'
   # - bank_name [string]: bank name associated with the DICT key. ex: 'Stark Bank'
   # - ispb [string]: bank ISPB associated with the DICT key. ex: '20018183'
-  # - branch_code [string]: bank account branch code associated with the DICT key. ex: '9585'
-  # - account_number [string]: bank account number associated with the DICT key. ex: '9828282578010513'
-  # - account_type [string]: bank account type associated with the DICT key. ex: 'checking', 'saving', 'salary' or 'payment'
+  # - branch_code [string]: encrypted bank account branch code associated with the DICT key. ex: 'ZW5jcnlwdGVkLWJyYW5jaC1jb2Rl'
+  # - account_number [string]: encrypted bank account number associated with the DICT key. ex: 'ZW5jcnlwdGVkLWFjY291bnQtbnVtYmVy'
+  # - account_type [string]: bank account type associated with the DICT key. ex: 'checking', 'savings', 'salary' or 'payment'
   # - status [string]: current DICT key status. ex: 'created', 'registered', 'canceled' or 'failed'
-  # - account_created [DateTime or string]: creation datetime of the bank account associated with the DICT key. ex: '2020-11-05T14:55:08.812665+00:00'
-  # - owned [DateTime or string]: datetime since when the current owner hold this DICT key. ex : '2020-11-05T14:55:08.812665+00:00'
-  # - created [DateTime or string]: creation datetime for the DICT key. ex: '2020-03-10 10:30:00.000'
   class DictKey < StarkCore::Utils::Resource
     attr_reader :id, :type, :name, :tax_id, :owner_type, :bank_name, :ispb, :branch_code, :account_number, :account_type, :status, :account_created, :owned, :created
-    def initialize(
-      id:, type:, name:, tax_id:, owner_type:, bank_name:, ispb:, branch_code:, account_number:, 
-      account_type:, status:, account_created:, owned:, created:
-    )
+    def initialize(id:, type:, name:, tax_id:, owner_type:, bank_name:, ispb:, branch_code:, account_number:, account_type:, status:)
       super(id)
       @type = type
       @name = name
@@ -42,9 +36,6 @@ module StarkBank
       @account_number = account_number
       @account_type = account_type
       @status = status
-      @account_created = StarkCore::Utils::Checks.check_datetime(account_created)
-      @owned = StarkCore::Utils::Checks.check_datetime(owned)
-      @created = StarkCore::Utils::Checks.check_datetime(created)
     end
 
     # # Retrieve a specific DictKey
@@ -141,10 +132,7 @@ module StarkBank
             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']
+            status: json['status']
           )
         }
       }

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/payment_preview/brcode_preview.rb

@@ -14,8 +14,6 @@ module StarkBank
     # - 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 different 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)
@@ -26,14 +24,12 @@ module StarkBank
     # - discount_amount [integer]: Current discount value in cents that this payment is expecting. ex: 123 (= R$1,23)
     # - reconciliation_id [string]: Reconciliation ID linked to this payment. ex: 'txId', 'payment-123'
     class BrcodePreview < StarkCore::Utils::SubResource
-      attr_reader :status, :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :allow_change, :amount, :nominal_amount, :interest_amount, :fine_amount, :reduction_amount, :discount_amount, :reconciliation_id
-      def initialize(status:, name:, tax_id:, bank_code:, branch_code:, account_number:, account_type:, allow_change:, amount:, nominal_amount:, interest_amount:, fine_amount:, reduction_amount:, discount_amount:, reconciliation_id:)
+      attr_reader :status, :name, :tax_id, :bank_code, :account_type, :allow_change, :amount, :nominal_amount, :interest_amount, :fine_amount, :reduction_amount, :discount_amount, :reconciliation_id
+      def initialize(status:, name:, tax_id:, bank_code:, account_type:, allow_change:, amount:, nominal_amount:, interest_amount:, fine_amount:, reduction_amount:, discount_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
@@ -54,8 +50,6 @@ module StarkBank
               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'],

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

@@ -54,12 +54,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.10.0'
+  SDK_VERSION = '2.12.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,14 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.12.0
 platform: ruby
 authors:
 - starkbank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2024-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: starkcore
@@ -16,14 +16,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
@@ -117,6 +117,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