starkbank 2.1.0.beta1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9da63502c7b5223de6fb3dd146b38f1bbb812ea44db8be8ed224090ed47d730b
-  data.tar.gz: 5a13dfc89a11da6e3283534c63d4a7d168c3d433f6e0817f45cb30c883a6bd9d
+  metadata.gz: b51d2704eb7609e1e76b616bbb3ac74bdb1a0ae8685db2c518c676a6005c7e16
+  data.tar.gz: 7f87b9c3f526aeb6ae7e2d7c20f1f1030954fa5db92cdac8247699085eb12914
 SHA512:
-  metadata.gz: 52b9461b3caca3b5185afa5818e240f02f2a0de5efe475fdce336f40120b1d46a6a9fec604ceb67bee7221d7f5af89a8b6ce2110aaaf092b903c56d460aa1464
-  data.tar.gz: 3d61fc51d7ddebd01bba544f2d43f8af70e34de78295b505f02e16f9c45832980304038e4397afb43b8c752ec622ccf7ddd1e815e83ae99602619a82a386cd8b
+  metadata.gz: 1fd6a1aa52db6930d017f2406ab328b3d0e625c087e95cee42aa67d45f8973b5e29173f56d05f01ef7f0a8a540699be5be798b9232db7be1c955935baa5bb812
+  data.tar.gz: 29fcbe0b5670e70339b186354f9d58057e2cdfa7278c0e0ad895f30c7b2b73e1164566fac49ada85b49a251099d7c705932b245bd9ffdf986f550b0d31f74960

data/lib/boleto/boleto.rb

@@ -58,7 +58,7 @@ module StarkBank
       @city = city
       @state_code = state_code
       @zip_code = zip_code
-      @due = due
+      @due = StarkBank::Utils::Checks.check_date(due)
       @fine = fine
       @interest = interest
       @overdue_limit = overdue_limit
@@ -115,12 +115,13 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - layout [string]: Layout specification. Available options are "default" and "booklet"
+    # - hidden_fields [list of strings, default nil]: List of string fields to be hidden in Boleto pdf. ex: ["customerAddress"]
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Boleto pdf file
-    def self.pdf(id, layout: nil, user: nil)
-      StarkBank::Utils::Rest.get_pdf(id: id, layout: layout, user: user, **resource)
+    def self.pdf(id, layout: nil, hidden_fields: nil, user: nil)
+      StarkBank::Utils::Rest.get_pdf(id: id, layout: layout, hidden_fields: hidden_fields, user: user, **resource)
     end
 
     # # Retrieve Boletos

data/lib/boleto_payment/boleto_payment.rb

@@ -37,7 +37,7 @@ module StarkBank
       @description = description
       @line = line
       @bar_code = bar_code
-      @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
+      @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
       @tags = tags
       @status = status
       @amount = amount

data/lib/boleto_payment/log.rb

@@ -54,7 +54,7 @@ module StarkBank
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
       # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
       # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
-      # - types [list of strings, default nil]: filter retrieved objects by event types. ex: 'paid' or 'registered'
+      # - types [list of strings, default nil]: filter retrieved objects by event types. ex: 'success' or 'failed'
       # - payment_ids [list of strings, default nil]: list of BoletoPayment ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
       # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
       #

data/lib/brcode_payment/brcode_payment.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # BrcodePayment object
+  #
+  # When you initialize a BrcodePayment, the entity will not be automatically
+  # created in the Stark Bank API. The 'create' function sends the objects
+  # to the Stark Bank API and returns the list of created objects.
+  #
+  # ## Parameters (required):
+  # - brcode [string]: String loaded directly from the QRCode or copied from the invoice. ex: "00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A"
+  # - tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: "01234567890" or "20.018.183/0001-80"
+  # - description [string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC"
+  #
+  # ## Parameters (conditionally required):
+  # - amount [int, default nil]: If the BRCode does not provide an amount, this parameter is mandatory, else it is optional. ex: 23456 (= R$ 234.56)
+  #
+  # ## Parameters (optional):
+  # - scheduled [datetime.date, datetime.datetime or string, default now]: payment scheduled date or datetime. ex: datetime.datetime(2020, 3, 10, 15, 17, 3)
+  # - tags [list of strings, default nil]: list of strings for tagging
+  #
+  # ## Attributes (return-only):
+  # - id [string, default nil]: unique id returned when payment is created. ex: "5656565656565656"
+  # - status [string, default nil]: current payment status. ex: "success" or "failed"
+  # - type [string, default nil]: brcode type. ex: "static" or "dynamic"
+  # - fee [integer, default nil]: fee charged when the brcode payment is created. ex: 200 (= R$ 2.00)
+  # - updated [datetime.datetime, default nil]: latest update datetime for the payment. ex: datetime.datetime(2020, 3, 10, 10, 30, 0, 0)
+  # - created [datetime.datetime, default nil]: creation datetime for the payment. ex: datetime.datetime(2020, 3, 10, 10, 30, 0, 0)
+  class BrcodePayment < StarkBank::Utils::Resource
+    attr_reader :brcode, :tax_id, :description, :amount, :scheduled, :tags, :id, :status, :type, :fee, :updated, :created
+    def initialize(brcode:, tax_id:, description:, amount: nil, scheduled: nil, tags: nil, id: nil, status: nil, type: nil, fee: nil, updated: nil, created: nil)
+      super(id)
+      @brcode = brcode
+      @tax_id = tax_id
+      @description = description
+      @amount = amount
+      @scheduled = StarkBank::Utils::Checks.check_date_or_datetime(scheduled)
+      @tags = tags
+      @status = status
+      @type = type
+      @fee = fee
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create BrcodePayments
+    #
+    # Send a list of BrcodePayment objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - payments [list of BrcodePayment objects]: list of BrcodePayment objects to be created in the API
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of BrcodePayment objects with updated attributes
+    def self.create(payments, user: nil)
+      StarkBank::Utils::Rest.post(entities: payments, user: user, **resource)
+    end
+
+    # # Retrieve a specific BrcodePayment
+    #
+    # Receive a single BrcodePayment object previously created by the Stark Bank API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - BrcodePayment object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve a specific BrcodePayment pdf file
+    #
+    # Receive a single BrcodePayment pdf file generated in the Stark Bank API by passing its id.
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - BrcodePayment pdf file
+    def self.pdf(id, user: nil)
+      StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
+    end
+
+    # # Update a BrcodePayment entity
+    #
+    # Update a BrcodePayment entity previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - id [string]: BrcodePayment unique id. ex: '5656565656565656'
+    # - status [string, nil]: You may cancel the payment by passing 'canceled' in the status
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - updated BrcodePayment object
+    def self.update(id, status: nil, user: nil)
+      StarkBank::Utils::Rest.patch_id(id: id, status: status, user: user, **resource)
+    end
+
+    # # Retrieve BrcodePayments
+    #
+    # Receive a generator of BrcodePayment objects previously created in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - ids [list of strings, default nil]: list of strings to get specific entities by ids. ex: ['12376517623', '1928367198236']
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid'
+    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of BrcodePayment objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, tags: nil, ids: nil, status: nil, user: nil)
+      after = StarkBank::Utils::Checks.check_date(after)
+      before = StarkBank::Utils::Checks.check_date(before)
+      StarkBank::Utils::Rest.get_list(
+        user: user,
+        limit: limit,
+        after: after,
+        before: before,
+        tags: tags,
+        ids: ids,
+        status: status,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'BrcodePayment',
+        resource_maker: proc { |json|
+          BrcodePayment.new(
+            brcode: json['brcode'],
+            tax_id: json['tax_id'],
+            description: json['description'],
+            amount: json['amount'],
+            scheduled: json['scheduled'],
+            tags: json['tags'],
+            id: json['id'],
+            status: json['status'],
+            type: json['type'],
+            fee: json['fee'],
+            updated: json['updated'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/brcode_payment/log.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('brcode_payment')
+
+module StarkBank
+  class BrcodePayment
+    # # BrcodePayment::Log object
+    #
+    # Every time a BrcodePayment entity is modified, a corresponding BrcodePayment::Log
+    # is generated for the entity. This log is never generated by the
+    # user, but it can be retrieved to check additional information
+    # on the BrcodePayment.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - payment [BrcodePayment]: BrcodePayment entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this BrcodePayment event.
+    # - type [string]: type of the BrcodePayment event which triggered the log creation. ex: 'processing' or 'success'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkBank::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :payment
+      def initialize(id:, created:, type:, errors:, payment:)
+        super(id)
+        @type = type
+        @errors = errors
+        @payment = payment
+        @created = StarkBank::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific Log
+      #
+      # Receive a single Log object previously created by the Stark Bank API by passing its id
+      #
+      # ## Parameters (required):
+      # - id [string]: object unique id. ex: '5656565656565656'
+      #
+      # ## Parameters (optional):
+      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      #
+      # ## Return:
+      # - Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve Logs
+      #
+      # Receive a generator of Log objects previously created in the Stark Bank API
+      #
+      # ## Parameters (optional):
+      # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+      # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+      # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+      # - types [list of strings, default nil]: filter retrieved objects by event types. ex: 'success' or 'failed'
+      # - payment_ids [list of strings, default nil]: list of BrcodePayment ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      #
+      # ## Return:
+      # - list of Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, payment_ids: nil, user: nil)
+        after = StarkBank::Utils::Checks.check_date(after)
+        before = StarkBank::Utils::Checks.check_date(before)
+        StarkBank::Utils::Rest.get_list(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          payment_ids: payment_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        payment_maker = StarkBank::BrcodePayment.resource[:resource_maker]
+        {
+          resource_name: 'BrcodePaymentLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              payment: StarkBank::Utils::API.from_api_json(payment_maker, json['payment'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/brcode_preview/brcode_preview.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # BrcodePreview object
+  #
+  # A BrcodePreview is used to get information from a BR Code you received to check the informations before paying it.
+  #
+  # ## Attributes (return-only):
+  # - status [string]: Payment status. ex: 'active', 'paid', 'canceled' or 'unknown'
+  # - name [string]: Payment receiver name. ex: 'Tony Stark'
+  # - tax_id [string]: Payment receiver tax ID. ex: '012.345.678-90'
+  # - bank_code [string]: Payment receiver bank code. ex: '20018183'
+  # - branch_code [string]: Payment receiver branch code. ex: '0001'
+  # - account_number [string]: Payment receiver account number. ex: '1234567'
+  # - account_type [string]: Payment receiver account type. ex: 'checking'
+  # - allow_change [bool]: If True, the payment is able to receive amounts that are diferent from the nominal one. ex: True or False
+  # - amount [integer]: Value in cents that this payment is expecting to receive. If 0, any value is accepted. ex: 123 (= R$1,23)
+  # - reconciliation_id [string]: Reconciliation ID linked to this payment. ex: 'txId', 'payment-123'
+  class BrcodePreview < StarkBank::Utils::Resource
+    attr_reader :status, :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :allow_change, :amount, :reconciliation_id
+    def initialize(status:, name:, tax_id:, bank_code:, branch_code:, account_number:, account_type:, allow_change:, amount:, reconciliation_id:)
+      @status = status
+      @name = name
+      @tax_id = tax_id
+      @bank_code = bank_code
+      @branch_code = branch_code
+      @account_number = account_number
+      @account_type = account_type
+      @allow_change = allow_change
+      @amount = amount
+      @reconciliation_id = reconciliation_id
+    end
+
+    # # Retrieve BrcodePreviews
+    #
+    # Receive a generator of BrcodePreview objects previously created in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - brcodes [list of strings]: List of brcodes to preview. ex: %w[00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A]
+    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of BrcodePreview objects with updated attributes
+    def self.query(limit: nil, brcodes: nil, user: nil)
+      StarkBank::Utils::Rest.get_list(
+        user: user,
+        limit: nil,
+        brcodes: brcodes,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'BrcodePreview',
+        resource_maker: proc { |json|
+          BrcodePreview.new(
+            status: json['status'],
+            name: json['name'],
+            tax_id: json['tax_id'],
+            bank_code: json['bank_code'],
+            branch_code: json['branch_code'],
+            account_number: json['account_number'],
+            account_type: json['account_type'],
+            allow_change: json['allow_change'],
+            amount: json['amount'],
+            reconciliation_id: json['reconciliation_id']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/deposit/deposit.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # Deposit object
+  #
+  # Deposits represent passive cash-in received by your account from external transfers
+  #
+  ## Attributes (return-only):
+  # - id [string]: unique id associated with a Deposit when it is created. ex: '5656565656565656'
+  # - name [string]: payer name. ex: 'Iron Bank S.A.'
+  # - tax_id [string]: payer tax ID (CPF or CNPJ). ex: '012.345.678-90' or '20.018.183/0001-80'
+  # - bank_code [string]: payer bank code in Brazil. ex: '20018183' or '341'
+  # - branch_code [string]: payer bank account branch. ex: '1357-9's
+  # - account_number [string]: payer bank account number. ex: '876543-2'
+  # - amount [integer]: Deposit value in cents. ex: 1234 (= R$ 12.34)
+  # - type [string]: Type of settlement that originated the deposit. ex: 'pix' or 'ted'
+  # - status [string]: current Deposit status. ex: 'created'
+  # - tags [list of strings]: list of strings that are tagging the deposit. ex: ['reconciliationId', 'txId']
+  # - fee [integer]: fee charged by this deposit. ex: 50 (= R$ 0.50)
+  # - transaction_ids [list of strings]: ledger transaction ids linked to this Deposit (if there are more than one, all but first are reversals). ex: ['19827356981273']
+  # - created [datetime.datetime]: creation datetime for the Deposit. ex: datetime.datetime(2020, 12, 10, 10, 30, 0, 0)
+  # - updated [datetime.datetime]: latest update datetime for the Deposit. ex: datetime.datetime(2020, 12, 10, 10, 30, 0, 0)
+  class Deposit < StarkBank::Utils::Resource
+    attr_reader :id, :name, :tax_id, :bank_code, :branch_code, :account_number, :amount, :type, :status, :tags, :fee, :transaction_ids, :created, :updated
+    def initialize(
+      id:, name:, tax_id:, bank_code:, branch_code:, account_number:, amount:, type:, status:, tags:, fee:,
+      transaction_ids:, created:, updated:
+    )
+      super(id)
+      @name = name
+      @tax_id = tax_id
+      @bank_code = bank_code
+      @branch_code = branch_code
+      @account_number = account_number
+      @amount = amount
+      @type = type
+      @status = status
+      @tags = tags
+      @fee = fee
+      @transaction_ids = transaction_ids
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Retrieve a specific Deposit
+    #
+    # Receive a single Deposit object previously created in the Stark Bank API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - Deposit object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve Deposits
+    #
+    # Receive a generator of Deposit objects previously created in the Stark Bank API
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date , DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
+    # - sort [string, default '-created']: sort order considered in response. Valid options are 'created' or '-created'.
+    # - 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 [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of Deposit objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, sort: nil, tags: nil, ids: nil, user: nil)
+      after = StarkBank::Utils::Checks.check_date(after)
+      before = StarkBank::Utils::Checks.check_date(before)
+      StarkBank::Utils::Rest.get_list(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        sort: sort,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'Deposit',
+        resource_maker: proc { |json|
+          Deposit.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'],
+            type: json['type'],
+            status: json['status'],
+            tags: json['tags'],
+            fee: json['fee'],
+            transaction_ids: json['transaction_ids'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end