Method: FulfilApi::Relation::QueryMethods#offset

Defined in:

lib/fulfil_api/relation/query_methods.rb

#offset(value) ⇒ FulfilApi::Relation

Note:

If not specified, Fulfil will assume a request offset of 0.

Applies an offset to the API resources returned by Fulfil’s API.

This is useful when paginating over larger lists of API resources.

Parameters:

• value (Integer) —

  The page offset for the API request.

Returns:

• (FulfilApi::Relation) —

  A new FulfilApi::Relation instance with the offset applied.

# File 'lib/fulfil_api/relation/query_methods.rb', line 55

def offset(value)
  clone.tap do |relation|
    relation.request_offset = value
  end
end