SDK updates - getUserByIdentifier

SDK updates
passageidentity · Mar 26, 2024 · 21c5ff4 · 21c5ff4
2 parents 8007062 + 29a48d2
commit 21c5ff4
Show file tree

Hide file tree

Showing 35 changed files with 2,281 additions and 93 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.6.0] - 2024-03-21
+
+### Added
+
+- `GetUserByIdentifier` method has been added
+- `ListPaginatedUsersItem` model has been added
+
 ## [0.5.0] - 2024-01-30
 
 ### Added

diff --git a/README.md b/README.md
@@ -87,6 +87,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
 

diff --git a/docs/generated/Link.md b/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
+)
+```
+
diff --git a/docs/generated/ListPaginatedUsersItem.md b/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
+)
+```
+
diff --git a/docs/generated/ListPaginatedUsersResponse.md b/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) --&gt; all users returned created before this timestamp |  |
+| **limit** | **Integer** |  |  |
+| **page** | **Integer** |  |  |
+| **total_users** | **Integer** | total number of users for a particular query |  |
+| **users** | [**Array&lt;ListPaginatedUsersItem&gt;**](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
+)
+```
+
diff --git a/docs/generated/Model403Error.md b/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
+)
+```
+
diff --git a/docs/generated/Nonce.md b/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
+)
+```
+
diff --git a/docs/generated/PaginatedLinks.md b/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
+)
+```
+
diff --git a/docs/generated/README.md b/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,24 +114,28 @@ 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)
  - [OpenapiClient::MagicLinkResponse](docs/MagicLinkResponse.md)
  - [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)

diff --git a/docs/generated/UpdateMagicLinkAuthMethod.md b/docs/generated/UpdateMagicLinkAuthMethod.md
diff --git a/docs/generated/UpdateOtpAuthMethod.md b/docs/generated/UpdateOtpAuthMethod.md
diff --git a/docs/generated/UpdatePasskeysAuthMethod.md b/docs/generated/UpdatePasskeysAuthMethod.md
diff --git a/docs/generated/UserEventStatus.md b/docs/generated/UserEventStatus.md
@@ -0,0 +1,15 @@
+# OpenapiClient::UserEventStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UserEventStatus.new()
+```
+
diff --git a/docs/generated/UserRecentEvent.md b/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
 )