starkbank 2.1.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21f296f6ce46e6451eb4650fcc5bd8f77b657184b10662daae70c79c4df26cc3
-  data.tar.gz: 2a0355e608aa51c1302ea55c8491741981afbfefd2bb86f56fb606fc4ab38c76
+  metadata.gz: 865e407d8c6cc8b02de3bbe91e5303ae996234867282f163a14f495fcdb5408c
+  data.tar.gz: 96d199d34eabfd9694a55b1b435d84aa008a71dd697141b106b2373b11625070
 SHA512:
-  metadata.gz: cce7c99b52dc834e4110caa9861a89dbb039d02d080d17631995666298798f6c1ca7024796958cc170d7f08d5a594a8f8ee4bb98078f8897e75a8455dad55987
-  data.tar.gz: 2e5c9d0a3d0f33b050f08b29e35453db3011190760145aec59a87a993a1086c038e9d430004cd8bdf7fe1ef657d08554d4eea4fec14d5e9d2692f57df71808c5
+  metadata.gz: db7c4ff0fb3fc908b2d68c16f984b685a9181e0fc7d43bb2ae5e6085c10778ff91e4fee4575b37ca03379ca976a131039d5a4fdb626757f9b53427336740b621
+  data.tar.gz: e3b1397b1b8b494f22469d6c8a3b74cd8165498096958d748bbbfeca4d7511efa6c599854b06a6be6d48af7aac1afb2184924d845894a72a08ed0084b4b8b85f

data/lib/balance/balance.rb

@@ -31,7 +31,7 @@ module StarkBank
     # Receive the Balance object linked to your workspace in the Stark Bank API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Balance object with updated attributes

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
@@ -82,7 +82,7 @@ module StarkBank
     # - boletos [list of Boleto objects]: list of Boleto objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of Boleto objects with updated attributes
@@ -98,7 +98,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Boleto object with updated attributes
@@ -115,12 +115,13 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - layout [string]: Layout specification. Available options are "default" and "booklet"
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - hidden_fields [list of strings, default nil]: List of string fields to be hidden in Boleto pdf. ex: ["customerAddress"]
+    # - user [Organization/Project object]: Organization or 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
@@ -134,7 +135,7 @@ module StarkBank
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
     # - 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
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of Boleto objects with updated attributes
@@ -161,7 +162,7 @@ module StarkBank
     # - id [string]: Boleto unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted Boleto object

data/lib/boleto/log.rb

@@ -38,7 +38,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -56,7 +56,7 @@ module StarkBank
       # - 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 for log event types. ex: 'paid' or 'registered'
       # - boleto_ids [list of strings, default nil]: list of Boleto ids to filter logs. ex: ['5656565656565656', '4545454545454545']
-      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

data/lib/boleto_holmes/boleto_holmes.rb

@@ -45,7 +45,7 @@ module StarkBank
     # - holmes [list of BoletoHolmes objects]: list of BoletoHolmes objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of BoletoHolmes objects with updated attributes
@@ -61,7 +61,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - BoletoHolmes object with updated attributes
@@ -81,7 +81,7 @@ module StarkBank
     # - 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']
     # - boleto_id [string, default nil]: filter for holmes that investigate a specific boleto by its ID. ex: '5656565656565656'
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of BoletoHolmes objects with updated attributes

data/lib/boleto_holmes/log.rb

@@ -36,7 +36,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -54,7 +54,7 @@ module StarkBank
       # - 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 for log event types. ex: 'paid' or 'registered'
       # - holmes_ids [list of strings, default nil]: list of BoletoHolmes ids to filter logs. ex: ['5656565656565656', '4545454545454545']
-      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

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
@@ -53,7 +53,7 @@ module StarkBank
     # - payments [list of BoletoPayment objects]: list of BoletoPayment objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of BoletoPayment objects with updated attributes
@@ -69,7 +69,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - BoletoPayment object with updated attributes
@@ -86,7 +86,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - BoletoPayment pdf file
@@ -105,7 +105,7 @@ module StarkBank
     # - 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
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
     #
     # ## Return:
     # - generator of BoletoPayment objects with updated attributes
@@ -131,7 +131,7 @@ module StarkBank
     # Parameters (required):
     # - id [string]: BoletoPayment unique id. ex: '5656565656565656'
     # Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     # Return:
     # - deleted BoletoPayment object
     def self.delete(id, user: nil)

data/lib/boleto_payment/log.rb

@@ -38,7 +38,7 @@ module StarkBank
       # - id [string]: object unique id. ex: '5656565656565656'
       #
       # ## Parameters (optional):
-      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
       #
       # ## Return:
       # - Log object with updated attributes
@@ -54,9 +54,9 @@ 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
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

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 [Organization/Project object]: Organization or 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 [Organization/Project object]: Organization or 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 [Organization/Project object]: Organization or 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 [Organization/Project object]: Organization or 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 [Organization/Project object]: Organization or 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 [Organization/Project object]: Organization or 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 [Organization/Project object]: Organization or 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