stytchauth/stytch-ruby

Documentation issue Users search for ruby client

dgalindez opened this issue · 0 comments

Not sure if this is the right place to report this, if I should report this elsewhere please point me in the right direction. I also did not find any template for bug/issue reports so let me know if I should change the format for this.

The documentation found here, at least for the ruby client seems to be outdated.
I am fairly new to ruby so if I am being dumb do say so 😄
It states that the following will work:

query = {
  operator: 'AND',
  operands: [
    { filter_name: 'user_id', filter_value: ['user-test-923a5504-ec8e-4258-96b5-b9ab870101bc'] }
  ]
}

resp = client.users.search(query)

However, the search method seems to expect a hash of parameters, so what needs to be passed in is

resp = client.users.search(query:)

It also states there is a search_all method, which does not seem to exist in the source code.
Not a big issue since doing

client.users.search

will return all records, but still something I thought worth pointing out

Please let me know if I should report this elsewhere or if more detail is needed

Thanks!