starkinfra 0.6.0 → 0.7.0

data/lib/issuing_holder/issuing_holder.rb

@@ -44,7 +44,8 @@ module StarkInfra
 
     # # Create IssuingHolders
     #
-    # Send a list of IssuingHolder objects for creation in the Stark Infra API
+    # Send a list of IssuingHolder objects for creation in the Stark Infra API. Use this method to create up
+    # to 100 new IssuingHolders at a time.
     #
     # ## Parameters (required):
     # - holders [list of IssuingHolder objects]: list of IssuingHolder objects to be created in the API
@@ -147,13 +148,13 @@ module StarkInfra
 
     # # Update IssuingHolder entity
     #
-    # Update an IssuingHolder by passing id, if it hasn't been paid yet.
+    # Update an IssuingHolder by passing id. A canceled holder can no longer be updated.
     #
     # ## Parameters (required):
     # - id [string]: IssuingHolder id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - status [string, default nil]: You may block the IssuingHolder by passing 'blocked' in the status
+    # - status [string, default nil]: status to update the holder to. Options: 'active', 'blocked'.
     # - name [string, default nil]: card holder name.
     # - tags [list of strings, default nil]: list of strings for tagging
     # - rules [list of IssuingRule objects, default nil]: list of objects that represent the holder's spending rules.
@@ -175,7 +176,7 @@ module StarkInfra
 
     # # Cancel an IssuingHolder entity
     #
-    # Cancel an IssuingHolder entity previously created in the Stark Infra API
+    # Cancel an IssuingHolder entity previously created in the Stark Infra API. This action is irreversible.
     #
     # ## Parameters (required):
     # - id [string]: IssuingHolder unique id. ex: '5656565656565656'
@@ -186,7 +187,7 @@ module StarkInfra
     # ## Return:
     # - canceled IssuingHolder object
     def self.cancel(id, user: nil)
-      StarkCore::Utils::Rest.delete_id(id: id, user: user, **resource)
+      StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
     end
 
     def self.resource

data/lib/issuing_product/issuing_product.rb

@@ -12,10 +12,10 @@ module StarkInfra
   # ## Attributes (return-only):
   # - id [string]: unique card product number (BIN) registered within the card network. ex: '53810200'
   # - network [string]: card network flag. ex: 'mastercard'
-  # - funding_type [string]: type of funding used for payment. ex: 'credit', 'debit'
+  # - funding_type [string]: type of funding used for payment. Options: 'prepaid', 'credit'.
   # - holder_type [string]: holder type. ex: 'business', 'individual'
   # - code [string]: internal code from card flag informing the product. ex: 'MRW', 'MCO', 'MWB', 'MCS'
-  # - customer_type [string]: Same as holderType. Kept for backward compatibility
+  # - customer_type [string]: same as holder_type. Kept for backward compatibility.
   # - created [DateTime]: creation datetime for the IssuingProduct. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class IssuingProduct < StarkCore::Utils::Resource
     attr_reader :id, :network, :funding_type, :holder_type, :code, :customer_type, :created

data/lib/issuing_purchase/issuing_purchase.rb

@@ -13,7 +13,7 @@ module StarkInfra
   # - product_id [string]: unique card product number (BIN) registered within the card network. ex: "53810200"
   # - card_id [string]: unique id returned when IssuingCard is created. ex: '5656565656565656'
   # - card_ending [string]: last 4 digits of the card number. ex: '1234'
-  # - purpose [string]: purchase purpose. ex: 'purchase'
+  # - purpose [string]: purchase purpose. Options: 'purchase', 'withdrawal', 'verification', 'purchaseRefund', 'cashbackPurchase', 'paymentTransaction'.
   # - installment_count [integer]: quantity of installments to be confirmed. Minimum = 1. ex: 12
   # - amount [integer]: IssuingPurchase value in cents. Minimum = 0. ex: 1234 (= R$ 12.34)
   # - tax [integer]: IOF amount taxed for international purchases. ex: 1234 (= R$ 12.34)
@@ -201,6 +201,30 @@ module StarkInfra
       )
     end
 
+    # # Update IssuingPurchase entity
+    #
+    # Update an IssuingPurchase by passing id.
+    #
+    # ## Parameters (required):
+    # - id [string]: IssuingPurchase id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - tags [list of strings, default nil]: list of strings for tagging. ex: ['tony', 'stark']
+    # - description [string, default nil]: new IssuingPurchase description. Max of 140 characters. ex: 'Office Supplies'
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - target IssuingPurchase with updated attributes
+    def self.update(id, description: nil, tags: nil, user: nil)
+      StarkInfra::Utils::Rest.patch_id(
+        id: id,
+        description: description,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
     # # Create a single verified IssuingPurchase authorization request from a content string
     #
     # Use this method to parse and verify the authenticity of the authorization request received at the informed endpoint.

data/lib/issuing_restock/issuing_restock.rb

@@ -18,7 +18,7 @@ module StarkInfra
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when IssuingRestock is created. ex: '5656565656565656'
-  # - status [string]: current IssuingRestock status. ex: "created", "processing", "confirmed"
+  # - status [string]: current IssuingRestock status. Options: 'created', 'processing', 'confirmed', 'canceled'.
   # - updated [DateTime]: latest update datetime for the IssuingRestock. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - created [DateTime]: creation datetime for the IssuingRestock. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class IssuingRestock < StarkCore::Utils::Resource
@@ -37,7 +37,8 @@ module StarkInfra
 
     # # Create IssuingRestocks
     #
-    # Send a list of IssuingRestock objects for creation in the Stark Infra API
+    # Send a list of IssuingRestock objects for creation in the Stark Infra API. Use this method to create up
+    # to 100 new IssuingRestocks at a time.
     #
     # ## Parameters (required):
     # - restocks [list of IssuingRestock objects]: list of IssuingRestock objects to be created in the API

data/lib/issuing_rule/issuing_rule.rb

@@ -48,6 +48,15 @@ module StarkInfra
       @purposes = purposes
     end
 
+    # # Parse MerchantCategories
+    #
+    # Converts a list of hashes into a list of MerchantCategory objects.
+    #
+    # ## Parameters (required):
+    # - categories [list of hashes]: list to be parsed.
+    #
+    # ## Return:
+    # - list of parsed MerchantCategory objects
     def self.parse_categories(categories)
       resource_maker = StarkInfra::MerchantCategory.resource[:resource_maker]
       return categories if categories.nil?
@@ -62,6 +71,15 @@ module StarkInfra
       parsed_categories
     end
 
+    # # Parse MerchantCountries
+    #
+    # Converts a list of hashes into a list of MerchantCountry objects.
+    #
+    # ## Parameters (required):
+    # - countries [list of hashes]: list to be parsed.
+    #
+    # ## Return:
+    # - list of parsed MerchantCountry objects
     def self.parse_countries(countries)
       resource_maker = StarkInfra::MerchantCountry.resource[:resource_maker]
       return countries if countries.nil?
@@ -76,6 +94,15 @@ module StarkInfra
       parsed_countries
     end
 
+    # # Parse CardMethods
+    #
+    # Converts a list of hashes into a list of CardMethod objects.
+    #
+    # ## Parameters (required):
+    # - methods [list of hashes]: list to be parsed.
+    #
+    # ## Return:
+    # - list of parsed CardMethod objects
     def self.parse_methods(methods)
       resource_maker = StarkInfra::CardMethod.resource[:resource_maker]
       return methods if methods.nil?
@@ -90,6 +117,15 @@ module StarkInfra
       parsed_methods
     end
 
+    # # Parse IssuingRules
+    #
+    # Converts a list of hashes into a list of IssuingRule objects.
+    #
+    # ## Parameters (required):
+    # - rules [list of hashes]: list to be parsed.
+    #
+    # ## Return:
+    # - list of parsed IssuingRule objects
     def self.parse_rules(rules)
       rule_maker = StarkInfra::IssuingRule.resource[:resource_maker]
       return rules if rules.nil?

data/lib/issuing_stock_rule/issuing_stock_rule.rb

@@ -8,7 +8,7 @@ module StarkInfra
   #
   # The IssuingStockRule object displays the notification rules attached to an IssuingStock.
   # When the linked stock balance reaches the minimum_balance, the recipients listed in
-  # emails and phones are notified.
+  # emails and phones are notified. Each IssuingStock can have only one active IssuingStockRule at a time.
   #
   # ## Parameters (required):
   # - minimum_balance [integer]: stock balance threshold that triggers a notification. ex: 10000
@@ -16,8 +16,8 @@ module StarkInfra
   #
   # ## Parameters (optional):
   # - tags [list of strings, default nil]: list of strings for tagging. ex: ['card', 'corporate']
-  # - emails [list of strings, default nil]: emails notified when the stock reaches the minimum balance. ex: ['john.doe@enterprise.com']
-  # - phones [list of strings, default nil]: phones notified when the stock reaches the minimum balance. ex: ['+5511912345678']
+  # - emails [list of up to 10 strings, default nil]: emails notified when the stock reaches the minimum balance. ex: ['john.doe@enterprise.com']
+  # - phones [list of up to 10 strings, default nil]: phones notified when the stock reaches the minimum balance. ex: ['+5511912345678']
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when IssuingStockRule is created. ex: '5664445921492992'
@@ -43,7 +43,8 @@ module StarkInfra
 
     # # Create IssuingStockRules
     #
-    # Send a list of IssuingStockRule objects for creation in the Stark Infra API
+    # Send a list of IssuingStockRule objects for creation in the Stark Infra API. At least one of emails or
+    # phones must be informed per rule.
     #
     # ## Parameters (required):
     # - rules [list of IssuingStockRule objects]: list of IssuingStockRule objects to be created in the API
@@ -177,7 +178,7 @@ module StarkInfra
 
     # # Cancel an IssuingStockRule entity
     #
-    # Cancel an IssuingStockRule entity previously created in the Stark Infra API
+    # Cancel an IssuingStockRule entity previously created in the Stark Infra API. This action is irreversible.
     #
     # ## Parameters (required):
     # - id [string]: IssuingStockRule unique id. ex: '5664445921492992'

data/lib/issuing_token/issuing_token.rb

@@ -15,7 +15,7 @@ module StarkInfra
   # - wallet_id [string]: wallet provider which the token is bounded to. ex: 'google'
   # - wallet_name [string]: wallet name. ex: 'GOOGLE'
   # - merchant_id [string]: merchant unique id. ex: '5656565656565656'
-  # - status [string]: current IssuingToken status. ex: 'active', 'blocked', 'canceled', 'frozen' or 'pending'
+  # - status [string]: current IssuingToken status. Options: 'active', 'blocked', 'canceled', 'frozen', 'pending', 'denied'.
   # - wallet_device_score [number]: Device score informed by the digital wallet.
   # - wallet_account_score [number]: Account score informed by the digital wallet
   # - updated [DateTime]: latest update datetime for the IssuingToken. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
@@ -180,7 +180,7 @@ module StarkInfra
 
     # # Cancel an IssuingToken entity
     #
-    # Cancel an IssuingToken entity previously created in the Stark Infra API by its id
+    # Cancel an IssuingToken entity previously created in the Stark Infra API by its id. This action is irreversible.
     #
     # ## Parameters (required):
     # - id [string]: IssuingToken unique id. ex: '5656565656565656'

data/lib/issuing_token/log.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+require_relative('issuing_token')
+
+module StarkInfra
+  class IssuingToken
+    # # IssuingToken::Log object
+    #
+    # Every time an IssuingToken entity is modified, a corresponding IssuingToken::Log
+    # is generated for the entity. This log is never generated by the user.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - token [IssuingToken]: IssuingToken entity to which the log refers to.
+    # - errors [list of hashes]: list of errors linked to this IssuingToken event, each with 'code' and 'message' keys.
+    # - type [string]: type of the IssuingToken event which triggered the log creation. ex: 'active', 'blocked', 'canceled', 'frozen' or 'pending'
+    # - 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, :created, :type, :errors, :token
+      def initialize(id:, created:, type:, errors:, token:)
+        super(id)
+        @token = token
+        @errors = errors
+        @type = type
+        @created = StarkCore::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific IssuingToken::Log
+      #
+      # Receive a single IssuingToken::Log object previously created by the Stark Infra 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 StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - IssuingToken::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve IssuingToken::Logs
+      #
+      # Receive a generator of IssuingToken::Log objects previously created in the Stark Infra 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)
+      # - types [list of strings, default nil]: filter for log event types. ex: ['active', 'blocked', 'canceled', 'frozen', 'pending']
+      # - token_ids [list of strings, default nil]: list of IssuingToken ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: list of ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - generator of IssuingToken::Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, token_ids: nil, ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          token_ids: token_ids,
+          ids: ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged IssuingToken::Logs
+      #
+      # Receive a list of up to 100 IssuingToken::Log objects previously created in the Stark Infra 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)
+      # - types [list of strings, default nil]: filter for log event types. ex: ['active', 'blocked', 'canceled', 'frozen', 'pending']
+      # - token_ids [list of strings, default nil]: list of IssuingToken ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: list of ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+      #
+      # ## Return:
+      # - list of IssuingToken::Log objects with updated attributes
+      # - cursor to retrieve the next page of IssuingToken::Log objects
+      def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, token_ids: nil, ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_page(
+          cursor: cursor,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          token_ids: token_ids,
+          ids: ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        token_maker = StarkInfra::IssuingToken.resource[:resource_maker]
+        {
+          resource_name: 'IssuingTokenLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              token: StarkCore::Utils::API.from_api_json(token_maker, json['token']),
+              errors: json['errors'],
+              type: json['type'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/issuing_token_activation/issuing_token_activation.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/parse')
+
+module StarkInfra
+  # # IssuingTokenActivation object
+  #
+  # The IssuingTokenActivation object displays the necessary information to proceed with the card tokenization.
+  # You will receive this object at your registered URL to notify you which method your user want to receive the activation code.
+  # The POST request must be answered with no content, within 2 seconds, and with an HTTP status code 200.
+  # After that, you may generate the activation code and send it to the cardholder.
+  #
+  # ## Attributes (return-only):
+  # - card_id [string]: card ID which the token is bounded to. ex: '5656565656565656'
+  # - token_id [string]: token unique id. ex: '5656565656565656'
+  # - tags [list of strings]: tags to filter retrieved object. ex: ['tony', 'stark']
+  # - activation_method [dictionary]: dictionary object with 'type':string and 'value':string pairs
+  class IssuingTokenActivation < StarkCore::Utils::SubResource
+    attr_reader :card_id, :token_id, :tags, :activation_method
+    def initialize(card_id: nil, token_id: nil, tags: nil, activation_method: nil)
+      @card_id = card_id
+      @token_id = token_id
+      @tags = tags
+      @activation_method = activation_method
+    end
+
+    # # Create a single verified IssuingTokenActivation request from a content string
+    #
+    # Use this method to parse and verify the authenticity of the request received at the informed endpoint.
+    # Activation requests are posted to your registered endpoint whenever IssuingTokenActivations are received.
+    # If the provided digital signature does not check out with the StarkInfra public key, a
+    # StarkInfra::Error::InvalidSignatureError will be raised.
+    #
+    # ## Parameters (required):
+    # - content [string]: response content from request received at user endpoint (not parsed)
+    # - signature [string]: base-64 digital signature received at response header 'Digital-Signature'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - Parsed IssuingTokenActivation object
+    def self.parse(content:, signature:, user: nil)
+      StarkInfra::Utils::Parse.parse_and_verify(content: content, signature: signature, user: user, resource: resource, key: nil)
+    end
+
+    def self.resource
+      {
+        resource_name: 'IssuingTokenActivation',
+        resource_maker: proc { |json|
+          IssuingTokenActivation.new(
+            card_id: json['card_id'],
+            token_id: json['token_id'],
+            tags: json['tags'],
+            activation_method: json['activation_method']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/issuing_token_request/issuing_token_request.rb

@@ -10,7 +10,7 @@ module StarkInfra
   #
   # ## Parameters (required):
   # - card_id [string]: card id to be tokenized. ex: '5734340247945216'
-  # - wallet_id [string]: desired wallet to be integrated. ex: 'google'
+  # - wallet_id [string]: desired wallet to be integrated. Options: 'apple', 'google', 'merchant'.
   # - method_code [string]: method code. ex: 'app' or 'manual'
   #
   # ## Attributes (return-only):

data/lib/issuing_withdrawal/issuing_withdrawal.rb

@@ -9,8 +9,8 @@ module StarkInfra
   # The IssuingWithdrawal objects created in your Workspace return cash from your Issuing balance to your Banking balance.
   #
   # ## Parameters (required):
-  # - amount [integer]: IssuingWithdrawal value in cents. Minimum = 0 (any value will be accepted). ex: 1234 (= R$ 12.34)
-  # - external_id [string] IssuingWithdrawal external ID. ex: '12345'
+  # - amount [integer]: IssuingWithdrawal value in cents. ex: 1234 (= R$ 12.34)
+  # - external_id [string]: unique identifier for this withdrawal, used to prevent duplicates on retries. ex: '12345'
   # - description [string]: IssuingWithdrawal description. ex: 'sending money back'
   #
   # ## Parameters (optional):

data/lib/ledger/ledger.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+
+module StarkInfra
+  # # Ledger object
+  #
+  # Ledgers are used to track the balance of a given amount by inserting LedgerTransactions to them.
+  # They can represent a bank account, a digital wallet, an inventory product, etc.
+  #
+  # ## Parameters (required):
+  # - external_id [string]: string that must be unique among all your Ledgers. ex: 'my-internal-id-123456'
+  #
+  # ## Parameters (optional):
+  # - rules [list of Ledger::Rule objects, default []]: list of Rule objects linked to the Ledger. Rules are used to limit the balance of the Ledger. ex: [Ledger::Rule.new(key: 'minimumBalance', value: 0)]
+  # - tags [list of strings, default []]: list of strings for reference when searching for Ledgers. ex: ['account/123', 'savings']
+  # - metadata [dictionary, default {}]: dictionary object used to store additional information about the Ledger object. ex: { 'accountId': '123', 'accountType': 'savings' }
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the Ledger is created. ex: '5656565656565656'
+  # - created [DateTime]: creation datetime for the Ledger. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the Ledger. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class Ledger < StarkCore::Utils::Resource
+    attr_reader :external_id, :rules, :tags, :metadata, :id, :created, :updated
+    def initialize(external_id:, id: nil, rules: nil, tags: nil, metadata: nil, created: nil, updated: nil)
+      super(id)
+      @external_id = external_id
+      @rules = StarkInfra::Ledger::Rule.parse_rules(rules)
+      @tags = tags
+      @metadata = metadata
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create Ledgers
+    #
+    # Send a list of Ledger objects for creation at the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - ledgers [list of Ledger objects]: list of Ledger objects to be created in the Stark Infra API. You can send up to 100 Ledger objects in a single request.
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of Ledger objects with updated attributes
+    def self.create(ledgers, user: nil)
+      StarkInfra::Utils::Rest.post(entities: ledgers, user: user, **resource)
+    end
+
+    # # Retrieve a specific Ledger
+    #
+    # Receive a single Ledger object previously created in the Stark Infra 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 StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - Ledger object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve Ledgers
+    #
+    # Receive a generator of Ledger objects previously created in the Stark Infra 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)
+    # - ids [list of strings, default nil]: list of Ledger ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - external_ids [list of strings, default nil]: list of Ledger external ids to filter retrieved objects. ex: ['my-internal-id-123456', 'my-internal-id-654321']
+    # - tags [list of strings, default nil]: list of tags to filter retrieved objects. ex: ['account/123', 'savings']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of Ledger objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, ids: nil, external_ids: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        ids: ids,
+        external_ids: external_ids,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged Ledgers
+    #
+    # Receive a list of up to 100 Ledger objects previously created in the Stark Infra 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)
+    # - ids [list of strings, default nil]: list of Ledger ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - external_ids [list of strings, default nil]: list of Ledger external ids to filter retrieved objects. ex: ['my-internal-id-123456', 'my-internal-id-654321']
+    # - tags [list of strings, default nil]: list of tags to filter retrieved objects. ex: ['account/123', 'savings']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of Ledger objects with updated attributes
+    # - cursor to retrieve the next page of Ledger objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, ids: nil, external_ids: nil, tags: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        after: after,
+        before: before,
+        ids: ids,
+        external_ids: external_ids,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Update Ledger
+    #
+    # Update a Ledger by passing id.
+    #
+    # ## Parameters (required):
+    # - id [string]: Ledger id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - rules [list of Ledger::Rule objects, default nil]: list of Rule objects linked to the Ledger. Rules are used to limit the balance of the Ledger. ex: [Ledger::Rule.new(key: 'minimumBalance', value: 0)]
+    # - tags [list of strings, default nil]: list of strings for reference when searching for Ledgers. ex: ['account/123', 'savings']
+    # - metadata [dictionary, default nil]: dictionary object used to store additional information about the Ledger object. ex: { 'accountId': '123', 'accountType': 'savings' }
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - target Ledger object with updated attributes
+    def self.update(id, rules: nil, tags: nil, metadata: nil, user: nil)
+      StarkInfra::Utils::Rest.patch_id(
+        id: id,
+        rules: rules,
+        tags: tags,
+        metadata: metadata,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'Ledger',
+        resource_maker: proc { |json|
+          Ledger.new(
+            id: json['id'],
+            external_id: json['external_id'],
+            rules: json['rules'],
+            tags: json['tags'],
+            metadata: json['metadata'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end