Method: MagicLinksClient#query_magic_links

Defined in:
lib/lockstep_sdk/clients/magic_links_client.rb

Queries Magic Links for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.

Parameters:

  • filter (string) —

    The filter for this query. See [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight)

  • include_param (string) —

    To fetch additional data on this object, specify the list of elements to retrieve. Available collections: User

  • order (string) —

    The sort order for the results, in the [Searchlight order syntax](github.com/tspence/csharp-searchlight).

  • page_size (int32) —

    The page size for results (default 250, maximum of 500)

  • page_number (int32) —

    The page number for results (default 0)



57
58
59
60
61
 
# File 'lib/lockstep_sdk/clients/magic_links_client.rb', line 57

def query_magic_links(filter:, include_param:, order:, page_size:, page_number:)
    path = "/api/v1/useraccounts/magic-links/query"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
    @connection.request(:get, path, nil, params)
end