starkinfra 0.2.0 → 0.4.0

data/lib/pixchargeback/log.rb

@@ -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/pixclaim/log.rb

@@ -13,13 +13,13 @@ 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.
     # - 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, :reason, :claim
       def initialize(id:, created:, type:, errors:, reason:, claim:)
@@ -31,9 +31,9 @@ module StarkInfra
         @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'
@@ -42,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, 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)
@@ -77,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, 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:

data/lib/pixclaim/pixclaim.rb

@@ -65,8 +65,8 @@ module StarkInfra
 
     # # Create a PixClaim object
     #
-    # Create a PixClaim to request the transfer of a Pix Key from an account
-    # hosted at another Pix participants to an account under you bank code.
+    # Create a PixClaim to request the transfer of a PixKey to an account
+    # hosted at other Pix participants in the Stark Infra API.
     #
     # ## Parameters (required):
     # - claim [PixClaim object]: PixClaim object to be created in the API.
@@ -184,7 +184,7 @@ module StarkInfra
 
     # # Update a PixClaim entity
     #
-    # Respond to a received PixClaim.
+    # Update a PixClaim parameters by passing id.
     #
     # ## Parameters (required):
     # - id [string]: PixClaim unique id. ex: '5656565656565656'
@@ -195,7 +195,7 @@ module StarkInfra
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - updated PixClaim object
+    # - updated PixClaim object with updated attributes
     def self.update(id, status:, reason: nil, user: nil)
       StarkInfra::Utils::Rest.patch_id(
         id: id,

data/lib/pixdomain/pixdomain.rb

@@ -23,7 +23,7 @@ module StarkInfra
 
     # # Retrieve PixDomains
     #
-    # Receive a generator of PixDomain objects registered at the Central Bank.
+    # Receive a generator of PixDomain objects.
     #
     # ## Parameters (optional):
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

data/lib/pixinfraction/log.rb

@@ -13,25 +13,25 @@ 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)
+    # - infraction [PixInfraction]: PixInfraction entity to which the log refers to.
     # - type [string]: type of the PixInfraction event which triggered the log creation. Options: 'created', 'failed', 'delivering', 'delivered', 'closed', 'canceled'
     # - errors [list of strings]: list of errors linked to this PixInfraction event.
-    # - infraction [PixInfraction]: PixInfraction 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, :infraction
       def initialize(id:, created:, type:, errors:, infraction:)
         super(id)
-        @created = StarkInfra::Utils::Checks.check_datetime(created)
+        @infraction = infraction
         @type = type
         @errors = errors
-        @infraction = infraction
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific PixInfraction::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single PixInfraction::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
+      # - PixInfraction::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 PixInfraction::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of PixInfraction::Log objects previously created in the Stark Infra API
       #
       # ## Parameters (optional):
-      # - ids [list of strings, default nil]: Log ids to filter PixInfraction 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 their types. Options: 'created', 'failed', 'delivering', 'delivered', 'closed', 'canceled'
       # - infraction_ids [list of strings, default nil]: list of PixInfraction ids to filter retrieved objects. ex: %w[5656565656565656 4545454545454545]
+      # - ids [list of strings, default nil]: Log ids to filter PixInfraction 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 PixInfraction::Log objects with updated attributes
       def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, infraction_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 PixInfraction::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 PixInfraction::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 infractions.
       #
       # ## Parameters (optional):
       # - cursor [string, default nil]: cursor returned on the previous page function call
-      # - ids [list of strings, default nil]: Log ids to filter PixInfraction 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 their types. Options: 'created', 'failed', 'delivering', 'delivered', 'closed', 'canceled'
       # - infraction_ids [list of strings, default nil]: list of PixInfraction ids to filter retrieved objects. ex: %w[5656565656565656 4545454545454545]
+      # - ids [list of strings, default nil]: Log ids to filter PixInfraction 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 PixInfraction::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, infraction_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
@@ -116,10 +116,10 @@ module StarkInfra
           resource_maker: proc { |json|
             Log.new(
               id: json['id'],
-              created: json['created'],
+              infraction: StarkInfra::Utils::API.from_api_json(infraction_maker, json['infraction']),
               type: json['type'],
               errors: json['errors'],
-              infraction: StarkInfra::Utils::API.from_api_json(infraction_maker, json['infraction'])
+              created: json['created'],
             )
           }
         }

data/lib/pixinfraction/pixinfraction.rb

@@ -19,7 +19,7 @@ module StarkInfra
   #
   # ## Parameters (optional):
   # - description [string, default nil]: description for any details that can help with the infraction investigation.
-  # - tags [list of strings, default nil]:  list of strings for tagging. ex: ['travel', 'food']
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['travel', 'food']
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the PixInfraction is created. ex: '5656565656565656'
@@ -45,9 +45,9 @@ module StarkInfra
       @description = description
       @tags = tags
       @credited_bank_code = credited_bank_code
+      @debited_bank_code = debited_bank_code
       @flow = flow
       @analysis = analysis
-      @debited_bank_code = debited_bank_code
       @reported_by = reported_by
       @result = result
       @status = status
@@ -172,7 +172,7 @@ module StarkInfra
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - updated PixInfraction object
+    # - PixInfraction object with updated attributes
     def self.update(id, result:, analysis: nil, user: nil)
       StarkInfra::Utils::Rest.patch_id(id: id, result: result, analysis: analysis, user: user, **resource)
     end

data/lib/pixkey/log.rb

@@ -12,25 +12,25 @@ module StarkInfra
     # Every time a PixKey entity is modified, a corresponding PixKey::Log 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)
+    # - key [PixKey]: PixKey entity to which the log refers to.
     # - type [string]: type of the PixKey event which triggered the log creation. Options: 'created', 'registered', 'updated', 'failed', 'canceling', 'canceled'.
     # - errors [list of strings]: list of errors linked to this PixKey event.
-    # - key [PixKey]: PixKey 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, :key
       def initialize(id:, created:, type:, errors:, key:)
         super(id)
-        @created = StarkInfra::Utils::Checks.check_datetime(created)
+        @key = key
         @type = type
         @errors = errors
-        @key = key
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific PixKey::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single PixKey::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -39,26 +39,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
+      # - PixKey::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 PixKey::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of PixKey::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 PixKey Logs by their types. Options: 'created', 'registered', 'updated', 'failed', 'canceling', 'canceled'.
       # - key_ids [list of strings, default nil]: list of PixKey ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter PixKey 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 PixKey::Log objects with updated attributes
       def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, key_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
@@ -74,23 +74,23 @@ module StarkInfra
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged PixKey::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 PixKey::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 keys.
       #
       # ## Parameters (optional):
-      # - ids [list of strings, default nil]: Log ids to filter PixKey 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, default nil]: filter PixKey Logs by their types. Options: 'created', 'registered', 'updated', 'failed', 'canceling', 'canceled'.
       # - key_ids [list of strings, default nil]: list of PixKey ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter PixKey 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 PixKey::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, key_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
@@ -115,10 +115,10 @@ module StarkInfra
           resource_maker: proc { |json|
             Log.new(
               id: json['id'],
-              created: json['created'],
+              key: StarkInfra::Utils::API.from_api_json(key_maker, json['key']),
               type: json['type'],
               errors: json['errors'],
-              key: StarkInfra::Utils::API.from_api_json(key_maker, json['key'])
+              created: json['created']
             )
           }
         }

data/lib/pixkey/pixkey.rb

@@ -6,6 +6,7 @@ require_relative('../utils/resource')
 
 module StarkInfra
   # # PixKey object
+  #
   # PixKeys link bank account information to key ids.
   # Key ids are a convenient way to search and pass bank account information.
   #
@@ -59,7 +60,7 @@ module StarkInfra
 
     # # Create a PixKey
     #
-    # Send a PixKey objects for creation in the Stark Infra API
+    # Create a PixKey linked to a specific account in the Stark Infra API
     #
     # ## Parameters (required):
     # - key [PixKey object]: PixKey object to be created in the API
@@ -167,7 +168,7 @@ module StarkInfra
 
     # # Update a PixKey entity
     #
-    # Respond to a received PixKey.
+    # Update a PixKey parameters by passing id.
     #
     # ## Parameters (required):
     # - id [string]: PixKey unique id. ex: '+5511989898989'
@@ -182,7 +183,7 @@ module StarkInfra
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - updated PixKey object
+    # - PixKey object with updated attributes
     def self.update(id, reason:, account_created: nil, account_number: nil, account_type: nil, branch_code: nil, name: nil, user: nil)
       StarkInfra::Utils::Rest.patch_id(
         id: id,

data/lib/pixrequest/log.rb

@@ -12,12 +12,12 @@ module StarkInfra
     # Every time a PixRequest entity is modified, a corresponding PixRequest::Log 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 PixRequest event which triggered the log creation. ex: 'processing' or 'success'
-    # - errors [list of strings]: list of errors linked to this PixRequest event.
     # - request [PixRequest object]: PixRequest entity to which the log refers to.
+    # - type [string]: type of the PixRequest event which triggered the log creation. ex: "sent", "denied", "failed", "created", "success", "approved", "credited", "refunded", "processing"
+    # - errors [list of strings]: list of errors linked to this PixRequest event.
+    # - 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, :request
       def initialize(id:, created:, type:, errors:, request:)
@@ -28,9 +28,9 @@ module StarkInfra
         @request = request
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific PixRequest::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single PixRequest::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -39,27 +39,28 @@ 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
+      # - PixRequest::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 PixRequest::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of PixRequest::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. ex: 'success' or 'failed'
       # - request_ids [list of strings, default nil]: list of PixRequest ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - reconciliation_id [string, default nil]: PixRequest reconciliation id to filter retrieved objects. ex: "b77f5236-7ab9-4487-9f95-66ee6eaf1781"
+      # - ids [list of strings, default nil]: Log ids to filter PixKey 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
-      def self.query(limit: nil, after: nil, before: nil, types: nil, request_ids: nil, user: nil)
+      # - generator of PixRequest::Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, request_ids: nil, reconciliation_id: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
         StarkInfra::Utils::Rest.get_stream(
@@ -68,14 +69,15 @@ module StarkInfra
           before: before,
           types: types,
           request_ids: request_ids,
+          reconciliation_id: reconciliation_id,
           user: user,
           **resource
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged PixRequest::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 PixRequest::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 logs.
       #
       # ## Parameters (optional):
@@ -85,12 +87,13 @@ module StarkInfra
       # - 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. ex: 'success' or 'failed'
       # - request_ids [list of strings, default nil]: list of PixRequest ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - reconciliation_id [string]: PixRequest reconciliation id to filter retrieved objects. ex: "b77f5236-7ab9-4487-9f95-66ee6eaf1781"
       # - 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 PixRequest::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, request_ids: nil, user: nil)
+      def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, request_ids: nil, reconciliation_id: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
         StarkInfra::Utils::Rest.get_page(
@@ -100,6 +103,7 @@ module StarkInfra
           before: before,
           types: types,
           request_ids: request_ids,
+          reconciliation_id: reconciliation_id,
           user: user,
           **resource
         )
@@ -112,10 +116,10 @@ module StarkInfra
           resource_maker: proc { |json|
             Log.new(
               id: json['id'],
-              created: json['created'],
+              request: StarkInfra::Utils::API.from_api_json(request_maker, json['request']),
               type: json['type'],
               errors: json['errors'],
-              request: StarkInfra::Utils::API.from_api_json(request_maker, json['request'])
+              created: json['created']
             )
           }
         }

data/lib/pixrequest/pixrequest.rb

@@ -8,6 +8,9 @@ require_relative('../utils/resource')
 module StarkInfra
   # # PixRequest object
   #
+  # PixRequests are used to receive or send instant payments to accounts
+  # hosted in any Pix participant.
+  #
   # When you initialize a PixRequest, 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 list of created objects.

data/lib/pixreversal/log.rb

@@ -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 PixReversal event which triggered the log creation. ex: 'processing' or 'success'

data/lib/pixstatement/pixstatement.rb

@@ -43,7 +43,7 @@ module StarkInfra
     # # Create a PixStatement object
     #
     # Create a PixStatements linked to your workspace in the Stark Infra API
-    # 
+    #
     # ## Parameters (required):
     # - statement [PixStatement object]: PixStatement object to be created in the API.
     #