starkinfra 0.1.0 → 0.3.0

data/lib/creditnote/invoice/invoice.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require_relative('../../utils/api')
+require_relative('../../utils/rest')
+require_relative('../../utils/sub_resource')
+
+module StarkInfra
+
+  # CreditNote::Invoice object
+  #
+  # Invoice issued after the contract is signed, to be paid by the credit receiver.
+  #
+  # ## Parameters (required):
+  # - amount [integer]: Invoice value in cents. Minimum = 1 (any value will be accepted). ex: 1234 (= R$ 12.34)
+  #
+  # ## Parameters (optional):
+  # - due [DateTime, Date or string, default now + 2 days]: Invoice due date in UTC ISO format. DateTime.new(2020, 3, 10, 10, 30, 0, 0) for immediate invoices and '2020-10-28' for scheduled invoices
+  # - expiration [integer, default 604800]: time interval in seconds between scheduled date and expiration date. ex: 123456789
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['employees', 'monthly']
+  # - descriptions [list of CreditNote::Invoice::Description objects or hash, default nil]: list Description objects. ex: [Description.new()]
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when Invoice is created. ex: '5656565656565656'
+  # - name [string]: payer name. ex: 'Iron Bank S.A.'
+  # - tax_id [string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  # - pdf [string]: public Invoice PDF URL. ex: 'https://invoice.starkbank.com/pdf/d454fa4e524441c1b0c1a729457ed9d8'
+  # - link [string]: public Invoice webpage URL. ex: 'https://my-workspace.sandbox.starkbank.com/invoicelink/d454fa4e524441c1b0c1a729457ed9d8'
+  # - fine [float, default 2.0]: Invoice fine for overdue payment in %. ex: 2.5
+  # - interest [float, default 1.0]: Invoice monthly interest in overdue payment in %. ex: 5.2
+  # - nominal_amount [integer]: Invoice emission value in cents (will change if invoice is updated, but not if it's paid). ex: 400000
+  # - fine_amount [integer]: Invoice fine value calculated over nominal_amount. ex: 20000
+  # - interest_amount [integer]: Invoice interest value calculated over nominal_amount. ex: 10000
+  # - discount_amount [integer]: Invoice discount value calculated over nominal_amount. ex: 3000
+  # - discounts [list of CreditNote::Invoice::Discount objects]: list of Discount objects. ex: [Discount.new()]
+  # - brcode [string]: BR Code for the Invoice payment. ex: '00020101021226800014br.gov.bcb.pix2558invoice.starkbank.com/f5333103-3279-4db2-8389-5efe335ba93d5204000053039865802BR5913Arya Stark6009Sao Paulo6220051656565656565656566304A9A0'
+  # - status [string]: current Invoice status. ex: 'registered' or 'paid'
+  # - fee [integer]: fee charged by this Invoice. ex: 200 (= R$ 2.00).
+  # - transaction_ids [list of strings]: ledger transaction ids linked to this Invoice (if there are more than one, all but the first are reversals or failed reversal chargebacks). ex: ['19827356981273']
+  # - created [DateTime]: creation datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class Invoice < StarkInfra::Utils::Resource
+    attr_reader :amount, :id, :due, :expiration, :tags, :descriptions, :name, :tax_id, :pdf, :link, :fine, :interest,
+                :nominal_amount, :fine_amount, :interest_amount, :discount_amount, :discounts, :brcode, :status, :fee,
+                :transaction_ids, :created, :updated
+    def initialize(
+      amount:, id: nil,  due: nil, expiration: nil, tags: nil, descriptions: nil, name: nil, tax_id: nil,
+      pdf: nil, link: nil, fine: nil, interest: nil, nominal_amount: nil, fine_amount: nil,
+      interest_amount: nil, discount_amount: nil, discounts: nil, brcode: nil, status: nil, fee: nil,
+      transaction_ids: nil, created: nil, updated: nil
+    )
+      super(id)
+      @tax_id = tax_id
+      @amount = amount
+      @due = due
+      @expiration = expiration
+      @tags = tags
+      @descriptions = Description.parse_descriptions(descriptions)
+      @name = name
+      @tax_id = tax_id
+      @pdf = pdf
+      @link = link
+      @fine = fine
+      @interest = interest
+      @nominal_amount = nominal_amount
+      @fine_amount = fine_amount
+      @interest_amount = interest_amount
+      @discount_amount = discount_amount
+      @discounts = Discount.parse_discounts(discounts)
+      @brcode = brcode
+      @status = status
+      @fee = fee
+      @transaction_ids = transaction_ids
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+    end
+
+    def self.parse_invoices(invoices)
+      resource_maker = StarkInfra::Invoice.resource[:resource_maker]
+      return invoices if invoices.nil?
+
+      parsed_invoices = []
+      invoices.each do |invoice|
+        unless invoice.is_a? Invoice
+          invoice = StarkInfra::Utils::API.from_api_json(resource_maker, invoice)
+        end
+        parsed_invoices << invoice
+      end
+      parsed_invoices
+    end
+
+    def self.resource
+      {
+        resource_name: 'Invoice',
+        resource_maker: proc { |json|
+          Invoice.new(
+            id: json['id'],
+            amount: json['amount'],
+            due: json['due'],
+            expiration: json['expiration'],
+            fine: json['fine'],
+            interest: json['interest'],
+            tags: json['tags'],
+            descriptions: json['descriptions'],
+            name: json['name'],
+            tax_id: json['tax_id'],
+            pdf: json['pdf'],
+            link: json['link'],
+            nominal_amount: json['nominal_amount'],
+            fine_amount: json['fine_amount'],
+            interest_amount: json['interest_amount'],
+            discount_amount: json['discount_amount'],
+            discounts: json['discounts'],
+            brcode: json['brcode'],
+            status: json['status'],
+            fee: json['fee'],
+            transaction_ids: json['transaction_ids'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/creditnote/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require_relative('creditnote')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
-require_relative('creditnote')
+require_relative('../utils/resource')
 
 module StarkInfra
   class CreditNote
@@ -13,25 +13,25 @@ module StarkInfra
     # is generated for the entity. This log is never generated by the
     # user.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
-    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-    # - type [string]: type of the CreditNote event which triggered the log creation. Options: 'canceled', 'created', 'expired', 'failed', 'refunded', 'registered', 'sending', 'sent', 'signed', 'success'
-    # - errors [list of strings]: list of errors linked to this CreditNote event.
     # - note [CreditNote]: CreditNote entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this CreditNote event.
+    # - type [string]: type of the CreditNote event which triggered the log creation. Options: 'canceled', 'created', 'expired', 'failed', 'refunded', 'registered', 'sending', 'sent', 'signed', 'success'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
     class Log < StarkInfra::Utils::Resource
       attr_reader :id, :created, :type, :errors, :note
       def initialize(id:, created:, type:, errors:, note:)
         super(id)
-        @created = StarkInfra::Utils::Checks.check_datetime(created)
-        @type = type
-        @errors = errors
         @note = note
+        @errors = errors
+        @type = type
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific CreditNote::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single CreditNote::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -45,12 +45,11 @@ module StarkInfra
         StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
-      # # Retrieve Logs
+      # # Retrieve CreditNote::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of CreditNote::Log objects previously created in the Stark Infra API
       #
       # ## Parameters (optional):
-      # - ids [list of strings, default nil]: Log ids to filter PixKey Logs. ex: ['5656565656565656']
       # - 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)
@@ -74,9 +73,9 @@ module StarkInfra
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged CreditNote::Logs
       #
-      # Receive a list of up to 100 Log objects previously created in the Stark Infra API and the cursor to the next page.
+      # Receive a list of up to 100 CreditNote::Log 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 notes.
       #
       # ## Parameters (optional):
@@ -113,10 +112,10 @@ module StarkInfra
           resource_maker: proc { |json|
             Log.new(
               id: json['id'],
-              created: json['created'],
-              type: json['type'],
+              note: StarkInfra::Utils::API.from_api_json(note_maker, json['note']),
               errors: json['errors'],
-              note: StarkInfra::Utils::API.from_api_json(note_maker, json['note'])
+              type: json['type'],
+              created: json['created']
             )
           }
         }

data/lib/creditnote/transfer.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative('../utils/api')
+require_relative('../utils/rest')
+require_relative('../utils/sub_resource')
+
+module StarkInfra
+
+  # # CreditNote::Transfer object
+  #
+  # Transfer sent to the credit receiver after the contract is signed.
+  #
+  # ## Parameters (required):
+  # - name [string]: receiver full name. ex: 'Anthony Edward Stark'
+  # - tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  # - bank_code [string]: code of the receiver bank institution in Brazil. ex: '20018183'
+  # - branch_code [string]: receiver bank account branch. Use '-' in case there is a verifier digit. ex: '1357-9'
+  # - account_number [string]: receiver bank account number. Use '-' before the verifier digit. ex: '876543-2'
+  #
+  # ## Parameters (optional):
+  # - account_type [string, default 'checking']: Receiver bank account type. This parameter only has effect on Pix Transfers. ex: 'checking', 'savings', 'salary' or 'payment'
+  # - tags [list of strings, default nil]: list of strings for reference when searching for transfers. ex: ['employees', 'monthly']
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the transfer is created. ex: '5656565656565656'
+  # - amount [integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34)
+  # - external_id [string]: url safe string that must be unique among all your transfers. Duplicated external_ids will cause failures. By default, this parameter will block any transfer that repeats amount and receiver information on the same date. ex: 'my-internal-id-123456'
+  # - scheduled [DateTime]: date or datetime when the transfer will be processed. May be pushed to next business day if necessary. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - description [string]: optional description to override default description to be shown in the bank statement. ex: 'Payment for service #1234'
+  # - fee [integer]: fee charged when the Transfer is processed. ex: 200 (= R$ 2.00)
+  # - status [string]: current transfer status. ex: 'success' or 'failed'
+  # - transaction_ids [list of strings]: ledger Transaction IDs linked to this Transfer (if there are two, the second is the chargeback). ex: ['19827356981273']
+  # - created [DateTime]: creation datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class Transfer < StarkInfra::Utils::Resource
+    attr_reader :id, :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :tags, :amount, :external_id,
+                :scheduled, :description, :fee, :status, :created, :updated, :transaction_ids
+    def initialize(
+      name:, tax_id:, bank_code:, branch_code:, account_number:, account_type: nil,
+      tags: nil, id: nil, amount: nil, external_id: nil, scheduled: nil,
+      description: nil, fee: nil, status: nil, created: nil, updated: nil,
+      transaction_ids: nil
+    )
+      super(id)
+      @name = name
+      @tax_id = tax_id
+      @bank_code = bank_code
+      @branch_code = branch_code
+      @account_number = account_number
+      @account_type = account_type
+      @tags = tags
+      @amount = amount
+      @external_id = external_id
+      @scheduled = scheduled
+      @description = description
+      @fee = fee
+      @status = status
+      @transaction_ids = transaction_ids
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+    end
+
+    def self.resource
+      {
+        resource_name: 'Transfer',
+        resource_maker: proc { |json|
+          Transfer.new(
+            id: json['id'],
+            name: json['name'],
+            tax_id: json['tax_id'],
+            bank_code: json['bank_code'],
+            branch_code: json['branch_code'],
+            account_number: json['account_number'],
+            amount: json['amount'],
+            account_type: json['account_type'],
+            external_id: json['external_id'],
+            scheduled: json['scheduled'],
+            description: json['description'],
+            tags: json['tags'],
+            fee: json['fee'],
+            status: json['status'],
+            created: json['created'],
+            updated: json['updated'],
+            transaction_ids: json['transaction_ids']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/creditpreview/creditnotepreview.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative('../utils/api')
+require_relative('../utils/rest')
+require_relative('../utils/sub_resource')
+
+module StarkInfra
+  # # CreditNotePreview object
+  #
+  # A CreditNotePreview is used to preview a CCB contract between the borrower and lender with a specific table type.
+  #
+  # When you initialize a CreditPreview, 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]: table type that defines the amortization system. Options: 'sac', 'price', 'american', 'bullet', 'custom'
+  # - nominal_amount [integer]: amount in cents transferred to the credit receiver, before deductions. ex: 11234 (= R$ 112.34)
+  # - scheduled [DateTime, Date or string]: date of transfer execution. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - tax_id [string]: credit receiver's tax ID (CPF or CNPJ). ex: '20.018.183/0001-80'
+  #
+  # ## Parameters (conditionally required):
+  # - invoices [list of CreditNote::Invoice objects]: list of CreditNote.Invoice objects to be created and sent to the credit receiver.
+  # - nominal_interest [float]: yearly nominal interest rate of the credit note, in percentage. ex: 12.5
+  # - initial_due [DateTime, Date or string]: date of the first invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0), Date.new(2020, 3, 10) or '2020-03-10'
+  # - count [integer]: quantity of invoices for payment. ex: 12
+  # - initial_amount [integer]: value of the first invoice in cents. ex: 1234 (= R$12.34)
+  # - interval [string]: interval between invoices. ex: 'year', 'month'
+  #
+  # ## Parameters (optional):
+  # - rebate_amount [integer, default nil]: credit analysis fee deducted from lent amount. ex: 11234 (= R$ 112.34)
+  #
+  # ## Attributes (return-only):
+  # - amount [integer]: credit note value in cents. ex: 1234 (= R$ 12.34)
+  # - interest [float]: yearly effective interest rate of the credit note, in percentage. ex: 12.5
+  # - tax_amount [integer]: tax amount included in the credit note. ex: 100
+  class CreditNotePreview < StarkInfra::Utils::SubResource
+    attr_reader :type, :nominal_amount, :scheduled, :tax_id, :invoices, :nominal_interest, :initial_due, :count,
+                :initial_amount, :interval, :rebate_amount, :amount, :interest, :tax_amount
+    def initialize(
+      type:, nominal_amount:, scheduled:, tax_id:, invoices: nil, nominal_interest: nil,
+      initial_due: nil, count: nil, initial_amount: nil, interval: nil, rebate_amount: nil,
+      amount: nil, interest: nil, tax_amount: nil
+    )
+      @type = type
+      @nominal_amount = nominal_amount
+      @scheduled = scheduled
+      @tax_id = tax_id
+      @invoices = Invoice.parse_invoices(invoices)
+      @nominal_interest = nominal_interest
+      @initial_due = initial_due
+      @count = count
+      @initial_amount = initial_amount
+      @interval = interval
+      @rebate_amount = rebate_amount
+      @amount = amount
+      @interest = interest
+      @tax_amount = tax_amount
+    end
+
+    def self.resource
+      {
+        resource_name: 'CreditNotePreview',
+        resource_maker: proc { |json|
+          CreditNotePreview.new(
+            type: json['type'],
+            nominal_amount: json['nominal_amount'],
+            scheduled: json['scheduled'],
+            tax_id: json['tax_id'],
+            invoices: json['invoices'],
+            nominal_interest: json['nominal_interest'],
+            initial_due: json['initial_due'],
+            count: json['count'],
+            initial_amount: json['initial_amount'],
+            interval: json['interval'],
+            rebate_amount: json['rebate_amount'],
+            amount: json['amount'],
+            interest: json['interest'],
+            tax_amount: json['tax_amount']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/creditpreview/creditpreview.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative('../utils/api')
+require_relative('../utils/rest')
+require_relative('../utils/sub_resource')
+
+module StarkInfra
+  # # CreditPreview object
+  #
+  # A CreditPreview is used to get information from a credit before taking it.
+  # This resource can be used to preview credit notes.
+  #
+  # ## Parameters (required):
+  # - credit [CreditNotePreview object]: Information preview of the informed credit.
+  # - type [string]: Credit type. ex: "credit-note"
+  class CreditPreview < StarkInfra::Utils::SubResource
+    attr_reader :credit, :type
+    def initialize(credit:, type: nil)
+      credit_info = CreditPreview.parse_credit(credit, type)
+      @credit = credit_info['credit']
+      @type = credit_info['type']
+
+    end
+
+    # # Create CreditPreviews
+    #
+    # Send a list of CreditPreview objects for processing in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - previews [list of CreditPreview objects]: list of CreditPreview 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 CreditPreview objects with updated attributes
+    def self.create(previews, user: nil)
+      StarkInfra::Utils::Rest.post(entities: previews, user: user, **resource)
+    end
+
+    def self.parse_credit(credit, type)
+      resource_maker = { 'credit-note' => StarkInfra::CreditNotePreview.resource[:resource_maker] }
+      if credit.is_a?(Hash)
+        begin
+          parsed_credit = StarkInfra::Utils::API.from_api_json(resource_maker[type], credit)
+          return { 'credit' => parsed_credit, 'type' => type }
+
+        rescue StandardError
+          return { 'credit' => credit, 'type' => type }
+
+        end
+      end
+
+      return { 'credit' => credit, 'type' => type } if type
+
+      if credit.class == StarkInfra::CreditNotePreview
+        return { 'credit' => credit, 'type' => 'credit-note' }
+
+      end
+
+      raise 'credit must be either ' + 'a dictionary, ' \
+              'a CreditNote.CreditNotePreview, but not a ' + credit.class.to_s
+    end
+
+    def self.resource
+      {
+        resource_name: 'CreditPreview',
+        resource_maker: proc { |json|
+          CreditPreview.new(
+            credit: json['credit'],
+            type: json['type']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/creditsigner/creditsigner.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+require_relative('../utils/parse')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
+
+module StarkInfra
+  # # CreditSigner object
+  #
+  # CreditNote signer's information.
+  #
+  # ## Parameters (required):
+  # - name [string]: signer's name. ex: 'Tony Stark'
+  # - contact [string]: signer's contact information. ex: 'tony@starkindustries.com'
+  # - method [string]: delivery method for the contract. ex: 'link'
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the CreditSigner is created. ex: '5656565656565656'
+  class CreditSigner < StarkInfra::Utils::Resource
+    attr_reader :name, :contact, :method, :id
+    def initialize(name:, contact:, method:, id: nil)
+      super(id)
+      @name = name
+      @contact = contact
+      @method = method
+    end
+
+    def self.parse_signers(signers)
+      resource_maker = StarkInfra::CreditSigner.resource[:resource_maker]
+      return signers if signers.nil?
+
+      parsed_signers = []
+      signers.each do |signer|
+        unless signer.is_a? CreditSigner
+          signer = StarkInfra::Utils::API.from_api_json(resource_maker, signer)
+        end
+        parsed_signers << signer
+      end
+      parsed_signers
+    end
+
+    def self.resource
+      {
+        resource_name: 'CreditSigner',
+        resource_maker: proc { |json|
+          CreditSigner.new(
+            id: json['id'],
+            name: json['name'],
+            contact: json['contact'],
+            method: json['method']
+          )
+        }
+      }
+    end
+  end
+end