starkinfra 0.2.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

@@ -83,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:
@@ -111,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:

data/lib/issuingholder/log.rb

@@ -9,10 +9,10 @@ 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

@@ -88,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
@@ -112,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

data/lib/issuinginvoice/log.rb

@@ -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)

data/lib/issuingproduct/issuingproduct.rb

@@ -7,7 +7,7 @@ require_relative('../utils/resource')
 module StarkInfra
   # # IssuingProduct object
   #
-  # The IssuingProduct object displays information of avaliable card products registered to your Workspace.
+  # The IssuingProduct object displays information of registered card products to your Workspace.
   # They represent a group of cards that begin with the same numbers (id) and offer the same product to end customers.
   #
   # ## Attributes (return-only):
@@ -30,7 +30,7 @@ module StarkInfra
 
     # # Retrieve IssuingProducts
     #
-    # Receive a generator of available IssuingProduct objects previously registered to your workspace
+    # Receive a generator of IssuingProduct objects previously registered in the Stark Infra API
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35

data/lib/issuingpurchase/issuingpurchase.rb

@@ -12,6 +12,7 @@ module StarkInfra
   # ## Attributes (return-only):
   # - id [string]: unique id returned when IssuingPurchase is created. ex: '5656565656565656'
   # - holder_name [string]: card holder name. ex: 'Tony Stark'
+  # - product_id [string]: unique card product number (BIN) registered within the card network. ex: "53810200"
   # - card_id [string]: unique id returned when IssuingCard is created. ex: '5656565656565656'
   # - card_ending [string]: last 4 digits of the card number. ex: '1234'
   # - purpose [string]: purchase purpose. ex: 'purchase'
@@ -47,14 +48,14 @@ module StarkInfra
   # - card_tags [list of strings]: tags of the IssuingCard responsible for this purchase. ex: ['travel', 'food']
   # - holder_tags [list of strings]: tags of the IssuingHolder responsible for this purchase. ex: ['technology', 'john snow']
   class IssuingPurchase < StarkInfra::Utils::Resource
-    attr_reader :id, :holder_name, :card_id, :card_ending, :purpose, :amount, :tax, :issuer_amount, :issuer_currency_code,
+    attr_reader :id, :holder_name, :product_id, :card_id, :card_ending, :purpose, :amount, :tax, :issuer_amount, :issuer_currency_code,
                 :issuer_currency_symbol, :merchant_amount, :merchant_currency_code, :merchant_currency_symbol,
                 :merchant_category_code, :merchant_country_code, :acquirer_id, :merchant_id, :merchant_name,
                 :merchant_fee, :wallet_id, :method_code, :score, :end_to_end_id, :tags, :zip_code,
                 :issuing_transaction_ids, :status, :updated, :created, :is_partial_allowed, :card_tags, :holder_tags
 
     def initialize(
-      id: nil, holder_name: nil, card_id: nil, card_ending: nil, purpose: nil, amount: nil, tax: nil, issuer_amount: nil,
+      id: nil, holder_name: nil, product_id: nil, card_id: nil, card_ending: nil, purpose: nil, amount: nil, tax: nil, issuer_amount: nil,
       issuer_currency_code: nil, issuer_currency_symbol: nil, merchant_amount: nil, merchant_currency_code: nil,
       merchant_currency_symbol: nil, merchant_category_code: nil, merchant_country_code: nil, acquirer_id: nil,
       merchant_id: nil, merchant_name: nil, merchant_fee: nil, wallet_id: nil, method_code: nil, score: nil,
@@ -63,6 +64,7 @@ module StarkInfra
     )
       super(id)
       @holder_name = holder_name
+      @product_id = product_id
       @card_id = card_id
       @card_ending = card_ending
       @purpose = purpose
@@ -112,19 +114,19 @@ module StarkInfra
       StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
-    # # Retrieve IssuingPurchase
+    # # Retrieve IssuingPurchases
     #
     # Receive a generator of IssuingPurchases objects previously created in the Stark Infra API
     #
     # ## Parameters (optional):
-    # - ids [list of strings, default nil]: purchase IDs. ex: ['5656565656565656', '4545454545454545']
     # - 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, 09)
-    # - 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, 09)
+    # - before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
     # - end_to_end_ids [list of strings, default nil]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
     # - holder_ids [list of strings, default nil]: card holder IDs. ex: ['5656565656565656', '4545454545454545']
     # - card_ids [list of strings, default nil]: card  IDs. ex: ['5656565656565656', '4545454545454545']
     # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['approved', 'canceled', 'denied', 'confirmed', 'voided']
+    # - ids [list of strings, default nil]: purchase IDs. ex: ['5656565656565656', '4545454545454545']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
     #
     # ## Return:
@@ -149,18 +151,19 @@ module StarkInfra
 
     # # Retrieve paged IssuingPurchases
     #
-    # Receive a list of IssuingPurchase objects previously created in the Stark Infra API and the cursor to the next page.
+    # Receive a list of up to 100 IssuingPurchases 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]: purchase IDs. 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)
     # - end_to_end_ids [list of strings, default nil]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
     # - holder_ids [list of strings, default nil]: card holder IDs. ex: ['5656565656565656', '4545454545454545']
     # - card_ids [list of strings, default nil]: card  IDs. ex: ['5656565656565656', '4545454545454545']
     # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['approved', 'canceled', 'denied', 'confirmed', 'voided']
+    # - ids [list of strings, default nil]: purchase IDs. ex: ['5656565656565656', '4545454545454545']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
     #
     # ## Return:
@@ -213,7 +216,7 @@ module StarkInfra
       )
     end
 
-    # # Helps you respond to a IssuingPurchase authorization request
+    # # Helps you respond IssuingPurchase request
     #
     # ## Parameters (required):
     # - status [string]: sub-issuer response to the authorization. ex: 'approved' or 'denied'
@@ -247,6 +250,7 @@ module StarkInfra
           IssuingPurchase.new(
             id: json['id'],
             holder_name: json['holder_name'],
+            product_id: json['product_id'],
             card_id: json['card_id'],
             card_ending: json['card_ending'],
             purpose: json['purpose'],

data/lib/issuingpurchase/log.rb

@@ -12,7 +12,7 @@ module StarkInfra
     # Every time an IssuingPurchase entity is updated, a corresponding IssuingInvoice::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 IssuingPurchase.
     #
-    # ## Attributes:
+    # ## Attributes (return-only):
     # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
     # - purchase [IssuingPurchase]: IssuingPurchase entity to which the log refers to.
     # - issuing_transaction_id [string]: transaction ID related to the IssuingCard.
@@ -30,9 +30,9 @@ module StarkInfra
         @created = StarkInfra::Utils::Checks.check_datetime(created)
       end
 
-      # # Retrieve a specific Log
+      # # Retrieve a specific IssuingPurchase::Log
       #
-      # Receive a single Log object previously created by the Stark Infra API by passing its id
+      # Receive a single IssuingPurchase::Log object previously created by the Stark Infra API by passing its id
       #
       # ## Parameters (required):
       # - id [string]: object unique id. ex: '5656565656565656'
@@ -41,26 +41,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
+      # - IssuingPurchase::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 IssuingPurchase::Logs
       #
-      # Receive a generator of Log objects previously created in the Stark Infra API
+      # Receive a generator of IssuingPurchase::Log objects previously created in the Stark Infra API
       #
       # ## Parameters (optional):
-      # - ids [list of strings, default nil]: list of IssuingPurchase ids to filter logs. ex: ['5656565656565656', '4545454545454545']
       # - 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)
       # - types [list of strings, default nil]: filter for log event types. ex: ['approved', 'canceled', 'confirmed', 'denied', 'reversed', 'voided']
       # - purchase_ids [list of strings, default nil]: list of Purchase ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: list of IssuingPurchase 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 IssuingPurchase::Log objects with updated attributes
       def self.query(ids: nil, limit: nil, after: nil, before: nil, types: nil, purchase_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)
         before = StarkInfra::Utils::Checks.check_date(before)
@@ -76,23 +76,23 @@ module StarkInfra
         )
       end
 
-      # # Retrieve paged Logs
+      # # Retrieve paged IssuingPurchase::Logs
       #
       # Receive a list of up to 100 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 purchases.
       #
       # ## Parameters (optional):
       # - cursor [string, default nil]: cursor returned on the previous page function call
-      # - ids [list of strings, default nil]: list of IssuingPurchase 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: ['approved', 'canceled', 'confirmed', 'denied', 'reversed', 'voided']
       # - purchase_ids [list of strings, default nil]: list of Purchase ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - ids [list of strings, default nil]: list of IssuingPurchase 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 IssuingPurchase::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, purchase_ids: nil, user: nil)
         after = StarkInfra::Utils::Checks.check_date(after)