starkinfra 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c35da5e6496d5271ac8467f26b02a3776d21dec476d4eb526d7a8e503f8bbc9
-  data.tar.gz: 0115cfd4453a7fcf939a3601611e6e1b96ff78e00f310c7c5d25df4ef42dbcb5
+  metadata.gz: 61eb746142fdcedb5bb2668292aaee6995c898114b0abea9a545e49593a005ac
+  data.tar.gz: '04082c73ccc17fd54b98b81d3ff05672c05a9d674fc5585745167eafcbda2153'
 SHA512:
-  metadata.gz: 95db214920f662bab0fcfaa10353e971a75bf32822402c44d071e1c15bde66e3a607b90f887a6b709d3b97faca5ed3496c1d757534f819e684493da145cf1069
-  data.tar.gz: 94eae035e2920bf65d23074dad0179c9d90b72b78f0b5d8c66a8fadc310c9c110f33ef02a6d1ee2ab80ec9329fd75be5b037165afe656a9173a939daa2fec6b5
+  metadata.gz: d61b4d1ab3e1569d5dd4ab63f18c94fe7f566cdb1486f4601d64e87be2f848026b1bcf7573592cefed3e73bc786fd11da776e0a860618f86b25456e4aaac8939
+  data.tar.gz: b57a0caaeb2a8c7c26330f18bca61a8e073186ffff1f83d95888c704bcc57919d76aa1a4a6c29d02a87c462a3e5bf41151802d52a5da80ee12584d449974c4ca

data/lib/{brcodepreview/brcodepreview.rb → brcode_preview/brcode_preview.rb}

@@ -34,16 +34,17 @@ module StarkInfra
   # - 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'
+  # - subscription [BrcodePreview::Subscription, default nil]: snapshot of the recurring-debit subscription attached to the BR Code, when present. Nil for one-shot BR Codes.
   # - tax_id [string]: Payment receiver tax ID. ex: '012.345.678-90'
   class BrcodePreview < StarkCore::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
+                :nominal_amount, :reconciliation_id, :reduction_amount, :scheduled, :status, :subscription, :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
+      reconciliation_id: nil, reduction_amount: nil, scheduled: nil, status: nil, subscription: nil, tax_id: nil
     )
       super(id)
       @payer_id = payer_id
@@ -67,6 +68,7 @@ module StarkInfra
       @reduction_amount = reduction_amount
       @scheduled = scheduled
       @status = status
+      @subscription = subscription
       @tax_id = tax_id
     end
 
@@ -113,6 +115,7 @@ module StarkInfra
             reduction_amount: json['reduction_amount'],
             scheduled: json['scheduled'],
             status: json['status'],
+            subscription: BrcodePreview::Subscription.parse_subscription(json['subscription']),
             tax_id: json['tax_id']
           )
         }

data/lib/brcode_preview/subscription.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('brcode_preview')
+require_relative('../utils/rest')
+
+module StarkInfra
+  class BrcodePreview
+    # # BrcodePreview::Subscription object
+    #
+    # A read-only snapshot of a Pix recurring-debit subscription, embedded inside a
+    # BrcodePreview response when the previewed BR Code carries subscription metadata.
+    # This sub-resource has no endpoints and is constructed only when deserializing a
+    # BrcodePreview returned by the API.
+    #
+    # ## Attributes (return-only):
+    # - amount [integer]: amount in cents charged per cycle. nil for variable-amount subscriptions. ex: 1000 (= R$ 10.00)
+    # - amount_min_limit [integer]: floor value for the maximum amount the sender can set when approving a variable-amount subscription. nil for fixed-amount subscriptions. ex: 500 (= R$ 5.00)
+    # - bacen_id [string]: Central Bank's unique recurrency id for the subscription.
+    # - created [DateTime]: creation datetime of the subscription. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    # - description [string]: additional information delivered to the sender.
+    # - installment_end [DateTime]: end datetime of settlements allowed for this subscription. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    # - installment_start [DateTime]: start datetime of settlements allowed for this subscription. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    # - interval [string]: cycle definition exposed verbatim from the server. ex: 'monthly'
+    # - pull_retry_limit [integer]: max number of retries the receiver may issue for a single failed pull cycle.
+    # - receiver_bank_code [string]: receiver's bank institution code.
+    # - receiver_name [string]: receiver's full name.
+    # - receiver_tax_id [string]: receiver's tax id (CPF or CNPJ).
+    # - reference_code [string]: commercial-relation identifier (contract number, order id, or client code).
+    # - sender_final_name [string]: final sender name when the sender differs from the originating institution.
+    # - sender_final_tax_id [string]: final sender tax id when distinct from the originating sender.
+    # - status [string]: current lifecycle state of the subscription snapshot, verbatim from the server. ex: 'created', 'pending', 'failed', 'denied', 'approved', 'active', 'expired', 'canceled'
+    # - type [string]: subscription journey type, verbatim from the server. ex: 'push', 'qrcode', 'qrcodeAndPayment', 'paymentAndOrQrcode'
+    # - updated [DateTime]: latest update datetime of the subscription. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Subscription < StarkCore::Utils::SubResource
+      attr_reader :amount, :amount_min_limit, :bacen_id, :created, :description, :installment_end,
+                  :installment_start, :interval, :pull_retry_limit, :receiver_bank_code, :receiver_name,
+                  :receiver_tax_id, :reference_code, :sender_final_name, :sender_final_tax_id, :status,
+                  :type, :updated
+      def initialize(
+        amount: nil, amount_min_limit: nil, bacen_id: nil, created: nil, description: nil,
+        installment_end: nil, installment_start: nil, interval: nil, pull_retry_limit: nil,
+        receiver_bank_code: nil, receiver_name: nil, receiver_tax_id: nil, reference_code: nil,
+        sender_final_name: nil, sender_final_tax_id: nil, status: nil, type: nil, updated: nil
+      )
+        @amount = amount
+        @amount_min_limit = amount_min_limit
+        @bacen_id = bacen_id
+        @created = StarkCore::Utils::Checks.check_datetime(created)
+        @description = description
+        @installment_end = StarkCore::Utils::Checks.check_datetime(installment_end == '' ? nil : installment_end)
+        @installment_start = StarkCore::Utils::Checks.check_datetime(installment_start == '' ? nil : installment_start)
+        @interval = interval
+        @pull_retry_limit = pull_retry_limit
+        @receiver_bank_code = receiver_bank_code
+        @receiver_name = receiver_name
+        @receiver_tax_id = receiver_tax_id
+        @reference_code = reference_code
+        @sender_final_name = sender_final_name
+        @sender_final_tax_id = sender_final_tax_id
+        @status = status
+        @type = type
+        @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      end
+
+      def self.parse_subscription(json)
+        return nil if json.nil? || (json.respond_to?(:empty?) && json.empty?)
+
+        subscription_maker = Subscription.resource[:resource_maker]
+        StarkCore::Utils::API.from_api_json(subscription_maker, json)
+      end
+
+      def self.resource
+        {
+          resource_name: 'Subscription',
+          resource_maker: proc { |json|
+            Subscription.new(
+              amount: json['amount'],
+              amount_min_limit: json['amount_min_limit'],
+              bacen_id: json['bacen_id'],
+              created: json['created'],
+              description: json['description'],
+              installment_end: json['installment_end'],
+              installment_start: json['installment_start'],
+              interval: json['interval'],
+              pull_retry_limit: json['pull_retry_limit'],
+              receiver_bank_code: json['receiver_bank_code'],
+              receiver_name: json['receiver_name'],
+              receiver_tax_id: json['receiver_tax_id'],
+              reference_code: json['reference_code'],
+              sender_final_name: json['sender_final_name'],
+              sender_final_tax_id: json['sender_final_tax_id'],
+              status: json['status'],
+              type: json['type'],
+              updated: json['updated']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/business_attachment/business_attachment.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+require_relative('../utils/parse')
+
+module StarkInfra
+  # # BusinessAttachment object
+  #
+  # Business attachments are files containing documents of a company that must be attached to a business
+  # identity to be used for its validation.
+  #
+  # When you initialize a BusinessAttachment, 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):
+  # - name [string]: name of the BusinessAttachment. ex: "articles-of-incorporation.pdf"
+  # - content [string]: Base64 data url of the file or its raw bytes. ex: data:application/pdf;base64,JVBERi0xLjQ...
+  # - business_identity_id [string]: Unique id of BusinessIdentity. ex: "5656565656565656"
+  #
+  # ## Parameters (optional):
+  # - content_type [string, default nil]: content MIME type. This parameter is required as input only. ex: "image/png" or "application/pdf"
+  # - tags [list of strings, default nil]: list of strings for reference when searching for BusinessAttachments. ex: ["employees", "monthly"]
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when the BusinessAttachment is created. ex: "5656565656565656"
+  # - attachment_id [string]: Unique id of the attached file. ex: "5656565656565656"
+  # - status [string]: current status of the BusinessAttachment. Options: "created", "canceled", "approved", "denied"
+  # - created [DateTime]: creation datetime for the BusinessAttachment. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime]: latest update datetime for the BusinessAttachment. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class BusinessAttachment < StarkCore::Utils::Resource
+    attr_reader :name, :content, :content_type, :business_identity_id, :tags, :id, :attachment_id, :status, :created, :updated
+    def initialize(name:, content:, business_identity_id:, content_type: nil, tags: nil, id: nil, attachment_id: nil,
+                   status: nil, created: nil, updated: nil)
+      super(id)
+      @name = name
+      @business_identity_id = business_identity_id
+      @tags = tags
+      @attachment_id = attachment_id
+      @status = status
+      @created = StarkCore::Utils::Checks.check_datetime(created)
+      @updated = StarkCore::Utils::Checks.check_datetime(updated)
+      @content = content
+      @content_type = content_type
+
+      if @content_type
+        @content = "data:#{content_type};base64,#{Base64.encode64(content)}"
+        @content_type = nil
+      end
+    end
+
+    # # Create BusinessAttachments
+    #
+    # Send a list of BusinessAttachment objects for creation at the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - attachments [list of BusinessAttachment objects]: list of BusinessAttachment 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 BusinessAttachment objects with updated attributes
+    def self.create(attachments, user: nil)
+      StarkInfra::Utils::Rest.post(entities: attachments, user: user, **resource)
+    end
+
+    # # Retrieve a specific BusinessAttachment
+    #
+    # Receive a single BusinessAttachment object previously created in the Stark Infra API by its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: "5656565656565656"
+    #
+    # ## Parameters (optional):
+    # - expand [list of strings, default nil]: fields to expand information. ex: ["content"]
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - BusinessAttachment object with updated attributes
+    def self.get(id, expand: nil, user: nil)
+      StarkInfra::Utils::Rest.get_id(id: id, expand: expand, user: user, **resource)
+    end
+
+    # # Retrieve BusinessAttachments
+    #
+    # Receive a generator of BusinessAttachment 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", "approved", "denied"]
+    # - 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 BusinessAttachment 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 BusinessAttachments
+    #
+    # Receive a list of up to 100 BusinessAttachment 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", "approved", "denied"]
+    # - 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 BusinessAttachment objects with updated attributes
+    # - cursor to retrieve the next page of BusinessAttachment 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
+
+    # # Cancel a BusinessAttachment entity
+    #
+    # Cancel a BusinessAttachment entity previously created in the Stark Infra API
+    #
+    # ## Parameters (required):
+    # - id [string]: BusinessAttachment 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:
+    # - canceled BusinessAttachment object
+    def self.cancel(id, user: nil)
+      StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'BusinessAttachment',
+        resource_maker: proc { |json|
+          BusinessAttachment.new(
+            name: json['name'],
+            content: json['content'],
+            content_type: json['content_type'],
+            business_identity_id: json['business_identity_id'],
+            tags: json['tags'],
+            id: json['id'],
+            attachment_id: json['attachment_id'],
+            status: json['status'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/business_attachment/log.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require('starkcore')
+require_relative('../utils/rest')
+require_relative('business_attachment')
+
+module StarkInfra
+  class BusinessAttachment
+    # # BusinessAttachment::Log object
+    #
+    # Every time a BusinessAttachment entity is updated, a corresponding BusinessAttachment::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 BusinessAttachment.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - attachment [BusinessAttachment]: BusinessAttachment entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this BusinessAttachment event
+    # - type [string]: type of the BusinessAttachment event which triggered the log creation. ex: 'created', 'canceled', 'approved', 'denied'.
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkCore::Utils::Resource
+      attr_reader :id, :attachment, :errors, :type, :created
+      def initialize(id: nil, attachment: nil, errors: nil, type: nil, created: nil)
+        super(id)
+        @attachment = attachment
+        @errors = errors
+        @type = type
+        @created = StarkCore::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific BusinessAttachment::Log
+      #
+      # Receive a single BusinessAttachment::Log object previously created by the Stark Infra API by passing 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:
+      # - BusinessAttachment::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve BusinessAttachment::Logs
+      #
+      # Receive a generator of BusinessAttachment::Log 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)
+      # - types [list of strings, default nil]: filter for log event types. ex: ['created', 'canceled', 'approved', 'denied']
+      # - attachment_ids [list of strings, default nil]: list of BusinessAttachment ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter BusinessAttachment Logs. ex: ['5656565656565656']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+      #
+      # ## Return:
+      # - generator of BusinessAttachment::Log objects with updated attributes
+      def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, attachment_ids: nil, user: nil)
+        after = StarkCore::Utils::Checks.check_date(after)
+        before = StarkCore::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          attachment_ids: attachment_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged BusinessAttachment::Logs
+      #
+      # Receive a list of up to 100 BusinessAttachment::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 attachments.
+      #
+      # ## 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)
+      # - types [list of strings, default nil]: filter for log event types. ex: ['created', 'canceled', 'approved', 'denied']
+      # - attachment_ids [list of strings, default nil]: list of attachment ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: Log ids to filter BusinessAttachment Logs. ex: ['5656565656565656']
+      # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+      #
+      # ## Return:
+      # - list of BusinessAttachment::Log objects with updated attributes
+      # - cursor to retrieve the next page of Log objects
+      def self.page(cursor: nil, ids: nil, limit: nil, after: nil, before: nil, types: nil, attachment_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,
+          ids: ids,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          attachment_ids: attachment_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        request_maker = StarkInfra::BusinessAttachment.resource[:resource_maker]
+        {
+          resource_name: 'BusinessAttachmentLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              attachment: StarkCore::Utils::API.from_api_json(request_maker, json['attachment']),
+              errors: json['errors'],
+              type: json['type'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end