Class: Sink::Resources::PaginationTests::Cursor

Inherits:
Object
  • Object
show all
Defined in:
lib/sink/resources/pagination_tests/cursor.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Cursor

Returns a new instance of Cursor.

Parameters:



8
9
10
 
# File 'lib/sink/resources/pagination_tests/cursor.rb', line 8

def initialize(client:)
  @client = client
end

Instance Method Details

#list(params = {}, opts = {}) ⇒ Sink::PageCursor<Sink::Models::MyModel>

Test case for cursor pagination

Parameters:

  • params (Hash{Symbol => Object}) (defaults to: {}) —

    Attributes to send in this request. @option params [String, nil] :cursor @option params [Integer, nil] :limit

  • opts (Hash, Sink::RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/sink/resources/pagination_tests/cursor.rb', line 21

def list(params = {}, opts = {})
  req = {
    method: :get,
    path: "/paginated/cursor",
    query: params,
    page: Sink::PageCursor,
    model: Sink::Models::MyModel
  }
  @client.request(req, opts)
end

#list_reverse(params = {}, opts = {}) ⇒ Sink::PageCursorWithReverse<Sink::Models::MyModel>

Test case for cursor pagination with reverse support

Parameters:

  • params (Hash{Symbol => Object}) (defaults to: {}) —

    Attributes to send in this request. @option params [String, nil] :after_id ID of the object to use as a cursor for pagination. When provided, returns the

    page of results immediately after this object.

    @option params [String, nil] :before_id ID of the object to use as a cursor for pagination. When provided, returns the

    page of results immediately before this object.

    @option params [Integer, nil] :limit

  • opts (Hash, Sink::RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/sink/resources/pagination_tests/cursor.rb', line 44

def list_reverse(params = {}, opts = {})
  req = {
    method: :get,
    path: "/paginated/cursor_with_reverse",
    query: params,
    page: Sink::PageCursorWithReverse,
    model: Sink::Models::MyModel
  }
  @client.request(req, opts)
end