starkinfra 0.6.0 → 0.7.0

data/lib/starkinfra.rb

@@ -1,6 +1,8 @@
 # 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')
@@ -15,12 +17,15 @@ 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')
@@ -46,10 +51,16 @@ 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')
@@ -63,6 +74,7 @@ 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')
@@ -80,17 +92,22 @@ 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')
 
 module StarkInfra
 
   API_VERSION = 'v2'
-  SDK_VERSION = '0.6.0'
+  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

@@ -14,11 +14,8 @@ module StarkInfra
   # ## 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}"
+      "D#{BacenId.create(bank_code)}"
     end
   end
 end

data/lib/webhook/webhook.rb

@@ -7,7 +7,7 @@ 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, pix-pull-request, pix-pull-subscription.
+  # 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.
@@ -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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starkinfra
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - starkinfra
@@ -71,12 +71,15 @@ 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
@@ -91,8 +94,10 @@ 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
@@ -118,10 +123,16 @@ files:
 - 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
@@ -143,6 +154,7 @@ files:
 - 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
@@ -153,10 +165,15 @@ files:
 - 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
@@ -178,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: SDK to facilitate Ruby integrations with Stark Infra
 test_files: []

data/lib/individual_document/individual_document.rb

@@ -1,164 +0,0 @@
-# frozen_string_literal: true
-
-require('starkcore')
-require_relative('../utils/rest')
-require_relative('../utils/parse')
-
-module StarkInfra
-  # # IndividualDocument object
-  #
-  # Individual documents are images containing either side of a document or a selfie
-  # to be used in a matching validation. When created, they must be attached to an individual
-  # identity to be used for its validation.
-  #
-  # When you initialize a IndividualDocument, 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):
-  # - type [string]: type of the IndividualDocument. Options: "drivers-license-front", "drivers-license-back", "identity-front", "identity-back" or "selfie"
-  # - content [string]: Base64 data url of the picture. ex: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD...
-  # - content_type [string]: content MIME type. This parameter is required as input only. ex: "image/png" or "image/jpeg"
-  # - identity_id [string]: Unique id of IndividualIdentity. ex: "5656565656565656"
-  #
-  # ## Parameters (optional):
-  # - tags [list of strings, default nil]: list of strings for reference when searching for IndividualDocuments. ex: ["employees", "monthly"]
-  #
-  # ## Attributes (return-only):
-  # - id [string]: unique id returned when the IndividualDocument is created. ex: "5656565656565656"
-  # - status [string]: current status of the IndividualDocument. Options: "created", "canceled", "processing", "failed", "success"
-  # - created [DateTime]: creation datetime for the IndividualDocument. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  class IndividualDocument < StarkCore::Utils::Resource
-    attr_reader :type, :content, :content_type, :identity_id, :tags, :id, :status, :created 
-    def initialize(type:, content:, content_type:, identity_id:, tags: nil, id: nil, status: nil, created: nil)
-      super(id)
-      @type = type
-      @identity_id = identity_id
-      @tags = tags
-      @status = status
-      @created = StarkCore::Utils::Checks.check_datetime(created)
-      @content = content
-      @content_type = content_type
-
-      if @content_type
-        @content = "data:#{content_type};base64,#{Base64.encode64(content)}"
-        @content_type = nil
-      end
-    end
-
-    # # Create IndividualDocuments
-    #
-    # Send a list of IndividualDocument objects for creation at the Stark Infra API
-    #
-    # ## Parameters (required):
-    # - documents [list of IndividualDocument objects]: list of IndividualDocument 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 IndividualDocument object with updated attributes
-    def self.create(documents, user: nil)
-      StarkInfra::Utils::Rest.post(entities: documents, user: user, **resource)
-    end
-
-    # # Retrieve a specific IndividualDocument
-    #
-    # Receive a single IndividualDocument object previously created in the Stark Infra API by 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:
-    # - IndividualDocument object with updated attributes
-    def self.get(id, user: nil)
-      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
-    end
-
-    # # Retrieve IndividualDocuments
-    #
-    # Receive a generator of IndividualDocument 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. Options: ["created", "canceled", "processing", "failed", "success"]
-    # - 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"]
-    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
-    #
-    # ## Return:
-    # - generator of IndividualDocument 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 IndividualDocuments
-    #
-    # Receive a list of up to 100 IndividualDocument 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 requests.
-    #
-    # ## 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. Options: ["created", "canceled", "processing", "failed", "success"]
-    # - 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"]
-    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
-    #
-    # ## Return:
-    # - list of IndividualDocument objects with updated attributes
-    # - cursor to retrieve the next page of IndividualDocument 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
-
-
-    def self.resource
-      {
-        resource_name: 'IndividualDocument',
-        resource_maker: proc { |json|
-          IndividualDocument.new(
-            type: json['type'],
-            content: json['content'],
-            content_type: json['content_type'],
-            identity_id: json['identity_id'],
-            tags: json['tags'],
-            id: json['id'],
-            status: json['status'],
-            created: json['created']
-          )
-        }
-      }
-    end
-  end
-end