passageidentity 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e054f6f2f16c809e2837abab2c504fdc74a72efc17637684fa16d7df46cb711
-  data.tar.gz: 7a2fdf636d8c50c6608f6bdf8f136c738ebc4a5778994ee571feaa04d480e640
+  metadata.gz: '08f4e03fb81dc561667b58f12c1be2e8add4599cab6e062abaa864f2e5bf8216'
+  data.tar.gz: cab51189540d53901348a97714bb5a1c7a606fd5a7d0a17f3d11d740d4d7a76d
 SHA512:
-  metadata.gz: 4e2c9626cbf491d68743c64ec42559dcfff2f9e555775937f89ba63f56e42ab3f98517f9aebac6b93ec84a145260374934b98dab1041051470663e0b429c6285
-  data.tar.gz: e4d50ed30523768f29e90fff59f864fbef471e59bc09dd33ad297ab287f2ff79966c187977212fd0ba8ff33bf63bc492150d96e9dd53266aa14c3414c49353c6
+  metadata.gz: 5f6b86e9cdf0aeb7ddb9b1595c0ede7322debf43601b85c17b72a39705a968f9ad7b1ad31dbc522b6f17ec83ddf76e379cc4df3a1463ce05f3b4a0f5dd1c5e91
+  data.tar.gz: 8f65d4dfbfed2ccfbbc15ca3ec2cb78cafbdc3680dac5c6806af9bdeb956c987f91704a87f333720c2385618d691da5e7e1af07472281b9c4426f5cd528cb6be

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.6.1] - 2024-09-26
+
+### Changed
+
+- Updated documentation links to point to new documentation
+
+## [0.6.0] - 2024-03-21
+
+### Added
+
+- `GetUserByIdentifier` method has been added
+- `ListPaginatedUsersItem` model has been added
+
 ## [0.5.0] - 2024-01-30
 
 ### Added
@@ -28,13 +41,11 @@ All notable changes to this project will be documented in this file.
 - Generate types and api calls with openapi generator.
 - Version constant instead of parsing gemspec.
 
-
 ### Deprecate
 
 - `user.signout()` -> `auth.revoke_user_refresh_tokens()`
 - `auth.authenticate_request()` -> `auth.validate_jwt()`
 
-
 ### Possible Breaking Changes
 
 - Types are now generated. Previous type names may have changed. [See documentation](https://github.com/passageidentity/passage-ruby/tree/main/docs/generated) for model definitions.

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in auth0.gemspec
+# Specify your gem's dependencies in passageidentity.gemspec
 gemspec
 
 group :development do

data/README.md

@@ -4,7 +4,7 @@
 
 # passage-ruby
 
-This Ruby SDK allows for verification of server-side authentication and user management for Ruby applications build with [Passage](https://passage.id).
+This Ruby SDK allows for verification of server-side authentication and user management for Ruby applications build with [Passage](https://passage.id). For more information, please visit [Passage Documentation](https://docs.passage.id).
 
 Install this package using [RubyGems](https://rubygems.org/gems/passageidentity).
 
@@ -61,9 +61,8 @@ require 'passageidentity'
 PassageClient =
   Passage::Client.new(app_id: PASSAGE_APP_ID)
 app_info = PassageClient.get_app()
-  
-```
 
+```
 
 ## Retrieve User Info
 
@@ -87,6 +86,27 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+## Retrieve User Info By Identifier
+
+To retrieve information about a user, you can also use the `get_by_identifier` method. You will need to use a Passage API key, which can be created in the Passage Console under your Application Settings. This API key grants your web server access to the Passage management APIs to get and update information about users. This API key must be protected and stored in an appropriate secure storage location. It should never be hard-coded in the repository.
+
+```ruby
+require 'passageidentity'
+
+class ApplicationController < ActionController::Base
+  PassageClient =
+    Passage::Client.new(app_id: PASSAGE_APP_ID, api_key: PASSAGE_API_KEY)
+  def authorize!
+    begin
+      user_id = PassageClient.auth.authenticate_request(request)
+      user = PassageClient.user.get_by_identifier(identifier: @identifier)
+      # user is authorized
+    rescue Exception => e
+      # handle exception (user is not authorized)
+    end
+  end
+end
+```
 
 ## Activate/Deactivate User
 
@@ -144,7 +164,6 @@ PassageClient =
 devices = PassageClient.user.list_devices(user_id: user_id)
 ```
 
-
 ## List User Devices
 
 You can list the devices associated with a particular Passage User.
@@ -162,7 +181,7 @@ end
 
 ## Create an Embeddable Magic Link
 
-To create a magic link, you should use the `create_magic_link` method. You can check out our guide on embeddable magic links in our [docs](https://docs.passage.id/guides/embedded-links).
+To create a magic link, you should use the `create_magic_link` method. You can check out our guide on embeddable magic links in our [docs](https://docs.passage.id/complete/magic-links).
 
 ```ruby
 require 'passageidentity'
@@ -182,19 +201,18 @@ magic_link =
 
 ## Available Functions
 
-
-Class | Method | Description
------------- | ------------- | -------------
-*ClientApi* | [**get_app**](docs/custom/ClientApi.md#get_app) |  Get App
-*ClientApi* | [**create_magic_link**](docs/custom/Passage/ClientApi.md#create_magic_link) | Create Embeddable Magic Link
-*AuthApi* | [**auth.authenticate_request**](docs/custom/AuthApi.md#authenticate_request) | Validates user jwt token
-*AuthApi* | [**auth.validate_jwt**](docs/custom/AuthApi.md#validate_jwt) | Validates user jwt token
-*UserAPI* | [**user.delete_device**](docs/custom/UserApi.md#delete_device) | Delete a device for a user
-*UserAPI* | [**user.list_devices**](docs/custom/UserApi.md#list_devices) | List User Devices
-*UserAPI* | [**user.activate**](docs/custom/UserApi.md#activate) | Activate User
-*UserAPI* | [**user.create**](docs/custom/UserApi.md#create) | Create User
-*UserAPI* | [**user.deactivate**](docs/custom/UserApi.md#deactivate) | Deactivate User
-*UserAPI* | [**user.delete**](docs/custom/UserApi.md#delete) | Delete User
-*UserAPI* | [**user.get**](docs/custom/UserApi.md#get) | Get User
-*UserAPI* | [**user.update**](docs/custom/UserApi.md#update) | Update User
-*UserAPI* | [**user.signout**](docs/custom/UserApi.md#signout) | Signout User
+| Class       | Method                                                                       | Description                  |
+| ----------- | ---------------------------------------------------------------------------- | ---------------------------- |
+| _ClientApi_ | [**get_app**](docs/custom/ClientApi.md#get_app)                              | Get App                      |
+| _ClientApi_ | [**create_magic_link**](docs/custom/Passage/ClientApi.md#create_magic_link)  | Create Embeddable Magic Link |
+| _AuthApi_   | [**auth.authenticate_request**](docs/custom/AuthApi.md#authenticate_request) | Validates user jwt token     |
+| _AuthApi_   | [**auth.validate_jwt**](docs/custom/AuthApi.md#validate_jwt)                 | Validates user jwt token     |
+| _UserAPI_   | [**user.delete_device**](docs/custom/UserApi.md#delete_device)               | Delete a device for a user   |
+| _UserAPI_   | [**user.list_devices**](docs/custom/UserApi.md#list_devices)                 | List User Devices            |
+| _UserAPI_   | [**user.activate**](docs/custom/UserApi.md#activate)                         | Activate User                |
+| _UserAPI_   | [**user.create**](docs/custom/UserApi.md#create)                             | Create User                  |
+| _UserAPI_   | [**user.deactivate**](docs/custom/UserApi.md#deactivate)                     | Deactivate User              |
+| _UserAPI_   | [**user.delete**](docs/custom/UserApi.md#delete)                             | Delete User                  |
+| _UserAPI_   | [**user.get**](docs/custom/UserApi.md#get)                                   | Get User                     |
+| _UserAPI_   | [**user.update**](docs/custom/UserApi.md#update)                             | Update User                  |
+| _UserAPI_   | [**user.signout**](docs/custom/UserApi.md#signout)                           | Signout User                 |

data/docs/generated/Link.md

@@ -0,0 +1,18 @@
+# OpenapiClient::Link
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **href** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Link.new(
+  href: null
+)
+```
+

data/docs/generated/ListPaginatedUsersItem.md

@@ -0,0 +1,38 @@
+# OpenapiClient::ListPaginatedUsersItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **email** | **String** |  |  |
+| **email_verified** | **Boolean** |  |  |
+| **id** | **String** |  |  |
+| **last_login_at** | **Time** |  |  |
+| **login_count** | **Integer** |  |  |
+| **phone** | **String** |  |  |
+| **phone_verified** | **Boolean** |  |  |
+| **status** | [**UserStatus**](UserStatus.md) |  |  |
+| **updated_at** | **Time** |  |  |
+| **user_metadata** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ListPaginatedUsersItem.new(
+  created_at: null,
+  email: null,
+  email_verified: null,
+  id: null,
+  last_login_at: null,
+  login_count: null,
+  phone: null,
+  phone_verified: null,
+  status: null,
+  updated_at: null,
+  user_metadata: null
+)
+```
+

data/docs/generated/ListPaginatedUsersResponse.md

@@ -0,0 +1,28 @@
+# OpenapiClient::ListPaginatedUsersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**PaginatedLinks**](PaginatedLinks.md) |  |  |
+| **created_before** | **Integer** | time anchor (Unix timestamp) --> all users returned created before this timestamp |  |
+| **limit** | **Integer** |  |  |
+| **page** | **Integer** |  |  |
+| **total_users** | **Integer** | total number of users for a particular query |  |
+| **users** | [**Array<ListPaginatedUsersItem>**](ListPaginatedUsersItem.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ListPaginatedUsersResponse.new(
+  _links: null,
+  created_before: null,
+  limit: null,
+  page: null,
+  total_users: null,
+  users: null
+)
+```
+

data/docs/generated/Model403Error.md

@@ -0,0 +1,20 @@
+# OpenapiClient::Model403Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **error** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Model403Error.new(
+  code: null,
+  error: null
+)
+```
+

data/docs/generated/Nonce.md

@@ -0,0 +1,18 @@
+# OpenapiClient::Nonce
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nonce** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Nonce.new(
+  nonce: null
+)
+```
+

data/docs/generated/PaginatedLinks.md

@@ -0,0 +1,26 @@
+# OpenapiClient::PaginatedLinks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first** | [**Link**](Link.md) |  |  |
+| **last** | [**Link**](Link.md) |  |  |
+| **_next** | [**Link**](Link.md) |  |  |
+| **previous** | [**Link**](Link.md) |  |  |
+| **_self** | [**Link**](Link.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::PaginatedLinks.new(
+  first: null,
+  last: null,
+  _next: null,
+  previous: null,
+  _self: null
+)
+```
+

data/docs/generated/README.md

@@ -96,6 +96,7 @@ Class | Method | HTTP request | Description
 *OpenapiClient::UsersApi* | [**deactivate_user**](docs/UsersApi.md#deactivate_user) | **PATCH** /apps/{app_id}/users/{user_id}/deactivate | Deactivate User
 *OpenapiClient::UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /apps/{app_id}/users/{user_id} | Delete User
 *OpenapiClient::UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /apps/{app_id}/users/{user_id} | Get User
+*OpenapiClient::UsersApi* | [**list_paginated_users**](docs/UsersApi.md#list_paginated_users) | **GET** /apps/{app_id}/users | List Users
 *OpenapiClient::UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PATCH** /apps/{app_id}/users/{user_id} | Update User
 
 
@@ -113,7 +114,10 @@ Class | Method | HTTP request | Description
  - [OpenapiClient::GoogleUserSocialConnection](docs/GoogleUserSocialConnection.md)
  - [OpenapiClient::LayoutConfig](docs/LayoutConfig.md)
  - [OpenapiClient::Layouts](docs/Layouts.md)
+ - [OpenapiClient::Link](docs/Link.md)
  - [OpenapiClient::ListDevicesResponse](docs/ListDevicesResponse.md)
+ - [OpenapiClient::ListPaginatedUsersItem](docs/ListPaginatedUsersItem.md)
+ - [OpenapiClient::ListPaginatedUsersResponse](docs/ListPaginatedUsersResponse.md)
  - [OpenapiClient::MagicLink](docs/MagicLink.md)
  - [OpenapiClient::MagicLinkAuthMethod](docs/MagicLinkAuthMethod.md)
  - [OpenapiClient::MagicLinkChannel](docs/MagicLinkChannel.md)
@@ -121,16 +125,17 @@ Class | Method | HTTP request | Description
  - [OpenapiClient::MagicLinkType](docs/MagicLinkType.md)
  - [OpenapiClient::Model400Error](docs/Model400Error.md)
  - [OpenapiClient::Model401Error](docs/Model401Error.md)
+ - [OpenapiClient::Model403Error](docs/Model403Error.md)
  - [OpenapiClient::Model404Error](docs/Model404Error.md)
  - [OpenapiClient::Model500Error](docs/Model500Error.md)
+ - [OpenapiClient::Nonce](docs/Nonce.md)
  - [OpenapiClient::OtpAuthMethod](docs/OtpAuthMethod.md)
+ - [OpenapiClient::PaginatedLinks](docs/PaginatedLinks.md)
  - [OpenapiClient::PasskeysAuthMethod](docs/PasskeysAuthMethod.md)
  - [OpenapiClient::Technologies](docs/Technologies.md)
  - [OpenapiClient::TtlDisplayUnit](docs/TtlDisplayUnit.md)
- - [OpenapiClient::UpdateMagicLinkAuthMethod](docs/UpdateMagicLinkAuthMethod.md)
- - [OpenapiClient::UpdateOtpAuthMethod](docs/UpdateOtpAuthMethod.md)
- - [OpenapiClient::UpdatePasskeysAuthMethod](docs/UpdatePasskeysAuthMethod.md)
  - [OpenapiClient::UpdateUserRequest](docs/UpdateUserRequest.md)
+ - [OpenapiClient::UserEventStatus](docs/UserEventStatus.md)
  - [OpenapiClient::UserInfo](docs/UserInfo.md)
  - [OpenapiClient::UserMetadataField](docs/UserMetadataField.md)
  - [OpenapiClient::UserMetadataFieldType](docs/UserMetadataFieldType.md)

data/docs/generated/UserEventStatus.md

@@ -0,0 +1,15 @@
+# OpenapiClient::UserEventStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UserEventStatus.new()
+```
+

data/docs/generated/UserRecentEvent.md

@@ -5,8 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **created_at** | **Time** |  |  |
+| **completed_at** | **Time** |  |  |
 | **id** | **String** |  |  |
 | **ip_addr** | **String** |  |  |
+| **status** | [**UserEventStatus**](UserEventStatus.md) |  |  |
 | **type** | **String** |  |  |
 | **user_agent** | **String** |  |  |
 
@@ -17,8 +19,10 @@ require 'openapi_client'
 
 instance = OpenapiClient::UserRecentEvent.new(
   created_at: null,
+  completed_at: null,
   id: null,
   ip_addr: null,
+  status: null,
   type: null,
   user_agent: null
 )

data/docs/generated/UsersApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://api.passage.id/v1*
 | [**deactivate_user**](UsersApi.md#deactivate_user) | **PATCH** /apps/{app_id}/users/{user_id}/deactivate | Deactivate User |
 | [**delete_user**](UsersApi.md#delete_user) | **DELETE** /apps/{app_id}/users/{user_id} | Delete User |
 | [**get_user**](UsersApi.md#get_user) | **GET** /apps/{app_id}/users/{user_id} | Get User |
+| [**list_paginated_users**](UsersApi.md#list_paginated_users) | **GET** /apps/{app_id}/users | List Users |
 | [**update_user**](UsersApi.md#update_user) | **PATCH** /apps/{app_id}/users/{user_id} | Update User |
 
 
@@ -366,6 +367,99 @@ end
 - **Accept**: application/json
 
 
+## list_paginated_users
+
+> <ListPaginatedUsersResponse> list_paginated_users(app_id, opts)
+
+List Users
+
+List users for an app.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenapiClient::UsersApi.new
+app_id = 'app_id_example' # String | App ID
+opts = {
+  page: 56, # Integer | page to fetch (min=1)
+  limit: 56, # Integer | number of users to fetch per page (max=500)
+  created_before: 56, # Integer | Unix timestamp to anchor pagination results (fetches events that were created before the timestamp)
+  order_by: 'order_by_example', # String | Comma separated list of <field>:<ASC/DESC> (example: order_by=id:DESC,created_at:ASC) **cannot order_by `identifier`
+  identifier: 'identifier_example', # String | search users email OR phone (pagination prepended operators identifier=<val>, identifier=<ne:val>, identifier=<gt:val>, identifier=<lt:val>, identifier=<like:val>, identifier=<not_like:val>)
+  id: 'id_example', # String | search users id (pagination prepended operators id=<val>, id=<ne:val>, id=<gt:val>, id=<lt:val>, id=<like:val>, id=<not_like:val>)
+  login_count: 56, # Integer | search users login_count (pagination prepended operators login_count=<val>, login_count=<ne:val>, login_count=<gt:val>, login_count=<lt:val>)
+  status: 'status_example', # String | search users by status (pagination prepended operators status=<val>, status=<ne:val>, status=<gt:val>, status=<lt:val>, status=<like:val>, status=<not_like:val>) -- valid values: (active, inactive, pending)
+  created_at: 'created_at_example', # String | search users created_at (pagination prepended operators created_at=<val>, created_at=<ne:val>, created_at=<gt:val>, created_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required
+  updated_at: 'updated_at_example', # String | search users updated_at (pagination prepended operators updated_at=<val>, updated_at=<ne:val>, updated_at=<gt:val>, updated_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required
+  last_login_at: 'last_login_at_example' # String | search users last_login_at (pagination prepended operators last_login_at=<val>, lat_login_at=<ne:val>, last_login_at=<gt:val>, last_login_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required
+}
+
+begin
+  # List Users
+  result = api_instance.list_paginated_users(app_id, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->list_paginated_users: #{e}"
+end
+```
+
+#### Using the list_paginated_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListPaginatedUsersResponse>, Integer, Hash)> list_paginated_users_with_http_info(app_id, opts)
+
+```ruby
+begin
+  # List Users
+  data, status_code, headers = api_instance.list_paginated_users_with_http_info(app_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListPaginatedUsersResponse>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->list_paginated_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **page** | **Integer** | page to fetch (min&#x3D;1) | [optional] |
+| **limit** | **Integer** | number of users to fetch per page (max&#x3D;500) | [optional] |
+| **created_before** | **Integer** | Unix timestamp to anchor pagination results (fetches events that were created before the timestamp) | [optional] |
+| **order_by** | **String** | Comma separated list of &lt;field&gt;:&lt;ASC/DESC&gt; (example: order_by&#x3D;id:DESC,created_at:ASC) **cannot order_by &#x60;identifier&#x60; | [optional] |
+| **identifier** | **String** | search users email OR phone (pagination prepended operators identifier&#x3D;&lt;val&gt;, identifier&#x3D;&lt;ne:val&gt;, identifier&#x3D;&lt;gt:val&gt;, identifier&#x3D;&lt;lt:val&gt;, identifier&#x3D;&lt;like:val&gt;, identifier&#x3D;&lt;not_like:val&gt;) | [optional] |
+| **id** | **String** | search users id (pagination prepended operators id&#x3D;&lt;val&gt;, id&#x3D;&lt;ne:val&gt;, id&#x3D;&lt;gt:val&gt;, id&#x3D;&lt;lt:val&gt;, id&#x3D;&lt;like:val&gt;, id&#x3D;&lt;not_like:val&gt;) | [optional] |
+| **login_count** | **Integer** | search users login_count (pagination prepended operators login_count&#x3D;&lt;val&gt;, login_count&#x3D;&lt;ne:val&gt;, login_count&#x3D;&lt;gt:val&gt;, login_count&#x3D;&lt;lt:val&gt;) | [optional] |
+| **status** | **String** | search users by status (pagination prepended operators status&#x3D;&lt;val&gt;, status&#x3D;&lt;ne:val&gt;, status&#x3D;&lt;gt:val&gt;, status&#x3D;&lt;lt:val&gt;, status&#x3D;&lt;like:val&gt;, status&#x3D;&lt;not_like:val&gt;) -- valid values: (active, inactive, pending) | [optional] |
+| **created_at** | **String** | search users created_at (pagination prepended operators created_at&#x3D;&lt;val&gt;, created_at&#x3D;&lt;ne:val&gt;, created_at&#x3D;&lt;gt:val&gt;, created_at&#x3D;&lt;lt:val&gt; -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required | [optional] |
+| **updated_at** | **String** | search users updated_at (pagination prepended operators updated_at&#x3D;&lt;val&gt;, updated_at&#x3D;&lt;ne:val&gt;, updated_at&#x3D;&lt;gt:val&gt;, updated_at&#x3D;&lt;lt:val&gt; -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required | [optional] |
+| **last_login_at** | **String** | search users last_login_at (pagination prepended operators last_login_at&#x3D;&lt;val&gt;, lat_login_at&#x3D;&lt;ne:val&gt;, last_login_at&#x3D;&lt;gt:val&gt;, last_login_at&#x3D;&lt;lt:val&gt; -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required | [optional] |
+
+### Return type
+
+[**ListPaginatedUsersResponse**](ListPaginatedUsersResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## update_user
 
 > <UserResponse> update_user(app_id, user_id, update_user_request)

data/lib/openapi_client/api/users_api.rb

@@ -369,6 +369,102 @@ module OpenapiClient
       return data, status_code, headers
     end
 
+    # List Users
+    # List users for an app.
+    # @param app_id [String] App ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page page to fetch (min=1)
+    # @option opts [Integer] :limit number of users to fetch per page (max=500)
+    # @option opts [Integer] :created_before Unix timestamp to anchor pagination results (fetches events that were created before the timestamp)
+    # @option opts [String] :order_by Comma separated list of <field>:<ASC/DESC> (example: order_by=id:DESC,created_at:ASC) **cannot order_by `identifier`
+    # @option opts [String] :identifier search users email OR phone (pagination prepended operators identifier=<val>, identifier=<ne:val>, identifier=<gt:val>, identifier=<lt:val>, identifier=<like:val>, identifier=<not_like:val>)
+    # @option opts [String] :id search users id (pagination prepended operators id=<val>, id=<ne:val>, id=<gt:val>, id=<lt:val>, id=<like:val>, id=<not_like:val>)
+    # @option opts [Integer] :login_count search users login_count (pagination prepended operators login_count=<val>, login_count=<ne:val>, login_count=<gt:val>, login_count=<lt:val>)
+    # @option opts [String] :status search users by status (pagination prepended operators status=<val>, status=<ne:val>, status=<gt:val>, status=<lt:val>, status=<like:val>, status=<not_like:val>) -- valid values: (active, inactive, pending)
+    # @option opts [String] :created_at search users created_at (pagination prepended operators created_at=<val>, created_at=<ne:val>, created_at=<gt:val>, created_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required
+    # @option opts [String] :updated_at search users updated_at (pagination prepended operators updated_at=<val>, updated_at=<ne:val>, updated_at=<gt:val>, updated_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required
+    # @option opts [String] :last_login_at search users last_login_at (pagination prepended operators last_login_at=<val>, lat_login_at=<ne:val>, last_login_at=<gt:val>, last_login_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required
+    # @return [ListPaginatedUsersResponse]
+    def list_paginated_users(app_id, opts = {})
+      data, _status_code, _headers = list_paginated_users_with_http_info(app_id, opts)
+      data
+    end
+
+    # List Users
+    # List users for an app.
+    # @param app_id [String] App ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page page to fetch (min=1)
+    # @option opts [Integer] :limit number of users to fetch per page (max=500)
+    # @option opts [Integer] :created_before Unix timestamp to anchor pagination results (fetches events that were created before the timestamp)
+    # @option opts [String] :order_by Comma separated list of <field>:<ASC/DESC> (example: order_by=id:DESC,created_at:ASC) **cannot order_by `identifier`
+    # @option opts [String] :identifier search users email OR phone (pagination prepended operators identifier=<val>, identifier=<ne:val>, identifier=<gt:val>, identifier=<lt:val>, identifier=<like:val>, identifier=<not_like:val>)
+    # @option opts [String] :id search users id (pagination prepended operators id=<val>, id=<ne:val>, id=<gt:val>, id=<lt:val>, id=<like:val>, id=<not_like:val>)
+    # @option opts [Integer] :login_count search users login_count (pagination prepended operators login_count=<val>, login_count=<ne:val>, login_count=<gt:val>, login_count=<lt:val>)
+    # @option opts [String] :status search users by status (pagination prepended operators status=<val>, status=<ne:val>, status=<gt:val>, status=<lt:val>, status=<like:val>, status=<not_like:val>) -- valid values: (active, inactive, pending)
+    # @option opts [String] :created_at search users created_at (pagination prepended operators created_at=<val>, created_at=<ne:val>, created_at=<gt:val>, created_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required
+    # @option opts [String] :updated_at search users updated_at (pagination prepended operators updated_at=<val>, updated_at=<ne:val>, updated_at=<gt:val>, updated_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required
+    # @option opts [String] :last_login_at search users last_login_at (pagination prepended operators last_login_at=<val>, lat_login_at=<ne:val>, last_login_at=<gt:val>, last_login_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required
+    # @return [Array<(ListPaginatedUsersResponse, Integer, Hash)>] ListPaginatedUsersResponse data, response status code and response headers
+    def list_paginated_users_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.list_paginated_users ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling UsersApi.list_paginated_users"
+      end
+      # resource path
+      local_var_path = '/apps/{app_id}/users'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+      query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
+      query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
+      query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
+      query_params[:'login_count'] = opts[:'login_count'] if !opts[:'login_count'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'created_at'] = opts[:'created_at'] if !opts[:'created_at'].nil?
+      query_params[:'updated_at'] = opts[:'updated_at'] if !opts[:'updated_at'].nil?
+      query_params[:'last_login_at'] = opts[:'last_login_at'] if !opts[:'last_login_at'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListPaginatedUsersResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.list_paginated_users",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#list_paginated_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update User
     # Update a user's information.
     # @param app_id [String] App ID