starkinfra 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d851779a2ac175de1c7c25ec156ff8c9c011bd438dc863e5e99dc031be4540c3
-  data.tar.gz: 6b0bce15d67fe07e569facaa3023152d865a0886cae0de131bf45ac0bd42916f
+  metadata.gz: 84494554057a87004d3c53122b4212049553964d4aae5a06b7045c104debbe61
+  data.tar.gz: 227df256622a80f1e2e827c8aef4b7363a0307abb2f727b9ee82876dc942cef1
 SHA512:
-  metadata.gz: e667c072faca5588ce99f991bd7f983849667281b0e11314444ed607b66cca7fd372c3a0a90ef33e2d0dbc8321e2ddc22941c6180710691472bc8eaa54cf33fe
-  data.tar.gz: 7060cff52d7a3634b96e515b18988227b8f1b88696fdccccca1263c48a09a8f73812956c1eecd0e2b1c423d13df9f1135e4f6577f04c189c62620ed3efc29057
+  metadata.gz: 7f077615c40b5066952932e8b771838665c203d6d4d238486abd4e2d07eba832da4a69b9610e086f525d7c38f499e1613275bdc7944d9d340d7d489fa2472637
+  data.tar.gz: 0e646b2ec34f440339c48dd368e761d30e26a1edea765ee034b89816888135465e11d49b66bb812cb458520117d67af57356f41cfd33f2f0dbc50d8a2b2be8a7

data/lib/brcodepreview/brcodepreview.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+require_relative('../utils/parse')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
+
+module StarkInfra
+  # # BrcodePreview object
+  #
+  # A BrcodePreview is used to get information from a BR Code you received to check the information before paying it.
+  #
+  # Parameters (required):
+  # - id [string]: BR Code string for the Pix payment. This is also de information directly encoded in a QR Code. ex: '00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A'
+  # - payer_id [string]: tax id (CPF/CNPJ) of the individual or business requesting the PixKey information. This id is used by the Central Bank to limit request rates. ex: "20.018.183/0001-80"
+  #
+  # Parameters (optional):
+  # - end_to_end_id [string]: central bank's unique transaction ID. ex: "E79457883202101262140HHX553UPqeq"
+  #
+  # Attributes (return-only):
+  # - account_number [string]: Payment receiver account number. ex: '1234567'
+  # - account_type [string]: Payment receiver account type. ex: 'checking'
+  # - amount [integer]: Value in cents that this payment is expecting to receive. If 0, any value is accepted. ex: 123 (= R$1,23)
+  # - amount_type [string]: amount type of the BR Code. If the amount type is 'custom' the BR Code's amount can be changed by the sender at the moment of payment. Options: 'fixed' or 'custom'
+  # - bank_code [string]: Payment receiver bank code. ex: '20018183'
+  # - branch_code [string]: Payment receiver branch code. ex: '0001'
+  # - cash_amount [integer]: Amount to be withdrawn from the cashier in cents. ex: 1000 (= R$ 10.00)
+  # - cashier_bank_code [string]: Cashier's bank code. ex: '20018183'
+  # - cashier_type [string]: Cashier's type. Options: 'merchant', 'participant' and 'other'
+  # - discount_amount [integer]: Discount value calculated over nominal_amount. ex: 3000
+  # - fine_amount [integer]: Fine value calculated over nominal_amount. ex: 20000
+  # - key_id [string]: Receiver's PixKey id. ex: '+5511989898989'
+  # - interest_amount [integer]: Interest value calculated over nominal_amount. ex: 10000
+  # - name [string]: Payment receiver name. ex: 'Tony Stark'
+  # - nominal_amount [integer]: BR Code emission amount, without fines, fees and discounts. ex: 1234 (= R$ 12.34)
+  # - reconciliation_id [string]: Reconciliation ID linked to this payment. If the BR Code is dynamic, the reconciliation_id will have from 26 to 35 alphanumeric characters, ex: 'cd65c78aeb6543eaaa0170f68bd741ee'. If the brcode is static, the reconciliation_id will have up to 25 alphanumeric characters 'ah27s53agj6493hjds6836v49'
+  # - reduction_amount [integer]: Reduction value to discount from nominal_amount. ex: 1000
+  # - scheduled [DateTime]: date of payment execution. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0).
+  # - status [string]: Payment status. ex: 'active', 'paid', 'canceled' or 'unknown'
+  # - tax_id [string]: Payment receiver tax ID. ex: '012.345.678-90'
+  class BrcodePreview < StarkInfra::Utils::Resource
+    attr_reader :id, :payer_id, :end_to_end_id, :account_number, :account_type, :amount, :amount_type, :bank_code, :branch_code, :cash_amount,
+                :cashier_bank_code, :cashier_type, :discount_amount, :fine_amount, :key_id, :interest_amount, :name,
+                :nominal_amount, :reconciliation_id, :reduction_amount, :scheduled, :status, :tax_id
+    def initialize(
+      id:, payer_id:, end_to_end_id: nil, account_number: nil, account_type: nil, amount: nil, amount_type: nil, bank_code: nil,
+      branch_code: nil, cash_amount: nil, cashier_bank_code:nil, cashier_type:nil, discount_amount: nil,
+      fine_amount: nil, key_id: nil, interest_amount: nil, name: nil, nominal_amount: nil,
+      reconciliation_id: nil, reduction_amount: nil, scheduled: nil, status: nil, tax_id: nil
+    )
+      super(id)
+      @payer_id = payer_id
+      @end_to_end_id = end_to_end_id
+      @account_number = account_number
+      @account_type = account_type
+      @amount = amount
+      @amount_type = amount_type
+      @bank_code = bank_code
+      @branch_code = branch_code
+      @cash_amount = cash_amount
+      @cashier_bank_code = cashier_bank_code
+      @cashier_type = cashier_type
+      @discount_amount = discount_amount
+      @fine_amount = fine_amount
+      @interest_amount = interest_amount
+      @key_id = key_id
+      @name = name
+      @nominal_amount = nominal_amount
+      @reconciliation_id = reconciliation_id
+      @reduction_amount = reduction_amount
+      @scheduled = scheduled
+      @status = status
+      @tax_id = tax_id
+    end
+
+    # # Retrieve BrcodePreviews
+    #
+    # Process BR Codes before paying them.
+    #
+    # ## Parameters (required):
+    # - previews [list of BrcodePreview objects]: List of BrcodePreview objects to preview. ex: [starkinfra.BrcodePreview('00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A')]
+    #
+    # ## 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 BrcodePreview objects with updated attributes
+    def self.create(previews, user: nil)
+      StarkInfra::Utils::Rest.post(entities: previews, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'BrcodePreview',
+        resource_maker: proc { |json|
+          BrcodePreview.new(
+            id: json['id'],
+            payer_id: json['payer_id'],
+            end_to_end_id: json['end_to_end_id'],
+            account_number: json['account_number'],
+            account_type: json['account_type'],
+            amount: json['amount'],
+            amount_type: json['amount_type'],
+            bank_code: json['bank_code'],
+            branch_code: json['branch_code'],
+            cash_amount: json['cash_amount'],
+            cashier_bank_code: json['cashier_bank_code'],
+            cashier_type: json['cashier_type'],
+            discount_amount: json['discount_amount'],
+            fine_amount: json['fine_amount'],
+            key_id: json['key_id'],
+            interest_amount: json['interest_amount'],
+            name: json['name'],
+            nominal_amount: json['nominal_amount'],
+            reconciliation_id: json['reconciliation_id'],
+            reduction_amount: json['reduction_amount'],
+            scheduled: json['scheduled'],
+            status: json['status'],
+            tax_id: json['tax_id']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/cardmethod/cardmethod.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+require_relative('../utils/sub_resource')
+
+module StarkInfra
+  # # CardMethod object
+  #
+  # CardMethod's codes are used to define method filters in IssuingRules.
+  #
+  # ## Parameters (required):
+  # - code [string]: method's code. Options: 'chip', 'token', 'server', 'manual', 'magstripe', 'contactless'
+  #
+  # Attributes (return-only):
+  # - name [string]: method's name. ex: 'token'
+  # - number [string]: method's number. ex: '81'
+  class CardMethod < StarkInfra::Utils::SubResource
+    attr_reader :code, :name, :number
+    def initialize(code:, name: nil, number: nil)
+      @code = code
+      @name = name
+      @number = number
+    end
+
+    # # Retrieve CardMethods
+    #
+    # Receive a generator of CardMethod objects available in the Stark Infra API
+    #
+    # ## Parameters (optional):
+    # - search [string, default nil]: keyword to search for code, name, number or short_code
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of CardMethod objects with updated attributes
+    def self.query(search: nil, user: nil)
+      StarkInfra::Utils::Rest.get_stream(
+        search: search,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'CardMethod',
+        resource_maker: proc { |json|
+          CardMethod.new(
+            code: json['code'],
+            name: json['name'],
+            number: json['number']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/creditholmes/creditholmes.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+require_relative('../utils/parse')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
+
+module StarkInfra
+  # # CreditHolmes object
+  #
+  # CreditHolmes are used to obtain debt information on your customers.
+  # Before you create a CreditHolmes, make sure you have your customer's express
+  # authorization to verify their information in the Central Bank's SCR.
+  #
+  # When you initialize a CreditHolmes, 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):
+  # - tax_id [string]: customer's tax ID (CPF or CNPJ) for whom the credit operations will be verified. ex: "20.018.183/0001-80"
+  #
+  # ## Parameters (optional):
+  # - competence [string, default 'two months before current date']: competence month of the operation verification, format: "YYYY-MM". ex: "2021-04"
+  # - tags [list of strings, default []]: list of strings for reference when searching for CreditHolmes. ex: ["credit", "operation"]
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the CreditHolmes is created. ex: "5656565656565656"
+  # - result [dictionary]: result of the investigation after the case is solved.
+  # - status [string]: current status of the CreditHolmes. ex: "created", "failed", "success"
+  # - created [DateTime]: creation datetime for the CreditHolmes. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the CreditHolmes. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class CreditHolmes < StarkInfra::Utils::Resource
+    attr_reader :tax_id, :competence, :tags, :id, :result, :status, :updated, :created
+    def initialize(tax_id:, competence: nil, tags: nil, id: nil, result: nil, status: nil, updated: nil, created: nil)
+      super(id)
+      @tax_id = tax_id
+      @competence = competence
+      @tags = tags
+      @id = id
+      @result = result
+      @status = status
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create CreditHolmes
+    #
+    # Send a list of CreditHolmes objects for creation at the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - holmes [list of CreditHolmes objects]: list of CreditHolmes 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 CreditHolmes object with updated attributes
+    def self.create(holmes, user: nil)
+      StarkInfra::Utils::Rest.post(entities: holmes, user: user, **resource)
+    end
+
+    # # Retrieve a specific CreditHolmes
+    #
+    # Receive a single CreditHolmes 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:
+    # - CreditHolmes object with updated attributes
+    def self.get(id, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve CreditHolmes
+    #
+    # Receive a generator of CreditHolmes 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: "created", "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 CreditHolmes objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: 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,
+        status: status,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve CreditHolmes
+    #
+    # Receive a list of up to 100 CreditHolmes 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. ex: "created", "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 CreditHolmes objects with updated attributes
+    # - cursor to retrieve the next page of CreditHolmes objects
+    def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: 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,
+        status: status,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'CreditHolmes',
+        resource_maker: proc { |json|
+          CreditHolmes.new(
+            tax_id: json['tax_id'],
+            competence: json['competence'],
+            tags: json['tags'],
+            id: json['id'],
+            result: json['result'],
+            status: json['status'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end