starkinfra 0.1.0 → 0.3.0

data/lib/merchantcategory/merchantcategory.rb

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

data/lib/merchantcountry/merchantcountry.rb

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

data/lib/pixbalance/pixbalance.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # PixBalance object
@@ -18,8 +18,8 @@ module StarkInfra
   # - 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)
+    attr_reader :id, :amount, :currency, :updated
+    def initialize(id: nil, amount: nil, currency: nil, updated: nil)
       super(id)
       @amount = amount
       @currency = currency
@@ -44,10 +44,10 @@ module StarkInfra
         resource_name: 'PixBalance',
         resource_maker: proc { |json|
           PixBalance.new(
+            id: json['id'],
             amount: json['amount'],
             currency: json['currency'],
-            updated: json['updated'],
-            id: json['id']
+            updated: json['updated']
           )
         }
       }

data/lib/pixchargeback/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require_relative('pixchargeback')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
-require_relative('pixchargeback')
+require_relative('../utils/resource')
 
 module StarkInfra
   class PixChargeback
@@ -13,7 +13,7 @@ module StarkInfra
     # is generated for the entity. This log is never generated by the
     # user.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - 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'
@@ -29,9 +29,9 @@ module StarkInfra
         @chargeback = chargeback
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific PixChargeback::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single PixChargeback::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -40,26 +40,26 @@ module StarkInfra
       # - 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
+      # - PixChargeback::Log object with updated attributes
       def self.get(id, user: nil)
         StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
       end
-      
-      # # Retrieve Logs
+
+      # # Retrieve PixChargeback::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of PixChargeback::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]
+      # - ids [list of strings, default nil]: Log ids to filter PixChargeback Logs. ex: ['5656565656565656']
       # - 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
+      # - generator of PixChargeback::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)
@@ -75,23 +75,23 @@ module StarkInfra
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged PixChargeback::Logs
       #
-      # Receive a list of up to 100 Log objects previously created in the Stark Infra API and the cursor to the next page.
+      # Receive a list of up to 100 PixChargeback::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]
+      # - ids [list of strings, default nil]: Log ids to filter PixChargeback Logs. ex: ['5656565656565656']
       # - 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
+      # - list of PixChargeback::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)

data/lib/pixchargeback/pixchargeback.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # PixChargeback object
@@ -10,8 +10,10 @@ module StarkInfra
   # A Pix chargeback can be created when fraud is detected on a transaction or a system malfunction
   # results in an erroneous transaction.
   # It notifies another participant of your request to reverse the payment they have received.
+  #
   # When you initialize a PixChargeback, the entity will not be automatically
   # created in the Stark Infra API. The 'create' function sends the objects
+  # to the Stark Infra API and returns the created object.
   #
   # ## Parameters (required):
   # - amount [integer]: amount in cents to be reversed. ex: 11234 (= R$ 112.34)
@@ -20,40 +22,41 @@ module StarkInfra
   #
   # ## Parameters (optional):
   # - description [string, default nil]: description for the PixChargeback. ex: 'Payment for service #1234'
+  # - tags [list of strings, default nil]:  list of strings for tagging. ex: ['travel', 'food']
   #
   # ## Attributes (return-only):
-  # - id [string]: unique id returned when PixChargeback is created. ex: '5656565656565656'
+  # - id [string]: unique id returned when the PixChargeback is created. ex: '5656565656565656'
   # - analysis [string]: analysis that led to the result.
-  # - bacen_id [string]: central bank's unique UUID that identifies the PixChargeback.
   # - sender_bank_code [string]: bank_code of the Pix participant that created the PixChargeback. ex: '20018183'
   # - receiver_bank_code [string]: bank_code of the Pix participant that received the PixChargeback. ex: '20018183'
   # - rejection_reason [string]: reason for the rejection of the Pix chargeback. Options: 'noBalance', 'accountClosed', 'unableToReverse'
   # - reversal_reference_id [string]: return id of the reversal transaction. ex: 'D20018183202202030109X3OoBHG74wo'.
-  # - id [string]: unique id returned when the PixChargeback is created. ex: '5656565656565656'
   # - result [string]: result after the analysis of the PixChargeback by the receiving party. Options: 'rejected', 'accepted', 'partiallyAccepted'
+  # - flow [string]: direction of the Pix Chargeback. Options: 'in' for received chargebacks, 'out' for chargebacks you requested
   # - status [string]: current PixChargeback status. Options: 'created', 'failed', 'delivered', 'closed', 'canceled'.
   # - created [DateTime]: creation datetime for the PixChargeback. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime]: latest update datetime for the PixChargeback. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class PixChargeback < StarkInfra::Utils::Resource
-    attr_reader :amount, :reference_id, :reason, :description, :id, :analysis, :bacen_id, :sender_bank_code,
-                :receiver_bank_code, :rejection_reason, :reversal_reference_id, :result, :status, :created, :updated
+    attr_reader :amount, :reference_id, :reason, :description, :tags, :id, :analysis, :sender_bank_code,
+                :receiver_bank_code, :rejection_reason, :reversal_reference_id, :result, :flow, :status, :created, :updated
     def initialize(
-      amount:, reference_id:, reason:, description: nil, id: nil, analysis: nil, bacen_id: nil,
-      sender_bank_code: nil, receiver_bank_code: nil, rejection_reason: nil, reversal_reference_id: nil,
-      result: nil, status: nil, created: nil, updated: nil
+      amount:, reference_id:, reason:, description: nil, tags: nil, id: nil, analysis: nil, sender_bank_code: nil,
+      receiver_bank_code: nil, rejection_reason: nil, reversal_reference_id: nil, result: nil, flow: nil, status: nil,
+      created: nil, updated: nil
     )
       super(id)
       @amount = amount
       @reference_id = reference_id
       @reason = reason
       @description = description
+      @tags = tags
       @analysis = analysis
-      @bacen_id = bacen_id
       @sender_bank_code = sender_bank_code
       @receiver_bank_code = receiver_bank_code
       @rejection_reason = rejection_reason
       @reversal_reference_id = reversal_reference_id
       @result = result
+      @flow = flow
       @status = status
       @created = StarkInfra::Utils::Checks.check_datetime(created)
       @updated = StarkInfra::Utils::Checks.check_datetime(updated)
@@ -61,10 +64,10 @@ module StarkInfra
 
     # # Create PixChargebacks
     #
-    # Send a list of PixChargeback objects for creation in the Stark Infra API
+    # Create PixChargebacks in the Stark Infra API
     #
     # ## Parameters (required):
-    # - chargebacks [list of PixChargeback objects]: list of PixChargeback objects to be created in the API. ex: [PixChargeback.new()]
+    # - chargebacks [list of PixChargeback objects]: list of PixChargeback objects 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
@@ -75,9 +78,9 @@ module StarkInfra
       StarkInfra::Utils::Rest.post(entities: chargebacks, user: user, **resource)
     end
 
-    # # Retrieve a specific PixChargeback
+    # # Retrieve a PixChargeback object
     #
-    # Receive a single PixChargeback object previously created in the Stark Infra API by passing its id
+    # Retrieve a PixChargeback object linked to your Workspace in the Stark Infra API using its id.
     #
     # ## Parameters (required):
     # - id [string]: object unique id. ex: '5656565656565656'
@@ -101,11 +104,13 @@ module StarkInfra
     # - before [Date or string, default nil]: date filter for objects created or updated only before specified date. ex: Date.new(2020, 3, 10)
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'success' or 'failed'
     # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - flow [string, default nil]: direction of the Pix Chargeback. Options: 'in' for received chargebacks, 'out' for chargebacks you requested
+    # - tags [list of strings, default nil]: filter for tags of retrieved objects. ex: ['travel', 'food']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - generator of PixChargeback objects with updated attributes
-    def self.query(limit: nil, after: nil, before: nil, status: nil, ids: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, status: nil, ids: nil, flow: nil, tags: nil, user: nil)
       after = StarkInfra::Utils::Checks.check_date(after)
       before = StarkInfra::Utils::Checks.check_date(before)
       StarkInfra::Utils::Rest.get_stream(
@@ -114,6 +119,8 @@ module StarkInfra
         before: before,
         status: status,
         ids: ids,
+        flow: flow,
+        tags: tags,
         user: user,
         **resource
       )
@@ -131,12 +138,14 @@ module StarkInfra
     # - before [Date or string, default nil]: date filter for objects created or updated only before specified date. ex: Date.new(2020, 3, 10)
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'success' or 'failed'
     # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - flow [string, default nil]: direction of the Pix Chargeback. Options: 'in' for received chargebacks, 'out' for chargebacks you requested
+    # - tags [list of strings, default nil]: filter for tags of retrieved objects. ex: ['travel', 'food']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - list of PixChargeback objects with updated attributes
     # - cursor to retrieve the next page of PixChargeback objects
-    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, ids: nil, user: nil)
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, ids: nil, flow: nil, tags: nil, user: nil)
       after = StarkInfra::Utils::Checks.check_date(after)
       before = StarkInfra::Utils::Checks.check_date(before)
       StarkInfra::Utils::Rest.get_page(
@@ -146,6 +155,8 @@ module StarkInfra
         before: before,
         status: status,
         ids: ids,
+        flow: flow,
+        tags: tags,
         user: user,
         **resource
       )
@@ -157,7 +168,7 @@ module StarkInfra
     #
     # ## Parameters (required):
     # - id [string]: PixChargeback unique id. ex: '5656565656565656'
-    # - result [string]: result of the PixChargeback. Options: 'rejected', 'accepted', 'partiallyAccepted'.
+    # - result [string]: result after the analysis of the PixChargeback. Options: 'rejected', 'accepted', 'partiallyAccepted'.
     #
     # ## Parameters (conditionally required):
     # - rejection_reason [string, default nil]: if the PixChargeback is rejected a reason is required. Options: 'noBalance', 'accountClosed', 'unableToReverse',
@@ -174,8 +185,8 @@ module StarkInfra
         id: id,
         result: result,
         rejection_reason: rejection_reason,
-        analysis: analysis,
         reversal_reference_id: reversal_reference_id,
+        analysis: analysis,
         user: user,
         **resource
       )
@@ -202,18 +213,19 @@ module StarkInfra
         resource_name: 'PixChargeback',
         resource_maker: proc { |json|
           PixChargeback.new(
+            id: json['id'],
             amount: json['amount'],
             reference_id: json['reference_id'],
             reason: json['reason'],
             description: json['description'],
-            id: json['id'],
+            tags: json['tags'],
             analysis: json['analysis'],
-            bacen_id: json['bacen_id'],
             sender_bank_code: json['sender_bank_code'],
             receiver_bank_code: json['receiver_bank_code'],
             rejection_reason: json['rejection_reason'],
             reversal_reference_id: json['reversal_reference_id'],
             result: json['result'],
+            flow: json['flow'],
             status: json['status'],
             created: json['created'],
             updated: json['updated']

data/lib/pixclaim/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require_relative('pixclaim')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
-require_relative('pixclaim')
+require_relative('../utils/resource')
 
 module StarkInfra
   class PixClaim
@@ -13,29 +13,27 @@ module StarkInfra
     # is generated for the entity. This log is never generated by the
     # user.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - 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)
+    # - claim [PixClaim]: PixClaim entity to which the log refers to.
     # - type [string]: type of the PixClaim event which triggered the log creation. Options: 'created', 'failed', 'delivering', 'delivered', 'confirming', 'confirmed', 'success', 'canceling', 'canceled'.
     # - errors [list of strings]: list of errors linked to this PixClaim event.
-    # - agent [string]: agent that modified the PixClaim resulting in the Log. Options: 'claimer', 'claimed'.
     # - reason [string]: reason why the PixClaim was modified, resulting in the Log. Options: 'fraud', 'userRequested', 'accountClosure', 'defaultOperation', 'reconciliation'
-    # - claim [PixClaim]: PixClaim entity to which the log refers to.
+    # - 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, :created, :type, :errors, :agent, :reason, :claim
-      def initialize(id:, created:, type:, errors:, agent:, reason:, claim:)
+      attr_reader :id, :created, :type, :errors, :reason, :claim
+      def initialize(id:, created:, type:, errors:, reason:, claim:)
         super(id)
         @created = StarkInfra::Utils::Checks.check_datetime(created)
         @type = type
         @errors = errors
-        @agent = agent
         @reason = reason
         @claim = claim
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific PixClaim::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single PixClaim::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -44,26 +42,26 @@ module StarkInfra
       # - 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
+      # - PixClaim::Log object with updated attributes
       def self.get(id, user: nil)
         StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
-      # # Retrieve Logs
+      # # Retrieve PixClaim::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of PixClaim::Log objects previously created in the Stark Infra API
       #
       # ## Parameters (optional):
-      # - ids [list of strings, default nil]: Log ids to filter PixClaim 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]: filter PixClaim Logs by their types. Options: 'created', 'failed', 'delivering', 'delivered', 'confirming', 'confirmed', 'success', 'canceling', 'canceled'.
-      # - claim_ids [list of strings, default nil]: list of PixClaim ids to filter retrieved objects. ex: %w[5656565656565656 4545454545454545]
+      # - types [list of strings, default nil]: filter PixClaim Logs by their types. Options: 'created', 'failed', 'delivering', 'delivered', 'confirming', 'confirmed', 'success', 'canceling', 'canceled'.
+      # - claim_ids [list of strings, default nil]: list of PixClaim ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter PixClaim Logs. ex: ['5656565656565656']
       # - 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
+      # - generator of PixClaim::Log objects with updated attributes
       def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, claim_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
@@ -79,19 +77,19 @@ module StarkInfra
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged PixClaim::Logs
       #
-      # Receive a list of up to 100 Log objects previously created in the Stark Infra API and the cursor to the next page.
+      # Receive a list of up to 100 PixClaim::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 claims.
       #
       # ## Parameters (optional):
-      # - ids [list of strings, default nil]: Log ids to filter PixClaim Logs. ex: ['5656565656565656']
       # - 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]: filter PixClaim Logs by their types. Options: 'created', 'failed', 'delivering', 'delivered', 'confirming', 'confirmed', 'success', 'canceling', 'canceled'.
-      # - claim_ids [list of strings, default nil]: list of PixClaim ids to filter retrieved objects. ex: %w[5656565656565656 4545454545454545]
+      # - types [list of strings, default nil]: filter PixClaim Logs by their types. Options: 'created', 'failed', 'delivering', 'delivered', 'confirming', 'confirmed', 'success', 'canceling', 'canceled'.
+      # - claim_ids [list of strings, default nil]: list of PixClaim ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter PixClaim Logs. ex: ['5656565656565656']
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
@@ -123,7 +121,6 @@ module StarkInfra
               created: json['created'],
               type: json['type'],
               errors: json['errors'],
-              agent: json['agent'],
               reason: json['reason'],
               claim: StarkInfra::Utils::API.from_api_json(claim_maker, json['claim'])
             )