starkinfra 0.5.0 → 0.6.0

data/lib/pix_pull_subscription/pix_pull_subscription.rb

@@ -0,0 +1,281 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+
+module StarkInfra
+  # # PixPullSubscription object
+  #
+  # A PixPullSubscription is a recurring Pix debit authorization. It defines the frequency, amount,
+  # and required payer authorizations for a series of Pix debits to be pulled from the sender by
+  # the receiver. Each cycle of an active subscription is triggered by a PixPullRequest whose
+  # subscription_id references the subscription's id.
+  #
+  # When you initialize a PixPullSubscription, 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):
+  # - bacen_id [string]: Central Bank's unique recurrency id. Identifies the subscription in the Pix infrastructure.
+  # - external_id [string]: url safe string that must be unique among all your Pix Pull Subscriptions. Used for idempotency. ex: 'my-internal-id-123456'
+  # - installment_start [DateTime or string]: start datetime of settlements allowed for this subscription. ex: '2020-10-28T17:59:26.249976+00:00'
+  # - interval [string]: cycle definition. Options: 'week', 'month', 'quarter', 'semester', 'year'
+  # - receiver_name [string]: receiver's full name. ex: 'Edward Stark'
+  # - receiver_tax_id [string]: receiver's tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  # - sender_account_number [string]: sender's bank account number. Use '-' before the verifier digit. ex: '876543-2'
+  # - sender_bank_code [string]: sender's bank institution code in Brazil. ex: '20018183'
+  # - sender_branch_code [string]: sender's bank account branch code. Use '-' in case there is a verifier digit. ex: '1357-9'
+  # - sender_tax_id [string]: sender's tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  # - type [string]: subscription journey type. Options: 'push', 'qrcode', 'qrcodeAndPayment', 'paymentAndOrQrcode'
+  #
+  # ## Parameters (conditionally-required):
+  # - amount [integer, default nil]: amount in cents charged every cycle. Required if the subscription has a fixed amount. ex: 1234 (= R$ 12.34)
+  # - amount_min_limit [integer, default nil]: floor value for the maximum amount the sender can set when approving. Required if the subscription has a variable amount. ex: 1234 (= R$ 12.34)
+  #
+  # ## Parameters (optional):
+  # - description [string, default nil]: additional information delivered to the sender. ex: 'Payment for service #1234'
+  # - due [DateTime or string, default nil]: due date for the sender's answer (approval or denial). ex: '2020-10-28T17:59:26.249976+00:00'
+  # - installment_end [DateTime or string, default nil]: end datetime of settlements allowed for this subscription. ex: '2020-10-28T17:59:26.249976+00:00'
+  # - receiver_bank_code [string, default nil]: receiver's bank institution code. Defaults to the workspace's primary institution when omitted. ex: '20018183'
+  # - reference_code [string, default nil]: commercial-relation identifier. May be a contract number, order id, or client code. ex: 'contract-123'
+  # - pull_retry_limit [integer, default nil]: max number of retries the receiver may issue for a single failed pull cycle. ex: 3
+  # - sender_city_code [string, default nil]: IBGE code of the payer's city. ex: '3550308'
+  # - sender_final_name [string, default nil]: final sender name when the sender differs from the originating institution. ex: 'Edward Stark'
+  # - sender_final_tax_id [string, default nil]: final sender tax ID. Same format rules as sender_tax_id. ex: '01234567890' or '20.018.183/0001-80'
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['employees', 'monthly']
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the PixPullSubscription is created. ex: '5656565656565656'
+  # - status [string]: current PixPullSubscription status. Options: 'created', 'pending', 'failed', 'denied', 'approved', 'active', 'expired', 'canceled'
+  # - flow [string]: direction of money flow. Options: 'in', 'out'
+  # - created [DateTime]: creation datetime for the PixPullSubscription. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the PixPullSubscription. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class PixPullSubscription < StarkCore::Utils::Resource
+    attr_reader :bacen_id, :external_id, :installment_start, :interval, :receiver_name, :receiver_tax_id,
+                :sender_account_number, :sender_bank_code, :sender_branch_code, :sender_tax_id, :type,
+                :amount, :amount_min_limit, :description, :due, :installment_end, :receiver_bank_code,
+                :reference_code, :pull_retry_limit, :sender_city_code, :sender_final_name, :sender_final_tax_id,
+                :tags, :id, :status, :flow, :created, :updated
+    def initialize(
+      bacen_id:, external_id:, installment_start:, interval:, receiver_name:, receiver_tax_id:,
+      sender_account_number:, sender_bank_code:, sender_branch_code:, sender_tax_id:, type:,
+      amount: nil, amount_min_limit: nil, description: nil, due: nil, installment_end: nil,
+      receiver_bank_code: nil, reference_code: nil, pull_retry_limit: nil, sender_city_code: nil,
+      sender_final_name: nil, sender_final_tax_id: nil, tags: nil, id: nil, status: nil, flow: nil,
+      created: nil, updated: nil
+    )
+      super(id)
+      @bacen_id = bacen_id
+      @external_id = external_id
+      @installment_start = StarkCore::Utils::Checks.check_datetime(installment_start)
+      @interval = interval
+      @receiver_name = receiver_name
+      @receiver_tax_id = receiver_tax_id
+      @sender_account_number = sender_account_number
+      @sender_bank_code = sender_bank_code
+      @sender_branch_code = sender_branch_code
+      @sender_tax_id = sender_tax_id
+      @type = type
+      @amount = amount
+      @amount_min_limit = amount_min_limit
+      @description = description
+      @due = StarkCore::Utils::Checks.check_datetime(due == '' ? nil : due)
+      @installment_end = StarkCore::Utils::Checks.check_datetime(installment_end == '' ? nil : installment_end)
+      @receiver_bank_code = receiver_bank_code
+      @reference_code = reference_code
+      @pull_retry_limit = pull_retry_limit
+      @sender_city_code = sender_city_code
+      @sender_final_name = sender_final_name
+      @sender_final_tax_id = sender_final_tax_id
+      @tags = tags
+      @status = status
+      @flow = flow
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create PixPullSubscriptions
+    #
+    # Send a list of PixPullSubscription objects for creation in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - subscriptions [list of PixPullSubscription objects]: list of PixPullSubscription 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 PixPullSubscription objects with updated attributes
+    def self.create(subscriptions, user: nil)
+      StarkInfra::Utils::Rest.post(entities: subscriptions, user: user, **resource)
+    end
+
+    # # Retrieve a specific PixPullSubscription
+    #
+    # Receive a single PixPullSubscription object previously created in the Stark Infra API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - PixPullSubscription object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve PixPullSubscriptions
+    #
+    # Receive a generator of PixPullSubscription 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)
+    # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['active', 'canceled']
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['employees', 'monthly']
+    # - ids [list of strings, default nil]: list of 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:
+    # - generator of PixPullSubscription objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged PixPullSubscriptions
+    #
+    # Receive a list of up to 100 PixPullSubscription 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 subscriptions.
+    #
+    # ## 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)
+    # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['active', 'canceled']
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['employees', 'monthly']
+    # - ids [list of strings, default nil]: list of 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:
+    # - list of PixPullSubscription objects with updated attributes
+    # - cursor to retrieve the next page of PixPullSubscription objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, user: nil)
+      after = StarkCore::Utils::Checks.check_date(after)
+      before = StarkCore::Utils::Checks.check_date(before)
+      StarkInfra::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Update PixPullSubscriptions
+    #
+    # A Pix Subscription can be patched for three distinct purposes - to update, confirm or deny it.
+    # As the receiver, you can approve or deny the subscription if the subscription type is 'subscriptionAndPayment'.
+    # As the sender, you can confirm or deny a delivered subscription.
+    #
+    # ## Parameters (required):
+    # - id [string]: PixPullSubscription unique id. ex: '5656565656565656'
+    # - patch_data [hash]: hash containing the attributes to be updated. ex: { status: 'approved', sender_city_code: '3550308' }
+    #     ## Parameters (required):
+    #     - status [string]: new status of the Pix Subscription.
+    #     ## Parameters (conditionally-required):
+    #     - sender_city_code [string]: IBGE code of the payer's city. Required if you are confirming the subscription.
+    #     - reason [string]: reason why the Pix Subscription is being patched. Options: 'accountClosed', 'accountBlocked', 'invalidBranchCode', 'notRecognizedBySender', 'userRejected', 'notOffered'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - updated PixPullSubscription object
+    def self.update(id, patch_data: nil, user: nil)
+      patch_data ||= {}
+      StarkInfra::Utils::Rest.patch_id(id: id, user: user, **patch_data, **resource)
+    end
+
+    # # Cancel a PixPullSubscription entity
+    #
+    # Cancel a PixPullSubscription entity previously created in the Stark Infra API.
+    # The reason is sent as a query parameter, not in the request body.
+    #
+    # ## Parameters (required):
+    # - id [string]: PixPullSubscription unique id. ex: '5656565656565656'
+    # - reason [string]: reason for the cancellation. As receiver: 'accountClosed', 'receiverOrganizationClosed', 'receiverInternalError', 'fraud', 'receiverUserRequested'. As sender: 'accountClosed', 'senderDeceased', 'fraud', 'senderUserRequested'.
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - canceled PixPullSubscription object
+    def self.cancel(id, reason:, user: nil)
+      response = StarkInfra::Utils::Rest.delete_raw(
+        path: "/pix-pull-subscription/#{id}",
+        query: { reason: reason },
+        user: user,
+        raiseException: true
+      )
+      maker = resource[:resource_maker]
+      StarkCore::Utils::API.from_api_json(maker, response.json['subscription'])
+    end
+
+    def self.resource
+      {
+        resource_name: 'PixPullSubscription',
+        resource_maker: proc { |json|
+          PixPullSubscription.new(
+            id: json['id'],
+            bacen_id: json['bacen_id'],
+            external_id: json['external_id'],
+            installment_start: json['installment_start'],
+            interval: json['interval'],
+            receiver_name: json['receiver_name'],
+            receiver_tax_id: json['receiver_tax_id'],
+            sender_account_number: json['sender_account_number'],
+            sender_bank_code: json['sender_bank_code'],
+            sender_branch_code: json['sender_branch_code'],
+            sender_tax_id: json['sender_tax_id'],
+            type: json['type'],
+            amount: json['amount'],
+            amount_min_limit: json['amount_min_limit'],
+            description: json['description'],
+            due: json['due'],
+            installment_end: json['installment_end'],
+            receiver_bank_code: json['receiver_bank_code'],
+            reference_code: json['reference_code'],
+            pull_retry_limit: json['pull_retry_limit'],
+            sender_city_code: json['sender_city_code'],
+            sender_final_name: json['sender_final_name'],
+            sender_final_tax_id: json['sender_final_tax_id'],
+            tags: json['tags'],
+            status: json['status'],
+            flow: json['flow'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/{pixrequest → pix_request}/log.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require('starkcore')
-require_relative('pixrequest')
+require_relative('pix_request')
 require_relative('../utils/rest')
 
 module StarkInfra

data/lib/{pixrequest/pixrequest.rb → pix_request/pix_request.rb}

@@ -42,6 +42,8 @@ module StarkInfra
   # - initiator_tax_id [string, default nil]: Payment initiator's tax id (CPF/CNPJ). ex: '01234567890' or '20.018.183/0001-80'
   # - 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'.
+  # - priority priority [string, default 'high']: Specifies the message channel used to send the Pix Request. If set to 'high', the request is sent through the primary channel; if set to 'low', it uses the secondary channel. Options: 'high' or 'low'
+  # - reason [string, default 'customerRequest']: underlying reason for the payment transaction. ex: 'customerRequest', 'fraud', 'subscriptionFlaw'
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the PixRequest is created. ex: '5656565656565656'
@@ -56,13 +58,14 @@ module StarkInfra
                 :sender_account_type, :receiver_name, :receiver_tax_id, :receiver_bank_code, :receiver_account_number,
                 :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
+                :tags, :method, :priority, :reason, :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:, 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
+      tags: nil, method: nil, priority: nil, reason: nil, id: nil, fee: nil, status:nil, flow: nil, sender_bank_code: nil,
+      created: nil, updated: nil
     )
       super(id)
       @amount = amount
@@ -88,6 +91,8 @@ module StarkInfra
       @initiator_tax_id = initiator_tax_id
       @tags = tags
       @method = method
+      @priority = priority
+      @reason = reason
       @fee = fee
       @status = status
       @flow = flow
@@ -276,6 +281,8 @@ module StarkInfra
             initiator_tax_id: json['initiator_tax_id'],
             tags: json['tags'],
             method: json['method'],
+            priority: json['priority'],
+            reason: json['reason'],
             fee: json['fee'],
             status: json['status'],
             flow: json['flow'],

data/lib/{pixreversal → pix_reversal}/log.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative('pixreversal')
+require_relative('pix_reversal')
 require_relative('../utils/rest')
 
 module StarkInfra

data/lib/starkinfra.rb

@@ -1,72 +1,96 @@
 # frozen_string_literal: true
 
-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('creditholmes/creditholmes')
-require_relative('creditpreview/creditpreview')
-require_relative('creditpreview/creditnotepreview')
-require_relative('creditsigner/creditsigner')
-require_relative('dynamicbrcode/dynamicbrcode')
-require_relative('individualdocument/individualdocument')
-require_relative('individualdocument/log')
-require_relative('individualidentity/individualidentity')
-require_relative('individualidentity/log')
-require_relative('issuingbalance/issuingbalance')
-require_relative('issuingdesign/issuingdesign')
-require_relative('issuingembossingkit/issuingembossingkit')
-require_relative('issuingembossingrequest/issuingembossingrequest')
-require_relative('issuingembossingrequest/log')
-require_relative('issuingstock/issuingstock')
-require_relative('issuingstock/log')
-require_relative('issuingrestock/issuingrestock')
-require_relative('issuingrestock/log')
-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('merchantcategory/merchantcategory')
-require_relative('merchantcountry/merchantcountry')
-require_relative('pixbalance/pixbalance')
-require_relative('pixchargeback/pixchargeback')
-require_relative('pixchargeback/log')
-require_relative('pixclaim/pixclaim')
-require_relative('pixclaim/log')
-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('brcode_preview/brcode_preview')
+require_relative('business_attachment/business_attachment')
+require_relative('business_attachment/log')
+require_relative('business_identity/business_identity')
+require_relative('business_identity/log')
+require_relative('brcode_preview/subscription')
+require_relative('card_method/card_method')
+require_relative('credit_note/invoice/invoice')
+require_relative('credit_note/invoice/description')
+require_relative('credit_note/invoice/discount')
+require_relative('credit_note/credit_note')
+require_relative('credit_note/rule')
+require_relative('credit_note/log')
+require_relative('credit_note/transfer')
+require_relative('credit_holmes/credit_holmes')
+require_relative('credit_preview/credit_preview')
+require_relative('credit_preview/credit_note_preview')
+require_relative('credit_signer/credit_signer')
+require_relative('dynamic_brcode/dynamic_brcode')
+require_relative('individual_document/individual_document')
+require_relative('individual_document/log')
+require_relative('individual_identity/individual_identity')
+require_relative('individual_identity/log')
+require_relative('issuing_balance/issuing_balance')
+require_relative('issuing_billing_invoice/issuing_billing_invoice')
+require_relative('issuing_billing_transaction/issuing_billing_transaction')
+require_relative('issuing_design/issuing_design')
+require_relative('issuing_embossing_kit/issuing_embossing_kit')
+require_relative('issuing_embossing_request/issuing_embossing_request')
+require_relative('issuing_embossing_request/log')
+require_relative('issuing_stock/issuing_stock')
+require_relative('issuing_stock/log')
+require_relative('issuing_stock_rule/issuing_stock_rule')
+require_relative('issuing_restock/issuing_restock')
+require_relative('issuing_restock/log')
+require_relative('issuing_card/issuing_card')
+require_relative('issuing_card/log')
+require_relative('issuing_holder/issuing_holder')
+require_relative('issuing_holder/log')
+require_relative('issuing_invoice/issuing_invoice')
+require_relative('issuing_invoice/log')
+require_relative('issuing_product/issuing_product')
+require_relative('issuing_purchase/issuing_purchase')
+require_relative('issuing_purchase/log')
+require_relative('issuing_rule/issuing_rule')
+require_relative('issuing_token/issuing_token')
+require_relative('issuing_token_request/issuing_token_request')
+require_relative('issuing_token_design/issuing_token_design')
+require_relative('issuing_transaction/issuing_transaction')
+require_relative('issuing_withdrawal/issuing_withdrawal')
+require_relative('merchant_category/merchant_category')
+require_relative('merchant_country/merchant_country')
+require_relative('pix_balance/pix_balance')
+require_relative('pix_chargeback/pix_chargeback')
+require_relative('pix_chargeback/log')
+require_relative('pix_claim/pix_claim')
+require_relative('pix_claim/log')
+require_relative('pix_director/pix_director')
+require_relative('pix_dispute/pix_dispute')
+require_relative('pix_dispute/transaction')
+require_relative('pix_dispute/log')
+require_relative('pix_domain/pix_domain')
+require_relative('pix_key_holmes/pix_key_holmes')
+require_relative('pix_fraud/pix_fraud')
+require_relative('pix_fraud/log')
+require_relative('pix_infraction/pix_infraction')
+require_relative('pix_infraction/log')
+require_relative('pix_internal_transaction_report/pix_internal_transaction_report')
+require_relative('pix_internal_transaction_report/log')
+require_relative('pix_key/pix_key')
+require_relative('pix_key/log')
+require_relative('pix_pull_request/pix_pull_request')
+require_relative('pix_pull_request/log')
+require_relative('pix_pull_subscription/pix_pull_subscription')
+require_relative('pix_pull_subscription/log')
+require_relative('pix_request/pix_request')
+require_relative('pix_request/log')
+require_relative('pix_reversal/pix_reversal')
+require_relative('pix_reversal/log')
+require_relative('pix_statement/pix_statement')
+require_relative('static_brcode/static_brcode')
 require_relative('webhook/webhook')
 require_relative('event/event')
 require_relative('event/attempt')
 require_relative('request/request')
+require_relative('utils/return_id')
 
-# SDK to facilitate Ruby integrations with Stark Infra
 module StarkInfra
 
   API_VERSION = 'v2'
-  SDK_VERSION = '0.5.0'
+  SDK_VERSION = '0.6.0'
   HOST = "infra"
   public_constant :API_VERSION, :SDK_VERSION, :HOST;
 

data/lib/utils/parse.rb

@@ -13,7 +13,7 @@ module StarkInfra
           resource: resource,
           user: user ? user : StarkInfra.user,
           language: StarkInfra.language,
-          timeout: StarkInfra.language,
+          timeout: StarkInfra.timeout,
           key: key
         )
       end
@@ -27,7 +27,7 @@ module StarkInfra
           host: StarkInfra::HOST,
           user: user ? user : StarkInfra.user,
           language: StarkInfra.language,
-          timeout: StarkInfra.language
+          timeout: StarkInfra.timeout
         )
       end
     end

data/lib/utils/return_id.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module StarkInfra
+  # # ReturnId object
+  #
+  # A ReturnId is a 32-character string that uniquely identifies a return Pix transaction
+  # at the BACEN (Banco Central do Brasil) level. It is composed of a "D" prefix,
+  # the sender bank's ISPB code (zero-padded to 8 digits), a datetime stamp (yyyyMMddHHmm),
+  # and 11 random alphanumeric characters.
+  #
+  # ## Parameters (required):
+  # - bank_code [string]: 8-digit ISPB code of the sending bank. ex: '20018183'
+  #
+  # ## Return:
+  # - ReturnId string. ex: 'D200181832022012014505GD19lzAbCdE'
+  class ReturnId
+    RANDOM_SOURCE = (('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a).freeze
+
+    def self.create(bank_code)
+      random_string = (0...11).map { RANDOM_SOURCE.sample }.join
+      "D#{bank_code}#{Time.now.strftime('%Y%m%d%H%M')}#{random_string}"
+    end
+  end
+end

data/lib/webhook/webhook.rb

@@ -7,11 +7,11 @@ module StarkInfra
   # # Webhook object
   #
   # A Webhook is used to subscribe to notification events on a user-selected endpoint.
-  # Currently available services for subscription are contract, credit-note, signer, issuing-card, issuing-invoice, issuing-purchase, pix-request.in, pix-request.out, pix-reversal.in, pix-reversal.out, pix-claim, pix-key, pix-chargeback, pix-infraction.
+  # Currently available services for subscription are contract, credit-note, signer, issuing-card, issuing-invoice, issuing-purchase, pix-request.in, pix-request.out, pix-reversal.in, pix-reversal.out, pix-claim, pix-key, pix-chargeback, pix-infraction, pix-pull-request, pix-pull-subscription.
   #
   # ## Parameters (required):
   # - url [string]: URL that will be notified when an event occurs.
-  # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ['contract', 'credit-note', 'signer', 'issuing-card', 'issuing-invoice', 'issuing-purchase', 'pix-request.in', 'pix-request.out', 'pix-reversal.in', 'pix-reversal.out', 'pix-claim', 'pix-key', 'pix-chargeback', 'pix-infraction']
+  # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ['contract', 'credit-note', 'signer', 'issuing-card', 'issuing-invoice', 'issuing-purchase', 'pix-request.in', 'pix-request.out', 'pix-reversal.in', 'pix-reversal.out', 'pix-claim', 'pix-key', 'pix-chargeback', 'pix-infraction', 'pix-pull-request', 'pix-pull-subscription']
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when the webhook is created. ex: '5656565656565656'