starkinfra 0.1.0 → 0.3.0

data/lib/issuingrestock/log.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative('IssuingRestock')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
+
+module StarkInfra
+  class IssuingRestock
+    # # IssuingRestock::Log object
+    #
+    # Every time an IssuingRestock entity is updated, a corresponding IssuingRestock::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 IssuingRestock.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - restock [IssuingRestock]: IssuingRestock entity to which the log refers to.
+    # - type [string]: type of the IssuingRestock event which triggered the log creation. ex: "created", "processing", "confirmed"
+    # - 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, :restock, :type, :created 
+      def initialize(id: nil, restock: nil, type: nil, created: nil)
+        super(id)
+        @restock = restock
+        @type = type
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific IssuingRestock::Log
+      #
+      # Receive a single IssuingRestock::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:
+      # - IssuingRestock::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve IssuingRestock::Logs
+      #
+      # Receive a generator of IssuingRestock::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", "processing", "confirmed"]
+      # - restock_ids [list of strings, default nil]: list of IssuingRestock 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 IssuingRestock::Log objects with updated attributes
+      def self.query(
+        limit: nil, after: nil, before: nil, types: nil, restock_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,
+          restock_ids: restock_ids,
+          ids: ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged IssuingRestock::Logs
+      #
+      # Receive a list of up to 100 IssuingRestock::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", "processing", "confirmed"]
+      # - restock_ids [list of strings, default nil]: list of IssuingRestock 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 IssuingRestock::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, restock_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,
+          restock_ids: restock_ids,
+          ids: ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        request_maker = StarkInfra::IssuingRestock.resource[:resource_maker]
+        {
+          resource_name: 'IssuingRestockLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              restock: StarkInfra::Utils::API.from_api_json(request_maker, json['restock']),
+              type: json['type'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/issuingrule/issuingrule.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # IssuingRule object
@@ -12,33 +12,79 @@ module StarkInfra
   # ## Parameters (required):
   # - name [string]: rule name. ex: 'Travel' or 'Food'
   # - amount [integer]: maximum amount that can be spent in the informed interval. ex: 200000 (= R$ 2000.00)
+  #
   # ## Parameters (optional):
-  # - id [string, default nil]: unique id returned when Rule is created. ex: '5656565656565656'
+  # - id [string, default nil]: unique id returned when an IssuingRule is created, used to update a specific IssuingRule. ex: '5656565656565656'
   # - interval [string, default 'lifetime']: interval after which the rule amount counter will be reset to 0. ex: 'instant', 'day', 'week', 'month', 'year' or 'lifetime'
   # - currency_code [string, default 'BRL']: code of the currency that the rule amount refers to. ex: 'BRL' or 'USD'
-  # - categories [list of strings, default []]: merchant categories accepted by the rule. ex: ['eatingPlacesRestaurants', 'travelAgenciesTourOperators']
-  # - countries [list of strings, default []]: countries accepted by the rule. ex: ['BRA', 'USA']
-  # - methods [list of strings, default []]: card purchase methods accepted by the rule. ex: ['chip', 'token', 'server', 'manual', 'magstripe', 'contactless']
+  # - categories [list of MerchantCategories, default nil]: merchant categories accepted by the rule. ex: [MerchantCategory(code='fastFoodRestaurants')]
+  # - countries [list of MerchantCountries, default nil]: countries accepted by the rule. ex: [MerchantCountry(code='BRA')]
+  # - methods [list of CardMethods, default nil]: card purchase methods accepted by the rule. ex: [CardMethod(code='magstripe')]
+  #
   # ## Attributes (expanded return-only):
   # - counter_amount [integer]: current rule spent amount. ex: 1000
   # - currency_symbol [string]: currency symbol. ex: 'R$'
   # - currency_name [string]: currency name. ex: 'Brazilian Real'
   class IssuingRule < StarkInfra::Utils::Resource
-    attr_reader :name, :interval, :amount, :currency_code, :counter_amount, :currency_name, :currency_symbol, :categories, :countries, :methods
-    def initialize(name:, amount:, id: nil, interval: nil, currency_code: nil, counter_amount: nil, currency_name: nil,
-      currency_symbol: nil, categories: nil, countries: nil, methods: nil
+    attr_reader :name, :interval, :amount, :currency_code, :counter_amount, :currency_name, :currency_symbol,
+                :categories, :countries, :methods
+    def initialize(
+      name:, amount:, id: nil, interval: nil, currency_code: nil, categories: nil, countries: nil, methods: nil,
+      counter_amount: nil, currency_symbol: nil, currency_name: nil
     )
       super(id)
       @name = name
-      @interval = interval
       @amount = amount
+      @interval = interval
       @currency_code = currency_code
+      @categories = IssuingRule.parse_categories(categories)
+      @countries = IssuingRule.parse_categories(countries)
+      @methods = IssuingRule.parse_categories(methods)
       @counter_amount = counter_amount
-      @currency_name = currency_name
       @currency_symbol = currency_symbol
-      @categories = categories
-      @countries = countries
-      @methods = methods
+      @currency_name = currency_name
+    end
+
+    def self.parse_categories(categories)
+      resource_maker = StarkInfra::MerchantCategory.resource[:resource_maker]
+      return categories if categories.nil?
+
+      parsed_categories = []
+      categories.each do |category|
+        unless category.is_a? MerchantCategory
+          category = StarkInfra::Utils::API.from_api_json(resource_maker, category)
+        end
+        parsed_categories << category
+      end
+      parsed_categories
+    end
+
+    def self.parse_countries(countries)
+      resource_maker = StarkInfra::MerchantCountry.resource[:resource_maker]
+      return countries if countries.nil?
+
+      parsed_countries = []
+      countries.each do |country|
+        unless country.is_a? MerchantCountry
+          country = StarkInfra::Utils::API.from_api_json(resource_maker, country)
+        end
+        parsed_countries << country
+      end
+      parsed_countries
+    end
+
+    def self.parse_methods(methods)
+      resource_maker = StarkInfra::CardMethod.resource[:resource_maker]
+      return methods if methods.nil?
+
+      parsed_methods = []
+      methods.each do |method|
+        unless method.is_a? CardMethod
+          method = StarkInfra::Utils::API.from_api_json(resource_maker, method)
+        end
+        parsed_methods << method
+      end
+      parsed_methods
     end
 
     def self.parse_rules(rules)
@@ -61,15 +107,15 @@ module StarkInfra
         resource_maker: proc { |json|
           IssuingRule.new(
             name: json['name'],
-            interval: json['interval'],
             amount: json['amount'],
+            interval: json['interval'],
             currency_code: json['currency_code'],
-            counter_amount: json['counter_amount'],
-            currency_name: json['currency_name'],
-            currency_symbol: json['currency_symbol'],
             categories: json['categories'],
             countries: json['countries'],
-            methods: json['methods']
+            methods: json['methods'],
+            counter_amount: json['counter_amount'],
+            currency_symbol: json['currency_symbol'],
+            currency_name: json['currency_name']
           )
         }
       }

data/lib/issuingstock/issuingstock.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
+
+module StarkInfra
+  # # IssuingStock object
+  #
+  # The IssuingStock object represents the current stock of a certain IssuingDesign linked to an Embosser available to your workspace.
+  #
+  # ## Attributes (return-only):
+  # - id [string]: unique id returned when IssuingStock is created. ex: "5656565656565656"
+  # - balance [integer]: [EXPANDABLE] current stock balance. ex: 1000
+  # - design_id [string]: IssuingDesign unique id. ex: "5656565656565656"
+  # - embosser_id [string]: Embosser unique id. ex: "5656565656565656"
+  # - updated [DateTime]: latest update datetime for the IssuingStock. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - created [DateTime]: creation datetime for the IssuingStock. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class IssuingStock < StarkInfra::Utils::Resource
+    attr_reader :id, :balance, :design_id, :embosser_id, :updated, :created
+    def initialize(
+      id: nil, balance: nil, design_id: nil, embosser_id: nil, updated: nil, created: nil 
+    )
+      super(id)
+      @balance = balance
+      @design_id = design_id
+      @embosser_id = embosser_id
+      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+    end
+
+    # # Retrieve a specific IssuingStock
+    #
+    # Receive a single IssuingStock 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: ['balance']
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - IssuingStock 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 IssuingStocks
+    #
+    # Receive a generator of IssuingStocks 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)
+    # - design_ids [list of strings, default nil]: IssuingDesign unique ids. ex: ["5656565656565656", "4545454545454545"]
+    # - embosser_ids [list of strings, default nil]: Embosser unique ids. ex: ["5656565656565656", "4545454545454545"]
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
+    # - expand [list of strings, default []]: fields to expand information. ex: ["balance"]
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of IssuingStocks objects with updated attributes
+    def self.query(
+      limit: nil, after: nil, before: nil, design_ids: nil, embosser_ids: nil, ids: nil, expand: 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,
+        design_ids: design_ids,
+        embosser_ids: embosser_ids,
+        ids: ids,
+        expand: expand,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged IssuingStocks
+    #
+    # Receive a list of up to 100 IssuingStock 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)
+    # - design_ids [list of strings, default nil]: IssuingDesign unique ids. ex: ["5656565656565656", "4545454545454545"]
+    # - embosser_ids [list of strings, default nil]: Embosser unique ids. ex: ["5656565656565656", "4545454545454545"]
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
+    # - expand [list of strings, default []]: fields to expand information. ex: ["balance"]
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
+    #
+    # ## Return:
+    # - list of IssuingStocks objects with updated attributes
+    # - cursor to retrieve the next page of IssuingStocks objects
+    def self.page(
+      cursor: nil, limit: nil, after: nil, before: nil, design_ids: nil, embosser_ids: nil, 
+      ids: nil, expand: 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,
+        design_ids: design_ids,
+        embosser_ids: embosser_ids,
+        ids: ids,
+        expand: expand,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'IssuingStock',
+        resource_maker: proc { |json|
+          IssuingStock.new(
+            id: json['id'],
+            balance: json['balance'],
+            design_id: json['design_id'],
+            embosser_id: json['embosser_id'],
+            updated: json['updated'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/issuingstock/log.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require_relative('IssuingStock')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
+
+module StarkInfra
+  class IssuingStock
+    # # IssuingStock::Log object
+    #
+    # Every time an IssuingStock entity is updated, a corresponding IssuingStock::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 IssuingStock.
+    #
+    # ## Attributes (return-only):
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - stock [IssuingStock]: IssuingStock entity to which the log refers to.
+    # - type [string]: type of the IssuingStock event which triggered the log creation. ex: "created", "spent", "restocked", "lost"
+    # - count [integer]: shift in stock balance. ex: 10
+    # - 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, :stock, :type, :count, :created
+      def initialize(id: nil, stock: nil, type: nil, count: nil, created: nil)
+        super(id)
+        @stock = stock
+        @type = type
+        @count = count
+        @created = StarkInfra::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific IssuingStock::Log
+      #
+      # Receive a single IssuingStock::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:
+      # - IssuingStock::Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve IssuingStock::Logs
+      #
+      # Receive a generator of IssuingStock::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", "spent", "restocked", "lost"]
+      # - stock_ids [list of strings, default nil]: list of IssuingStock 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 IssuingStock::Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, stock_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,
+          stock_ids: stock_ids,
+          ids: ids,
+          user: user,
+          **resource
+        )
+      end
+
+      # # Retrieve paged IssuingStock::Logs
+      #
+      # Receive a list of up to 100 IssuingStock::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", "spent", "restocked", "lost"]
+      # - stock_ids [list of strings, default nil]: list of IssuingStock 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 IssuingStock::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, stock_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,
+          stock_ids: stock_ids,
+          ids: ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        request_maker = StarkInfra::IssuingStock.resource[:resource_maker]
+        {
+          resource_name: 'IssuingStockLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              stock: StarkInfra::Utils::API.from_api_json(request_maker, json['stock']),
+              type: json['type'],
+              count: json['count'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/issuingtransaction/issuingtransaction.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # IssuingTransaction object
@@ -20,9 +20,7 @@ module StarkInfra
   class IssuingTransaction < StarkInfra::Utils::Resource
     attr_reader :id, :amount, :balance, :description, :source, :tags, :created
 
-    def initialize(
-      id: nil, amount: nil, balance: nil, description: nil, source: nil, tags: nil, created: nil
-    )
+    def initialize(id: nil, amount: nil, balance: nil, description: nil, source: nil, tags: nil, created: nil)
       super(id)
       @amount = amount
       @balance = balance
@@ -54,11 +52,11 @@ module StarkInfra
     #
     # ## Parameters (optional):
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
-    # - external_ids [list of strings, default []]: external IDs. 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)
+    # - external_ids [list of strings, default nil]: external IDs. 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)
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'approved', 'canceled', 'denied', 'confirmed' or 'voided'
-    # - ids [list of strings, default [], default nil]: purchase IDs
+    # - ids [list of strings, default nil]: purchase IDs
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
     #
@@ -82,17 +80,18 @@ module StarkInfra
 
     # # Retrieve paged IssuingTransactions
     #
-    # Receive a list of IssuingTransaction objects previously created in the Stark Infra API and the cursor to the next page.
+    # Receive a list of up to 100 IssuingTransaction 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)
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
-    # - external_ids [list of strings, default nil: external IDs. 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)
+    # - external_ids [list of strings, default nil]: external IDs. ex: ['5656565656565656', '4545454545454545']
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'approved', 'canceled', 'denied', 'confirmed' or 'voided'
     # - ids [list of strings, default nil]: purchase IDs
-    # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
     #
     # ## Return:

data/lib/issuingwithdrawal/issuingwithdrawal.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # IssuingWithdrawal object
@@ -15,7 +15,7 @@ module StarkInfra
   # - description [string]: IssuingWithdrawal description. ex: 'sending money back'
   #
   # ## Parameters (optional):
-  # - tags [list of strings, default []]: list of strings for tagging. ex: ['tony', 'stark']
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['tony', 'stark']
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when IssuingWithdrawal is created. ex: '5656565656565656'
@@ -36,8 +36,8 @@ module StarkInfra
       @tags = tags
       @transaction_id = transaction_id
       @issuing_transaction_id = issuing_transaction_id
-      @created = StarkInfra::Utils::Checks.check_datetime(created)
       @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
     end
 
     # # Create an IssuingWithdrawal
@@ -78,10 +78,10 @@ module StarkInfra
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - external_ids [list of strings, default []]: external IDs. 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)
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - external_ids [list of strings, default nil]: external 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:
@@ -102,15 +102,16 @@ module StarkInfra
 
     # # Retrieve paged IssuingWithdrawals
     #
-    # Receive a list of IssuingWithdrawals objects previously created in the Stark Infra API and the cursor to the next page.
+    # Receive a list of up to 100 IssuingWithdrawal 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
-    # - external_ids [list of strings, default []]: external IDs. 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)
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - external_ids [list of strings, default nil]: external 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:
@@ -136,11 +137,11 @@ module StarkInfra
         resource_name: 'IssuingWithdrawal',
         resource_maker: proc { |json|
           IssuingWithdrawal.new(
+            id: json['id'],
             amount: json['amount'],
             external_id: json['external_id'],
             description: json['description'],
             tags: json['tags'],
-            id: json['id'],
             transaction_id: json['transaction_id'],
             issuing_transaction_id: json['issuing_transaction_id'],
             updated: json['updated'],