starkinfra 0.5.2 → 0.7.0

data/lib/starkinfra.rb

@@ -1,29 +1,43 @@
 # frozen_string_literal: true
 
 require_relative('brcode_preview/brcode_preview')
+require_relative('business_account_request/business_account_request')
+require_relative('business_account_request/log')
+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_holmes/log')
 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_account_request/individual_account_request')
+require_relative('individual_account_request/log')
+require_relative('individual_account_attachment/individual_account_attachment')
+require_relative('individual_account_attachment/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')
@@ -36,8 +50,17 @@ 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/log')
+require_relative('issuing_token_activation/issuing_token_activation')
+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('ledger/ledger')
+require_relative('ledger/rule')
+require_relative('ledger/log')
+require_relative('ledger_transaction/ledger_transaction')
 require_relative('merchant_category/merchant_category')
 require_relative('merchant_country/merchant_country')
 require_relative('pix_balance/pix_balance')
@@ -46,27 +69,45 @@ 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_key_holmes/log')
+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('pix_user/pix_user')
+require_relative('pix_user/statistics')
 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/bacen_id')
+require_relative('utils/end_to_end_id')
+require_relative('utils/return_id')
+require_relative('utils/pix_subscription_bacen_id')
 
-# SDK to facilitate Ruby integrations with Stark Infra
 module StarkInfra
 
   API_VERSION = 'v2'
-  SDK_VERSION = '0.5.2'
+  SDK_VERSION = '0.7.0'
   HOST = "infra"
   public_constant :API_VERSION, :SDK_VERSION, :HOST;
 

data/lib/static_brcode/static_brcode.rb

@@ -17,7 +17,7 @@ module StarkInfra
   ## 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'
+  # - city [string]: 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)
@@ -25,6 +25,7 @@ module StarkInfra
   # - 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'
   # - description [string, default None]: optional description to override default description to be shown in the bank statement. ex: "Payment for service #1234"
   # - tags [list of strings, default nil]:  list of strings for tagging. ex: ['travel', 'food']
+  # - type [string, default 'instant']: type of the StaticBrcode. Options: 'instant', 'instantAndOrSubscription'
   #
   # ## Attributes (return-only):
   # - id [string]: id returned on creation, this is the BR Code. ex: '00020126360014br.gov.bcb.pix0114+552840092118152040000530398654040.095802BR5915Jamie Lannister6009Sao Paulo620705038566304FC6C'
@@ -33,9 +34,10 @@ module StarkInfra
   # - 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 < StarkCore::Utils::Resource
-    attr_reader :name, :key_id, :city, :amount, :cashier_bank_code, :description, :reconciliation_id, :id, :tags, :uuid, :url, :created, :updated
+    attr_reader :name, :key_id, :city, :amount, :cashier_bank_code, :description, :reconciliation_id, :id, :tags, :uuid, :url, :created, :updated, :type
     def initialize(
-      name:, key_id:, city:, amount:, cashier_bank_code: nil, description: nil, reconciliation_id: nil, id: nil, tags:nil, uuid: nil, url: nil, created: nil, updated: nil
+      name:, key_id:, city:, amount:, cashier_bank_code: nil, description: nil, reconciliation_id: nil, id: nil, tags:nil, uuid: nil, url: nil, created: nil, updated: nil,
+      type: nil
     )
       super(id)
       @name = name
@@ -50,6 +52,7 @@ module StarkInfra
       @url = url
       @created = StarkCore::Utils::Checks.check_datetime(created)
       @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      @type = type
     end
 
     # # Create StaticBrcodes
@@ -160,7 +163,8 @@ module StarkInfra
             uuid: json['uuid'],
             url: json['url'],
             created: json['created'],
-            updated: json['updated']
+            updated: json['updated'],
+            type: json['type']
           )
         }
       }

data/lib/utils/bacen_id.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module StarkInfra
+  # # BacenId object
+  #
+  # A BacenId is the common body of the identifiers used at the BACEN (Banco Central do Brasil) level.
+  # It is composed of the bank's ISPB code, a datetime stamp and 11 random alphanumeric characters.
+  # The datetime stamp is always generated in UTC, regardless of the machine timezone.
+  # It is the base of EndToEndId, ReturnId and PixSubscriptionBacenId.
+  #
+  # ## Parameters (required):
+  # - bank_code [string]: 8-digit ISPB code of the bank. ex: '20018183'
+  #
+  # ## Parameters (optional):
+  # - date_format [string, default '%Y%m%d%H%M']: strftime format of the UTC datetime stamp.
+  #
+  # ## Return:
+  # - BacenId string. ex: '200181832022012014505GD19lzAbCdE'
+  class BacenId
+    RANDOM_SOURCE = (('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a).freeze
+
+    def self.create(bank_code, date_format = '%Y%m%d%H%M')
+      random_string = (0...11).map { RANDOM_SOURCE.sample }.join
+      "#{bank_code}#{Time.now.utc.strftime(date_format)}#{random_string}"
+    end
+  end
+end

data/lib/utils/end_to_end_id.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module StarkInfra
+  # # EndToEndId object
+  #
+  # An EndToEndId is a 32-character string that uniquely identifies a Pix transaction
+  # at the BACEN (Banco Central do Brasil) level. It is composed of an "E" prefix,
+  # the sender bank's ISPB code, 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:
+  # - EndToEndId string. ex: 'E200181832022012014505GD19lzAbCdE'
+  class EndToEndId
+    def self.create(bank_code)
+      "E#{BacenId.create(bank_code)}"
+    end
+  end
+end

data/lib/utils/pix_subscription_bacen_id.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module StarkInfra
+  # # PixSubscriptionBacenId object
+  #
+  # A PixSubscriptionBacenId is a 29-character string that uniquely identifies a Pix subscription
+  # at the BACEN (Banco Central do Brasil) level. It is composed of a prefix (e.g. "RR"),
+  # the receiver bank's ISPB code, a date stamp (yyyyMMdd) and 11 random alphanumeric characters.
+  #
+  # ## Parameters (required):
+  # - bank_code [string]: 8-digit ISPB code of the bank. ex: '20018183'
+  # - prefix [string]: prefix of the bacen id. ex: 'RR'
+  #
+  # ## Return:
+  # - PixSubscriptionBacenId string. ex: 'RR2001818320220120GD19lzAbCdE'
+  class PixSubscriptionBacenId
+    def self.create(bank_code, prefix)
+      "#{prefix}#{BacenId.create(bank_code, '%Y%m%d')}"
+    end
+  end
+end

data/lib/utils/return_id.rb

@@ -0,0 +1,21 @@
+# 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
+    def self.create(bank_code)
+      "D#{BacenId.create(bank_code)}"
+    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 include 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-dispute, pix-pull-request, pix-pull-subscription, business-identity (see StarkInfra::Event for the authoritative, currently-wired list).
   #
   # ## 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'
@@ -93,7 +93,7 @@ module StarkInfra
 
     # # Delete a Webhook entity
     #
-    # Delete a Webhook entity previously created in the Stark Infra API
+    # Delete a Webhook entity previously created in the Stark Infra API. This action cannot be undone.
     #
     # ## Parameters (required):
     # - id [string]: Webhook unique id. ex: '5656565656565656'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: starkinfra
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0
 platform: ruby
 authors:
 - starkinfra
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: starkcore
@@ -66,20 +65,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.81'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/brcode_preview/brcode_preview.rb
+- lib/brcode_preview/subscription.rb
+- lib/business_account_request/business_account_request.rb
+- lib/business_account_request/log.rb
+- lib/business_attachment/business_attachment.rb
+- lib/business_attachment/log.rb
+- lib/business_identity/business_identity.rb
+- lib/business_identity/log.rb
 - lib/card_method/card_method.rb
 - lib/credit_holmes/credit_holmes.rb
+- lib/credit_holmes/log.rb
 - lib/credit_note/credit_note.rb
 - lib/credit_note/invoice/description.rb
 - lib/credit_note/invoice/discount.rb
 - lib/credit_note/invoice/invoice.rb
 - lib/credit_note/log.rb
+- lib/credit_note/rule.rb
 - lib/credit_note/transfer.rb
 - lib/credit_preview/credit_note_preview.rb
 - lib/credit_preview/credit_preview.rb
@@ -88,11 +94,15 @@ files:
 - lib/error.rb
 - lib/event/attempt.rb
 - lib/event/event.rb
-- lib/individual_document/individual_document.rb
-- lib/individual_document/log.rb
+- lib/individual_account_attachment/individual_account_attachment.rb
+- lib/individual_account_attachment/log.rb
+- lib/individual_account_request/individual_account_request.rb
+- lib/individual_account_request/log.rb
 - lib/individual_identity/individual_identity.rb
 - lib/individual_identity/log.rb
 - lib/issuing_balance/issuing_balance.rb
+- lib/issuing_billing_invoice/issuing_billing_invoice.rb
+- lib/issuing_billing_transaction/issuing_billing_transaction.rb
 - lib/issuing_card/issuing_card.rb
 - lib/issuing_card/log.rb
 - lib/issuing_design/issuing_design.rb
@@ -111,8 +121,18 @@ files:
 - lib/issuing_rule/issuing_rule.rb
 - lib/issuing_stock/issuing_stock.rb
 - lib/issuing_stock/log.rb
+- lib/issuing_stock_rule/issuing_stock_rule.rb
+- lib/issuing_token/issuing_token.rb
+- lib/issuing_token/log.rb
+- lib/issuing_token_activation/issuing_token_activation.rb
+- lib/issuing_token_design/issuing_token_design.rb
+- lib/issuing_token_request/issuing_token_request.rb
 - lib/issuing_transaction/issuing_transaction.rb
 - lib/issuing_withdrawal/issuing_withdrawal.rb
+- lib/ledger/ledger.rb
+- lib/ledger/log.rb
+- lib/ledger/rule.rb
+- lib/ledger_transaction/ledger_transaction.rb
 - lib/merchant_category/merchant_category.rb
 - lib/merchant_country/merchant_country.rb
 - lib/pix_balance/pix_balance.rb
@@ -121,28 +141,46 @@ files:
 - lib/pix_claim/log.rb
 - lib/pix_claim/pix_claim.rb
 - lib/pix_director/pix_director.rb
+- lib/pix_dispute/log.rb
+- lib/pix_dispute/pix_dispute.rb
+- lib/pix_dispute/transaction.rb
 - lib/pix_domain/certificate.rb
 - lib/pix_domain/pix_domain.rb
+- lib/pix_fraud/log.rb
+- lib/pix_fraud/pix_fraud.rb
 - lib/pix_infraction/log.rb
 - lib/pix_infraction/pix_infraction.rb
+- lib/pix_internal_transaction_report/log.rb
+- lib/pix_internal_transaction_report/pix_internal_transaction_report.rb
 - lib/pix_key/log.rb
 - lib/pix_key/pix_key.rb
+- lib/pix_key_holmes/log.rb
+- lib/pix_key_holmes/pix_key_holmes.rb
+- lib/pix_pull_request/log.rb
+- lib/pix_pull_request/pix_pull_request.rb
+- lib/pix_pull_subscription/log.rb
+- lib/pix_pull_subscription/pix_pull_subscription.rb
 - lib/pix_request/log.rb
 - lib/pix_request/pix_request.rb
 - lib/pix_reversal/log.rb
 - lib/pix_reversal/pix_reversal.rb
 - lib/pix_statement/pix_statement.rb
+- lib/pix_user/pix_user.rb
+- lib/pix_user/statistics.rb
 - lib/request/request.rb
 - lib/starkinfra.rb
 - lib/static_brcode/static_brcode.rb
+- lib/utils/bacen_id.rb
+- lib/utils/end_to_end_id.rb
 - lib/utils/parse.rb
+- lib/utils/pix_subscription_bacen_id.rb
 - lib/utils/rest.rb
+- lib/utils/return_id.rb
 - lib/webhook/webhook.rb
 homepage: https://github.com/starkinfra/sdk-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,15 +188,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
 summary: SDK to facilitate Ruby integrations with Stark Infra
 test_files: []