ory-client 0.0.1.alpha21 → 0.0.1.alpha28

data/docs/ProjectPatch.md

@@ -0,0 +1,60 @@
+# OryClient::ProjectPatch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_url** | **String** | URL of Project API  In the future will allow to override Kratos project URL. If set, error is returned. If left empty our hosted URL is used | [optional] |
+| **application_url** | **String** | URL where your application is available.  Your users will be redirected to this URL when they successfully complete a login, logout, verification, recovery, or registration flow. More fine-grained redirection patterns are available for the individual flows (login, registration, ...).  If left empty, our hosted URL will be used instead. It contains technical information on the identities and is useful when developing a new project or trying out Ory Cloud. | [optional] |
+| **default_identity_schema_url** | **String** | Default Identity Schema URL  This represents your Ory Kratos Default Identity Schema. It is your identity's default schema. This allows setting custom fields such as \"address\", specifying whether you want to log in using email or a username, and more. For more information on this topic, please check out the identity documentation.  If KratosCustomSchemaID is also added to the payload, it will be preferred and replace the value of DefaultIdentitySchemaURL set by the client.  The value of this field can be either any \"https://\" URL - for example a file hosted at GitHub, or a `preset://`-prefixed string.  Available presets are:  preset://email preset://username preset://basic preset://blank | [optional] |
+| **error_ui_url** | **String** | Self-Service Error UI URL  Sets the UI URL for the error UI. If left empty, this will use Ory's hosted pages. |  |
+| **kratos_custom_schema_id** | **String** | The Custom Schema ID  The custom schema ID is a preferred field over DefaultIdentitySchemaURL, meaning it will override the DefaultIdentitySchemaURL with the custom schema's URL instead of accepting it from the client-side. Once this field is set the given custom schema will be associated with this project. | [optional] |
+| **login_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the login UI. If left empty, this will use Ory's hosted pages. |  |
+| **lookup_secret** | [**ProjectLookupSecretConfig**](ProjectLookupSecretConfig.md) |  |  |
+| **name** | **String** | The project name.  Helps you identify your project.  in: body | [optional] |
+| **password** | [**ProjectPasswordConfig**](ProjectPasswordConfig.md) |  |  |
+| **recovery** | [**ProjectRecoveryConfig**](ProjectRecoveryConfig.md) |  |  |
+| **recovery_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the recovery UI. If left empty, this will use Ory's hosted pages. |  |
+| **redirection_config** | [**RedirectionConfig**](RedirectionConfig.md) |  | [optional] |
+| **registration_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the registration UI. If left empty, this will use Ory's hosted pages. |  |
+| **session_after_sign_up** | **Boolean** | Issue Session after Sign Up  If set to true, users will receive a session after they successfully signed up. Enabling this option allows account enumeration during registration flows. Read more: https://www.ory.sh/kratos/docs/self-service/flows/user-registration#successful-registration |  |
+| **session_soft_2fa** | **Boolean** | Enable Soft 2FA for Login Sessions |  |
+| **settings_privileged_session_max_age_seconds** | **Integer** | Duration in Seconds of how long a Session is Privileged  Defines how long a session is considered privileged in seconds. If the session's authenticated_at is older than the value specified here, the user needs to re-authenticate to perform certain actions (e.g. password change). |  |
+| **settings_soft_2fa** | **Boolean** | Enable Soft 2FA for Self-Service Settings Flows |  |
+| **settings_ui_url** | **String** | Self-Service Settings UI URL  Sets the UI URL for the settings UI. If left empty, this will use Ory's hosted pages. |  |
+| **totp** | [**ProjectTotpConfig**](ProjectTotpConfig.md) |  |  |
+| **verification** | [**ProjectVerificationConfig**](ProjectVerificationConfig.md) |  |  |
+| **verification_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the verification UI. If left empty, this will use Ory's hosted pages. |  |
+| **webauthn** | [**ProjectWebAuthnConfig**](ProjectWebAuthnConfig.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ProjectPatch.new(
+  api_url: null,
+  application_url: null,
+  default_identity_schema_url: null,
+  error_ui_url: https://example.org/error,
+  kratos_custom_schema_id: null,
+  login_ui_url: https://example.org/login,
+  lookup_secret: null,
+  name: ACME App,
+  password: null,
+  recovery: null,
+  recovery_ui_url: https://example.org/recover,
+  redirection_config: null,
+  registration_ui_url: https://example.org/signup,
+  session_after_sign_up: null,
+  session_soft_2fa: null,
+  settings_privileged_session_max_age_seconds: 900,
+  settings_soft_2fa: null,
+  settings_ui_url: https://example.org/settings,
+  totp: null,
+  verification: null,
+  verification_ui_url: https://example.org/verify,
+  webauthn: null
+)
+```
+

data/docs/ProjectRecoveryConfig.md

@@ -0,0 +1,18 @@
+# OryClient::ProjectRecoveryConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** | Set to true to enable account recovery. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ProjectRecoveryConfig.new(
+  enabled: null
+)
+```
+

data/docs/ProjectRevision.md

@@ -0,0 +1,74 @@
+# OryClient::ProjectRevision
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_url** | **String** | The Project API URL  The URL where the Project's APIs are available. |  |
+| **application_url** | **String** | Your Application URL  The URL where your application is available. Your users will be redirected to this URL when they successfully complete a login, logout, verification, recovery, or registration flow.  More fine-grained redirection patterns are available for the individual flows. |  |
+| **created_at** | **Time** | The Project's Revision Creation Date | [readonly] |
+| **default_identity_schema_url** | **String** | Default Identity Schema URL  This represents your Ory Kratos Default Identity Schema. It is your identity's default schema. This allows setting custom fields such as \"address\", specifying whether you want to log in using email or a username, and more. For more information on this topic, please check out the identity documentation.  The value of this field can be either any \"https://\" URL - for example a file hosted at GitHub, or a `preset://`-prefixed string. Available profiles are:  profile://email profile://username |  |
+| **error_ui_url** | **String** | Self-Service Error UI URL  Sets the UI URL for the error UI. If left empty, this will use Ory's hosted pages. | [optional] |
+| **hosts** | **Array<String>** |  |  |
+| **id** | **String** |  |  |
+| **kratos_config_version** | **String** | The Project's Kratos Config Version | [optional][readonly] |
+| **kratos_custom_schema_id** | [**NullUUID**](NullUUID.md) |  | [optional] |
+| **login_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the login UI. If left empty, this will use Ory's hosted pages. | [optional] |
+| **lookup_secret** | [**ProjectLookupSecretConfig**](ProjectLookupSecretConfig.md) |  | [optional] |
+| **name** | **String** | The project's name. |  |
+| **oidc_providers** | [**Array<ProjectOidcConfig>**](ProjectOidcConfig.md) |  | [optional] |
+| **password** | [**ProjectPasswordConfig**](ProjectPasswordConfig.md) |  | [optional] |
+| **project_id** | **String** |  |  |
+| **recovery** | [**ProjectRecoveryConfig**](ProjectRecoveryConfig.md) |  | [optional] |
+| **recovery_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the recovery UI. If left empty, this will use Ory's hosted pages. | [optional] |
+| **redirection_config** | [**RedirectionConfig**](RedirectionConfig.md) |  | [optional] |
+| **registration_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the registration UI. If left empty, this will use Ory's hosted pages. | [optional] |
+| **session_after_sign_up** | **Boolean** | Issue Session after Sign Up  If set to true, users will receive a session after they successfully signed up. Enabling this option allows account enumeration during registration flows. Read more: https://www.ory.sh/kratos/docs/self-service/flows/user-registration#successful-registration |  |
+| **session_soft_2fa** | **Boolean** | Enable Soft 2FA for Login Sessions | [optional] |
+| **settings_privileged_session_max_age_seconds** | **Integer** | Duration in Seconds of how long a Session is Privileged  Defines how long a session is considered privileged in seconds. If the session's authenticated_at is older than the value specified here, the user needs to re-authenticate to perform certain actions (e.g. password change). | [optional] |
+| **settings_soft_2fa** | **Boolean** | Enable Soft 2FA for Self-Service Settings Flows | [optional] |
+| **settings_ui_url** | **String** | Self-Service Settings UI URL  Sets the UI URL for the settings UI. If left empty, this will use Ory's hosted pages. | [optional] |
+| **totp** | [**ProjectTotpConfig**](ProjectTotpConfig.md) |  | [optional] |
+| **updated_at** | **Time** | Last Time Project's Revision was Updated | [readonly] |
+| **verification** | [**ProjectVerificationConfig**](ProjectVerificationConfig.md) |  | [optional] |
+| **verification_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the verification UI. If left empty, this will use Ory's hosted pages. | [optional] |
+| **webauthn** | [**ProjectWebAuthnConfig**](ProjectWebAuthnConfig.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ProjectRevision.new(
+  api_url: null,
+  application_url: null,
+  created_at: null,
+  default_identity_schema_url: null,
+  error_ui_url: null,
+  hosts: null,
+  id: null,
+  kratos_config_version: null,
+  kratos_custom_schema_id: null,
+  login_ui_url: null,
+  lookup_secret: null,
+  name: null,
+  oidc_providers: null,
+  password: null,
+  project_id: null,
+  recovery: null,
+  recovery_ui_url: null,
+  redirection_config: null,
+  registration_ui_url: null,
+  session_after_sign_up: null,
+  session_soft_2fa: null,
+  settings_privileged_session_max_age_seconds: null,
+  settings_soft_2fa: null,
+  settings_ui_url: null,
+  totp: null,
+  updated_at: null,
+  verification: null,
+  verification_ui_url: null,
+  webauthn: null
+)
+```
+

data/docs/ProjectSlug.md

@@ -0,0 +1,18 @@
+# OryClient::ProjectSlug
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slug** | **String** | The Project Slug | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ProjectSlug.new(
+  slug: null
+)
+```
+

data/docs/ProjectTotpConfig.md

@@ -0,0 +1,20 @@
+# OryClient::ProjectTotpConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** | Set to true to enable the TOTP authentication method. | [optional] |
+| **issuer** | **String** | The issuer is the name which will appear in the Authenticator app. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ProjectTotpConfig.new(
+  enabled: null,
+  issuer: ory.sh
+)
+```
+

data/docs/ProjectVerificationConfig.md

@@ -0,0 +1,20 @@
+# OryClient::ProjectVerificationConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** | Set to true to enable email / phone verification. | [optional] |
+| **require_verified_address** | **Boolean** | Set to true to only allow users with a verified address to sign in. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ProjectVerificationConfig.new(
+  enabled: null,
+  require_verified_address: null
+)
+```
+

data/docs/ProjectWebAuthnConfig.md

@@ -0,0 +1,26 @@
+# OryClient::ProjectWebAuthnConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** | Set to true to enable the WebAuthn authentication method. | [optional] |
+| **rp_display_name** | **String** | The display name to show in the authenticator. | [optional] |
+| **rp_icon** | **String** | A URL to an icon which might be shown in the authenticator. | [optional] |
+| **rp_id** | **String** | This must be the hostname of the login page. | [optional] |
+| **rp_origin** | **String** | This must be the scheme://hostname of the login page. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ProjectWebAuthnConfig.new(
+  enabled: null,
+  rp_display_name: Ory Corp,
+  rp_icon: https://example.org/icon.png,
+  rp_id: example.org,
+  rp_origin: https://example.org/
+)
+```
+

data/docs/ProvisionProjectPayload.md

@@ -0,0 +1,18 @@
+# OryClient::ProvisionProjectPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription_id** | **String** | The stripe subscription ID to use for provisioning the project. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ProvisionProjectPayload.new(
+  subscription_id: null
+)
+```
+

data/docs/RedirectionConfig.md

@@ -0,0 +1,32 @@
+# OryClient::RedirectionConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **global** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
+| **login** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
+| **logout** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
+| **recovery** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
+| **registration** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
+| **settings** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
+| **url_allowlist** | **Array<String>** |  | [optional] |
+| **verification** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::RedirectionConfig.new(
+  global: null,
+  login: null,
+  logout: null,
+  recovery: null,
+  registration: null,
+  settings: null,
+  url_allowlist: null,
+  verification: null
+)
+```
+

data/docs/RedirectionField.md

@@ -0,0 +1,24 @@
+# OryClient::RedirectionField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **main** | **String** |  | [optional] |
+| **oidc** | **String** |  | [optional] |
+| **password** | **String** |  | [optional] |
+| **profile** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::RedirectionField.new(
+  main: null,
+  oidc: null,
+  password: null,
+  profile: null
+)
+```
+

data/docs/SchemaPatch.md

@@ -0,0 +1,20 @@
+# OryClient::SchemaPatch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Object** | The json schema |  |
+| **name** | **String** | The user defined schema name |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SchemaPatch.new(
+  data: null,
+  name: null
+)
+```
+

data/docs/SelfServiceBrowserLocationChangeRequiredError.md

@@ -4,8 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **error** | [**GenericError**](GenericError.md) |  | [optional] |
+| **code** | **Integer** | The status code | [optional] |
+| **debug** | **String** | Debug information  This field is often not exposed to protect against leaking sensitive information. | [optional] |
+| **details** | **Hash<String, Object>** | Further error details | [optional] |
+| **id** | **String** | The error ID  Useful when trying to identify various errors in application logic. | [optional] |
+| **message** | **String** | Error message  The error's message. |  |
+| **reason** | **String** | A human-readable reason for the error | [optional] |
 | **redirect_browser_to** | **String** | Since when the flow has expired | [optional] |
+| **request** | **String** | The request ID  The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID. | [optional] |
+| **status** | **String** | The status description | [optional] |
 
 ## Example
 
@@ -13,8 +20,15 @@
 require 'ory-client'
 
 instance = OryClient::SelfServiceBrowserLocationChangeRequiredError.new(
-  error: null,
-  redirect_browser_to: null
+  code: 404,
+  debug: SQL field "foo" is not a bool.,
+  details: null,
+  id: null,
+  message: The resource could not be found,
+  reason: User with ID 1234 does not exist.,
+  redirect_browser_to: null,
+  request: d7ef54b1-ec15-46e6-bccb-524b82c035e6,
+  status: Not Found
 )
 ```
 

data/docs/SelfServiceFlowExpiredError.md

@@ -4,8 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **error** | [**GenericError**](GenericError.md) |  | [optional] |
+| **code** | **Integer** | The status code | [optional] |
+| **debug** | **String** | Debug information  This field is often not exposed to protect against leaking sensitive information. | [optional] |
+| **details** | **Hash<String, Object>** | Further error details | [optional] |
+| **id** | **String** | The error ID  Useful when trying to identify various errors in application logic. | [optional] |
+| **message** | **String** | Error message  The error's message. |  |
+| **reason** | **String** | A human-readable reason for the error | [optional] |
+| **request** | **String** | The request ID  The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID. | [optional] |
 | **since** | **Integer** | A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. | [optional] |
+| **status** | **String** | The status description | [optional] |
 | **use_flow_id** | **String** |  | [optional] |
 
 ## Example
@@ -14,8 +21,15 @@
 require 'ory-client'
 
 instance = OryClient::SelfServiceFlowExpiredError.new(
-  error: null,
+  code: 404,
+  debug: SQL field "foo" is not a bool.,
+  details: null,
+  id: null,
+  message: The resource could not be found,
+  reason: User with ID 1234 does not exist.,
+  request: d7ef54b1-ec15-46e6-bccb-524b82c035e6,
   since: null,
+  status: Not Found,
   use_flow_id: null
 )
 ```

data/docs/StripeCustomerResponse.md

@@ -0,0 +1,18 @@
+# OryClient::StripeCustomerResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::StripeCustomerResponse.new(
+  id: null
+)
+```
+