passageidentity 0.6.2 → 0.7.0

data/docs/generated/AppsApi.md

@@ -1,77 +0,0 @@
-# OpenapiClient::AppsApi
-
-All URIs are relative to *https://api.passage.id/v1*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_app**](AppsApi.md#get_app) | **GET** /apps/{app_id} | Get App |
-
-
-## get_app
-
-> <AppResponse> get_app(app_id)
-
-Get App
-
-Get app information.
-
-### 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::AppsApi.new
-app_id = 'app_id_example' # String | App ID
-
-begin
-  # Get App
-  result = api_instance.get_app(app_id)
-  p result
-rescue OpenapiClient::ApiError => e
-  puts "Error when calling AppsApi->get_app: #{e}"
-end
-```
-
-#### Using the get_app_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<AppResponse>, Integer, Hash)> get_app_with_http_info(app_id)
-
-```ruby
-begin
-  # Get App
-  data, status_code, headers = api_instance.get_app_with_http_info(app_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <AppResponse>
-rescue OpenapiClient::ApiError => e
-  puts "Error when calling AppsApi->get_app_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | App ID |  |
-
-### Return type
-
-[**AppResponse**](AppResponse.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/generated/AuthMethods.md

@@ -1,22 +0,0 @@
-# OpenapiClient::AuthMethods
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **passkeys** | [**PasskeysAuthMethod**](PasskeysAuthMethod.md) |  |  |
-| **otp** | [**OtpAuthMethod**](OtpAuthMethod.md) |  |  |
-| **magic_link** | [**MagicLinkAuthMethod**](MagicLinkAuthMethod.md) |  |  |
-
-## Example
-
-```ruby
-require 'openapi_client'
-
-instance = OpenapiClient::AuthMethods.new(
-  passkeys: null,
-  otp: null,
-  magic_link: null
-)
-```
-

data/docs/generated/CreateMagicLinkRequest.md

@@ -1,36 +0,0 @@
-# OpenapiClient::CreateMagicLinkRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **channel** | [**MagicLinkChannel**](MagicLinkChannel.md) |  |  |
-| **email** | **String** |  |  |
-| **language** | **String** | language of the email to send (optional) | [optional] |
-| **magic_link_path** | **String** |  |  |
-| **phone** | **String** |  |  |
-| **redirect_url** | **String** |  |  |
-| **_send** | **Boolean** |  |  |
-| **ttl** | **Integer** |  |  |
-| **type** | [**MagicLinkType**](MagicLinkType.md) |  | [optional] |
-| **user_id** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'openapi_client'
-
-instance = OpenapiClient::CreateMagicLinkRequest.new(
-  channel: null,
-  email: null,
-  language: null,
-  magic_link_path: null,
-  phone: null,
-  redirect_url: null,
-  _send: null,
-  ttl: null,
-  type: null,
-  user_id: null
-)
-```
-

data/docs/generated/CreateUserRequest.md

@@ -1,22 +0,0 @@
-# OpenapiClient::CreateUserRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **email** | **String** | Email of the new user. Either this or `phone` is required; both may be provided. | [optional] |
-| **phone** | **String** | Phone number of the new user. Either this or `email` is required; both may be provided. | [optional] |
-| **user_metadata** | **Object** |  | [optional] |
-
-## Example
-
-```ruby
-require 'openapi_client'
-
-instance = OpenapiClient::CreateUserRequest.new(
-  email: null,
-  phone: null,
-  user_metadata: null
-)
-```
-

data/docs/generated/ElementCustomization.md

@@ -1,56 +0,0 @@
-# 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

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

data/docs/generated/GithubUserSocialConnection.md

@@ -1,24 +0,0 @@
-# OpenapiClient::GithubUserSocialConnection
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **provider_id** | **String** | The external ID of the Social Connection. |  |
-| **created_at** | **Time** |  |  |
-| **last_login_at** | **Time** |  |  |
-| **provider_identifier** | **String** | The email of connected social user. |  |
-
-## Example
-
-```ruby
-require 'openapi_client'
-
-instance = OpenapiClient::GithubUserSocialConnection.new(
-  provider_id: null,
-  created_at: null,
-  last_login_at: null,
-  provider_identifier: null
-)
-```
-

data/docs/generated/GoogleUserSocialConnection.md

@@ -1,24 +0,0 @@
-# OpenapiClient::GoogleUserSocialConnection
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **provider_id** | **String** | The external ID of the Social Connection. |  |
-| **created_at** | **Time** |  |  |
-| **last_login_at** | **Time** |  |  |
-| **provider_identifier** | **String** | The email of connected social user. |  |
-
-## Example
-
-```ruby
-require 'openapi_client'
-
-instance = OpenapiClient::GoogleUserSocialConnection.new(
-  provider_id: null,
-  created_at: null,
-  last_login_at: null,
-  provider_identifier: null
-)
-```
-

data/docs/generated/LayoutConfig.md

@@ -1,26 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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/Link.md

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

data/docs/generated/ListDevicesResponse.md

@@ -1,18 +0,0 @@
-# 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/ListPaginatedUsersItem.md

@@ -1,38 +0,0 @@
-# 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

@@ -1,28 +0,0 @@
-# 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/MagicLink.md

@@ -1,36 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

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

data/docs/generated/MagicLinkResponse.md

@@ -1,18 +0,0 @@
-# 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

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

data/docs/generated/MagicLinksApi.md

@@ -1,79 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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

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