starkinfra 0.0.2 → 0.0.3

data/lib/issuingpurchase/log.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('issuingpurchase')
+
+module StarkInfra
+  class IssuingPurchase
+    # # IssuingPurchase::Log object
+    #
+    # Every time an IssuingPurchase entity is updated, a corresponding IssuingInvoice::Log is generated for the entity.
+    # This Log is never generated by the user, but it can be retrieved to check additional information on the IssuingPurchase.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - purchase [IssuingPurchase]: IssuingPurchase entity to which the log refers to.
+    # - issuing_transaction_id [string]: transaction ID related to the IssuingCard.
+    # - errors [list of strings]: list of errors linked to this IssuingPurchase event
+    # - type [string]: type of the IssuingPurchase 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 < StarkInfra::Utils::Resource
+      attr_reader :id, :purchase, :issuing_transaction_id, :errors, :type, :created
+      def initialize(id: nil, purchase: nil, issuing_transaction_id: nil, errors: nil, type: nil, created: nil)
+        super(id)
+        @purchase = purchase
+        @issuing_transaction_id = issuing_transaction_id
+        @errors = errors
+        @type = type
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
+      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]: list of IssuingPurchase ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - 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: ['approved', 'canceled', 'confirmed', 'denied', 'reversed', 'voided']
+      # - purchase_ids [list of strings, default nil]: list of Purchase 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 Log objects with updated attributes
+      def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, purchase_ids: nil, user: nil)
+        after = StarkInfra::Utils::Checks.check_date(after)
+        before = StarkInfra::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          purchase_ids: purchase_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 purchases.
+      #
+      # ## Parameters (optional):
+      # - cursor [string, default nil]: cursor returned on the previous page function call
+      # - ids [list of strings, default nil]: list of IssuingPurchase ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - limit [integer, default nil]: 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: ['approved', 'canceled', 'confirmed', 'denied', 'reversed', 'voided']
+      # - purchase_ids [list of strings, default nil]: list of Purchase 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 Log objects with updated attributes
+      # - cursor to retrieve the next page of Log objects
+      def self.page(cursor: nil, ids: nil, limit: nil, after: nil, before: nil, types: nil, purchase_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,
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          purchase_ids: purchase_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        request_maker = StarkInfra::IssuingPurchase.resource[:resource_maker]
+        {
+          resource_name: 'IssuingPurchaseLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              purchase: StarkInfra::Utils::API.from_api_json(request_maker, json['purchase']),
+              issuing_transaction_id: json['issuing_transaction_id'],
+              errors: json['errors'],
+              type: json['type'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/issuingrule/issuingrule.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkInfra
+  # # IssuingRule object
+  #
+  # The IssuingRule object displays the spending rules of IssuingCards and IssuingHolders created in your Workspace.
+  #
+  # ## Parameters (required):
+  # - name [string]: rule name. ex: 'Travel' or 'Food'
+  # - amount [integer]: maximum amount that can be spent in the informed interval. ex: 200000 (= R$ 2000.00)
+  # - interval [string]: interval after which the rule amount counter will be reset to 0. ex: 'instant', 'day', 'week', 'month', 'year' or 'lifetime'
+  # ## Parameters (optional):
+  # - currency_code [string, default 'BRL']: code of the currency that the rule amount refers to. ex: 'BRL' or 'USD'
+  # - categories [list of strings, default []]: merchant categories accepted by the rule. ex: ['eatingPlacesRestaurants', 'travelAgenciesTourOperators']
+  # - countries [list of strings, default []]: countries accepted by the rule. ex: ['BRA', 'USA']
+  # - methods [list of strings, default []]: card purchase methods accepted by the rule. ex: ['chip', 'token', 'server', 'manual', 'magstripe', 'contactless']
+  # ## Attributes (expanded return-only):
+  # - counter_amount [integer]: current rule spent amount. ex: 1000
+  # - currency_symbol [string]: currency symbol. ex: 'R$'
+  # - currency_name [string]: currency name. ex: 'Brazilian Real'
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when Rule is created. ex: '5656565656565656'
+  class IssuingRule < StarkInfra::Utils::Resource
+    attr_reader :name, :interval, :amount, :currency_code, :counter_amount, :currency_name, :currency_symbol, :categories, :countries, :methods
+    def initialize(name:, interval:, amount:, currency_code: nil, counter_amount: nil, currency_name: nil,
+      currency_symbol: nil, categories: nil, countries: nil, methods: nil
+    )
+      super(id)
+      @name = name
+      @interval = interval
+      @amount = amount
+      @currency_code = currency_code
+      @counter_amount = counter_amount
+      @currency_name = currency_name
+      @currency_symbol = currency_symbol
+      @categories = categories
+      @countries = countries
+      @methods = methods
+    end
+
+    def self.parse_rules(rules)
+      parsed_rules = []
+      rule_maker = StarkInfra::IssuingRule.resource[:resource_maker]
+      return rules if rules.nil?
+
+      rules.each do |rule|
+        if rule.is_a? IssuingRule
+          parsed_rules.append(rule)
+          next
+        end
+        parsed_rules.append(StarkInfra::Utils::API.from_api_json(rule_maker, rule))
+      end
+      parsed_rules
+    end
+
+    def self.resource
+      {
+        resource_name: 'IssuingRule',
+        resource_maker: proc { |json|
+          IssuingRule.new(
+            name: json[:name],
+            interval: json[:interval],
+            amount: json[:amount],
+            currency_code: json[:currency_code],
+            counter_amount: json[:counter_amount],
+            currency_name: json[:currency_name],
+            currency_symbol: json[:currency_symbol],
+            categories: json[:categories],
+            countries: json[:countries],
+            methods: json[:methods]
+          )
+        }
+      }
+    end
+  end
+end
+

data/lib/issuingtransaction/issuingtransaction.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkInfra
+  # # IssuingTransaction object
+  #
+  # The IssuingTransaction objects created in your Workspace to represent each balance shift.
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when IssuingTransaction is created. ex: '5656565656565656'
+  # - amount [integer]: IssuingTransaction value in cents. ex: 1234 (= R$ 12.34)
+  # - balance [integer]: balance amount of the Workspace at the instant of the Transaction in cents. ex: 200 (= R$ 2.00)
+  # - description [string]: IssuingTransaction description. ex: 'Buying food'
+  # - source [string]: source of the transaction. ex: 'issuing-purchase/5656565656565656'
+  # - tags [string]: list of strings inherited from the source resource. ex: ['tony', 'stark']
+  # - created [DateTime]: creation datetime for the IssuingTransaction. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class IssuingTransaction < StarkInfra::Utils::Resource
+    attr_reader :id, :amount, :balance, :description, :source, :tags, :created
+
+    def initialize(
+      id: nil, amount: nil, balance: nil, description: nil, source: nil, tags: nil, created: nil
+    )
+      super(id)
+      @amount = amount
+      @balance = balance
+      @description = description
+      @source = source
+      @tags = tags
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+    end
+
+    # # Retrieve a specific IssuingTransaction
+    #
+    # Receive a single IssuingTransaction 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:
+    # - IssuingTransaction object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve IssuingTransactions
+    #
+    # Receive a generator of IssuingTransaction objects previously created in the Stark Infra API
+    #
+    # ## Parameters (optional):
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - external_ids [list of strings, default []]: external IDs. ex: ['5656565656565656', '4545454545454545']
+    # - 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)
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'approved', 'canceled', 'denied', 'confirmed' or 'voided'
+    # - ids [list of strings, default [], default nil]: purchase IDs
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of IssuingTransaction objects with updated attributes
+    def self.query(tags: nil, external_ids: nil, after: nil, before: nil, status: nil, ids: nil, limit: nil, user: nil)
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        tags: tags,
+        external_ids: external_ids,
+        after: after,
+        before: before,
+        status: status,
+        ids: ids,
+        limit: limit,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged IssuingTransactions
+    #
+    # Receive a list of IssuingTransaction objects previously created in the Stark Infra API and the cursor to the next page.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call.
+    # - 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']
+    # - 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)
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'approved', 'canceled', 'denied', 'confirmed' or 'voided'
+    # - ids [list of strings, default nil]: purchase IDs
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Max = 100. ex: 35
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - list of IssuingTransactions objects with updated attributes
+    # - cursor to retrieve the next page of IssuingTransactions objects
+    def self.page(cursor: nil, tags: nil, external_ids: nil, after: nil, before: nil, status: nil, ids: nil, limit: nil,
+                  user: nil)
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        tags: tags,
+        external_ids: external_ids,
+        after: after,
+        before: before,
+        status: status,
+        ids: ids,
+        limit: limit,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'IssuingTransaction',
+        resource_maker: proc { |json|
+          IssuingTransaction.new(
+            id: json['id'],
+            amount: json['amount'],
+            balance: json['balance'],
+            description: json['description'],
+            source: json['source'],
+            tags: json['tags'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/issuingwithdrawal/issuingwithdrawal.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkInfra
+  # # IssuingWithdrawal object
+  #
+  # 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'
+  # - description [string]: IssuingWithdrawal description. ex: 'sending money back'
+  #
+  # ## Parameters (optional):
+  # - tags [list of strings, default []]: list of strings for tagging. ex: ['tony', 'stark']
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when IssuingWithdrawal is created. ex: '5656565656565656'
+  # - transaction_id [string]: Stark Bank ledger transaction ids linked to this IssuingWithdrawal
+  # - issuing_transaction_id [string]: issuing ledger transaction ids linked to this IssuingWithdrawal
+  # - updated [DateTime]: latest update datetime for the IssuingWithdrawal. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - created [DateTime]: creation datetime for the IssuingWithdrawal. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class IssuingWithdrawal < StarkInfra::Utils::Resource
+    attr_reader :amount, :external_id, :description, :tags, :id, :transaction_id, :issuing_transaction_id, :updated, :created
+    def initialize(
+      amount:, external_id:, description:, tags: nil, id: nil, transaction_id: nil, issuing_transaction_id: nil,
+      updated: nil, created: nil
+    )
+      super(id)
+      @amount = amount
+      @external_id = external_id
+      @description = description
+      @tags = tags
+      @transaction_id = transaction_id
+      @issuing_transaction_id = issuing_transaction_id
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create an IssuingWithdrawal
+    #
+    # Send a single IssuingWithdrawal object for creation in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - withdrawal [IssuingWithdrawal object]: IssuingWithdrawal object to be created in the API.
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - IssuingWithdrawal object with updated attributes
+    def self.create(withdrawal, user: nil)
+      StarkInfra::Utils::Rest.post_single(entity: withdrawal, user: user, **resource)
+    end
+
+    # # Retrieve a specific IssuingWithdrawal
+    #
+    # Receive a single IssuingWithdrawal 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:
+    # - IssuingWithdrawal object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve IssuingWithdrawals
+    #
+    # Receive a generator of IssuingWithdrawal 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
+    # - external_ids [list of strings, default []]: external IDs. ex: ['5656565656565656', '4545454545454545']
+    # - 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']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of IssuingWithdrawal objects with updated attributes
+    def self.query(limit: nil, external_ids: nil, after: nil, before: nil, tags: nil, user: nil)
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        limit: limit,
+        external_ids: external_ids,
+        after: after,
+        before: before,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged IssuingWithdrawals
+    #
+    # Receive a list of IssuingWithdrawals objects previously created in the Stark Infra API and the cursor to the next page.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call.
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Max = 100. ex: 35
+    # - external_ids [list of strings, default []]: external IDs. ex: ['5656565656565656', '4545454545454545']
+    # - 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']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - list of IssuingWithdrawal objects with updated attributes
+    # - cursor to retrieve the next page of IssuingWithdrawal objects
+    def self.page(cursor: nil, limit: nil, external_ids: nil, after: nil, before: nil, tags: 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,
+        external_ids: external_ids,
+        after: after,
+        before: before,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'IssuingWithdrawal',
+        resource_maker: proc { |json|
+          IssuingWithdrawal.new(
+            amount: json['amount'],
+            external_id: json['external_id'],
+            description: json['description'],
+            tags: json['tags'],
+            id: json['id'],
+            transaction_id: json['transaction_id'],
+            issuing_transaction_id: json['issuing_transaction_id'],
+            updated: json['updated'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/pixbalance/pixbalance.rb

@@ -5,18 +5,18 @@ require_relative('../utils/rest')
 require_relative('../utils/checks')
 
 module StarkInfra
-    # # PixBalance object
-    #
-    # The PixBalance object displays the current 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 Balance 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 balance. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-
+  # # PixBalance object
+  #
+  # The PixBalance object displays the current 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 Balance 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 balance. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class PixBalance < StarkInfra::Utils::Resource
     attr_reader :amount, :currency, :updated, :id
     def initialize(amount: nil, currency: nil, updated: nil, id: nil)
@@ -31,7 +31,7 @@ module StarkInfra
     # Receive the PixBalance object linked to your workspace in the Stark Infra API
     #
     # ## Parameters (optional):
-    # - user [Organization/Project object, default nil]: 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:
     # - PixBalance object with updated attributes

data/lib/pixchargeback/log.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('pixchargeback')
+
+module StarkInfra
+  class PixChargeback
+    # # PixChargeback::Log object
+    #
+    # Every time a PixChargeback entity is modified, a corresponding PixChargeback::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 PixChargeback event which triggered the log creation. Options: 'created', 'failed', 'delivering', 'delivered', 'closed', 'canceled'
+    # - errors [list of strings]: list of errors linked to this PixChargeback event.
+    # - chargeback [PixChargeback]: PixChargeback entity to which the log refers to.
+    class Log < StarkInfra::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :chargeback
+      def initialize(id:, created:, type:, errors:, chargeback:)
+        super(id)
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
+        @type = type
+        @errors = errors
+        @chargeback = chargeback
+      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 PixChargeback 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: 'created', 'failed', 'delivering', 'delivered', 'closed', 'canceled'
+      # - chargeback_ids [list of strings, default nil]: list of PixChargeback ids to filter retrieved objects. ex: %w[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 Log objects with updated attributes
+      def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, chargeback_ids: nil, user: nil)
+        after = StarkInfra::Utils::Checks.check_date(after)
+        before = StarkInfra::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          chargeback_ids: chargeback_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 chargebacks.
+      #
+      # ## Parameters (optional):
+      # - cursor [string, default nil]: cursor returned on the previous page function call
+      # - ids [list of strings, default nil]: Log ids to filter PixChargeback Logs. ex: ['5656565656565656']
+      # - 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: 'created', 'failed', 'delivering', 'delivered', 'closed', 'canceled'
+      # - chargeback_ids [list of strings, default nil]: list of PixChargeback ids to filter retrieved objects. ex: %w[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, ids: nil, limit: nil, after: nil, before: nil, types: nil, chargeback_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,
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          chargeback_ids: chargeback_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        chargeback_maker = StarkInfra::PixChargeback.resource[:resource_maker]
+        {
+          resource_name: 'PixChargebackLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              chargeback: StarkInfra::Utils::API.from_api_json(chargeback_maker, json['chargeback'])
+            )
+          }
+        }
+      end
+    end
+  end
+end