starkbank 2.9.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0dc58311d66ee8900115301e82e6ffdeb7ff667b845a67c7ec42de2d00533ed
-  data.tar.gz: ff84f801db89c14d69e21e287ace3f804c1aed4ca8bd5ea546a5047aec6c221e
+  metadata.gz: 9571bfbacd93d4716d5e3b0135d3db8ec76caa565938f602f44e43ab717c7dff
+  data.tar.gz: 288fedf58500ee29541406ede7b9c102063ca4967138a09a81f017ceaf52ba03
 SHA512:
-  metadata.gz: 4456311856c14f16b8076060fececadb8437b8f379f7ed725a1655381e1dec5ba4f970878c3e1bc12b9569be766e638c8c2667bf29e6ea75d061c2b1b8d50a41
-  data.tar.gz: 5f4293cc4fe23711f6bd1b015771dfb5fb4949803c810fd60eb1f12e1af4361936ff1e6388cebe96e660c6fa8d9e8e4cbe092d885f8282af61024e4fb5b8db57
+  metadata.gz: e98c7542080e894d92dfbcd88dbaefd08823bb5339f5b5957e2d32760a92f06c8a2f04f816b78ed5f1cddd0de1a2c53d6093efea11f9a11d98ab61982c28278c
+  data.tar.gz: 94df51cee5a7b90b7ed502882aaf7ad5c373255c0db7f5744fe20ba8ff9f73089574d90e7081f29670241f2ea6684cd97a0657dcc461b20a4dff60fa850465e6

data/lib/corporate_purchase/log.rb

@@ -14,15 +14,17 @@ module StarkBank
     # ## Attributes (return-only):
     # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
     # - purchase [CorporatePurchase]: CorporatePurchase entity to which the log refers to.
+    # - description [string]: purchase descriptions. ex: 'my_description'
     # - corporate_transaction_id [string]: transaction ID related to the CorporateCard.
     # - errors [list of strings]: list of errors linked to this CorporatePurchase event
     # - type [string]: type of the CorporatePurchase event which triggered the log creation. ex: 'approved', 'canceled', 'confirmed', 'denied', 'reversed', 'voided'.
     # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
     class Log < StarkCore::Utils::Resource
-      attr_reader :id, :purchase, :corporate_transaction_id, :errors, :type, :created
-      def initialize(id: nil, purchase: nil, corporate_transaction_id: nil, errors: nil, type: nil, created: nil)
+      attr_reader :id, :purchase, :description, :corporate_transaction_id, :errors, :type, :created
+      def initialize(id: nil, purchase: nil, description: nil, corporate_transaction_id: nil, errors: nil, type: nil, created: nil)
         super(id)
         @purchase = purchase
+        @description = description
         @corporate_transaction_id = corporate_transaction_id
         @errors = errors
         @type = type
@@ -117,6 +119,7 @@ module StarkBank
             Log.new(
               id: json['id'],
               purchase: StarkCore::Utils::API.from_api_json(request_maker, json['purchase']),
+              description: json['description'],
               corporate_transaction_id: json['corporate_transaction_id'],
               errors: json['errors'],
               type: json['type'],

data/lib/corporate_rule/corporaterule.rb

@@ -14,6 +14,7 @@ module StarkBank
   # ## Parameters (optional):
   # - interval [string, default 'lifetime']: interval after which the rule amount counter will be reset to 0. ex: 'instant', 'day', 'week', 'month', 'year' or 'lifetime'
   # - schedule [string, default nil]: schedule time for user to spend. ex: "every monday, wednesday from 00:00 to 23:59 in America/Sao_Paulo"
+  # - purposes [list of string, default []]: list of strings representing the allowed purposes for card purchases, you can use this to restrict ATM withdrawals. ex: ["purchase", "withdrawal"]
   # - currency_code [string, default 'BRL']: code of the currency that the rule amount refers to. ex: 'BRL' or 'USD'
   # - categories [list of MerchantCategories, default nil]: merchant categories accepted by the rule. ex: [MerchantCategory(code='fastFoodRestaurants')]
   # - countries [list of MerchantCountries, default nil]: countries accepted by the rule. ex: [MerchantCountry(code='BRA')]
@@ -25,10 +26,10 @@ module StarkBank
   # - currency_symbol [string]: currency symbol. ex: 'R$'
   # - currency_name [string]: currency name. ex: 'Brazilian Real'
   class CorporateRule < StarkCore::Utils::Resource
-    attr_reader :name, :interval, :amount, :currency_code, :counter_amount, :currency_name, :currency_symbol,
+    attr_reader :name, :interval, :amount, :currency_code, :counter_amount, :schedule, :purposes, :currency_name, :currency_symbol,
                 :categories, :countries, :methods
     def initialize(
-      name:, amount:, id: nil, interval: nil, schedule: nil, currency_code: nil, categories: nil, countries: nil, methods: nil,
+      name:, amount:, id: nil, interval: nil, schedule: nil, purposes: nil, currency_code: nil, categories: nil, countries: nil, methods: nil,
       counter_amount: nil, currency_symbol: nil, currency_name: nil
     )
       super(id)
@@ -36,6 +37,7 @@ module StarkBank
       @amount = amount
       @interval = interval
       @schedule = schedule
+      @purposes = purposes
       @currency_code = currency_code
       @categories = CorporateRule.parse_categories(categories)
       @countries = CorporateRule.parse_categories(countries)
@@ -110,6 +112,7 @@ module StarkBank
             amount: json['amount'],
             interval: json['interval'],
             schedule: json['schedule'],
+            purposes: json['purposes'],
             currency_code: json['currency_code'],
             categories: json['categories'],
             countries: json['countries'],

data/lib/darf_payment/darf_payment.rb

@@ -56,7 +56,7 @@ module StarkBank
       @amount = amount
       @nominal_amount = nominal_amount
       @fee = fee
-      @transaction_ids = @transaction_ids
+      @transaction_ids = transaction_ids
       @updated = StarkCore::Utils::Checks.check_datetime(updated)
       @created = StarkCore::Utils::Checks.check_datetime(created)
     end

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

@@ -24,6 +24,7 @@ module StarkBank
   # - fine [float, default 0.0]: Invoice fine for overdue payment in %. ex: 2.5
   # - interest [float, default 0.0]: Invoice monthly interest for overdue payment in %. ex: 5.2
   # - discounts [list of hashes, default nil]: list of hashes with 'percentage':float and 'due':DateTime or string pairs
+  # - rules [list of Invoice::Rule, default []]: list of Invoice::Rule objects for modifying invoice behavior. ex: [Invoice::Rule(key="allowedTaxIds", value=[ "012.345.678-90", "45.059.493/0001-73" ])]
   # - descriptions [list of hashes, default nil]: list of hashes with 'key':string and 'value':string pairs
   # - tags [list of strings, default nil]: list of strings for tagging
   #
@@ -42,9 +43,9 @@ module StarkBank
   # - created [DateTime]: creation datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime]: latest update datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class Invoice < StarkCore::Utils::Resource
-    attr_reader :amount, :tax_id, :name, :due, :expiration, :fine, :interest, :discounts, :tags, :pdf, :link, :descriptions, :nominal_amount, :fine_amount, :interest_amount, :discount_amount, :id, :brcode, :fee, :status, :transaction_ids, :created, :updated
+    attr_reader :amount, :tax_id, :name, :due, :expiration, :fine, :interest, :discounts, :rules, :tags, :pdf, :link, :descriptions, :nominal_amount, :fine_amount, :interest_amount, :discount_amount, :id, :brcode, :fee, :status, :transaction_ids, :created, :updated
     def initialize(
-      amount:, tax_id:, name:, due: nil, expiration: nil, fine: nil, interest: nil, discounts: nil,
+      amount:, tax_id:, name:, due: nil, expiration: nil, fine: nil, interest: nil, discounts: nil, rules: nil,
       tags: nil, pdf: nil, link: nil, descriptions: nil, nominal_amount: nil, fine_amount: nil, interest_amount: nil,
       discount_amount: nil, id: nil, brcode: nil, fee: nil, status: nil, transaction_ids: nil, created: nil, updated: nil
     )
@@ -60,6 +61,7 @@ module StarkBank
       @pdf = pdf
       @link = link
       @descriptions = descriptions
+      @rules = StarkBank::Invoice::Rule.parse_rules(rules)
       @nominal_amount = nominal_amount
       @fine_amount = fine_amount
       @interest_amount = interest_amount
@@ -256,6 +258,7 @@ module StarkBank
             fine: json['fine'],
             interest: json['interest'],
             discounts: json['discounts'],
+            rules: json['rules'],
             tags: json['tags'],
             pdf: json['pdf'],
             link: json['link'],

data/lib/invoice/rule.rb

@@ -0,0 +1,46 @@
+require_relative('../utils/rest')
+
+module StarkBank
+  class Invoice
+    # # Invoice::Rule object
+    #
+    # The Invoice::Rule object modifies the behavior of Invoice objects when passed as an argument upon their creation.
+    #
+    # ## Parameters (required):
+    # - key [string]: Rule to be customized, describes what Invoice behavior will be altered. ex: "allowedTaxIds"
+    # - value [list of string]: 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::Invoice::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/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/starkbank.rb

@@ -5,6 +5,7 @@ require_relative('balance/balance')
 require_relative('transaction/transaction')
 require_relative('invoice/invoice')
 require_relative('invoice/log')
+require_relative('invoice/rule')
 require_relative('invoice/payment')
 require_relative('dict_key/dict_key')
 require_relative('dynamic_brcode/dynamic_brcode')
@@ -58,7 +59,7 @@ require_relative('institution/institution')
 module StarkBank
 
   API_VERSION = 'v2'
-  SDK_VERSION = '2.9.0'
+  SDK_VERSION = '2.11.0'
   HOST = "bank"
   public_constant :API_VERSION, :SDK_VERSION, :HOST;
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.11.0
 platform: ruby
 authors:
 - starkbank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-04 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: starkcore
@@ -108,6 +108,7 @@ files:
 - lib/invoice/invoice.rb
 - lib/invoice/log.rb
 - lib/invoice/payment.rb
+- lib/invoice/rule.rb
 - lib/merchant_category/merchantcategory.rb
 - lib/merchant_country/merchantcountry.rb
 - lib/payment_preview/boleto_preview.rb