starkinfra 0.1.0 → 0.2.0

data/lib/pixclaim/pixclaim.rb

@@ -1,43 +1,48 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # PixClaim object
   #
-  # PixClaims intend to transfer a PixClaim from one account to another.
+  # A Pix Claim is a request to transfer a Pix Key from an account hosted at another
+  # Pix participant to an account under your bank code. Pix Claims must always be requested by the claimer.
+  #
   # When you initialize a PixClaim, 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):
-  # - account_created [Date, DateTime or string]: opening Date or DateTime for the account claiming the PixClaim. ex: '2022-01-01'.
-  # - account_number [string]: number of the account claiming the PixClaim. ex: '76543'.
-  # - account_type [string]: type of the account claiming the PixClaim. Options: 'checking', 'savings', 'salary' or 'payment'.
-  # - branch_code [string]: branch code of the account claiming the PixClaim. ex: 1234'.
-  # - name [string]: holder's name of the account claiming the PixClaim. ex: 'Jamie Lannister'.
-  # - tax_id [string]: holder's taxId of the account claiming the PixClaim (CPF/CNPJ). ex: '012.345.678-90'.
+  # - account_created [Date, DateTime or string]: opening Date or DateTime for the account claiming the PixKey. ex: '2022-01-01', Date.new(2020, 3, 10) or DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - account_number [string]: number of the account claiming the PixKey. ex: '76543'.
+  # - account_type [string]: type of the account claiming the PixKey. Options: 'checking', 'savings', 'salary' or 'payment'.
+  # - branch_code [string]: branch code of the account claiming the PixKey. ex: 1234'.
+  # - name [string]: holder's name of the account claiming the PixKey. ex: 'Jamie Lannister'.
+  # - tax_id [string]: holder's taxId of the account claiming the PixKey (CPF/CNPJ). ex: '012.345.678-90'.
   # - key_id [string]: id of the registered Pix Key to be claimed. Allowed keyTypes are CPF, CNPJ, phone number or email. ex: '+5511989898989'.
   #
+  # ## Parameters (optional):
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['travel', 'food']
+  #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the PixClaim is created. ex: '5656565656565656'
   # - status [string]: current PixClaim status. Options: 'created', 'failed', 'delivered', 'confirmed', 'success', 'canceled'
   # - type [string]: type of Pix Claim. Options: 'ownership', 'portability'.
   # - key_type [string]: keyType of the claimed Pix Key. Options: 'CPF', 'CNPJ', 'phone' or 'email'
-  # - agent [string]: Options: 'claimer' if you requested the PixClaim or 'claimed' if you received a PixClaim request.
-  # - bank_code [string]: bank_code of the account linked to the PixClaim being claimed. ex: '20018183'.
+  # - flow [string]: direction of the Pix Claim. Options: 'in' if you received the PixClaim or 'out' if you created the PixClaim.
+  # - claimer_bank_code [string]: bank_code of the Pix participant that created the PixClaim. ex: '20018183'.
   # - claimed_bank_code [string]: bank_code of the account donating the PixClaim. ex: '20018183'.
   # - created [DateTime]: creation datetime for the PixClaim. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime]: update datetime for the PixClaim. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class PixClaim < StarkInfra::Utils::Resource
     attr_reader :account_created, :account_number, :account_type, :branch_code, :name, :tax_id, :key_id,
-                :id, :status, :type, :key_type, :agent, :bank_code, :claimed_bank_code, :created, :updated
+                :tags, :id, :status, :type, :key_type, :flow, :claimer_bank_code, :claimed_bank_code, :created, :updated
     def initialize(
       account_created:, account_number:, account_type:, branch_code:, name:,
-      tax_id:, key_id:, id: nil, status: nil, type: nil, key_type: nil, agent: nil,
-      bank_code: nil, claimed_bank_code: nil, created: nil, updated: nil
+      tax_id:, key_id:, tags: nil, id: nil, status: nil, type: nil, key_type: nil, flow: nil,
+      claimer_bank_code: nil, claimed_bank_code: nil, created: nil, updated: nil
     )
       super(id)
       @account_created = account_created
@@ -47,22 +52,24 @@ module StarkInfra
       @name = name
       @tax_id = tax_id
       @key_id = key_id
+      @tags = tags
       @status = status
       @type = type
       @key_type = key_type
-      @agent = agent
-      @bank_code = bank_code
+      @flow = flow
+      @claimer_bank_code = claimer_bank_code
       @claimed_bank_code = claimed_bank_code
       @created = StarkInfra::Utils::Checks.check_datetime(created)
       @updated = StarkInfra::Utils::Checks.check_datetime(updated)
     end
 
-    # # Create a PixClaim
+    # # Create a PixClaim object
     #
-    # Send a PixClaim object for creation in the Stark Infra API
+    # 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.
     #
     # ## Parameters (required):
-    # - claim [PixClaim object]: PixClaim object to be created in the API. ex: PixClaim.new()
+    # - claim [PixClaim object]: PixClaim 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
@@ -73,9 +80,9 @@ module StarkInfra
       StarkInfra::Utils::Rest.post_single(entity: claim, user: user, **resource)
     end
 
-    # # Retrieve a specific PixClaim
+    # # Retrieve a PixClaim object
     #
-    # Receive a single PixClaim object previously created in the Stark Infra API by passing its id
+    # Retrieve a PixClaim object linked to your Workspace in the Stark Infra API by its id.
     #
     # ## Parameters (required):
     # - id [string]: object unique id. ex: '5656565656565656'
@@ -84,7 +91,7 @@ module StarkInfra
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - PixClaim object with updated attributes
+    # - PixClaim object that corresponds to the given id.
     def self.get(id, user: nil)
       StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
     end
@@ -98,19 +105,19 @@ module StarkInfra
     # - after [Date or string, default nil]: date filter for objects created or updated only after specified date. ex: Date.new(2020, 3, 10)
     # - 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. Options: 'created', 'failed', 'delivered', 'confirmed', 'success', 'canceled'
-    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
     # - type [string, default nil]: filter for the type of retrieved PixClaims. Options: 'ownership' or 'portability'
-    # - agent [string, default nil]: filter for the agent of retrieved PixClaims. Options: 'claimer' or 'claimed'.
     # - key_type [string, default nil]: filter for the PixKey type of retrieved PixClaims. Options: 'cpf', 'cnpj', 'phone', 'email' and 'evp',
     # - key_id [string, default nil]: filter PixClaims linked to a specific PixKey id. Example: '+5511989898989'.
+    # - flow [string, default nil]: direction of the Pix Claim. Options: 'in' if you received the PixClaim or 'out' if you created the PixClaim.
+    # - 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 PixClaim objects with updated attributes
     def self.query(
       limit: nil, after: nil, before: nil, status: nil, ids: nil,
-      type: nil, agent: nil, key_type: nil, key_id: nil, user: nil
+      type: nil, flow: nil, tags: nil, key_type: nil, key_id: nil, user: nil
     )
       after = StarkInfra::Utils::Checks.check_date(after)
       before = StarkInfra::Utils::Checks.check_date(before)
@@ -121,7 +128,8 @@ module StarkInfra
         status: status,
         ids: ids,
         type: type,
-        agent: agent,
+        flow: flow,
+        tags: tags,
         key_type: key_type,
         key_id: key_id,
         user: user,
@@ -140,12 +148,12 @@ module StarkInfra
     # - after [Date or string, default nil]: date filter for objects created or updated only after specified date. ex: Date.new(2020, 3, 10)
     # - 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. Options: 'created', 'failed', 'delivered', 'confirmed', 'success', 'canceled'
-    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
     # - type [string, default nil]: filter for the type of retrieved PixClaims. Options: 'ownership' or 'portability'
-    # - agent [string, default nil]: filter for the agent of retrieved PixClaims. Options: 'claimer' or 'claimed'.
     # - key_type [string, default nil]: filter for the PixKey type of retrieved PixClaims. Options: 'cpf', 'cnpj', 'phone', 'email' and 'evp',
     # - key_id [string, default nil]: filter PixClaims linked to a specific PixKey id. Example: '+5511989898989'.
+    # - flow [string, default nil]: direction of the Pix Claim. Options: 'in' if you received the PixClaim or 'out' if you created the PixClaim.
+    # - 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:
@@ -153,7 +161,7 @@ module StarkInfra
     # - cursor to retrieve the next page of PixClaim objects
     def self.page(
       cursor: nil, limit: nil, after: nil, before: nil, status: nil, ids: nil,
-      type: nil, agent: nil, key_type: nil, key_id: nil, user: nil
+      type: nil, flow: nil, tags: nil, key_type: nil, key_id: nil, user: nil
     )
       after = StarkInfra::Utils::Checks.check_date(after)
       before = StarkInfra::Utils::Checks.check_date(before)
@@ -165,7 +173,8 @@ module StarkInfra
         status: status,
         ids: ids,
         type: type,
-        agent: agent,
+        flow: flow,
+        tags: tags,
         key_type: key_type,
         key_id: key_id,
         user: user,
@@ -202,6 +211,7 @@ module StarkInfra
         resource_name: 'PixClaim',
         resource_maker: proc { |json|
           PixClaim.new(
+            id: json['id'],
             account_created: json['account_created'],
             account_number: json['account_number'],
             account_type: json['account_type'],
@@ -209,12 +219,12 @@ module StarkInfra
             name: json['name'],
             tax_id: json['tax_id'],
             key_id: json['key_id'],
-            id: json['id'],
+            tags: json['tags'],
             status: json['status'],
             type: json['type'],
             key_type: json['key_type'],
-            agent: json['agent'],
-            bank_code: json['bank_code'],
+            flow: json['flow'],
+            claimer_bank_code: json['claimer_bank_code'],
             claimed_bank_code: json['claimed_bank_code'],
             created: json['created'],
             updated: json['updated']

data/lib/pixdirector/pixdirector.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # PixDirector object
   #
   # Mandatory data that must be registered within the Central Bank for
-  # emergency contact purposes. When you initialize a PixDirector,
-  # 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.
+  # emergency contact purposes.
+  #
+  # When you initialize a PixDirector, 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):
   # - name [string]: name of the PixDirector. ex: 'Edward Stark'.
@@ -22,12 +23,10 @@ module StarkInfra
   # - team_phones [list of strings]: list of phones of the team. ex: ['+5511988889999', '+5511988889998']
   #
   # ## Attributes (return-only):
-  # - id [string]: unique id returned when the PixDirector is created. ex: '5656565656565656'
   # - status [string]: current PixDirector status. ex: 'success'
-  class PixDirector < StarkInfra::Utils::Resource
-    attr_reader :name, :tax_id, :phone, :email, :password, :team_email, :team_phones, :id, :status
-    def initialize(name:, tax_id:, phone:, email:, password:, team_email:, team_phones:, id: nil, status: nil)
-      super(id)
+  class PixDirector < StarkInfra::Utils::SubResource
+    attr_reader :name, :tax_id, :phone, :email, :password, :team_email, :team_phones, :status
+    def initialize(name:, tax_id:, phone:, email:, password:, team_email:, team_phones:, status: nil)
       @name = name
       @tax_id = tax_id
       @phone = phone
@@ -59,7 +58,6 @@ module StarkInfra
         resource_name: 'PixDirector',
         resource_maker: proc { |json|
           PixDirector.new(
-            id: json['id'],
             name: json['name'],
             tax_id: json['tax_id'],
             phone: json['phone'],

data/lib/pixdomain/certificate.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # PixDomain::Certificate object

data/lib/pixdomain/pixdomain.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
-require_relative('../utils/rest')
 require_relative('certificate')
+require_relative('../utils/rest')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # PixDomain object
   #
-  # The PixDomain object displays the domain name and the QR Code
-  # domain certificate of Pix participants.
+  # The PixDomain object displays the domain name and the QR Code domain
+  # certificate of Pix participants.
   # All certificates must be registered with the Central Bank.
   #
   # ## Attributes (return-only):

data/lib/pixinfraction/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require_relative('pixinfraction')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
-require_relative('pixinfraction')
+require_relative('../utils/resource')
 
 module StarkInfra
   class PixInfraction

data/lib/pixinfraction/pixinfraction.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
   # # PixInfraction object
@@ -19,34 +19,34 @@ 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']
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the PixInfraction is created. ex: '5656565656565656'
   # - credited_bank_code [string]: bank_code of the credited Pix participant in the reported transaction. ex: '20018183'
   # - debited_bank_code [string]: bank_code of the debited Pix participant in the reported transaction. ex: '20018183'
-  # - agent [string]: Options: 'reporter' if you created the PixInfraction, 'reported' if you received the PixInfraction.
+  # - flow [string]: direction of the PixInfraction flow. Options: 'out' if you created the PixInfraction, 'in' if you received the PixInfraction.
   # - analysis [string]: analysis that led to the result.
-  # - bacen_id [string]: central bank's unique UUID that identifies the infraction report.
   # - reported_by [string]: agent that reported the PixInfraction. Options: 'debited', 'credited'.
   # - result [string]: result after the analysis of the PixInfraction by the receiving party. Options: 'agreed', 'disagreed'
   # - status [string]: current PixInfraction status. Options: 'created', 'failed', 'delivered', 'closed', 'canceled'.
   # - created [DateTime]: creation datetime for the PixInfraction. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime]: latest update datetime for the PixInfraction. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class PixInfraction < StarkInfra::Utils::Resource
-    attr_reader :reference_id, :type, :description, :id, :credited_bank_code, :agent, :analysis, :bacen_id,
+    attr_reader :reference_id, :type, :description, :tags, :id, :credited_bank_code, :flow, :analysis,
                 :debited_bank_code, :reported_by, :result, :status, :created, :updated
     def initialize(
-      reference_id:, type:, description:, id: nil, credited_bank_code: nil, agent: nil, analysis: nil, bacen_id: nil,
-      debited_bank_code: nil, reported_by: nil, result: nil, status: nil, created: nil, updated: nil
+      reference_id:, type:, description: nil, id: nil, tags: nil, credited_bank_code: nil, debited_bank_code: nil,
+      flow: nil, analysis: nil, reported_by: nil, result: nil, status: nil, created: nil, updated: nil
     )
       super(id)
       @reference_id = reference_id
       @type = type
       @description = description
+      @tags = tags
       @credited_bank_code = credited_bank_code
-      @agent = agent
+      @flow = flow
       @analysis = analysis
-      @bacen_id = bacen_id
       @debited_bank_code = debited_bank_code
       @reported_by = reported_by
       @result = result
@@ -98,11 +98,13 @@ module StarkInfra
     # - 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']
     # - type [string]: filter for the type of retrieved PixInfractions. Options: 'fraud', 'reversal', 'reversalChargeback'
+    # - flow [string, default nil]: direction of the PixInfraction flow. Options: 'out' if you created the PixInfraction, 'in' if you received the PixInfraction.
+    # - tags [list of strings, default nil]: list of strings for tagging. 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 PixInfraction objects with updated attributes
-    def self.query(limit: nil, after: nil, before: nil, status: nil, ids: nil, type: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, status: nil, ids: nil, type: 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(
@@ -112,6 +114,8 @@ module StarkInfra
         status: status,
         ids: ids,
         type: type,
+        flow: flow,
+        tags: tags,
         user: user,
         **resource
       )
@@ -130,12 +134,14 @@ module StarkInfra
     # - 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']
     # - type [string, default nil]: filter for the type of retrieved PixInfractions. Options: 'fraud', 'reversal', 'reversalChargeback'
+    # - flow [string, default nil]: direction of the PixInfraction flow. Options: 'out' if you created the PixInfraction, 'in' if you received the PixInfraction.
+    # - tags [list of strings, default nil]: list of strings for tagging. 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 PixInfraction objects with updated attributes
     # - cursor to retrieve the next page of PixInfraction objects
-    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, ids: nil, type: nil, user: nil)
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, ids: nil, flow: nil, tags: nil, type: nil, user: nil)
       after = StarkInfra::Utils::Checks.check_date(after)
       before = StarkInfra::Utils::Checks.check_date(before)
       StarkInfra::Utils::Rest.get_page(
@@ -145,6 +151,8 @@ module StarkInfra
         before: before,
         status: status,
         ids: ids,
+        flow: flow,
+        tags: tags,
         type: type,
         user: user,
         **resource
@@ -194,11 +202,11 @@ module StarkInfra
             reference_id: json['reference_id'],
             type: json['type'],
             description: json['description'],
+            tags: json['tags'],
             credited_bank_code: json['credited_bank_code'],
-            agent: json['agent'],
-            analysis: json['analysis'],
-            bacen_id: json['bacen_id'],
             debited_bank_code: json['debited_bank_code'],
+            flow: json['flow'],
+            analysis: json['analysis'],
             reported_by: json['reported_by'],
             result: json['result'],
             status: json['status'],

data/lib/pixkey/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require_relative('pixkey')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
-require_relative('pixkey')
+require_relative('../utils/resource')
 
 module StarkInfra
   class PixKey
@@ -54,7 +54,7 @@ module StarkInfra
       # - 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: %w[5656565656565656 4545454545454545]
+      # - key_ids [list of strings, default nil]: list of PixKey ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
@@ -85,8 +85,8 @@ module StarkInfra
       # - 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 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: %w[5656565656565656 4545454545454545]
+      # - 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']
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:

data/lib/pixkey/pixkey.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+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.
+  #
   # When you initialize a Pix Key, 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):
-  # - account_created [DateTime, Date or string]: opening Date or DateTime for the linked account. ex: '2022-01-01T12:00:00:00'.
+  # - account_created [DateTime or string]: opening Date or DateTime for the linked account. ex: '2020-03-10T10:30:00.000000+00:00' or DateTime.new(2020, 3, 10, 10, 30, 0, 0).
   # - account_number [string]: number of the linked account. ex: '76543'.
   # - account_type [string]: type of the linked account. Options: 'checking', 'savings', 'salary' or 'payment'.
   # - branch_code [string]: branch code of the linked account. ex: '1234'.
@@ -77,7 +78,7 @@ module StarkInfra
     # Receive a single PixKey object previously created in the Stark Infra API by passing its id
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: '5656565656565656'
+    # - id [string]: object unique id. ex: '+5511989898989'
     # - payer_id [string]: tax id (CPF/CNPJ) of the individual or business requesting the PixKey information. This id is used by the Central Bank to limit request rates. ex: '20.018.183/0001-80'.
     #
     # ## Parameters (optional):
@@ -106,7 +107,7 @@ 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'
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
-    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['+5511989898989', '+5511967676767']
     # - type [string, default nil]: filter for the type of retrieved PixKeys. Options: 'cpf', 'cnpj', 'phone', 'email' and 'evp'
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
@@ -140,7 +141,7 @@ 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'
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
-    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['+5511989898989', '+5511967676767']
     # - type [string, default nil]: filter for the type of retrieved PixKeys. Options: 'cpf', 'cnpj', 'phone', 'email' and 'evp'
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
@@ -169,11 +170,11 @@ module StarkInfra
     # Respond to a received PixKey.
     #
     # ## Parameters (required):
-    # - id [string]: PixKey unique id. ex: '5656565656565656'
+    # - id [string]: PixKey unique id. ex: '+5511989898989'
     # - reason [string]: reason why the PixKey is being patched. Options: 'branchTransfer', 'reconciliation' or 'userRequested'.
     #
     # ## Parameters (optional):
-    # - account_created [Date, DateTime or string, default nil]: opening Date or DateTime for the account to be linked. ex: '2022-01-01.
+    # - account_created [Date, DateTime or string, default nil]: opening Date or DateTime for the account to be linked. ex: '2022-01-01', Date.new(2020, 3, 10) or DateTime.new(2020, 3, 10, 10, 30, 0, 0)
     # - account_number [string, default nil]: number of the account to be linked. ex: '76543'.
     # - account_type [string, default nil]: type of the account to be linked. Options: 'checking', 'savings', 'salary' or 'payment'.
     # - branch_code [string, default nil]: branch code of the account to be linked. ex: 1234'.
@@ -201,7 +202,7 @@ module StarkInfra
     # Cancel a PixKey entity previously created in the Stark Infra API
     #
     # ## Parameters (required):
-    # - id [string]: PixKey unique id. ex: '5656565656565656'
+    # - id [string]: PixKey unique id. ex: '+5511989898989'
     #
     # ## Parameters (optional):
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
@@ -217,13 +218,13 @@ module StarkInfra
         resource_name: 'PixKey',
         resource_maker: proc { |json|
           PixKey.new(
+            id: json['id'],
             account_created: json['account_created'],
             account_number: json['account_number'],
             account_type: json['account_type'],
             branch_code: json['branch_code'],
             name: json['name'],
             tax_id: json['tax_id'],
-            id: json['id'],
             tags: json['tags'],
             owned: json['owned'],
             owner_type: json['owner_type'],

data/lib/pixrequest/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require_relative('pixrequest')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
-require_relative('pixrequest')
+require_relative('../utils/resource')
 
 module StarkInfra
   class PixRequest