starkinfra 0.1.0 → 0.3.0

data/lib/issuingembossingrequest/log.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require_relative('IssuingEmbossingRequest')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
+
+module StarkInfra
+  class IssuingEmbossingRequest
+    # # IssuingEmbossingRequest::Log object
+    #
+    # Every time an IssuingEmbossingRequest entity is updated, a corresponding IssuingEmbossingRequest::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 IssuingEmbossingRequest.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - request [IssuingEmbossingRequest]: IssuingEmbossingRequest entity to which the log refers to.
+    # - errors [list of string]: list of errors linked to this IssuingEmbossingRequest event.
+    # - type [string]: type of the IssuingEmbossingRequest event which triggered the log creation. ex: "created", "sending", "sent", "processing", "success", "failed"
+    # - 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, :request,:errors,:type, :created 
+      def initialize(id: nil, request: nil, errors: nil, type: nil, created: nil)
+        super(id)
+        @request = request
+        @type = type
+        @errors = errors
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific IssuingEmbossingRequest::Log
+      #
+      # Receive a single IssuingEmbossingRequest::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:
+      # - IssuingEmbossingRequest::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve IssuingEmbossingRequest::Logs
+      #
+      # Receive a generator of IssuingEmbossingRequest::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", "sending", "sent", "processing", "success", "failed"]
+      # - request_ids [list of strings, default nil]: list of IssuingEmbossingRequest ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - 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 IssuingEmbossingRequest::Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, request_ids: nil, ids: nil, user: nil)
+        after = StarkInfra::Utils::Checks.check_date(after)
+        before = StarkInfra::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_stream(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          request_ids: request_ids,
+          ids: ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged IssuingEmbossingRequest::Logs
+      #
+      # Receive a list of up to 100 IssuingEmbossingRequest::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 logs.
+      #
+      # ## 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", "sending", "sent", "processing", "success", "failed"]
+      # - request_ids [list of strings, default nil]: list of IssuingEmbossingRequest ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - 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 IssuingEmbossingRequest::Log objects with updated attributes
+      # - Cursor to retrieve the next page of Log objects
+      def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, request_ids: nil, ids: nil, user: nil)
+        after = StarkInfra::Utils::Checks.check_date(after)
+        before = StarkInfra::Utils::Checks.check_date(before)
+        StarkInfra::Utils::Rest.get_page(
+          cursor: cursor,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          request_ids: request_ids,
+          ids: ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        request_maker = StarkInfra::IssuingEmbossingRequest.resource[:resource_maker]
+        {
+          resource_name: 'IssuingEmbossingRequestLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              request: StarkInfra::Utils::API.from_api_json(request_maker, json['request']),
+              errors: json['errors'],
+              created: json['created'],
+              type: json['type']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/issuingholder/issuingholder.rb

@@ -1,14 +1,18 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # IssuingHolder object
   #
   # The IssuingHolder describes a card holder that may group several cards.
   #
+  # When you initialize a IssuingHolder, 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 created object.
+  #
   # ## Parameters (required):
   # - name [string]: card holder name.
   # - tax_id [string]: card holder tax ID
@@ -16,7 +20,7 @@ module StarkInfra
   #
   # ## Parameters (optional):
   # - rules [list of IssuingRule objects, default nil]: [EXPANDABLE] list of holder spending rules.
-  # - tags [list of strings, default []]: list of strings for tagging. ex: ['travel', 'food']
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['travel', 'food']
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when IssuingHolder is created. ex: '5656565656565656'
@@ -24,17 +28,17 @@ module StarkInfra
   # - updated [DateTime]: latest update datetime for the IssuingHolder. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class IssuingHolder < StarkInfra::Utils::Resource
-    attr_reader :id, :name, :tax_id, :external_id, :status, :rules, :tags, :updated, :created
+    attr_reader :id, :name, :tax_id, :external_id, :rules, :tags, :status, :updated, :created
     def initialize(
-      name:, tax_id:, external_id:, id: nil, status: nil, rules: nil, tags: nil, updated: nil, created: nil
+      name:, tax_id:, external_id:, rules: nil, tags: nil, id: nil, status: nil, updated: nil, created: nil
     )
       super(id)
       @name = name
       @tax_id = tax_id
       @external_id = external_id
-      @status = status
       @rules = StarkInfra::IssuingRule.parse_rules(rules)
       @tags = tags
+      @status = status
       @created = StarkInfra::Utils::Checks.check_datetime(created)
       @updated = StarkInfra::Utils::Checks.check_datetime(updated)
     end
@@ -47,12 +51,13 @@ module StarkInfra
     # - holders [list of IssuingHolder objects]: list of IssuingHolder objects to be created in the API
     #
     # ## Parameters (optional):
+    # - expand [list of strings, default nil]: fields to expand information. Options: ['rules']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - list of IssuingHolder objects with updated attributes
-    def self.create(holders:, user: nil)
-      StarkInfra::Utils::Rest.post(entities: holders, user: user, **resource)
+    def self.create(holders:, expand: nil, user: nil)
+      StarkInfra::Utils::Rest.post(entities: holders, expand: expand, user: user, **resource)
     end
 
     # # Retrieve a specific IssuingHolder
@@ -78,12 +83,12 @@ module StarkInfra
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-    # - 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)
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
     # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['active', 'blocked', 'canceled']
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - expand [string, default nil]: fields to expand information. ex: ['rules']
+    # - 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:
@@ -106,17 +111,18 @@ module StarkInfra
 
     # # Retrieve paged IssuingHolders
     #
-    # Receive a list of IssuingHolder objects previously created in the Stark Infra API and the cursor to the next page.
+    # Receive a list of up to 100 IssuingHolders 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 logs.
     #
     # ## 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
-    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-    # - 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)
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
     # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['active', 'blocked', 'canceled']
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - expand [string, default nil]: fields to expand information. ex: ['rules']
+    # - 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:
@@ -193,9 +199,9 @@ module StarkInfra
             name: json['name'],
             tax_id: json['tax_id'],
             external_id: json['external_id'],
-            status: json['status'],
             rules: json['rules'],
             tags: json['tags'],
+            status: json['status'],
             updated: json['updated'],
             created: json['created']
           )

data/lib/issuingholder/log.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require_relative('issuingholder')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
-require_relative('issuingholder')
+require_relative('../utils/resource')
 
 module StarkInfra
   class IssuingHolder
     # # IssuingHolder::Log object
     #
-    # Every time an IssuingHolder entity is updated, a corresponding IssuingHolder.Log is generated for the entity. This
+    # Every time an IssuingHolder entity is updated, a corresponding IssuingHolder::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 IssuingHolder.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
     # - holder [IssuingHolder]: IssuingHolder entity to which the log refers to.
     # - type [string]: type of the IssuingHolder event which triggered the log creation. ex: 'blocked', 'canceled', 'created', 'unblocked', 'updated'
@@ -26,9 +26,9 @@ module StarkInfra
         @created = StarkInfra::Utils::Checks.check_datetime(created)
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific IssuingHolder::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single IssuingHolder::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -37,26 +37,26 @@ module StarkInfra
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
-      # - Log object with updated attributes
+      # - IssuingHolder::Log object with updated attributes
       def self.get(id, user: nil)
         StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
-      # # Retrieve Logs
+      # # Retrieve IssuingHolder::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of IssuingHolder::Log objects previously created in the Stark Infra API
       #
       # ## Parameters (optional):
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Max = 100. ex: 35
-      # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-      # - 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)
+      # - 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', 'blocked']
       # - holder_ids [list of strings, default nil]: list of IssuingHolder ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - 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 Log objects with updated attributes
+      # - generator of IssuingHolder::Log objects with updated attributes
       def self.query(limit: nil, after: nil, before: nil, types: nil, holder_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
@@ -71,23 +71,23 @@ module StarkInfra
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged IssuingHolder::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 IssuingHolder::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 holders.
       #
       # ## 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
-      # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-      # - 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)
+      # - 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', 'blocked']
       # - holder_ids [list of strings, default nil]: list of IssuingHolder ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - 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 Log objects with updated attributes
+      # - list of IssuingHolder::Log objects with updated attributes
       # - cursor to retrieve the next page of Log objects
       def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, holder_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)

data/lib/issuinginvoice/issuinginvoice.rb

@@ -1,42 +1,53 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # IssuingInvoice object
   #
   # The IssuingInvoice objects created in your Workspace load your Issuing balance when paid.
   #
+  # When you initialize a IssuingInvoice, 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 created object.
+  #
   # ## Parameters (required):
   # - amount [integer]: IssuingInvoice value in cents. ex: 1234 (= R$ 12.34)
   #
   # ## Parameters (optional):
   # - tax_id [string, default sub-issuer tax ID]: payer tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
   # - name [string, default sub-issuer name]: payer name. ex: 'Iron Bank S.A.'
-  # - tags [list of strings, default []]: list of strings for tagging. ex: ['travel', 'food']
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['travel', 'food']
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when IssuingInvoice is created. ex: '5656565656565656'
+  # - brcode [string]: BR Code for the Invoice payment. ex: '00020101021226930014br.gov.bcb.pix2571brcode-h.development.starkinfra.com/v2/d7f6546e194d4c64a153e8f79f1c41ac5204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63042109'
+  # - due [DateTime, Date or string]: Invoice due and expiration date in UTC ISO format. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0), Date.new(2020, 3, 10) or '2020-03-10T10:30:00.000000+00:00'
+  # - link [string]: public Invoice webpage URL. ex: 'https://starkbank-card-issuer.development.starkbank.com/invoicelink/d7f6546e194d4c64a153e8f79f1c41ac'
   # - status [string]: current IssuingInvoice status. ex: 'created', 'expired', 'overdue', 'paid'
   # - issuing_transaction_id [string]: ledger transaction ids linked to this IssuingInvoice. ex: 'issuing-invoice/5656565656565656'
   # - updated [DateTime]: latest update datetime for the IssuingInvoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - created [DateTime]: creation datetime for the IssuingInvoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class IssuingInvoice < StarkInfra::Utils::Resource
-    attr_reader :amount, :id, :name, :tax_id, :status, :issuing_transaction_id, :tags, :updated, :created
+    attr_reader :id, :amount, :tax_id, :name, :tags, :brcode, :due, :link, :status, :issuing_transaction_id, :updated, :created
     def initialize(
-      amount:, id: nil, name: nil, tax_id: nil, status: nil, issuing_transaction_id: nil, tags: nil, updated: nil, created: nil
+      amount:, id: nil, tax_id: nil, name: nil, tags: nil, brcode: nil, due: nil, link: nil, status: nil, issuing_transaction_id: nil,
+      updated: nil, created: nil
     )
       super(id)
       @amount = amount
-      @name = name
       @tax_id = tax_id
+      @name = name
+      @tags = tags
+      @brcode = brcode
+      @due = due
+      @link = link
       @status = status
       @issuing_transaction_id = issuing_transaction_id
-      @tags = tags
-      @created = StarkInfra::Utils::Checks.check_datetime(created)
       @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
     end
 
     # # Create an IssuingInvoice
@@ -77,8 +88,8 @@ module StarkInfra
     #
     # ## 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)
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
     # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['created', 'expired', 'overdue', 'paid']
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
@@ -101,13 +112,14 @@ module StarkInfra
 
     # # Retrieve paged IssuingInvoices
     #
-    # Receive a list of IssuingInvoices objects previously created in the Stark Infra API and the cursor to the next page.
+    # Receive a list of up to 100 IssuingInvoices 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 logs.
     #
     # ## 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)
+    # - after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
     # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['created', 'expired', 'overdue', 'paid']
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
@@ -137,11 +149,14 @@ module StarkInfra
           IssuingInvoice.new(
             id: json['id'],
             amount: json['amount'],
-            name: json['name'],
             tax_id: json['tax_id'],
+            name: json['name'],
+            tags: json['tags'],
+            brcode: json['brcode'],
+            due: json['due'],
+            link: json['link'],
             status: json['status'],
             issuing_transaction_id: json['issuing_transaction_id'],
-            tags: json['tags'],
             updated: json['updated'],
             created: json['created']
           )

data/lib/issuinginvoice/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
 require_relative('issuinginvoice')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   class IssuingInvoice
@@ -13,7 +13,7 @@ module StarkInfra
     # This log is never generated by the user, but it can be retrieved to check additional information on the
     # IssuingInvoice.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
     # - invoice [IssuingInvoice]: IssuingInvoice entity to which the log refers to.
     # - type [string]: type of the IssuingInvoice event which triggered the log creation. ex: 'created', 'credited', 'expired', 'overdue', 'paid'.
@@ -27,9 +27,9 @@ module StarkInfra
         @created = StarkInfra::Utils::Checks.check_datetime(created)
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific IssuingInvoice::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by its id
+      # Receive a single IssuingInvoice::Log object previously created by the Stark Infra API by its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -38,25 +38,25 @@ module StarkInfra
       # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
       #
       # ## Return:
-      # - Log object with updated attributes
+      # - IssuingInvoice::Log object with updated attributes
       def self.get(id, user: nil)
         StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
-      # # Retrieve Logs
+      # # Retrieve IssuingInvoice::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of IssuingInvoice::Log objects previously created in the Stark Infra API
       #
       # ## Parameters (optional):
-      # - ids [list of strings, default nil]: list of IssuingInvoice ids to filter logs. ex: ['5656565656565656', '4545454545454545']
       # - limit [integer, default nil]: 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)
+      # - 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', 'credited', 'expired', 'overdue', 'paid']
+      # - ids [list of strings, default nil]: list of IssuingInvoice ids to filter logs. 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 Log objects with updated attributes
+      # - generator of IssuingInvoice::Log objects with updated attributes
       def self.query(limit: nil, after: nil, before: nil, types: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
@@ -70,22 +70,22 @@ module StarkInfra
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged IssuingInvoice::Logs
       #
-      # Receive a list of up to 100 issuinginvoice.Log objects previously created in the Stark Infra API and the cursor
+      # Receive a list of up to 100 IssuingInvoice::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 invoices.
       #
       # ## Parameters (optional):
       # - cursor [string, default nil]: cursor returned on the previous page function call
-      # - ids [list of strings, default nil]: list of IssuingInvoice ids to filter logs. ex: ['5656565656565656', '4545454545454545']
       # - 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)
+      # - 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', 'credited', 'expired', 'overdue', 'paid']
+      # - ids [list of strings, default nil]: list of IssuingInvoice ids to filter logs. 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 Log objects with updated attributes
+      # - list of IssuingInvoice::Log objects with updated attributes
       # - cursor to retrieve the next page of Log objects
       def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)