passageidentity 0.2.3 → 0.3.0

data/docs/generated/ElementCustomization.md

@@ -0,0 +1,56 @@
+# OpenapiClient::ElementCustomization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **passage_container_background_color** | **String** | Container background color in hex. Default is `#ffffff` in light mode & `#383838` in dark mode.  | [optional] |
+| **passage_container_max_width** | **Integer** | Maximum width of container (px) | [optional][default to 300] |
+| **passage_input_box_background_color** | **String** | Input box background color in hex. Default is `#ffffff` in light mode & `#4b4b4b` in dark mode.  | [optional] |
+| **passage_input_box_border_radius** | **Integer** | Input box border radius (px) | [optional][default to 5] |
+| **passage_header_font_family** | [**FontFamily**](FontFamily.md) |  | [optional][default to 'Helvetica'] |
+| **passage_body_font_family** | [**FontFamily**](FontFamily.md) |  | [optional][default to 'Helvetica'] |
+| **passage_header_text_color** | **String** | Header text color in hex. Default is `#222222` in light mode & `#f3f3f3` in dark mode.  | [optional] |
+| **passage_body_text_color** | **String** | Body text color in hex. Default is `#222222` in light mode & `#f3f3f3` in dark mode.  | [optional] |
+| **passage_primary_button_background_color** | **String** | Primary button background colour (hex) | [optional][default to '#121212'] |
+| **passage_primary_button_text_color** | **String** | Primary button font colour (hex) | [optional][default to '#f3f3f3'] |
+| **passage_primary_button_hover_color** | **String** | Primary button background on hover (hex) | [optional][default to '#4d4d4d'] |
+| **passage_primary_button_border_radius** | **Integer** | Primary button border radius (px) | [optional][default to 5] |
+| **passage_primary_button_border_color** | **String** | Primary button border color | [optional][default to '#121212'] |
+| **passage_primary_button_border_width** | **Integer** | Primary button border width (px) | [optional][default to 0] |
+| **passage_secondary_button_background_color** | **String** | Secondary button background colour (hex) | [optional][default to '#ffffff'] |
+| **passage_secondary_button_text_color** | **String** | Secondary button font colour (hex) | [optional][default to '#222222'] |
+| **passage_secondary_button_hover_color** | **String** | Secondary button background on hover (hex) | [optional][default to '#d7d7d7'] |
+| **passage_secondary_button_border_radius** | **Integer** | Secondary button border radius (px) | [optional][default to 5] |
+| **passage_secondary_button_border_color** | **String** | Secondary button border color | [optional][default to '#d7d7d7'] |
+| **passage_secondary_button_border_width** | **Integer** | Secondary button border width (px) | [optional][default to 1] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ElementCustomization.new(
+  passage_container_background_color: #ffffff,
+  passage_container_max_width: null,
+  passage_input_box_background_color: #ffffff,
+  passage_input_box_border_radius: null,
+  passage_header_font_family: null,
+  passage_body_font_family: null,
+  passage_header_text_color: #222222,
+  passage_body_text_color: #222222,
+  passage_primary_button_background_color: null,
+  passage_primary_button_text_color: null,
+  passage_primary_button_hover_color: null,
+  passage_primary_button_border_radius: null,
+  passage_primary_button_border_color: null,
+  passage_primary_button_border_width: null,
+  passage_secondary_button_background_color: null,
+  passage_secondary_button_text_color: null,
+  passage_secondary_button_hover_color: null,
+  passage_secondary_button_border_radius: null,
+  passage_secondary_button_border_color: null,
+  passage_secondary_button_border_width: null
+)
+```
+

data/docs/generated/FontFamily.md

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

data/docs/generated/LayoutConfig.md

@@ -0,0 +1,26 @@
+# OpenapiClient::LayoutConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **h** | **Integer** |  |  |
+| **id** | **String** |  |  |
+| **w** | **Integer** |  |  |
+| **x** | **Integer** |  |  |
+| **y** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::LayoutConfig.new(
+  h: null,
+  id: null,
+  w: null,
+  x: null,
+  y: null
+)
+```
+

data/docs/generated/Layouts.md

@@ -0,0 +1,20 @@
+# OpenapiClient::Layouts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile** | [**Array<LayoutConfig>**](LayoutConfig.md) |  |  |
+| **registration** | [**Array<LayoutConfig>**](LayoutConfig.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Layouts.new(
+  profile: null,
+  registration: null
+)
+```
+

data/docs/generated/ListDevicesResponse.md

@@ -0,0 +1,18 @@
+# OpenapiClient::ListDevicesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **devices** | [**Array<WebAuthnDevices>**](WebAuthnDevices.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ListDevicesResponse.new(
+  devices: null
+)
+```
+

data/docs/generated/MagicLink.md

@@ -0,0 +1,36 @@
+# OpenapiClient::MagicLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **activated** | **Boolean** |  |  |
+| **app_id** | **String** |  |  |
+| **id** | **String** |  |  |
+| **identifier** | **String** |  |  |
+| **redirect_url** | **String** |  |  |
+| **secret** | **String** |  |  |
+| **ttl** | **Integer** |  |  |
+| **type** | [**MagicLinkType**](MagicLinkType.md) |  |  |
+| **url** | **String** |  |  |
+| **user_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::MagicLink.new(
+  activated: null,
+  app_id: null,
+  id: null,
+  identifier: null,
+  redirect_url: null,
+  secret: null,
+  ttl: null,
+  type: null,
+  url: null,
+  user_id: null
+)
+```
+

data/docs/generated/MagicLinkAuthMethod.md

@@ -0,0 +1,22 @@
+# OpenapiClient::MagicLinkAuthMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  |  |
+| **ttl** | **Integer** | Maximum time (IN SECONDS) for the auth to expire. | [default to 300] |
+| **ttl_display_unit** | [**TtlDisplayUnit**](TtlDisplayUnit.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::MagicLinkAuthMethod.new(
+  enabled: null,
+  ttl: null,
+  ttl_display_unit: null
+)
+```
+

data/docs/generated/MagicLinkChannel.md

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

data/docs/generated/MagicLinkResponse.md

@@ -0,0 +1,18 @@
+# OpenapiClient::MagicLinkResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **magic_link** | [**MagicLink**](MagicLink.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::MagicLinkResponse.new(
+  magic_link: null
+)
+```
+

data/docs/generated/MagicLinkType.md

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

data/docs/generated/MagicLinksApi.md

@@ -0,0 +1,79 @@
+# OpenapiClient::MagicLinksApi
+
+All URIs are relative to *https://api.passage.id/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_magic_link**](MagicLinksApi.md#create_magic_link) | **POST** /apps/{app_id}/magic-links | Create Embeddable Magic Link |
+
+
+## create_magic_link
+
+> <MagicLinkResponse> create_magic_link(app_id, create_magic_link_request)
+
+Create Embeddable Magic Link
+
+Create magic link for a user.
+
+### 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::MagicLinksApi.new
+app_id = 'app_id_example' # String | App ID
+create_magic_link_request = OpenapiClient::CreateMagicLinkRequest.new({channel: OpenapiClient::MagicLinkChannel::EMAIL, email: 'email_example', magic_link_path: 'magic_link_path_example', phone: 'phone_example', redirect_url: 'redirect_url_example', _send: false, ttl: 37, user_id: 'user_id_example'}) # CreateMagicLinkRequest | magic link request
+
+begin
+  # Create Embeddable Magic Link
+  result = api_instance.create_magic_link(app_id, create_magic_link_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling MagicLinksApi->create_magic_link: #{e}"
+end
+```
+
+#### Using the create_magic_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MagicLinkResponse>, Integer, Hash)> create_magic_link_with_http_info(app_id, create_magic_link_request)
+
+```ruby
+begin
+  # Create Embeddable Magic Link
+  data, status_code, headers = api_instance.create_magic_link_with_http_info(app_id, create_magic_link_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MagicLinkResponse>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling MagicLinksApi->create_magic_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **create_magic_link_request** | [**CreateMagicLinkRequest**](CreateMagicLinkRequest.md) | magic link request |  |
+
+### Return type
+
+[**MagicLinkResponse**](MagicLinkResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/generated/Model400Error.md

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

data/docs/generated/Model401Error.md

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

data/docs/generated/Model404Error.md

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

data/docs/generated/Model500Error.md

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

data/docs/generated/OtpAuthMethod.md

@@ -0,0 +1,22 @@
+# OpenapiClient::OtpAuthMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  |  |
+| **ttl** | **Integer** | Maximum time (IN SECONDS) for the auth to expire. | [default to 300] |
+| **ttl_display_unit** | [**TtlDisplayUnit**](TtlDisplayUnit.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::OtpAuthMethod.new(
+  enabled: null,
+  ttl: null,
+  ttl_display_unit: null
+)
+```
+

data/docs/generated/PasskeysAuthMethod.md

@@ -0,0 +1,18 @@
+# OpenapiClient::PasskeysAuthMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  | [default to true] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::PasskeysAuthMethod.new(
+  enabled: null
+)
+```
+

data/docs/generated/Technologies.md

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

data/docs/generated/TokensApi.md

@@ -0,0 +1,78 @@
+# OpenapiClient::TokensApi
+
+All URIs are relative to *https://api.passage.id/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**revoke_user_refresh_tokens**](TokensApi.md#revoke_user_refresh_tokens) | **DELETE** /apps/{app_id}/users/{user_id}/tokens | Revokes refresh tokens |
+
+
+## revoke_user_refresh_tokens
+
+> revoke_user_refresh_tokens(app_id, user_id)
+
+Revokes refresh tokens
+
+Revokes all refresh tokens for a user
+
+### 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::TokensApi.new
+app_id = 'app_id_example' # String | App ID
+user_id = 'user_id_example' # String | User ID
+
+begin
+  # Revokes refresh tokens
+  api_instance.revoke_user_refresh_tokens(app_id, user_id)
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling TokensApi->revoke_user_refresh_tokens: #{e}"
+end
+```
+
+#### Using the revoke_user_refresh_tokens_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> revoke_user_refresh_tokens_with_http_info(app_id, user_id)
+
+```ruby
+begin
+  # Revokes refresh tokens
+  data, status_code, headers = api_instance.revoke_user_refresh_tokens_with_http_info(app_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling TokensApi->revoke_user_refresh_tokens_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **user_id** | **String** | User ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/generated/TtlDisplayUnit.md

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

data/docs/generated/UpdateMagicLinkAuthMethod.md

@@ -0,0 +1,22 @@
+# OpenapiClient::UpdateMagicLinkAuthMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  | [optional] |
+| **ttl** | **Integer** | Maximum time (IN SECONDS) for the auth to expire. | [optional][default to 300] |
+| **ttl_display_unit** | [**TtlDisplayUnit**](TtlDisplayUnit.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UpdateMagicLinkAuthMethod.new(
+  enabled: null,
+  ttl: null,
+  ttl_display_unit: null
+)
+```
+

data/docs/generated/UpdateOtpAuthMethod.md

@@ -0,0 +1,22 @@
+# OpenapiClient::UpdateOtpAuthMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  | [optional] |
+| **ttl** | **Integer** | Maximum time (IN SECONDS) for the auth to expire. | [optional][default to 300] |
+| **ttl_display_unit** | [**TtlDisplayUnit**](TtlDisplayUnit.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UpdateOtpAuthMethod.new(
+  enabled: null,
+  ttl: null,
+  ttl_display_unit: null
+)
+```
+

data/docs/generated/UpdatePasskeysAuthMethod.md

@@ -0,0 +1,18 @@
+# OpenapiClient::UpdatePasskeysAuthMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UpdatePasskeysAuthMethod.new(
+  enabled: null
+)
+```
+

data/docs/generated/UpdateUserRequest.md

@@ -0,0 +1,22 @@
+# OpenapiClient::UpdateUserRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **user_metadata** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UpdateUserRequest.new(
+  email: null,
+  phone: null,
+  user_metadata: null
+)
+```
+