starkinfra 0.0.3 → 0.2.0

data/lib/pixrequest/pixrequest.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
 require_relative('../utils/parse')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # PixRequest object
@@ -28,16 +28,18 @@ module StarkInfra
   # - receiver_account_type [string]: receiver bank account type. ex: 'checking', 'savings', 'salary' or 'payment'
   # - end_to_end_id [string]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
   #
+  # ## Parameters (conditionally-required):
+  # - cashier_type [string]: Cashier's type. Required if the cash_amount is different from 0. Options: 'merchant', 'participant' and 'other'
+  # - cashier_bank_code [string]: Cashier's bank code. Required if the cash_amount is different from 0. ex: '20018183'
+  #
   # ## Parameters (optional):
+  # - cash_amount [integer, default nil]: Amount to be withdrawal from the cashier in cents. ex: 1000 (= R$ 10.00)
   # - receiver_key_id [string, default nil]: Receiver's dict key. Example: tax id (CPF/CNPJ).
   # - description [string, default nil]: optional description to override default description to be shown in the bank statement. ex: 'Payment for service #1234'
   # - reconciliation_id [string, default nil]: Reconciliation ID linked to this payment. ex: 'b77f5236-7ab9-4487-9f95-66ee6eaf1781'
   # - initiator_tax_id [string, default nil]: Payment initiator's tax id (CPF/CNPJ). ex: '01234567890' or '20.018.183/0001-80'
-  # - cash_amount [integer, default nil]: Amount to be withdrawal from the cashier in cents. ex: 1000 (= R$ 10.00)
-  # - cashier_bank_code [string, default nil]: Cashier's bank code. ex: '00000000'
-  # - cashier_type [string, default nil]: Cashier's type. ex: [merchant, other, participant]
   # - tags [list of strings, default nil]: list of strings for reference when searching for PixRequests. ex: ['employees', 'monthly']
-  # - method [string, default nil]: execution  method of creation of the PIX. ex: 'manual', 'payerQrcode', 'dynamicQrcode'.
+  # - method [string, default nil]: execution method of creation of the Pix. ex: 'manual', 'payerQrcode', 'dynamicQrcode'.
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the PixRequest is created. ex: '5656565656565656'
@@ -50,15 +52,15 @@ module StarkInfra
   class PixRequest < StarkInfra::Utils::Resource
     attr_reader :amount, :external_id, :sender_name, :sender_tax_id, :sender_branch_code, :sender_account_number,
                 :sender_account_type, :receiver_name, :receiver_tax_id, :receiver_bank_code, :receiver_account_number,
-                :receiver_branch_code, :receiver_account_type, :end_to_end_id, :receiver_key_id, :sender_bank_code,
-                :status, :reconciliation_id, :description, :flow, :initiator_tax_id, :cash_amount, :cashier_bank_code,
-                :cashier_type, :tags, :created, :updated, :fee, :id
+                :receiver_branch_code, :receiver_account_type, :end_to_end_id, :cashier_type,
+                :cashier_bank_code, :cash_amount, :receiver_key_id, :description, :reconciliation_id, :initiator_tax_id,
+                :tags, :method, :id, :fee, :status, :flow, :sender_bank_code, :created, :updated
     def initialize(
       amount:, external_id:, sender_name:, sender_tax_id:, sender_branch_code:, sender_account_number:, 
       sender_account_type:, receiver_name:, receiver_tax_id:, receiver_bank_code:, receiver_account_number:, 
-      receiver_branch_code:, receiver_account_type:, end_to_end_id:, receiver_key_id: nil, description: nil, 
-      reconciliation_id: nil, initiator_tax_id: nil, cash_amount: nil, cashier_bank_code: nil, cashier_type: nil, 
-      tags: nil, id: nil, fee: nil, status:nil, flow: nil, method: nil, sender_bank_code: nil, created: nil, updated: nil
+      receiver_branch_code:, receiver_account_type:, end_to_end_id:, cashier_type: nil, cashier_bank_code: nil,
+      cash_amount: nil, receiver_key_id: nil, description: nil, reconciliation_id: nil, initiator_tax_id: nil,
+      tags: nil, method: nil, id: nil, fee: nil, status:nil, flow: nil, sender_bank_code: nil, created: nil, updated: nil
     )
       super(id)
       @amount = amount
@@ -75,13 +77,13 @@ module StarkInfra
       @receiver_branch_code = receiver_branch_code
       @receiver_account_type = receiver_account_type
       @end_to_end_id = end_to_end_id
+      @cashier_type = cashier_type
+      @cashier_bank_code = cashier_bank_code
+      @cash_amount = cash_amount
       @receiver_key_id = receiver_key_id
       @description = description
       @reconciliation_id = reconciliation_id
       @initiator_tax_id = initiator_tax_id
-      @cash_amount = cash_amount
-      @cashier_bank_code = cashier_bank_code
-      @cashier_type = cashier_type
       @tags = tags
       @method = method
       @fee = fee
@@ -169,10 +171,10 @@ 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)
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
-    # - 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']
     # - end_to_end_ids [list of strings, default nil]: central bank's unique transaction IDs. ex: ['E79457883202101262140HHX553UPqeq', 'E79457883202101262140HHX553UPxzx']
     # - external_ids [list of strings, default nil]: url safe strings that must be unique among all your PixRequests. Duplicated external IDs will cause failures. By default, this parameter will block any PixRequests that repeats amount and receiver information on the same date. ex: ['my-internal-id-123456', 'my-internal-id-654321']
+    # - 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:
@@ -212,7 +214,35 @@ module StarkInfra
     # ## Return:
     # - Parsed PixRequest object
     def self.parse(content:, signature:, user: nil)
-      StarkInfra::Utils::Parse.parse_and_verify(content: content, signature: signature, user: user, resource: resource)
+      request = StarkInfra::Utils::Parse.parse_and_verify(content: content, signature: signature, user: user, resource: resource)
+
+      !request.fee.nil? ? request.fee : 0
+      !request.tags.nil? ? request.tags : []
+      !request.external_id.nil?  ? request.external_id : ''
+      !request.description.nil?  ? request.description : ''
+
+      request
+    end
+
+    # Helps you respond to a PixRequest authorization
+    #
+    ## Parameters (required):
+    # - status [string]: response to the authorization. ex: 'approved' or 'denied'
+    #
+    ## Parameters (conditionally required):
+    # - reason [string, default nil]: denial reason. Options: 'invalidAccountNumber', 'blockedAccount', 'accountClosed', 'invalidAccountType', 'invalidTransactionType', 'taxIdMismatch', 'invalidTaxId', 'orderRejected', 'reversalTimeExpired', 'settlementFailed'
+    #
+    ## Return:
+    # - Dumped JSON string that must be returned to us
+    def self.response(status:, reason: nil)
+      response = {
+        authorization: {
+          status: status,
+          reason: reason
+        }
+      }.to_json
+
+      response
     end
 
     def self.resource
@@ -235,18 +265,18 @@ module StarkInfra
             receiver_branch_code: json['receiver_branch_code'],
             receiver_account_type: json['receiver_account_type'],
             end_to_end_id: json['end_to_end_id'],
+            cashier_type: json['cashier_type'],
+            cashier_bank_code: json['cashier_bank_code'],
+            cash_amount: json['cash_amount'],
             receiver_key_id: json['receiver_key_id'],
             description: json['description'],
             reconciliation_id: json['reconciliation_id'],
             initiator_tax_id: json['initiator_tax_id'],
-            cash_amount: json['cash_amount'],
-            cashier_bank_code: json['cashier_bank_code'],
-            cashier_type: json['cashier_type'],
             tags: json['tags'],
+            method: json['method'],
             fee: json['fee'],
             status: json['status'],
             flow: json['flow'],
-            method: json['method'],
             sender_bank_code: json['sender_bank_code'],
             created: json['created'],
             updated: json['updated']

data/lib/pixreversal/log.rb

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

data/lib/pixreversal/pixreversal.rb

@@ -1,42 +1,44 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
 require_relative('../utils/parse')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # PixReversal object
   #
-  # When you initialize a PixReversal, 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.
+  # PixReversals are instant payments used to revert PixRequests. You can
+  # only revert inbound PixRequests.
+  #
+  # When you initialize a PixReversal, 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.
   #
   # ## Parameters (required):
   # - amount [integer]: amount in cents to be reversed from PixRequest. ex: 1234 (= R$ 12.34)
-  # - external_id [string]: url safe string that must be unique among all your PixReversals. Duplicated external ids will cause failures. By default, this parameter will block any PixReversal that repeats amount and receiver information on the same date. ex: 'my-internal-id-123456'
+  # - external_id [string]: string that must be unique among all your PixReversals. Duplicated external IDs will cause failures. By default, this parameter will block any PixReversal that repeats amount and receiver information on the same date. ex: 'my-internal-id-123456'
   # - end_to_end_id [string]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
   # - reason [string]: reason why the PixRequest is being reversed. Options are 'bankError', 'fraud', 'pixWithdrawError', 'refund3ByEndCustomer'
   #
   # ## Parameters (optional):
-  # - tags [string, default nil]: [list of strings]: list of strings for reference when searching for PixReversals. ex: ['employees', 'monthly']
+  # - tags [list of strings, default nil]: list of strings for reference when searching for PixReversals. ex: ['employees', 'monthly']
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the PixReversal is created. ex: '5656565656565656'.
   # - return_id [string]: central bank's unique reversal transaction ID. ex: 'D20018183202202030109X3OoBHG74wo'.
-  # - bank_code [string]: code of the bank institution in Brazil. ex: '20018183' or '341'
   # - fee [string]: fee charged by this PixReversal. ex: 200 (= R$ 2.00)
   # - status [string]: current PixReversal status. ex: 'registered' or 'paid'
   # - flow [string]: direction of money flow. ex: 'in' or 'out'
   # - created [DateTime]: creation datetime for the PixReversal. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime]: latest update datetime for the PixReversal. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  class PixReversal < StarkInfra::Utils::Resource;
-    attr_reader :amount, :external_id, :end_to_end_id, :reason, :tags, :id, :return_id, :bank_code, :fee, :status, :flow, :created, :updated
+  class PixReversal < StarkInfra::Utils::Resource
+    attr_reader :amount, :external_id, :end_to_end_id, :reason, :tags, :id, :return_id,
+                :fee, :status, :flow, :created, :updated
     def initialize(
-      amount:, external_id:, end_to_end_id:, reason:, tags: nil, id: nil, return_id: nil, bank_code: nil, fee: nil, 
+      amount:, external_id:, end_to_end_id:, reason:, tags: nil, id: nil, return_id: nil, fee: nil,
       status: nil, flow: nil, created: nil, updated: nil
     )
-      created = StarkInfra::Utils::Checks.check_datetime(created)
-      updated = StarkInfra::Utils::Checks.check_datetime(updated)
       super(id)
       @amount = amount
       @external_id = external_id
@@ -44,12 +46,11 @@ module StarkInfra
       @reason = reason
       @tags = tags
       @return_id = return_id
-      @bank_code = bank_code
       @fee = fee
       @status = status
       @flow = flow
-      @created = created
-      @updated = updated
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
     end
 
     # # Create PixReversals
@@ -93,10 +94,10 @@ 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)
     # - 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']
     # - return_ids [list of strings, default nil]: central bank's unique reversal transaction ID. ex: ['D20018183202202030109X3OoBHG74wo', 'D20018183202202030109X3OoBHG72rd'].
     # - external_ids [list of strings, default nil]: url safe string that must be unique among all your PixReversals. Duplicated external IDs will cause failures. By default, this parameter will block any PixReversal that repeats amount and receiver information on the same date. ex: ['my-internal-id-123456', 'my-internal-id-654321']
+    # - 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:
@@ -129,10 +130,10 @@ 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)
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
-    # - 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']
     # - return_ids [list of strings, default nil]: central bank's unique reversal transaction ID. ex: ['D20018183202202030109X3OoBHG74wo', 'D20018183202202030109X3OoBHG72rd'].
     # - external_ids [list of strings, default nil]: url safe string that must be unique among all your PixReversals. Duplicated external IDs will cause failures. By default, this parameter will block any PixReversal that repeats amount and receiver information on the same date. ex: ['my-internal-id-123456', 'my-internal-id-654321']
+    # - 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:
@@ -170,12 +171,40 @@ module StarkInfra
     # ## Return:
     # - Parsed PixReversal object
     def self.parse(content:, signature:, user: nil)
-      StarkInfra::Utils::Parse.parse_and_verify(
+      reversal = StarkInfra::Utils::Parse.parse_and_verify(
         content: content,
         signature: signature,
         user: user,
         resource: resource
       )
+
+      !reversal.fee.nil? ? reversal.fee : 0
+      !reversal.tags.nil? ? reversal.tags : []
+      !reversal.external_id.nil? ? reversal.external_id : ''
+      !reversal.description.nil? ? reversal.description : ''
+
+      reversal
+    end
+
+    # Helps you respond to a PixReversal authorization
+    #
+    ## Parameters (required):
+    # - status [string]: response to the authorization. ex: 'approved' or 'denied'
+    #
+    ## Parameters (conditionally required):
+    # - reason [string, default nil]: denial reason. Options: 'invalidAccountNumber', 'blockedAccount', 'accountClosed', 'invalidAccountType', 'invalidTransactionType', 'taxIdMismatch', 'invalidTaxId', 'orderRejected', 'reversalTimeExpired', 'settlementFailed'
+    #
+    ## Return:
+    # - Dumped JSON string that must be returned to us
+    def self.response(status:, reason: nil)
+      response = {
+        authorization: {
+          status: status,
+          reason: reason
+        }
+      }.to_json
+
+      response
     end
 
     def self.resource
@@ -183,14 +212,13 @@ module StarkInfra
         resource_name: 'PixReversal',
         resource_maker: proc { |json|
           PixReversal.new(
+            id: json['id'],
             amount: json['amount'],
             external_id: json['external_id'],
             end_to_end_id: json['end_to_end_id'],
             reason: json['reason'],
             tags: json['tags'],
-            id: json['id'],
             return_id: json['return_id'],
-            bank_code: json['bank_code'],
             fee: json['fee'],
             status: json['status'],
             flow: json['flow'],

data/lib/pixstatement/pixstatement.rb

@@ -1,19 +1,24 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # PixStatement object
   #
-  # The PixStatement object stores information about all the transactions that happened on
-  # a specific day at the workspace. It must be created by the user before it can be
-  # accessed by the user. This feature is only available for direct participants.
+  # The PixStatement object stores information about all the transactions that
+  # happened on a specific day at your settlment account according to the Central Bank.
+  # It must be created by the user before it can be accessed.
+  # This feature is only available for direct participants.
+  #
+  # When you initialize a PixStatement, 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):
-  # - after [Date or string]: transactions that happened at this date are stored in the PixStatement, must be the same as before. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - before [Date or string]: transactions that happened at this date are stored in the PixStatement, must be the same as after. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - after [Date or string]: transactions that happened at this date are stored in the PixStatement, must be the same as before. ex: Date.new(2020, 3, 10) or '2020-03-10'
+  # - before [Date or string]: transactions that happened at this date are stored in the PixStatement, must be the same as after. ex: Date.new(2020, 3, 10) or '2020-03-10'
   # - type [string]: type of entities to include in statement. Options: 'interchange', 'interchangeTotal', 'transaction'
   #
   # ## Attributes (return-only):
@@ -132,10 +137,10 @@ module StarkInfra
         resource_name: 'PixStatement',
         resource_maker: proc { |json|
           PixStatement.new(
+            id: json['id'],
             after: json['after'],
             before: json['before'],
             type: json['type'],
-            id: json['id'],
             status: json['status'],
             transaction_count: json['transaction_count'],
             created: json['created'],

data/lib/starkinfra.rb

@@ -3,43 +3,55 @@
 require_relative('key')
 require_relative('user/project')
 require_relative('user/organization')
-require_relative('issuingauthorization/issuingauthorization')
+require_relative('brcodepreview/brcodepreview')
+require_relative('cardmethod/cardmethod')
+require_relative('creditnote/invoice/invoice')
+require_relative('creditnote/invoice/description')
+require_relative('creditnote/invoice/discount')
+require_relative('creditnote/creditnote')
+require_relative('creditnote/log')
+require_relative('creditnote/transfer')
+require_relative('creditpreview/creditpreview')
+require_relative('creditpreview/creditnotepreview')
+require_relative('creditsigner/creditsigner')
+require_relative('dynamicbrcode/dynamicbrcode')
 require_relative('issuingbalance/issuingbalance')
-require_relative('issuingbin/issuingbin')
 require_relative('issuingcard/issuingcard')
 require_relative('issuingcard/log')
 require_relative('issuingholder/issuingholder')
 require_relative('issuingholder/log')
 require_relative('issuinginvoice/issuinginvoice')
 require_relative('issuinginvoice/log')
+require_relative('issuingproduct/issuingproduct')
 require_relative('issuingpurchase/issuingpurchase')
 require_relative('issuingpurchase/log')
+require_relative('issuingrule/issuingrule')
 require_relative('issuingtransaction/issuingtransaction')
 require_relative('issuingwithdrawal/issuingwithdrawal')
-require_relative('issuingrule/issuingrule')
-require_relative('pixrequest/pixrequest')
-require_relative('pixrequest/log')
-require_relative('pixreversal/pixreversal')
-require_relative('pixreversal/log')
+require_relative('merchantcategory/merchantcategory')
+require_relative('merchantcountry/merchantcountry')
 require_relative('pixbalance/pixbalance')
-require_relative('pixstatement/pixstatement')
-require_relative('pixinfraction/pixinfraction')
-require_relative('pixinfraction/log')
 require_relative('pixchargeback/pixchargeback')
 require_relative('pixchargeback/log')
-require_relative('pixkey/pixkey')
-require_relative('pixkey/log')
 require_relative('pixclaim/pixclaim')
 require_relative('pixclaim/log')
-require_relative('pixdomain/pixdomain')
 require_relative('pixdirector/pixdirector')
+require_relative('pixdomain/pixdomain')
+require_relative('pixinfraction/pixinfraction')
+require_relative('pixinfraction/log')
+require_relative('pixkey/pixkey')
+require_relative('pixkey/log')
+require_relative('pixrequest/pixrequest')
+require_relative('pixrequest/log')
+require_relative('pixreversal/pixreversal')
+require_relative('pixreversal/log')
+require_relative('pixstatement/pixstatement')
+require_relative('staticbrcode/staticbrcode')
 require_relative('webhook/webhook')
 require_relative('event/event')
 require_relative('event/attempt')
 require_relative('utils/endtoendid')
 require_relative('utils/returnid')
-require_relative('creditnote/creditnote')
-require_relative('creditnote/log')
 
 # SDK to facilitate Ruby integrations with Stark Infra
 module StarkInfra

data/lib/staticbrcode/staticbrcode.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+require_relative('../utils/parse')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
+
+module StarkInfra
+  # # StaticBrcode object
+  #
+  # A StaticBrcode stores account information in the form of a PixKey and can be used to create
+  # Pix transactions easily.
+  #
+  # When you initialize a StaticBrcode, 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]: receiver's name. ex: 'Tony Stark'
+  # - key_id [string]: receiver's Pixkey id. ex: '+5541999999999'
+  # - city [string, default São Paulo]: receiver's city name. ex: 'Rio de Janeiro'
+  #
+  # ## Parameters (optional):
+  # - amount [integer, default nil]: positive integer that represents the amount in cents of the resulting Pix transaction. If the amount is zero, the sender can choose any amount in the moment of payment. ex: 1234 (= R$ 12.34)
+  # - reconciliation_id [string, default nil]: id to be used for conciliation of the resulting Pix transaction. This id must have up to 25 alphanumeric digits ex: 'ah27s53agj6493hjds6836v49'
+  # - tags [list of strings, default nil]:  list of strings for tagging. ex: ['travel', 'food']
+  #
+  # ## Attributes (return-only):
+  # - id [string]: id returned on creation, this is the BR Code. ex: '00020126360014br.gov.bcb.pix0114+552840092118152040000530398654040.095802BR5915Jamie Lannister6009Sao Paulo620705038566304FC6C'
+  # - uuid [string]: unique uuid returned when a StaticBrcode is created. ex: '97756273400d42ce9086404fe10ea0d6'
+  # - url [string]: url link to the BR Code image. ex: 'https://brcode-h.development.starkinfra.com/static-qrcode/97756273400d42ce9086404fe10ea0d6.png'
+  # - created [DateTime]: creation datetime for the StaticBrcode. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the StaticBrcode. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class StaticBrcode < StarkInfra::Utils::Resource
+    attr_reader :name, :key_id, :city, :amount, :reconciliation_id, :id, :tags, :uuid, :url, :created, :updated
+    def initialize(
+      name:, key_id:, city:, amount:, reconciliation_id:, id: nil, tags:nil, uuid: nil, url: nil, created: nil, updated: nil
+    )
+      super(id)
+      @name = name
+      @key_id = key_id
+      @city = city
+      @amount = amount
+      @reconciliation_id = reconciliation_id
+      @tags = tags
+      @uuid = uuid
+      @url = url
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create StaticBrcodes
+    #
+    # Send a list of StaticBrcode objects for creation at the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - brcodes [list of StaticBrcode objects]: list of StaticBrcode 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
+    #
+    # ## Return:
+    # - list of StaticBrcode objects with updated attributes
+    def self.create(brcodes, user: nil)
+      StarkInfra::Utils::Rest.post(entities: brcodes, user: user, **resource)
+    end
+
+    # # Retrieve a specific StaticBrcode
+    #
+    # Receive a single StaticBrcode object previously created in the Stark Infra API by its uuid
+    #
+    # ## Parameters (required):
+    # - uuid [string]: object's unique uuid. ex: '97756273400d42ce9086404fe10ea0d6'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - StaticBrcode object with updated attributes
+    def self.get(uuid, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: uuid, user: user, **resource)
+    end
+
+    # # Retrieve StaticBrcodes
+    #
+    # Receive a generator of StaticBrcode objects previously created in the Stark Infra API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - uuids [list of strings, default nil]: list of uuids to filter retrieved objects. ex: ['901e71f2447c43c886f58366a5432c4b', '4e2eab725ddd495f9c98ffd97440702d']
+    # - 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 StaticBrcode objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, uuids: nil, tags: nil, user: nil)
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        uuids: uuids,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve StaticBrcodes
+    #
+    # Receive a list of StaticBrcode objects previously created in the Stark Infra API and the cursor to the next page.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call
+    # - limit [integer, default 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)
+    # - uuids [list of strings, default nil]: list of uuids to filter retrieved objects. ex: ['901e71f2447c43c886f58366a5432c4b', '4e2eab725ddd495f9c98ffd97440702d']
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of StaticBrcode objects with updated attributes
+    # - cursor to retrieve the next page of StaticBrcode objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, tags: nil, uuids: nil, user: nil)
+      after = StarkInfra::Utils::Checks.check_date(after)
+      before = StarkInfra::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        after: after,
+        before: before,
+        uuids: uuids,
+        tags: tags,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'StaticBrcode',
+        resource_maker: proc { |json|
+          StaticBrcode.new(
+            id: json['id'],
+            name: json['name'],
+            key_id: json['key_id'],
+            city: json['city'],
+            amount: json['amount'],
+            reconciliation_id: json['reconciliation_id'],
+            tags: json['tags'],
+            uuid: json['uuid'],
+            url: json['url'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/user/project.rb

@@ -19,7 +19,7 @@ module StarkInfra
   # - environment [string]: environment where the project is being used. ex: 'sandbox' or 'production'
   #
   # ## Attributes (return-only):
-  # - name [string, default '']: project name. ex: 'MyProject'
+  # - name [string, default nil]: project name. ex: 'MyProject'
   # - allowed_ips [list of strings]: list containing the strings of the ips allowed to make requests on behalf of this project. ex: ['190.190.0.50']
   # - pem [string]: private key in pem format. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
   class Project < StarkInfra::User

data/lib/utils/api.rb

@@ -34,6 +34,7 @@ module StarkInfra
       end
 
       def self.parse_value(value)
+        return api_json(value) if value.is_a?(SubResource)
         return value.strftime('%Y-%m-%d') if value.is_a?(Date)
         return value.strftime('%Y-%m-%dT%H:%M:%S+00:00') if value.is_a?(DateTime) || value.is_a?(Time)
         return cast_json_to_api_format(value) if value.is_a?(Hash)

data/lib/utils/parse.rb

@@ -11,10 +11,14 @@ module StarkInfra
   module Utils
     module Parse
       def self.parse_and_verify(content:, signature:, user: nil, resource:, key: nil)
+        content = verify(content:content, signature: signature, user: user)
         json = JSON.parse(content)
         json = JSON.parse(content)[key] unless key.nil?
-        event = StarkInfra::Utils::API.from_api_json(resource[:resource_maker], json)
 
+        StarkInfra::Utils::API.from_api_json(resource[:resource_maker], json)
+      end
+
+      def self.verify(content:, signature:, user: nil)
         begin
           signature = EllipticCurve::Signature.fromBase64(signature)
         rescue
@@ -22,11 +26,11 @@ module StarkInfra
         end
 
         if verify_signature(content: content, signature: signature, user: user)
-          return event
+          return content
         end
 
         if verify_signature(content: content, signature: signature, user: user, refresh: true)
-          return event
+          return content
         end
 
         raise(StarkInfra::Error::InvalidSignatureError, 'The provided signature and content do not match the Stark Infra public key')

data/lib/utils/request.rb

@@ -61,7 +61,7 @@ module StarkInfra
         req['Access-Time'] = access_time
         req['Access-Signature'] = signature
         req['Content-Type'] = 'application/json'
-        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-Infra-0.0.3"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-Infra-0.2.0"
         req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }