starkinfra 0.0.2 → 0.0.3

data/lib/creditnote/log.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('creditnote')
+
+module StarkInfra
+  class CreditNote
+    # # CreditNote::Log object
+    #
+    # Every time a CreditNote entity is modified, a corresponding CreditNote::Log
+    # is generated for the entity. This log is never generated by the
+    # user.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    # - type [string]: type of the CreditNote event which triggered the log creation. Options: 'canceled', 'created', 'expired', 'failed', 'refunded', 'registered', 'sending', 'sent', 'signed', 'success'
+    # - errors [list of strings]: list of errors linked to this CreditNote event.
+    # - note [CreditNote]: CreditNote entity to which the log refers to.
+    class Log < StarkInfra::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :note
+      def initialize(id:, created:, type:, errors:, note:)
+        super(id)
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
+        @type = type
+        @errors = errors
+        @note = note
+      end
+
+      # # Retrieve a specific Log
+      #
+      # Receive a single Log object previously created by the Stark Infra API by passing 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:
+      # - Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve Logs
+      #
+      # Receive a generator of Log objects previously created in the Stark Infra API
+      #
+      # ## Parameters (optional):
+      # - ids [list of strings, default nil]: Log ids to filter PixKey Logs. ex: ['5656565656565656']
+      # - 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 retrieved objects by types. Options: 'canceled', 'created', 'expired', 'failed', 'refunded', 'registered', 'sending', 'sent', 'signed', 'success'
+      # - note_ids [list of strings, default nil]: list of CreditNote ids to filter retrieved objects. 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 Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, note_ids: nil, user: nil)
+        after = StarkInfra::Utils::Checks.check_date(after)
+        before = StarkInfra::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          note_ids: note_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged Logs
+      #
+      # Receive a list of up to 100 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 notes.
+      #
+      # ## 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 retrieved objects by types. Options: 'canceled', 'created', 'expired', 'failed', 'refunded', 'registered', 'sending', 'sent', 'signed', 'success'
+      # - note_ids [list of strings, default nil]: list of CreditNote ids to filter retrieved objects. 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 Log objects with updated attributes
+      # - Cursor to retrieve the next page of Log objects
+      def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, note_ids: nil, user: nil)
+        after = StarkInfra::Utils::Checks.check_date(after)
+        before = StarkInfra::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_page(
+          cursor: cursor,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          note_ids: note_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        note_maker = StarkInfra::CreditNote.resource[:resource_maker]
+        {
+          resource_name: 'CreditNoteLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              note: StarkInfra::Utils::API.from_api_json(note_maker, json['note'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/event/attempt.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('event')
+
+module StarkInfra
+  class Event
+    # # Event::Attempt object
+    #
+    # When an Event delivery fails, an event attempt will be registered.
+    # It carries information meant to help you debug event reception issues.
+    #
+    # ## Attributes:
+    # - id [string]: unique id that identifies the delivery attempt. ex: '5656565656565656'
+    # - code [string]: delivery error code. ex: badHttpStatus, badConnection, timeout
+    # - message [string]: delivery error full description. ex: 'HTTP POST request returned status 404'
+    # - event_id [string]: ID of the Event whose delivery failed. ex: '4848484848484848'
+    # - webhook_id [string]: ID of the Webhook that triggered this event. ex: '5656565656565656'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Attempt < StarkInfra::Utils::Resource
+      attr_reader :id, :code, :message, :event_id, :webhook_id, :created
+      def initialize(id:, code:, message:, event_id:, webhook_id:, created:)
+        super(id)
+        @code = code
+        @message = message
+        @event_id = event_id
+        @webhook_id = webhook_id
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific Event::Attempt
+      #
+      # Receive a single Event::Attempt 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:
+      # - Event::Attempt object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve Event::Attempts
+      #
+      # Receive a generator of Event::Attempt 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)
+      # - event_ids [list of strings, default nil]: list of Event ids to filter attempts. ex: ['5656565656565656', '4545454545454545']
+      # - webhook_ids [list of strings, default nil]: list of Webhook ids to filter attempts. 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 Event::Attempt objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, event_ids: nil, webhook_ids: nil, user: nil)
+        after = StarkInfra::Utils::Checks.check_date(after)
+        before = StarkInfra::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          limit: limit,
+          after: after,
+          before: before,
+          event_ids: event_ids,
+          webhook_ids: webhook_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged Event::Attempts
+      #
+      # Receive a list of up to 100 Attempt 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)
+      # - event_ids [list of strings, default nil]: list of Event ids to filter attempts. ex: ['5656565656565656', '4545454545454545']
+      # - webhook_ids [list of strings, default nil]: list of Webhook ids to filter attempts. 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 Event::Attempt objects with updated attributes
+      # - cursor to retrieve the next page of Attempt objects
+      def self.page(cursor: nil, limit: nil, after: nil, before: nil, event_ids: nil, webhook_ids: nil, user: nil)
+        after = StarkInfra::Utils::Checks.check_date(after)
+        before = StarkInfra::Utils::Checks.check_date(before)
+        return StarkInfra::Utils::Rest.get_page(
+          cursor: cursor,
+          limit: limit,
+          after: after,
+          before: before,
+          event_ids: event_ids,
+          webhook_ids: webhook_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        {
+          resource_name: 'EventAttempt',
+          resource_maker: proc { |json|
+            Attempt.new(
+              id: json['id'],
+              code: json['code'],
+              message: json['message'],
+              event_id: json['event_id'],
+              webhook_id: json['webhook_id'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/event/event.rb

@@ -11,7 +11,6 @@ require_relative('../pixrequest/log')
 require_relative('../pixreversal/log')
 require_relative('../utils/parse')
 
-
 module StarkInfra
   # # Webhook Event object
   #
@@ -21,7 +20,7 @@ module StarkInfra
   #
   # ## Attributes:
   # - id [string]: unique id returned when the event is created. ex: '5656565656565656'
-  # - log [Log]: a Log object from one the subscription services (TransferLog, InvoiceLog, BoletoLog, BoletoPaymentlog or UtilityPaymentLog)
+  # - log [Log]: a Log object from one the subscription services (PixRequestLog, PixReversalLog)
   # - created [DateTime]: creation datetime for the notification event. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - is_delivered [bool]: true if the event has been successfully delivered to the user url. ex: False
   # - workspace_id [string]: ID of the Workspace that generated this event. Mostly used when multiple Workspaces have Webhooks registered to the same endpoint. ex: '4545454545454545'
@@ -36,35 +35,155 @@ module StarkInfra
       @subscription = subscription
 
       resource = {
+        'credit-note': StarkInfra::CreditNote::Log.resource,
         'pix-request.in': StarkInfra::PixRequest::Log.resource,
         'pix-request.out': StarkInfra::PixRequest::Log.resource,
         'pix-reversal.in': StarkInfra::PixReversal::Log.resource,
         'pix-reversal.out': StarkInfra::PixReversal::Log.resource,
+        'pix-key': StarkInfra::PixKey::Log.resource,
+        'pix-claim': StarkInfra::PixClaim::Log.resource,
+        'pix-infraction': StarkInfra::PixInfraction::Log.resource,
+        'pix-chargeback': StarkInfra::PixChargeback::Log.resource,
+        'issuing-card': StarkInfra::IssuingCard::Log.resource,
+        'issuing-invoice': StarkInfra::IssuingInvoice::Log.resource,
+        'issuing-purchase': StarkInfra::IssuingPurchase::Log.resource
       }[subscription.to_sym]
 
       @log = log
       @log = StarkInfra::Utils::API.from_api_json(resource[:resource_maker], log) unless resource.nil?
     end
 
+    # # Retrieve a specific notification Event
+    #
+    # Receive a single notification Event object previously created in the Stark Infra API by passing 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:
+    # - Event object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve notification Events
+    #
+    # Receive a generator of notification Event 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)
+    # - is_delivered [bool, default nil]: bool to filter successfully delivered events. ex: true or false
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of Event objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, is_delivered: nil, user: nil)
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        user: user,
+        limit: limit,
+        after: after,
+        before: before,
+        is_delivered: is_delivered,
+        **resource
+      )
+    end
+
+    # # Retrieve paged Events
+    #
+    # Receive a list of up to 100 Event 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)
+    # - is_delivered [bool, default nil]: bool to filter successfully delivered events. ex: true or false
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of Event objects with updated attributes
+    # - cursor to retrieve the next page of Event objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, is_delivered: nil, user: nil)
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        after: after,
+        before: before,
+        is_delivered: is_delivered,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Delete a notification Event
+    #
+    # Delete a notification Event entity previously created in the Stark Infra API by its ID
+    #
+    # ## Parameters (required):
+    # - id [string]: Event 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:
+    # - deleted Event object
+    def self.delete(id, user: nil)
+      StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
+    # # Update notification Event entity
+    #
+    # Update a notification Event by its id.
+    # If is_delivered is true, the event will no longer be returned on queries with is_delivered=false.
+    #
+    # ## Parameters (required):
+    # - id [list of strings]: Event unique ids. ex: '5656565656565656'
+    # - is_delivered [bool]: If true and event hasn't been delivered already, event will be set as delivered. ex: true
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - target Event with updated attributes
+    def self.update(id, is_delivered:, user: nil)
+      StarkInfra::Utils::Rest.patch_id(id: id, user: user, is_delivered: is_delivered, **resource)
+    end
+
     # # Create single notification Event from a content string
     #
     # Create a single Event object received from event listening at subscribed user endpoint.
     # If the provided digital signature does not check out with the StarkInfra public key, a
-    # starkinfra.exception.InvalidSignatureException will be raised.
+    # 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]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - Parsed Event object
     def self.parse(content:, signature:, user: nil)
-      return StarkInfra::Utils::Parse.parse_and_verify(content: content, signature: signature, user: user, resource: resource, key: 'event')
+      StarkInfra::Utils::Parse.parse_and_verify(
+        content: content,
+        signature: signature,
+        user: user,
+        resource: resource,
+        key: 'event'
+      )
     end
-    
+
     class << self
       private
 
@@ -86,4 +205,3 @@ module StarkInfra
     end
   end
 end
-

data/lib/issuingauthorization/issuingauthorization.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require('json')
+
+module StarkInfra
+  # # IssuingAuthorization object
+  #
+  # An IssuingAuthorization presents purchase data to be analysed and answered with an approval or a declination.
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the IssuingAuthorization is created. ex: '5656565656565656'
+  # - end_to_end_id [string]: central bank's unique transaction ID. ex: "E79457883202101262140HHX553UPqeq"
+  # - 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)
+  # - card_id [string]: unique id returned when IssuingCard is created. ex: "5656565656565656"
+  # - issuer_amount [integer]: issuer amount. ex: 1234 (= R$ 12.34)
+  # - issuer_currency_code [string]: issuer currency code. ex: "USD"
+  # - merchant_amount [integer]: merchant amount. ex: 1234 (= R$ 12.34)
+  # - merchant_currency_code [string]: merchant currency code. ex: "USD"
+  # - merchant_category_code [string]: merchant category code. ex: "fastFoodRestaurants"
+  # - merchant_country_code [string]: merchant country code. ex: "USA"
+  # - acquirer_id [string]: acquirer ID. ex: "5656565656565656"
+  # - merchant_id [string]: merchant ID. ex: "5656565656565656"
+  # - merchant_name [string]: merchant name. ex: "Google Cloud Platform"
+  # - merchant_fee [integer]: merchant fee charged. ex: 200 (= R$ 2.00)
+  # - wallet_id [string]: virtual wallet ID. ex: "googlePay"
+  # - method_code [string]: method code. ex: "chip", "token", "server", "manual", "magstripe" or "contactless"
+  # - score [float]: internal score calculated for the authenticity of the purchase. nil in case of insufficient data. ex: 7.6
+  # - is_partial_allowed [bool]: true if the the merchant allows partial purchases. ex: False
+  # - purpose [string]: purchase purpose. ex: "purchase"
+  # - card_tags [list of strings]: tags of the IssuingCard responsible for this purchase. ex: ["travel", "food"]
+  # - holder_tags [list of strings]: tags of the IssuingHolder responsible for this purchase. ex: ["technology", "john snow"]
+  class IssuingAuthorization < StarkInfra::Utils::Resource
+    attr_reader :id, :end_to_end_id, :amount, :tax, :card_id, :issuer_amount, :issuer_currency_code, :merchant_amount,
+                :merchant_currency_code, :merchant_category_code, :merchant_country_code, :acquirer_id, :merchant_id,
+                :merchant_name, :merchant_fee, :wallet_id, :method_code, :score, :is_partial_allowed, :purpose,
+                :card_tags, :holder_tags
+    def initialize(
+      id: nil, end_to_end_id: nil, amount: nil, tax: nil, card_id: nil, issuer_amount: nil,
+      issuer_currency_code: nil, merchant_amount: nil, merchant_currency_code: nil,
+      merchant_category_code: nil, merchant_country_code: nil, acquirer_id: nil, merchant_id: nil,
+      merchant_name: nil, merchant_fee: nil, wallet_id: nil, method_code: nil, score: nil,
+      is_partial_allowed: nil, purpose: nil, card_tags: nil, holder_tags: nil
+    )
+      super(id)
+      @end_to_end_id = end_to_end_id
+      @amount = amount
+      @tax = tax
+      @card_id = card_id
+      @issuer_amount = issuer_amount
+      @issuer_currency_code = issuer_currency_code
+      @merchant_amount = merchant_amount
+      @merchant_currency_code = merchant_currency_code
+      @merchant_category_code = merchant_category_code
+      @merchant_country_code = merchant_country_code
+      @acquirer_id = acquirer_id
+      @merchant_id = merchant_id
+      @merchant_name = merchant_name
+      @merchant_fee = merchant_fee
+      @wallet_id = wallet_id
+      @method_code = method_code
+      @score = score
+      @is_partial_allowed = is_partial_allowed
+      @purpose = purpose
+      @card_tags = card_tags
+      @holder_tags = holder_tags
+    end
+
+    # # Create single IssuingAuthorization from a content string
+    #
+    # Create a single IssuingAuthorization object received from IssuingAuthorization at the informed endpoint.
+    # If the provided digital signature does not check out with the StarkInfra public key, a
+    # StarkInfra.Error.InvalidSignatureError will be raised.
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - IssuingAuthorization object with updated attributes
+    def self.parse(content:, signature:, user: nil)
+      StarkInfra::Utils::Parse.parse_and_verify(content: content, signature: signature, user: user, resource: resource)
+    end
+
+    # # Helps you respond IssuingAuthorization requests.
+    #
+    # ## Parameters (required):
+    # - status [string]: sub-issuer response to the authorization. ex: 'accepted' or 'denied'
+    #
+    # ## Parameters (optional):
+    # - amount [integer, default 0]: amount in cents that was authorized. ex: 1234 (= R$ 12.34)
+    # - reason [string, default '']: denial reason. ex: 'other'
+    # - tags [list of strings, default []]: tags to filter retrieved object. ex: ['tony', 'stark']
+    #
+    # ## Return:
+    # - Dumped JSON string that must be returned to us on the IssuingAuthorization request
+    def self.response(status:, amount: nil, reason: nil, tags: nil)
+      response_hash = {
+        "status": status,
+        "amount": amount || 0,
+        "reason": reason || '',
+        "tags": tags || []
+      }
+      response_hash.to_json
+    end
+
+    def self.resource
+      {
+        resource_name: 'IssuingAuthorization',
+        resource_maker: proc { |json|
+          IssuingAuthorization.new(
+            id: json['id'],
+            end_to_end_id: json['end_to_end_id'],
+            amount: json['amount'],
+            tax: json['tax'],
+            card_id: json['card_id'],
+            issuer_amount: json['issuer_amount'],
+            issuer_currency_code: json['issuer_currency_code'],
+            merchant_amount: json['merchant_amount'],
+            merchant_currency_code: json['merchant_currency_code'],
+            merchant_category_code: json['merchant_category_code'],
+            merchant_country_code: json['merchant_country_code'],
+            acquirer_id: json['acquirer_id'],
+            merchant_id: json['merchant_id'],
+            merchant_name: json['merchant_name'],
+            merchant_fee: json['merchant_fee'],
+            wallet_id: json['wallet_id'],
+            method_code: json['method_code'],
+            score: json['score'],
+            is_partial_allowed: json['is_partial_allowed'],
+            purpose: json['purpose'],
+            card_tags: json['card_tags'],
+            holder_tags: json['holder_tags']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/issuingbalance/issuingbalance.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkInfra
+  # # IssuingBalance object
+  #
+  # The IssuingBalance object displays the current issuing balance of the Workspace, which is the result of the sum of
+  # all transactions within this Workspace. The balance is never generated by the user, but it can be retrieved to see
+  # the available information.
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when IssuingBalance is created. ex: '5656565656565656'
+  # - amount [integer]: current balance amount of the Workspace in cents. ex: 200 (= R$ 2.00)
+  # - currency [string]: currency of the current Workspace. Expect others to be added eventually. ex: 'BRL'
+  # - updated [DateTime]: latest update datetime for the IssuingBalance. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class IssuingBalance < StarkInfra::Utils::Resource
+    attr_reader :amount, :currency, :updated, :id
+    def initialize(amount: nil, currency: nil, updated: nil, id: nil)
+      super(id)
+      @amount = amount
+      @currency = currency
+      @updated = updated
+    end
+
+    # # Retrieve the IssuingBalance object
+    #
+    # Receive the IssuingBalance object linked to your Workspace in the Stark Infrq API
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - IssuingBalance object with updated attributes
+    def self.get(user: nil)
+      StarkInfra::Utils::Rest.get_stream(user: user, **resource).next
+    end
+
+    def self.resource
+      {
+        resource_name: 'IssuingBalance',
+        resource_maker: proc { |json|
+          IssuingBalance.new(
+            amount: json['amount'],
+            currency: json['currency'],
+            updated: json['updated'],
+            id: json['id']
+          )
+        }
+      }
+    end
+  end
+end