schematichq 1.5.4 → 1.5.6

data/lib/schematic/billing/types/mark_invoice_paid_request_body.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Billing
+    module Types
+      class MarkInvoicePaidRequestBody < Internal::Types::Model
+        field :invoice_id, -> { String }, optional: false, nullable: false
+
+        field :amount, -> { Integer }, optional: true, nullable: false
+
+        field :idempotency_key, -> { String }, optional: false, nullable: false
+
+        field :reference, -> { String }, optional: true, nullable: false
+
+        field :settled_at, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/billing/types/void_native_invoice_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Billing
+    module Types
+      class VoidNativeInvoiceResponse < Internal::Types::Model
+        field :data, -> { Schematic::Types::BillingInvoiceDetailResponseData }, optional: false, nullable: false
+
+        field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/catalogs/client.rb

@@ -639,6 +639,88 @@ module Schematic
         error_body = Schematic::Errors::ResponseError.load_error_body(code, response.body, error_types)
         raise error_class.new(response.body, code: code, body: error_body)
       end
+
+      # @param request_options [Hash]
+      # @param _params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @example
+      #   client.catalogs.get_public_catalog
+      #
+      # @return [Schematic::Catalogs::Types::GetPublicCatalogResponse]
+      def get_public_catalog(request_options: {}, **_params)
+        request = Schematic::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "public/catalog",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Schematic::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Schematic::Catalogs::Types::GetPublicCatalogResponse.load(response.body))
+        else
+          error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+          error_types = {
+            401 => Schematic::Types::ApiError,
+            403 => Schematic::Types::ApiError,
+            404 => Schematic::Types::ApiError,
+            500 => Schematic::Types::ApiError
+          }
+          error_body = Schematic::Errors::ResponseError.load_error_body(code, response.body, error_types)
+          raise error_class.new(response.body, code: code, body: error_body)
+        end
+      end
+
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :catalog_id
+      #
+      # @example
+      #   client.catalogs.get_public_catalog_by_id(catalog_id: "catalog_id")
+      #
+      # @return [Schematic::Catalogs::Types::GetPublicCatalogByIdResponse]
+      def get_public_catalog_by_id(request_options: {}, **params)
+        params = Schematic::Internal::Types::Utils.normalize_keys(params)
+        request = Schematic::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "public/catalogs/#{URI.encode_uri_component(params[:catalog_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Schematic::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Schematic::Catalogs::Types::GetPublicCatalogByIdResponse.load(response.body))
+        else
+          error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+          error_types = {
+            401 => Schematic::Types::ApiError,
+            403 => Schematic::Types::ApiError,
+            404 => Schematic::Types::ApiError,
+            500 => Schematic::Types::ApiError
+          }
+          error_body = Schematic::Errors::ResponseError.load_error_body(code, response.body, error_types)
+          raise error_class.new(response.body, code: code, body: error_body)
+        end
+      end
     end
   end
 end

data/lib/schematic/{accounts/types/create_api_key_response.rb → catalogs/types/get_public_catalog_by_id_response.rb}

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module Schematic
-  module Accounts
+  module Catalogs
     module Types
-      class CreateApiKeyResponse < Internal::Types::Model
-        field :data, -> { Schematic::Types::ApiKeyCreateResponseData }, optional: false, nullable: false
+      class GetPublicCatalogByIdResponse < Internal::Types::Model
+        field :data, -> { Schematic::Types::PublicCatalogResponseData }, optional: false, nullable: false
 
         field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
       end

data/lib/schematic/{accounts/types/delete_api_key_response.rb → catalogs/types/get_public_catalog_response.rb}

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module Schematic
-  module Accounts
+  module Catalogs
     module Types
-      class DeleteApiKeyResponse < Internal::Types::Model
-        field :data, -> { Schematic::Types::DeleteResponse }, optional: false, nullable: false
+      class GetPublicCatalogResponse < Internal::Types::Model
+        field :data, -> { Schematic::Types::PublicCatalogResponseData }, optional: false, nullable: false
 
         field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
       end

data/lib/schematic/client.rb

@@ -2,6 +2,200 @@
 
 module Schematic
   class Client
+    # @param request_options [Hash]
+    # @param _params [Hash]
+    # @option request_options [String] :base_url
+    # @option request_options [Hash{String => Object}] :additional_headers
+    # @option request_options [Hash{String => Object}] :additional_query_parameters
+    # @option request_options [Hash{String => Object}] :additional_body_parameters
+    # @option request_options [Integer] :timeout_in_seconds
+    #
+    # @example
+    #   client.post_api_keys
+    #
+    # @return [untyped]
+    def post_api_keys(request_options: {}, **_params)
+      request = Schematic::Internal::JSON::Request.new(
+        base_url: request_options[:base_url],
+        method: "POST",
+        path: "api-keys",
+        request_options: request_options
+      )
+      begin
+        response = @client.send(request)
+      rescue Net::HTTPRequestTimeout
+        raise Schematic::Errors::TimeoutError
+      end
+      code = response.code.to_i
+      return if code.between?(200, 299)
+
+      error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+      raise error_class.new(response.body, code: code)
+    end
+
+    # @param request_options [Hash]
+    # @param params [Hash]
+    # @option request_options [String] :base_url
+    # @option request_options [Hash{String => Object}] :additional_headers
+    # @option request_options [Hash{String => Object}] :additional_query_parameters
+    # @option request_options [Hash{String => Object}] :additional_body_parameters
+    # @option request_options [Integer] :timeout_in_seconds
+    # @option params [String] :api_key_id
+    #
+    # @example
+    #   client.put_api_keys_api_key_id(api_key_id: "api_key_id")
+    #
+    # @return [untyped]
+    def put_api_keys_api_key_id(request_options: {}, **params)
+      params = Schematic::Internal::Types::Utils.normalize_keys(params)
+      request = Schematic::Internal::JSON::Request.new(
+        base_url: request_options[:base_url],
+        method: "PUT",
+        path: "api-keys/#{URI.encode_uri_component(params[:api_key_id].to_s)}",
+        request_options: request_options
+      )
+      begin
+        response = @client.send(request)
+      rescue Net::HTTPRequestTimeout
+        raise Schematic::Errors::TimeoutError
+      end
+      code = response.code.to_i
+      return if code.between?(200, 299)
+
+      error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+      raise error_class.new(response.body, code: code)
+    end
+
+    # @param request_options [Hash]
+    # @param params [Hash]
+    # @option request_options [String] :base_url
+    # @option request_options [Hash{String => Object}] :additional_headers
+    # @option request_options [Hash{String => Object}] :additional_query_parameters
+    # @option request_options [Hash{String => Object}] :additional_body_parameters
+    # @option request_options [Integer] :timeout_in_seconds
+    # @option params [String] :api_key_id
+    #
+    # @example
+    #   client.delete_api_keys_api_key_id(api_key_id: "api_key_id")
+    #
+    # @return [untyped]
+    def delete_api_keys_api_key_id(request_options: {}, **params)
+      params = Schematic::Internal::Types::Utils.normalize_keys(params)
+      request = Schematic::Internal::JSON::Request.new(
+        base_url: request_options[:base_url],
+        method: "DELETE",
+        path: "api-keys/#{URI.encode_uri_component(params[:api_key_id].to_s)}",
+        request_options: request_options
+      )
+      begin
+        response = @client.send(request)
+      rescue Net::HTTPRequestTimeout
+        raise Schematic::Errors::TimeoutError
+      end
+      code = response.code.to_i
+      return if code.between?(200, 299)
+
+      error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+      raise error_class.new(response.body, code: code)
+    end
+
+    # @param request_options [Hash]
+    # @param _params [Hash]
+    # @option request_options [String] :base_url
+    # @option request_options [Hash{String => Object}] :additional_headers
+    # @option request_options [Hash{String => Object}] :additional_query_parameters
+    # @option request_options [Hash{String => Object}] :additional_body_parameters
+    # @option request_options [Integer] :timeout_in_seconds
+    #
+    # @example
+    #   client.post_environments
+    #
+    # @return [untyped]
+    def post_environments(request_options: {}, **_params)
+      request = Schematic::Internal::JSON::Request.new(
+        base_url: request_options[:base_url],
+        method: "POST",
+        path: "environments",
+        request_options: request_options
+      )
+      begin
+        response = @client.send(request)
+      rescue Net::HTTPRequestTimeout
+        raise Schematic::Errors::TimeoutError
+      end
+      code = response.code.to_i
+      return if code.between?(200, 299)
+
+      error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+      raise error_class.new(response.body, code: code)
+    end
+
+    # @param request_options [Hash]
+    # @param params [Hash]
+    # @option request_options [String] :base_url
+    # @option request_options [Hash{String => Object}] :additional_headers
+    # @option request_options [Hash{String => Object}] :additional_query_parameters
+    # @option request_options [Hash{String => Object}] :additional_body_parameters
+    # @option request_options [Integer] :timeout_in_seconds
+    # @option params [String] :environment_id
+    #
+    # @example
+    #   client.put_environments_environment_id(environment_id: "environment_id")
+    #
+    # @return [untyped]
+    def put_environments_environment_id(request_options: {}, **params)
+      params = Schematic::Internal::Types::Utils.normalize_keys(params)
+      request = Schematic::Internal::JSON::Request.new(
+        base_url: request_options[:base_url],
+        method: "PUT",
+        path: "environments/#{URI.encode_uri_component(params[:environment_id].to_s)}",
+        request_options: request_options
+      )
+      begin
+        response = @client.send(request)
+      rescue Net::HTTPRequestTimeout
+        raise Schematic::Errors::TimeoutError
+      end
+      code = response.code.to_i
+      return if code.between?(200, 299)
+
+      error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+      raise error_class.new(response.body, code: code)
+    end
+
+    # @param request_options [Hash]
+    # @param params [Hash]
+    # @option request_options [String] :base_url
+    # @option request_options [Hash{String => Object}] :additional_headers
+    # @option request_options [Hash{String => Object}] :additional_query_parameters
+    # @option request_options [Hash{String => Object}] :additional_body_parameters
+    # @option request_options [Integer] :timeout_in_seconds
+    # @option params [String] :environment_id
+    #
+    # @example
+    #   client.delete_environments_environment_id(environment_id: "environment_id")
+    #
+    # @return [untyped]
+    def delete_environments_environment_id(request_options: {}, **params)
+      params = Schematic::Internal::Types::Utils.normalize_keys(params)
+      request = Schematic::Internal::JSON::Request.new(
+        base_url: request_options[:base_url],
+        method: "DELETE",
+        path: "environments/#{URI.encode_uri_component(params[:environment_id].to_s)}",
+        request_options: request_options
+      )
+      begin
+        response = @client.send(request)
+      rescue Net::HTTPRequestTimeout
+        raise Schematic::Errors::TimeoutError
+      end
+      code = response.code.to_i
+      return if code.between?(200, 299)
+
+      error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+      raise error_class.new(response.body, code: code)
+    end
+
     # @param request_options [Hash]
     # @param _params [Hash]
     # @option request_options [String] :base_url
@@ -43,7 +237,7 @@ module Schematic
       @raw_client = Schematic::Internal::Http::RawClient.new(
         base_url: base_url || Schematic::Environment::DEFAULT,
         headers: {
-          "User-Agent" => "schematichq/1.5.4",
+          "User-Agent" => "schematichq/1.5.6",
           "X-Fern-Language" => "Ruby",
           "X-Schematic-Api-Key" => api_key.to_s
         },

data/lib/schematic/credits/client.rb

@@ -2005,6 +2005,7 @@ module Schematic
       # @option params [String, nil] :end_time
       # @option params [Schematic::Types::CreditEventType, nil] :event_type
       # @option params [String, nil] :feature_id
+      # @option params [String, nil] :source_event_id
       # @option params [String, nil] :start_time
       # @option params [Integer, nil] :limit
       # @option params [Integer, nil] :offset
@@ -2016,6 +2017,7 @@ module Schematic
       #     end_time: "end_time",
       #     event_type: "adjustment",
       #     feature_id: "feature_id",
+      #     source_event_id: "source_event_id",
       #     start_time: "start_time",
       #     limit: 1000000,
       #     offset: 1000000
@@ -2030,6 +2032,7 @@ module Schematic
         query_params["end_time"] = params[:end_time] if params.key?(:end_time)
         query_params["event_type"] = params[:event_type] if params.key?(:event_type)
         query_params["feature_id"] = params[:feature_id] if params.key?(:feature_id)
+        query_params["source_event_id"] = params[:source_event_id] if params.key?(:source_event_id)
         query_params["start_time"] = params[:start_time] if params.key?(:start_time)
         query_params["limit"] = params[:limit] if params.key?(:limit)
         query_params["offset"] = params[:offset] if params.key?(:offset)
@@ -2063,6 +2066,48 @@ module Schematic
         end
       end
 
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :ledger_entry_id
+      #
+      # @example
+      #   client.credits.get_credit_event_ledger_entry(ledger_entry_id: "ledger_entry_id")
+      #
+      # @return [Schematic::Credits::Types::GetCreditEventLedgerEntryResponse]
+      def get_credit_event_ledger_entry(request_options: {}, **params)
+        params = Schematic::Internal::Types::Utils.normalize_keys(params)
+        request = Schematic::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v2/billing/credits/ledger/#{URI.encode_uri_component(params[:ledger_entry_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Schematic::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Schematic::Credits::Types::GetCreditEventLedgerEntryResponse.load(response.body))
+        else
+          error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+          error_types = {
+            401 => Schematic::Types::ApiError,
+            403 => Schematic::Types::ApiError,
+            404 => Schematic::Types::ApiError,
+            500 => Schematic::Types::ApiError
+          }
+          error_body = Schematic::Errors::ResponseError.load_error_body(code, response.body, error_types)
+          raise error_class.new(response.body, code: code, body: error_body)
+        end
+      end
+
       # @param request_options [Hash]
       # @param params [Hash]
       # @option request_options [String] :base_url
@@ -2075,6 +2120,7 @@ module Schematic
       # @option params [String, nil] :end_time
       # @option params [Schematic::Types::CreditEventType, nil] :event_type
       # @option params [String, nil] :feature_id
+      # @option params [String, nil] :source_event_id
       # @option params [String, nil] :start_time
       # @option params [Integer, nil] :limit
       # @option params [Integer, nil] :offset
@@ -2086,6 +2132,7 @@ module Schematic
       #     end_time: "end_time",
       #     event_type: "adjustment",
       #     feature_id: "feature_id",
+      #     source_event_id: "source_event_id",
       #     start_time: "start_time",
       #     limit: 1000000,
       #     offset: 1000000
@@ -2100,6 +2147,7 @@ module Schematic
         query_params["end_time"] = params[:end_time] if params.key?(:end_time)
         query_params["event_type"] = params[:event_type] if params.key?(:event_type)
         query_params["feature_id"] = params[:feature_id] if params.key?(:feature_id)
+        query_params["source_event_id"] = params[:source_event_id] if params.key?(:source_event_id)
         query_params["start_time"] = params[:start_time] if params.key?(:start_time)
         query_params["limit"] = params[:limit] if params.key?(:limit)
         query_params["offset"] = params[:offset] if params.key?(:offset)

data/lib/schematic/credits/types/count_credit_event_ledger_params.rb

@@ -19,6 +19,8 @@ module Schematic
 
         field :offset, -> { Integer }, optional: true, nullable: false
 
+        field :source_event_id, -> { String }, optional: true, nullable: false
+
         field :start_time, -> { String }, optional: true, nullable: false
       end
     end

data/lib/schematic/credits/types/count_credit_event_ledger_request.rb

@@ -14,6 +14,8 @@ module Schematic
 
         field :feature_id, -> { String }, optional: true, nullable: false
 
+        field :source_event_id, -> { String }, optional: true, nullable: false
+
         field :start_time, -> { String }, optional: true, nullable: false
 
         field :limit, -> { Integer }, optional: true, nullable: false

data/lib/schematic/{accounts/types/create_environment_response.rb → credits/types/get_credit_event_ledger_entry_response.rb}

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module Schematic
-  module Accounts
+  module Credits
     module Types
-      class CreateEnvironmentResponse < Internal::Types::Model
-        field :data, -> { Schematic::Types::EnvironmentDetailResponseData }, optional: false, nullable: false
+      class GetCreditEventLedgerEntryResponse < Internal::Types::Model
+        field :data, -> { Schematic::Types::CreditEventLedgerResponseData }, optional: false, nullable: false
 
         field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
       end

data/lib/schematic/credits/types/list_credit_event_ledger_params.rb

@@ -19,6 +19,8 @@ module Schematic
 
         field :offset, -> { Integer }, optional: true, nullable: false
 
+        field :source_event_id, -> { String }, optional: true, nullable: false
+
         field :start_time, -> { String }, optional: true, nullable: false
       end
     end

data/lib/schematic/credits/types/list_credit_event_ledger_request.rb

@@ -14,6 +14,8 @@ module Schematic
 
         field :feature_id, -> { String }, optional: true, nullable: false
 
+        field :source_event_id, -> { String }, optional: true, nullable: false
+
         field :start_time, -> { String }, optional: true, nullable: false
 
         field :limit, -> { Integer }, optional: true, nullable: false

data/lib/schematic/features/client.rb

@@ -462,7 +462,6 @@ module Schematic
       #
       # @example
       #   client.features.create_flag(
-      #     default_value: true,
       #     description: "description",
       #     flag_type: "boolean",
       #     key: "key",
@@ -555,7 +554,6 @@ module Schematic
       # @example
       #   client.features.update_flag(
       #     flag_id: "flag_id",
-      #     default_value: true,
       #     description: "description",
       #     flag_type: "boolean",
       #     key: "key",

data/lib/schematic/internal/iterators/cursor_item_iterator.rb

@@ -6,8 +6,8 @@ module Schematic
       # Instantiates a CursorItemIterator, an Enumerable class which wraps calls to a cursor-based paginated API and yields individual items from it.
       #
       # @param initial_cursor [String] The initial cursor to use when iterating, if any.
-      # @param cursor_field [Symbol] The field in API responses to extract the next cursor from.
-      # @param item_field [Symbol] The field in API responses to extract the items to iterate over.
+      # @param cursor_field [Symbol, Array<Symbol>] The field (or nested path) in API responses to extract the next cursor from.
+      # @param item_field [Symbol, Array<Symbol>] The field (or nested path) in API responses to extract the items to iterate over.
       # @param block [Proc] A block which is responsible for receiving a cursor to use and returning the given page from the API.
       # @return [Schematic::Internal::CursorItemIterator]
       def initialize(initial_cursor:, cursor_field:, item_field:, &block)

data/lib/schematic/internal/iterators/cursor_page_iterator.rb

@@ -12,7 +12,7 @@ module Schematic
       # Instantiates a CursorPageIterator, an Enumerable class which wraps calls to a cursor-based paginated API and yields pages of items.
       #
       # @param initial_cursor [String] The initial cursor to use when iterating, if any.
-      # @param cursor_field [Symbol] The name of the field in API responses to extract the next cursor from.
+      # @param cursor_field [Symbol, Array<Symbol>] The name (or nested path) of the field in API responses to extract the next cursor from.
       # @param block [Proc] A block which is responsible for receiving a cursor to use and returning the given page from the API.
       #   The block should return a two-element array: [parsed_page, raw_http_response].
       # @return [Schematic::Internal::CursorPageIterator]
@@ -93,7 +93,7 @@ module Schematic
         end
         @at_first_page = false
         @need_initial_load = false
-        @cursor = page.send(@cursor_field)
+        @cursor = read_field(page, @cursor_field)
         page
       end
 
@@ -112,6 +112,15 @@ module Schematic
         @http_response = raw_response
         fetched_page
       end
+
+      # Reads a field from an API response, walking through enclosing objects when the field is nested.
+      #
+      # @param value [Object, nil] The API response.
+      # @param field [Symbol, Array<Symbol>] The field name, or the path of field names for a nested field.
+      # @return [Object, nil]
+      def read_field(value, field)
+        Array(field).reduce(value) { |object, name| object&.send(name) }
+      end
     end
   end
 end

data/lib/schematic/internal/iterators/item_iterator.rb

@@ -21,7 +21,7 @@ module Schematic
         # share a position with each other or with `next_element`.
         pass = @item_pages.dup.tap(&:rewind)
         while (page = pass.next_page)
-          (page.send(@item_field) || []).each(&)
+          (read_field(page, @item_field) || []).each(&)
         end
         nil
       end
@@ -86,7 +86,7 @@ module Schematic
       def cached_page_items
         return [] unless @page
 
-        @page.send(@item_field) || []
+        read_field(@page, @item_field) || []
       end
 
       def next_item_from_cached_page
@@ -106,6 +106,15 @@ module Schematic
         @page = @item_pages.next_page
         @item_index = 0
       end
+
+      # Reads a field from an API response, walking through enclosing objects when the field is nested.
+      #
+      # @param value [Object, nil] The API response.
+      # @param field [Symbol, Array<Symbol>] The field name, or the path of field names for a nested field.
+      # @return [Object, nil]
+      def read_field(value, field)
+        Array(field).reduce(value) { |object, name| object&.send(name) }
+      end
     end
   end
 end

data/lib/schematic/internal/iterators/offset_item_iterator.rb

@@ -6,8 +6,8 @@ module Schematic
       # Instantiates an OffsetItemIterator, an Enumerable class which wraps calls to an offset-based paginated API and yields the individual items from it.
       #
       # @param initial_page [Integer] The initial page or offset to start from when iterating.
-      # @param item_field [Symbol] The name of the field in API responses to extract the items to iterate over.
-      # @param has_next_field [Symbol] The name of the field in API responses containing a boolean of whether another page exists.
+      # @param item_field [Symbol, Array<Symbol>] The name (or nested path) of the field in API responses to extract the items to iterate over.
+      # @param has_next_field [Symbol, Array<Symbol>] The name (or nested path) of the field in API responses containing a boolean of whether another page exists.
       # @param step [Boolean] If true, treats the page number as a true offset (i.e. increments the page number by the number of items returned from each call rather than just 1)
       # @param block [Proc] A block which is responsible for receiving a page number to use and returning the given page from the API.
       #