ory-client 1.6.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 404e58b93dce077d3700a7363638faf0de40e705b64d836d1201c74dbf0f4802
-  data.tar.gz: ceb35ab4b848c0898b5ff9be10e66b3a32c73173f94a7cc195067001b21b47ef
+  metadata.gz: 659d54c7cf50f14895f15f9e918ffa686631a2ba7749365acb58487a0b911567
+  data.tar.gz: 58c450d855cadf07db1e0025c722a140c4a23ea9c7f198ac4810db3565e2b313
 SHA512:
-  metadata.gz: 0074ec06f5ab805640a00382de4e0e309c403932f759bf6d7ee4e3faaaddf43686f0080da2cf5da4b5759245aa603e14ac16d9755a03b9055068e2793c40bb37
-  data.tar.gz: d8b9d838aed07339a2096a8680bb6f1a72bf12367f3abfb1eabfcf0fa4207a1d96531f73763f50b1815e52c930b76dcfc6216befe9c763154e303c38b4772492
+  metadata.gz: 515e385029bb00452cb44660791c4a2835db9c5f43c37d136dd7f3ec11da2f8349a81449ba9a445ca7a5b49d6293238fa7a23fadcac9d5dcc175e8bddc8b72b7
+  data.tar.gz: 53d465496bec5209ed80d1e5e05931498d147ed99f50d4e54841771a103593d66be3a9b90211384c6d888f8cff46b6dbc9e9ef65b741a98b0568b524dab5e5ab

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ory-client (1.6.2)
+    ory-client (1.8.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -20,12 +20,12 @@ GEM
     parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
-    pry (0.13.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
+      pry (>= 0.13, < 0.15)
     psych (4.0.6)
       stringio
     racc (1.7.3)
@@ -43,7 +43,7 @@ GEM
     rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.0)
+    rspec-support (3.13.1)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -53,7 +53,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.13.0)
-    stringio (3.0.6)
+    stringio (3.1.0)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     unicode-display_width (1.5.0)

data/README.md

@@ -8,8 +8,8 @@ with a valid Personal Access Token. Public APIs are mostly used in browsers.
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v1.6.2
-- Package version: v1.6.2
+- API version: v1.8.0
+- Package version: v1.8.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -25,16 +25,16 @@ gem build ory-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ory-client-v1.6.2.gem
+gem install ./ory-client-v1.8.0.gem
 ```
 
-(for development, run `gem install --dev ./ory-client-v1.6.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ory-client-v1.8.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ory-client', '~> v1.6.2'
+    gem 'ory-client', '~> v1.8.0'
 
 ### Install from Git
 
@@ -62,6 +62,8 @@ require 'ory-client'
 OryClient.configure do |config|
   # Configure Bearer authorization: oryAccessToken
   config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
 end
 
 api_instance = OryClient::CourierApi.new
@@ -308,7 +310,6 @@ Class | Method | HTTP request | Description
  - [OryClient::InternalIsAXWelcomeScreenEnabledForProjectBody](docs/InternalIsAXWelcomeScreenEnabledForProjectBody.md)
  - [OryClient::InternalIsOwnerForProjectBySlugBody](docs/InternalIsOwnerForProjectBySlugBody.md)
  - [OryClient::InternalIsOwnerForProjectBySlugResponse](docs/InternalIsOwnerForProjectBySlugResponse.md)
- - [OryClient::InternalProvisionMockSubscription](docs/InternalProvisionMockSubscription.md)
  - [OryClient::IntrospectedOAuth2Token](docs/IntrospectedOAuth2Token.md)
  - [OryClient::IsOwnerForProjectBySlug](docs/IsOwnerForProjectBySlug.md)
  - [OryClient::IsReady200Response](docs/IsReady200Response.md)
@@ -359,6 +360,7 @@ Class | Method | HTTP request | Description
  - [OryClient::ParseError](docs/ParseError.md)
  - [OryClient::PatchIdentitiesBody](docs/PatchIdentitiesBody.md)
  - [OryClient::PerformNativeLogoutBody](docs/PerformNativeLogoutBody.md)
+ - [OryClient::PermissionsOnWorkpaceResponse](docs/PermissionsOnWorkpaceResponse.md)
  - [OryClient::Plan](docs/Plan.md)
  - [OryClient::PlanDetails](docs/PlanDetails.md)
  - [OryClient::PostCheckPermissionBody](docs/PostCheckPermissionBody.md)
@@ -371,6 +373,7 @@ Class | Method | HTTP request | Description
  - [OryClient::ProjectCors](docs/ProjectCors.md)
  - [OryClient::ProjectEventsDatapoint](docs/ProjectEventsDatapoint.md)
  - [OryClient::ProjectHost](docs/ProjectHost.md)
+ - [OryClient::ProjectMember](docs/ProjectMember.md)
  - [OryClient::ProjectMetadata](docs/ProjectMetadata.md)
  - [OryClient::ProjectServiceIdentity](docs/ProjectServiceIdentity.md)
  - [OryClient::ProjectServiceOAuth2](docs/ProjectServiceOAuth2.md)
@@ -455,6 +458,7 @@ Class | Method | HTTP request | Description
  - [OryClient::UpdateVerificationFlowBody](docs/UpdateVerificationFlowBody.md)
  - [OryClient::UpdateVerificationFlowWithCodeMethod](docs/UpdateVerificationFlowWithCodeMethod.md)
  - [OryClient::UpdateVerificationFlowWithLinkMethod](docs/UpdateVerificationFlowWithLinkMethod.md)
+ - [OryClient::UpdateWorkspacePayload](docs/UpdateWorkspacePayload.md)
  - [OryClient::Usage](docs/Usage.md)
  - [OryClient::VerifiableCredentialPrimingResponse](docs/VerifiableCredentialPrimingResponse.md)
  - [OryClient::VerifiableCredentialProof](docs/VerifiableCredentialProof.md)
@@ -471,6 +475,7 @@ Class | Method | HTTP request | Description
 ## Documentation for Authorization
 
 
+Authentication schemes defined for the API:
 ### basic
 
 - **Type**: HTTP basic authentication

data/docs/CloudAccount.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** |  | [optional] |
-| **id** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
+| **email** | **String** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
 
 ## Example
 

data/docs/ContinueWith.md

@@ -51,6 +51,7 @@ OryClient::ContinueWith.openapi_discriminator_mapping
 #   :'show_settings_ui' => :'ContinueWithSettingsUi',
 #   :'show_verification_ui' => :'ContinueWithVerificationUi'
 # }
+```
 
 ### build
 

data/docs/CreateProjectNormalizedPayload.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **created_at** | **Time** | The Project's Revision Creation Date | [optional][readonly] |
 | **disable_account_experience_welcome_screen** | **Boolean** | Whether to disable the account experience welcome screen, which is hosted under `/ui/welcome`. | [optional] |
+| **enable_ax_v2** | **Boolean** | Whether the new account experience is enabled and reachable. | [optional] |
 | **environment** | **String** |  prod Production dev Development |  |
 | **hydra_oauth2_allowed_top_level_claims** | **Array<String>** |  | [optional] |
 | **hydra_oauth2_client_credentials_default_grant_allowed_scope** | **Boolean** | Automatically grant authorized OAuth2 Scope in OAuth2 Client Credentials Flow.  Each OAuth2 Client is allowed to request a predefined OAuth2 Scope (for example `read write`). If this option is enabled, the full scope is automatically granted when performing the OAuth2 Client Credentials flow.  If disabled, the OAuth2 Client has to request the scope in the OAuth2 request by providing the `scope` query parameter.  Setting this option to true is common if you need compatibility with MITREid.  This governs the \"oauth2.client_credentials.default_grant_allowed_scope\" setting. | [optional] |
@@ -206,6 +207,7 @@ require 'ory-client'
 instance = OryClient::CreateProjectNormalizedPayload.new(
   created_at: null,
   disable_account_experience_welcome_screen: null,
+  enable_ax_v2: null,
   environment: null,
   hydra_oauth2_allowed_top_level_claims: null,
   hydra_oauth2_client_credentials_default_grant_allowed_scope: null,

data/docs/FrontendApi.md

@@ -57,7 +57,8 @@ opts = {
   return_to: 'return_to_example', # String | The URL to return the browser to after the flow was completed.
   cookie: 'cookie_example', # String | HTTP Cookies  When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
   login_challenge: 'login_challenge_example', # String | An optional Hydra login challenge. If present, Kratos will cooperate with Ory Hydra to act as an OAuth2 identity provider.  The value for this parameter comes from `login_challenge` URL Query parameter sent to your application (e.g. `/login?login_challenge=abcde`).
-  organization: 'organization_example' # String | An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network.
+  organization: 'organization_example', # String | An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network.
+  via: 'via_example' # String | Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows.
 }
 
 begin
@@ -97,6 +98,7 @@ end
 | **cookie** | **String** | HTTP Cookies  When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected. | [optional] |
 | **login_challenge** | **String** | An optional Hydra login challenge. If present, Kratos will cooperate with Ory Hydra to act as an OAuth2 identity provider.  The value for this parameter comes from `login_challenge` URL Query parameter sent to your application (e.g. `/login?login_challenge=abcde`). | [optional] |
 | **organization** | **String** | An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network. | [optional] |
+| **via** | **String** | Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows. | [optional] |
 
 ### Return type
 

data/docs/IdentityApi.md

@@ -891,7 +891,8 @@ opts = {
   consistency: 'consistency_example', # String | Read Consistency Level (preview)  The read consistency level determines the consistency guarantee for reads:  strong (slow): The read is guaranteed to return the most recent data committed at the start of the read. eventual (very fast): The result will return data that is about 4.8 seconds old.  The default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with `ory patch project --replace '/previews/default_read_consistency_level=\"strong\"'`.  Setting the default consistency level to `eventual` may cause regressions in the future as we add consistency controls to more APIs. Currently, the following APIs will be affected by this setting:  `GET /admin/identities`  This feature is in preview and only available in Ory Network.  ConsistencyLevelUnset  ConsistencyLevelUnset is the unset / default consistency level. strong ConsistencyLevelStrong  ConsistencyLevelStrong is the strong consistency level. eventual ConsistencyLevelEventual  ConsistencyLevelEventual is the eventual consistency level using follower read timestamps.
   ids: ['inner_example'], # Array<String> | List of ids used to filter identities. If this list is empty, then no filter will be applied.
   credentials_identifier: 'credentials_identifier_example', # String | CredentialsIdentifier is the identifier (username, email) of the credentials to look up using exact match. Only one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used.
-  preview_credentials_identifier_similar: 'preview_credentials_identifier_similar_example' # String | This is an EXPERIMENTAL parameter that WILL CHANGE. Do NOT rely on consistent, deterministic behavior. THIS PARAMETER WILL BE REMOVED IN AN UPCOMING RELEASE WITHOUT ANY MIGRATION PATH.  CredentialsIdentifierSimilar is the (partial) identifier (username, email) of the credentials to look up using similarity search. Only one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used.
+  preview_credentials_identifier_similar: 'preview_credentials_identifier_similar_example', # String | This is an EXPERIMENTAL parameter that WILL CHANGE. Do NOT rely on consistent, deterministic behavior. THIS PARAMETER WILL BE REMOVED IN AN UPCOMING RELEASE WITHOUT ANY MIGRATION PATH.  CredentialsIdentifierSimilar is the (partial) identifier (username, email) of the credentials to look up using similarity search. Only one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used.
+  include_credential: ['inner_example'] # Array<String> | Include Credentials in Response  Include any credential, for example `password` or `oidc`, in the response. When set to `oidc`, This will return the initial OAuth 2.0 Access Token, OAuth 2.0 Refresh Token and the OpenID Connect ID Token if available.
 }
 
 begin
@@ -933,6 +934,7 @@ end
 | **ids** | [**Array&lt;String&gt;**](String.md) | List of ids used to filter identities. If this list is empty, then no filter will be applied. | [optional] |
 | **credentials_identifier** | **String** | CredentialsIdentifier is the identifier (username, email) of the credentials to look up using exact match. Only one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used. | [optional] |
 | **preview_credentials_identifier_similar** | **String** | This is an EXPERIMENTAL parameter that WILL CHANGE. Do NOT rely on consistent, deterministic behavior. THIS PARAMETER WILL BE REMOVED IN AN UPCOMING RELEASE WITHOUT ANY MIGRATION PATH.  CredentialsIdentifierSimilar is the (partial) identifier (username, email) of the credentials to look up using similarity search. Only one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used. | [optional] |
+| **include_credential** | [**Array&lt;String&gt;**](String.md) | Include Credentials in Response  Include any credential, for example &#x60;password&#x60; or &#x60;oidc&#x60;, in the response. When set to &#x60;oidc&#x60;, This will return the initial OAuth 2.0 Access Token, OAuth 2.0 Refresh Token and the OpenID Connect ID Token if available. | [optional] |
 
 ### Return type
 

data/docs/LoginFlow.md

@@ -18,6 +18,7 @@
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
 | **session_token_exchange_code** | **String** | SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the login flow has been completed. This is only set if the client has requested a session token exchange code, and if the flow is of type \"api\", and only on creating the login flow. | [optional] |
 | **state** | **Object** | State represents the state of this request:  choose_method: ask the user to choose a method to sign in with sent_email: the email has been sent to the user passed_challenge: the request was successful and the login challenge was passed. |  |
+| **transient_payload** | **Object** | TransientPayload is used to pass data from the login to hooks and email templates | [optional] |
 | **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
 | **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
@@ -42,6 +43,7 @@ instance = OryClient::LoginFlow.new(
   return_to: null,
   session_token_exchange_code: null,
   state: null,
+  transient_payload: null,
   type: null,
   ui: null,
   updated_at: null

data/docs/NormalizedProjectRevision.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **created_at** | **Time** | The Project's Revision Creation Date | [optional][readonly] |
 | **disable_account_experience_welcome_screen** | **Boolean** | Whether to disable the account experience welcome screen, which is hosted under `/ui/welcome`. | [optional] |
+| **enable_ax_v2** | **Boolean** | Whether the new account experience is enabled and reachable. | [optional] |
 | **hydra_oauth2_allowed_top_level_claims** | **Array<String>** |  | [optional] |
 | **hydra_oauth2_client_credentials_default_grant_allowed_scope** | **Boolean** | Automatically grant authorized OAuth2 Scope in OAuth2 Client Credentials Flow.  Each OAuth2 Client is allowed to request a predefined OAuth2 Scope (for example `read write`). If this option is enabled, the full scope is automatically granted when performing the OAuth2 Client Credentials flow.  If disabled, the OAuth2 Client has to request the scope in the OAuth2 request by providing the `scope` query parameter.  Setting this option to true is common if you need compatibility with MITREid.  This governs the \"oauth2.client_credentials.default_grant_allowed_scope\" setting. | [optional] |
 | **hydra_oauth2_exclude_not_before_claim** | **Boolean** | Set to true if you want to exclude claim `nbf (not before)` part of access token.  This governs the \"oauth2.exclude_not_before_claim\" setting. | [optional] |
@@ -204,6 +205,7 @@ require 'ory-client'
 instance = OryClient::NormalizedProjectRevision.new(
   created_at: null,
   disable_account_experience_welcome_screen: null,
+  enable_ax_v2: null,
   hydra_oauth2_allowed_top_level_claims: null,
   hydra_oauth2_client_credentials_default_grant_allowed_scope: null,
   hydra_oauth2_exclude_not_before_claim: null,

data/docs/PermissionsOnWorkpaceResponse.md

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

data/docs/PlanDetails.md

@@ -8,7 +8,7 @@
 | **base_fee_yearly** | **Integer** | BaseFeeYearly is the yearly base fee for the plan. |  |
 | **custom** | **Boolean** | Custom is true if the plan is custom. This means it will be hidden from the pricing page. |  |
 | **description** | **String** | Description is the description of the plan. |  |
-| **features** | [**Hash<String, GenericUsage>**](GenericUsage.md) | Features are the feature definitions included in the plan. |  |
+| **features** | [**Hash<String, GenericUsage>**](GenericUsage.md) |  |  |
 | **name** | **String** | Name is the name of the plan. |  |
 | **version** | **Integer** | Version is the version of the plan. The combination of `name@version` must be unique. |  |
 

data/docs/ProjectApi.md

@@ -586,7 +586,7 @@ end
 
 ## get_project_members
 
-> <Array<CloudAccount>> get_project_members(project)
+> <Array<ProjectMember>> get_project_members(project)
 
 Get all members associated with this project
 
@@ -619,7 +619,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<CloudAccount>>, Integer, Hash)> get_project_members_with_http_info(project)
+> <Array(<Array<ProjectMember>>, Integer, Hash)> get_project_members_with_http_info(project)
 
 ```ruby
 begin
@@ -627,7 +627,7 @@ begin
   data, status_code, headers = api_instance.get_project_members_with_http_info(project)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<CloudAccount>>
+  p data # => <Array<ProjectMember>>
 rescue OryClient::ApiError => e
   puts "Error when calling ProjectApi->get_project_members_with_http_info: #{e}"
 end
@@ -641,7 +641,7 @@ end
 
 ### Return type
 
-[**Array&lt;CloudAccount&gt;**](CloudAccount.md)
+[**Array&lt;ProjectMember&gt;**](ProjectMember.md)
 
 ### Authorization
 
@@ -675,7 +675,7 @@ end
 api_instance = OryClient::ProjectApi.new
 project_id = 'project_id_example' # String | Project ID
 event_type = 'event_type_example' # String | The event type to query for
-resolution = 'resolution_example' # String | The resolution of the buckets  The minimum resolution is 1 hour.
+resolution = 'resolution_example' # String | The resolution of the buckets  The minimum resolution is 1 minute.
 from = Time.parse('2013-10-20T19:20:30+01:00') # Time | The start RFC3339 date of the time window
 to = Time.parse('2013-10-20T19:20:30+01:00') # Time | The end RFC3339 date of the time window
 
@@ -712,7 +712,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **project_id** | **String** | Project ID |  |
 | **event_type** | **String** | The event type to query for |  |
-| **resolution** | **String** | The resolution of the buckets  The minimum resolution is 1 hour. |  |
+| **resolution** | **String** | The resolution of the buckets  The minimum resolution is 1 minute. |  |
 | **from** | **Time** | The start RFC3339 date of the time window |  |
 | **to** | **Time** | The end RFC3339 date of the time window |  |
 

data/docs/ProjectMember.md

@@ -0,0 +1,24 @@
+# OryClient::ProjectMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **role** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ProjectMember.new(
+  email: null,
+  id: null,
+  name: null,
+  role: null
+)
+```
+

data/docs/QuotaUsage.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **additional_price** | **Integer** | The additional price per unit in cents. |  |
 | **can_use_more** | **Boolean** |  |  |
-| **feature** | **String** |  region_eu RegionEU region_us RegionUS region_apac RegionAPAC region_global RegionGlobal production_projects ProductionProjects daily_active_users DailyActiveUsers custom_domains CustomDomains event_streams EventStreams sla SLA collaborator_seats CollaboratorSeats edge_cache EdgeCache branding_themes BrandingThemes zendesk_support ZendeskSupport project_metrics ProjectMetrics project_metrics_time_window ProjectMetricsTimeWindow project_metrics_events_history ProjectMetricsEventsHistory organizations Organizations rop_grant ResourceOwnerPasswordGrant rate_limit_tier RateLimitTier session_rate_limit_tier RateLimitTierSessions identities_list_rate_limit_tier RateLimitTierIdentitiesList permission_checks_rate_limit_tier RateLimitTierPermissionChecks oauth2_introspect_rate_limit_tier RateLimitTierOAuth2Introspect |  |
+| **feature** | **String** |  region_eu RegionEU region_us RegionUS region_apac RegionAPAC region_global RegionGlobal production_projects ProductionProjects daily_active_users DailyActiveUsers custom_domains CustomDomains event_streams EventStreams sla SLA collaborator_seats CollaboratorSeats edge_cache EdgeCache branding_themes BrandingThemes zendesk_support ZendeskSupport project_metrics ProjectMetrics project_metrics_time_window ProjectMetricsTimeWindow project_metrics_events_history ProjectMetricsEventsHistory organizations Organizations rop_grant ResourceOwnerPasswordGrant concierge_onboarding ConciergeOnboarding rate_limit_tier RateLimitTier session_rate_limit_tier RateLimitTierSessions identities_list_rate_limit_tier RateLimitTierIdentitiesList permission_checks_rate_limit_tier RateLimitTierPermissionChecks oauth2_introspect_rate_limit_tier RateLimitTierOAuth2Introspect |  |
 | **feature_available** | **Boolean** |  |  |
 | **included** | **Integer** |  |  |
 | **used** | **Integer** |  |  |

data/docs/RecoveryFlow.md

@@ -12,6 +12,7 @@
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
 | **state** | **Object** | State represents the state of this request:  choose_method: ask the user to choose a method (e.g. recover account via email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the recovery challenge was passed. |  |
+| **transient_payload** | **Object** | TransientPayload is used to pass data from the recovery flow to hooks and email templates | [optional] |
 | **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
 
@@ -29,6 +30,7 @@ instance = OryClient::RecoveryFlow.new(
   request_url: null,
   return_to: null,
   state: null,
+  transient_payload: null,
   type: null,
   ui: null
 )

data/docs/SettingsFlow.md

@@ -13,6 +13,7 @@
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
 | **state** | **Object** | State represents the state of this flow. It knows two states:  show_form: No user data has been collected, or it is invalid, and thus the form should be shown. success: Indicates that the settings flow has been updated successfully with the provided data. Done will stay true when repeatedly checking. If set to true, done will revert back to false only when a flow with invalid (e.g. \"please use a valid phone number\") data was sent. |  |
+| **transient_payload** | **Object** | TransientPayload is used to pass data from the settings flow to hooks and email templates | [optional] |
 | **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
 
@@ -31,6 +32,7 @@ instance = OryClient::SettingsFlow.new(
   request_url: null,
   return_to: null,
   state: null,
+  transient_payload: null,
   type: null,
   ui: null
 )

data/docs/Subscription.md

@@ -8,6 +8,7 @@
 | **currency** | **String** | The currency of the subscription. To change this, a new subscription must be created. usd USD eur Euro | [readonly] |
 | **current_interval** | **String** | The currently active interval of the subscription monthly Monthly yearly Yearly | [readonly] |
 | **current_plan** | **String** | The currently active plan of the subscription | [readonly] |
+| **current_plan_details** | [**PlanDetails**](PlanDetails.md) |  | [optional] |
 | **customer_id** | **String** | The ID of the stripe customer | [readonly] |
 | **id** | **String** | The ID of the subscription | [readonly] |
 | **interval_changes_to** | **String** |  |  |
@@ -16,6 +17,7 @@
 | **plan_changes_at** | **Time** |  | [optional] |
 | **plan_changes_to** | **String** |  |  |
 | **status** | **String** | For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated.  A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over.  If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings).  If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices. |  |
+| **stripe_checkout_expires_at** | **Time** |  | [optional] |
 | **updated_at** | **Time** |  | [readonly] |
 
 ## Example
@@ -28,6 +30,7 @@ instance = OryClient::Subscription.new(
   currency: null,
   current_interval: null,
   current_plan: null,
+  current_plan_details: null,
   customer_id: null,
   id: null,
   interval_changes_to: null,
@@ -36,6 +39,7 @@ instance = OryClient::Subscription.new(
   plan_changes_at: null,
   plan_changes_to: null,
   status: null,
+  stripe_checkout_expires_at: null,
   updated_at: null
 )
 ```

data/docs/UiNodeAttributes.md

@@ -53,6 +53,7 @@ OryClient::UiNodeAttributes.openapi_discriminator_mapping
 #   :'script' => :'UiNodeScriptAttributes',
 #   :'text' => :'UiNodeTextAttributes'
 # }
+```
 
 ### build
 

data/docs/UpdateLoginFlowBody.md

@@ -55,6 +55,7 @@ OryClient::UpdateLoginFlowBody.openapi_discriminator_mapping
 #   :'totp' => :'UpdateLoginFlowWithTotpMethod',
 #   :'webauthn' => :'UpdateLoginFlowWithWebAuthnMethod'
 # }
+```
 
 ### build
 

data/docs/UpdateLoginFlowWithCodeMethod.md

@@ -9,6 +9,7 @@
 | **identifier** | **String** | Identifier is the code identifier The identifier requires that the user has already completed the registration or settings with code flow. | [optional] |
 | **method** | **String** | Method should be set to \"code\" when logging in using the code strategy. |  |
 | **resend** | **String** | Resend is set when the user wants to resend the code | [optional] |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = OryClient::UpdateLoginFlowWithCodeMethod.new(
   csrf_token: null,
   identifier: null,
   method: null,
-  resend: null
+  resend: null,
+  transient_payload: null
 )
 ```
 

data/docs/UpdateLoginFlowWithOidcMethod.md

@@ -10,6 +10,7 @@
 | **method** | **String** | Method to use  This field must be set to `oidc` when using the oidc method. |  |
 | **provider** | **String** | The provider to register with |  |
 | **traits** | **Object** | The identity traits. This is a placeholder for the registration flow. | [optional] |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
 | **upstream_parameters** | **Object** | UpstreamParameters are the parameters that are passed to the upstream identity provider.  These parameters are optional and depend on what the upstream identity provider supports. Supported parameters are: `login_hint` (string): The `login_hint` parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session. `hd` (string): The `hd` parameter limits the login/registration process to a Google Organization, e.g. `mycollege.edu`. `prompt` (string): The `prompt` specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g. `select_account`. | [optional] |
 
 ## Example
@@ -24,6 +25,7 @@ instance = OryClient::UpdateLoginFlowWithOidcMethod.new(
   method: null,
   provider: null,
   traits: null,
+  transient_payload: null,
   upstream_parameters: null
 )
 ```

data/docs/UpdateLoginFlowWithPasswordMethod.md

@@ -9,6 +9,7 @@
 | **method** | **String** | Method should be set to \"password\" when logging in using the identifier and password strategy. |  |
 | **password** | **String** | The user's password. |  |
 | **password_identifier** | **String** | Identifier is the email or username of the user trying to log in. This field is deprecated! | [optional] |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = OryClient::UpdateLoginFlowWithPasswordMethod.new(
   identifier: null,
   method: null,
   password: null,
-  password_identifier: null
+  password_identifier: null,
+  transient_payload: null
 )
 ```
 

data/docs/UpdateLoginFlowWithTotpMethod.md

@@ -7,6 +7,7 @@
 | **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
 | **method** | **String** | Method should be set to \"totp\" when logging in using the TOTP strategy. |  |
 | **totp_code** | **String** | The TOTP code. |  |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'ory-client'
 instance = OryClient::UpdateLoginFlowWithTotpMethod.new(
   csrf_token: null,
   method: null,
-  totp_code: null
+  totp_code: null,
+  transient_payload: null
 )
 ```
 

data/docs/UpdateLoginFlowWithWebAuthnMethod.md

@@ -7,6 +7,7 @@
 | **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
 | **identifier** | **String** | Identifier is the email or username of the user trying to log in. |  |
 | **method** | **String** | Method should be set to \"webAuthn\" when logging in using the WebAuthn strategy. |  |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
 | **webauthn_login** | **String** | Login a WebAuthn Security Key  This must contain the ID of the WebAuthN connection. | [optional] |
 
 ## Example
@@ -18,6 +19,7 @@ instance = OryClient::UpdateLoginFlowWithWebAuthnMethod.new(
   csrf_token: null,
   identifier: null,
   method: null,
+  transient_payload: null,
   webauthn_login: null
 )
 ```

data/docs/UpdateRecoveryFlowBody.md

@@ -47,6 +47,7 @@ OryClient::UpdateRecoveryFlowBody.openapi_discriminator_mapping
 #   :'code' => :'UpdateRecoveryFlowWithCodeMethod',
 #   :'link' => :'UpdateRecoveryFlowWithLinkMethod'
 # }
+```
 
 ### build
 

data/docs/UpdateRecoveryFlowWithCodeMethod.md

@@ -8,6 +8,7 @@
 | **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
 | **email** | **String** | The email address of the account to recover  If the email belongs to a valid account, a recovery email will be sent.  If you want to notify the email address if the account does not exist, see the [notify_unknown_recipients flag](https://www.ory.sh/docs/kratos/self-service/flows/account-recovery-password-reset#attempted-recovery-notifications)  If a code was already sent, including this field in the payload will invalidate the sent code and re-send a new code.  format: email | [optional] |
 | **method** | **String** | Method is the method that should be used for this recovery flow  Allowed values are `link` and `code`. link RecoveryStrategyLink code RecoveryStrategyCode |  |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = OryClient::UpdateRecoveryFlowWithCodeMethod.new(
   code: null,
   csrf_token: null,
   email: null,
-  method: null
+  method: null,
+  transient_payload: null
 )
 ```
 

data/docs/UpdateRecoveryFlowWithLinkMethod.md

@@ -7,6 +7,7 @@
 | **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
 | **email** | **String** | Email to Recover  Needs to be set when initiating the flow. If the email is a registered recovery email, a recovery link will be sent. If the email is not known, a email with details on what happened will be sent instead.  format: email |  |
 | **method** | **String** | Method is the method that should be used for this recovery flow  Allowed values are `link` and `code` link RecoveryStrategyLink code RecoveryStrategyCode |  |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'ory-client'
 instance = OryClient::UpdateRecoveryFlowWithLinkMethod.new(
   csrf_token: null,
   email: null,
-  method: null
+  method: null,
+  transient_payload: null
 )
 ```
 

data/docs/UpdateRegistrationFlowBody.md

@@ -51,6 +51,7 @@ OryClient::UpdateRegistrationFlowBody.openapi_discriminator_mapping
 #   :'password' => :'UpdateRegistrationFlowWithPasswordMethod',
 #   :'webauthn' => :'UpdateRegistrationFlowWithWebAuthnMethod'
 # }
+```
 
 ### build
 

data/docs/UpdateSettingsFlowBody.md

@@ -55,6 +55,7 @@ OryClient::UpdateSettingsFlowBody.openapi_discriminator_mapping
 #   :'totp' => :'UpdateSettingsFlowWithTotpMethod',
 #   :'webauthn' => :'UpdateSettingsFlowWithWebAuthnMethod'
 # }
+```
 
 ### build
 

data/docs/UpdateSettingsFlowWithLookupMethod.md

@@ -10,6 +10,7 @@
 | **lookup_secret_regenerate** | **Boolean** | If set to true will regenerate the lookup secrets | [optional] |
 | **lookup_secret_reveal** | **Boolean** | If set to true will reveal the lookup secrets | [optional] |
 | **method** | **String** | Method  Should be set to \"lookup\" when trying to add, update, or remove a lookup pairing. |  |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
 
 ## Example
 
@@ -22,7 +23,8 @@ instance = OryClient::UpdateSettingsFlowWithLookupMethod.new(
   lookup_secret_disable: null,
   lookup_secret_regenerate: null,
   lookup_secret_reveal: null,
-  method: null
+  method: null,
+  transient_payload: null
 )
 ```