starkbank 2.8.0 → 2.10.0

data/lib/corporate_withdrawal/corporatewithdrawal.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require 'starkcore'
+require_relative('../utils/rest')
+
+module StarkBank
+  # # CorporateWithdrawal object
+  #
+  # The CorporateWithdrawal objects created in your Workspace return cash from your Corporate balance to your Banking balance.
+  #
+  # ## Parameters (required):
+  # - amount [integer]: CorporateWithdrawal value in cents. Minimum = 0 (any value will be accepted). ex: 1234 (= R$ 12.34)
+  # - external_id [string] CorporateWithdrawal external ID. ex: '12345'
+  #
+  # ## Parameters (optional):
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['tony', 'stark']
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when CorporateWithdrawal is created. ex: '5656565656565656'
+  # - transaction_id [string]: Stark Bank ledger transaction ids linked to this CorporateWithdrawal
+  # - corporate_transaction_id [string]: corporate ledger transaction ids linked to this CorporateWithdrawal
+  # - updated [DateTime]: latest update datetime for the CorporateWithdrawal. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - created [DateTime]: creation datetime for the CorporateWithdrawal. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class CorporateWithdrawal < StarkCore::Utils::Resource
+    attr_reader :amount, :external_id, :tags, :id, :transaction_id, :corporate_transaction_id, :updated, :created
+    def initialize(
+      amount:, external_id:, tags: nil, id: nil, transaction_id: nil, corporate_transaction_id: nil,
+      updated: nil, created: nil
+    )
+      super(id)
+      @amount = amount
+      @external_id = external_id
+      @tags = tags
+      @transaction_id = transaction_id
+      @corporate_transaction_id = corporate_transaction_id
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create a CorporateWithdrawal
+    #
+    # Send a single CorporateWithdrawal object for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - withdrawal [CorporateWithdrawal object]: CorporateWithdrawal object to be created in the API.
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkbank.user was set before function call
+    #
+    # ## Return:
+    # - CorporateWithdrawal object with updated attributes
+    def self.create(withdrawal, user: nil)
+      StarkBank::Utils::Rest.post_single(entity: withdrawal, user: user, **resource)
+    end
+
+    # # Retrieve a specific CorporateWithdrawal
+    #
+    # Receive a single CorporateWithdrawal object previously created in the Stark Bank API by its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkbank.user was set before function call
+    #
+    # ## Return:
+    # - CorporateWithdrawal object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve CorporateWithdrawals
+    #
+    # Receive a generator of CorporateWithdrawal 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 or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date 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']
+    # - external_ids [list of strings, default nil]: external IDs. ex: ['5656565656565656', '4545454545454545']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkbank.user was set before function call
+    #
+    # ## Return:
+    # - generator of CorporateWithdrawal objects with updated attributes
+    def self.query(limit: nil, external_ids: nil, after: nil, before: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkBank::Utils::Rest.get_stream(
+        limit: limit,
+        external_ids: external_ids,
+        after: after,
+        before: before,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged CorporateWithdrawals
+    #
+    # Receive a list of up to 100 CorporateWithdrawal objects previously created in the Stark Bank API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call.
+    # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date 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']
+    # - external_ids [list of strings, default nil]: external IDs. ex: ['5656565656565656', '4545454545454545']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkbank.user was set before function call
+    #
+    # ## Return:
+    # - list of CorporateWithdrawal objects with updated attributes
+    # - cursor to retrieve the next page of CorporateWithdrawal objects
+    def self.page(cursor: nil, limit: nil, external_ids: nil, after: nil, before: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkBank::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        external_ids: external_ids,
+        after: after,
+        before: before,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'CorporateWithdrawal',
+        resource_maker: proc { |json|
+          CorporateWithdrawal.new(
+            id: json['id'],
+            amount: json['amount'],
+            external_id: json['external_id'],
+            tags: json['tags'],
+            transaction_id: json['transaction_id'],
+            corporate_transaction_id: json['corporate_transaction_id'],
+            updated: json['updated'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

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/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/merchant_category/merchantcategory.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'starkcore'
+require_relative('../utils/rest')
+
+module StarkBank
+  # # MerchantCategory object
+  #
+  # MerchantCategory's codes and types are used to define categories filters in CorporateRules.
+  #
+  # A MerchantCategory filter must define exactly one parameter between code and type.
+  # A type, such as 'food', 'services', etc., defines an entire group of merchant codes,
+  # whereas a code only specifies a specific MCC.
+  #
+  # ## Parameters (conditionally required):
+  # - code [string, default nil]: category's code. ex: 'veterinaryServices', 'fastFoodRestaurants'
+  # - type [string, default nil]: category's type. ex: 'pets', 'food'
+  #
+  # Attributes (return-only):
+  # - name [string]: category's name. ex: 'Veterinary services', 'Fast food restaurants'
+  # - number [string]: category's number. ex: '742', '5814'
+  class MerchantCategory < StarkCore::Utils::SubResource
+    attr_reader :code, :type, :name, :number
+    def initialize(code:, type:, name: nil, number: nil)
+      @code = code
+      @type = type
+      @name = name
+      @number = number
+    end
+
+    # # Retrieve MerchantCategories
+    #
+    # Receive a generator of MerchantCategory objects available in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - search [string, default nil]: keyword to search for code, name, number or short_code
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkbank.user was set before function call
+    #
+    # ## Return:
+    # - generator of MerchantCategory objects with updated attributes
+    def self.query(search: nil, user: nil)
+      StarkBank::Utils::Rest.get_stream(
+        search: search,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'MerchantCategory',
+        resource_maker: proc { |json|
+          MerchantCategory.new(
+            code: json['code'],
+            type: json['type'],
+            name: json['name'],
+            number: json['number']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/merchant_country/merchantcountry.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'starkcore'
+require_relative('../utils/rest')
+
+module StarkBank
+  # # MerchantCountry object
+  #
+  # MerchantCountry's codes are used to define countries filters in CorporateRules.
+  #
+  # ## Parameters (required):
+  # - code [string]: country's code. ex: 'BRA'
+  #
+  # Attributes (return-only):
+  # - name [string]: country's name. ex: 'Brazil'
+  # - number [string]: country's number. ex: '076'
+  # - short_code [string]: country's short code. ex: 'BR'
+  class MerchantCountry < StarkCore::Utils::SubResource
+    attr_reader :code, :short_code, :name, :number
+    def initialize(code:, name: nil, number: nil, short_code: nil)
+      @code = code
+      @name = name
+      @number = number
+      @short_code = short_code
+    end
+
+    # # Retrieve MerchantCountries
+    #
+    # Receive a generator of MerchantCountry objects available in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - search [string, default nil]: keyword to search for code, name, number or short_code
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkbank.user was set before function call
+    #
+    # ## Return:
+    # - generator of MerchantCountry objects with updated attributes
+    def self.query(search: nil, user: nil)
+      StarkBank::Utils::Rest.get_stream(
+        search: search,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'MerchantCountry',
+        resource_maker: proc { |json|
+          MerchantCountry.new(
+            code: json['code'],
+            name: json['name'],
+            number: json['number'],
+            short_code: json['short_code']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/payment_request/payment_request.rb

@@ -47,8 +47,8 @@ module StarkBank
       @status = status
       @actions = actions
       @description = description
-      @updated = updated
-      @created = created
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      @created = StarkCore::Utils::Checks.check_datetime(created)
 
       @payment, @type = parse_payment(payment: payment, type: type)
     end

data/lib/starkbank.rb

@@ -5,11 +5,27 @@ 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')
 require_relative('deposit/deposit')
 require_relative('deposit/log')
+require_relative('card_method/cardmethod')
+require_relative('corporate_balance/corporatebalance')
+require_relative('corporate_card/corporatecard')
+require_relative('corporate_card/log')
+require_relative('corporate_holder/corporateholder')
+require_relative('corporate_holder/log')
+require_relative('corporate_holder/permission')
+require_relative('corporate_invoice/corporateinvoice')
+require_relative('corporate_purchase/corporatepurchase')
+require_relative('corporate_purchase/log')
+require_relative('corporate_rule/corporaterule')
+require_relative('corporate_transaction/corporatetransaction')
+require_relative('corporate_withdrawal/corporatewithdrawal')
+require_relative('merchant_category/merchantcategory')
+require_relative('merchant_country/merchantcountry')
 require_relative('brcode_payment/brcode_payment')
 require_relative('brcode_payment/rule')
 require_relative('brcode_payment/log')
@@ -43,7 +59,7 @@ require_relative('institution/institution')
 module StarkBank
 
   API_VERSION = 'v2'
-  SDK_VERSION = '2.8.0'
+  SDK_VERSION = '2.10.0'
   HOST = "bank"
   public_constant :API_VERSION, :SDK_VERSION, :HOST;
 

data/lib/utils/rest.rb

@@ -126,6 +126,20 @@ 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,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.10.0
 platform: ruby
 authors:
 - starkbank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: starkcore
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +82,19 @@ files:
 - lib/brcode_payment/brcode_payment.rb
 - lib/brcode_payment/log.rb
 - lib/brcode_payment/rule.rb
+- lib/card_method/cardmethod.rb
+- lib/corporate_balance/corporatebalance.rb
+- lib/corporate_card/corporatecard.rb
+- lib/corporate_card/log.rb
+- lib/corporate_holder/corporateholder.rb
+- lib/corporate_holder/log.rb
+- lib/corporate_holder/permission.rb
+- lib/corporate_invoice/corporateinvoice.rb
+- lib/corporate_purchase/corporatepurchase.rb
+- lib/corporate_purchase/log.rb
+- lib/corporate_rule/corporaterule.rb
+- lib/corporate_transaction/corporatetransaction.rb
+- lib/corporate_withdrawal/corporatewithdrawal.rb
 - lib/darf_payment/darf_payment.rb
 - lib/darf_payment/log.rb
 - lib/deposit/deposit.rb
@@ -95,6 +108,9 @@ 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
 - lib/payment_preview/brcode_preview.rb
 - lib/payment_preview/payment_preview.rb