ory-client-client 0.0.1.alpha1

data/docs/RegistrationViaApiResponse.md

@@ -0,0 +1,22 @@
+# OryHydraClient::RegistrationViaApiResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identity** | [**Identity**](Identity.md) |  |  |
+| **session** | [**Session**](Session.md) |  | [optional] |
+| **session_token** | **String** | The Session Token  This field is only set when the session hook is configured as a post-registration hook.  A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header:  Authorization: bearer ${session-token}  The session token is only issued for API flows, not for Browser flows! |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::RegistrationViaApiResponse.new(
+  identity: null,
+  session: null,
+  session_token: null
+)
+```
+

data/docs/RevokeSession.md

@@ -0,0 +1,18 @@
+# OryHydraClient::RevokeSession
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_token** | **String** | The Session Token  Invalidate this session token. |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::RevokeSession.new(
+  session_token: null
+)
+```
+

data/docs/ServiceUpdateResponse.md

@@ -0,0 +1,18 @@
+# OryHydraClient::ServiceUpdateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **warnings** | **Array<String>** | Optional warning messages | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::ServiceUpdateResponse.new(
+  warnings: null
+)
+```
+

data/docs/Session.md

@@ -0,0 +1,28 @@
+# OryHydraClient::Session
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** |  | [optional] |
+| **authenticated_at** | **Time** |  |  |
+| **expires_at** | **Time** |  |  |
+| **id** | **String** |  |  |
+| **identity** | [**Identity**](Identity.md) |  |  |
+| **issued_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::Session.new(
+  active: null,
+  authenticated_at: null,
+  expires_at: null,
+  id: null,
+  identity: null,
+  issued_at: null
+)
+```
+

data/docs/SettingsFlow.md

@@ -0,0 +1,34 @@
+# OryHydraClient::SettingsFlow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. | [optional] |
+| **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to update the setting, a new flow has to be initiated. |  |
+| **id** | **String** |  |  |
+| **identity** | [**Identity**](Identity.md) |  |  |
+| **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow occurred. |  |
+| **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. |  |
+| **state** | **String** |  |  |
+| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
+| **ui** | [**UiContainer**](UiContainer.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::SettingsFlow.new(
+  active: null,
+  expires_at: null,
+  id: null,
+  identity: null,
+  issued_at: null,
+  request_url: null,
+  state: null,
+  type: null,
+  ui: null
+)
+```
+

data/docs/SettingsProfileFormConfig.md

@@ -0,0 +1,24 @@
+# OryHydraClient::SettingsProfileFormConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. |  |
+| **messages** | [**Array<UiText>**](UiText.md) |  | [optional] |
+| **method** | **String** | Method is the form method (e.g. POST) |  |
+| **nodes** | [**Array<UiNode>**](UiNode.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::SettingsProfileFormConfig.new(
+  action: null,
+  messages: null,
+  method: null,
+  nodes: null
+)
+```
+

data/docs/SettingsViaApiResponse.md

@@ -0,0 +1,20 @@
+# OryHydraClient::SettingsViaApiResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow** | [**SettingsFlow**](SettingsFlow.md) |  |  |
+| **identity** | [**Identity**](Identity.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::SettingsViaApiResponse.new(
+  flow: null,
+  identity: null
+)
+```
+

data/docs/SubmitSelfServiceBrowserSettingsOIDCFlowPayload.md

@@ -0,0 +1,22 @@
+# OryHydraClient::SubmitSelfServiceBrowserSettingsOIDCFlowPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow** | **String** | Flow ID is the flow's ID.  in: query | [optional] |
+| **link** | **String** | Link this provider  Either this or `unlink` must be set.  type: string in: body | [optional] |
+| **unlink** | **String** | Unlink this provider  Either this or `link` must be set.  type: string in: body | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::SubmitSelfServiceBrowserSettingsOIDCFlowPayload.new(
+  flow: null,
+  link: null,
+  unlink: null
+)
+```
+

data/docs/SubmitSelfServiceLoginFlow.md

@@ -0,0 +1,47 @@
+# OryHydraClient::SubmitSelfServiceLoginFlow
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ory-client-client'
+
+OryHydraClient::SubmitSelfServiceLoginFlow.openapi_one_of
+# =>
+# [
+#   :'SubmitSelfServiceLoginFlowWithPasswordMethod'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ory-client-client'
+
+OryHydraClient::SubmitSelfServiceLoginFlow.build(data)
+# => #<SubmitSelfServiceLoginFlowWithPasswordMethod:0x00007fdd4aab02a0>
+
+OryHydraClient::SubmitSelfServiceLoginFlow.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SubmitSelfServiceLoginFlowWithPasswordMethod`
+- `nil` (if no type matches)
+

data/docs/SubmitSelfServiceLoginFlowWithPasswordMethod.md

@@ -0,0 +1,24 @@
+# OryHydraClient::SubmitSelfServiceLoginFlowWithPasswordMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
+| **method** | **String** | Method should be set to \"password\" when logging in using the identifier and password strategy. | [optional] |
+| **password** | **String** | The user's password. | [optional] |
+| **password_identifier** | **String** | Identifier is the email or username of the user trying to log in. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::SubmitSelfServiceLoginFlowWithPasswordMethod.new(
+  csrf_token: null,
+  method: null,
+  password: null,
+  password_identifier: null
+)
+```
+

data/docs/SubmitSelfServiceRecoveryFlowWithLinkMethod.md

@@ -0,0 +1,20 @@
+# OryHydraClient::SubmitSelfServiceRecoveryFlowWithLinkMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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 in: body | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::SubmitSelfServiceRecoveryFlowWithLinkMethod.new(
+  csrf_token: null,
+  email: null
+)
+```
+

data/docs/SubmitSelfServiceRegistrationFlow.md

@@ -0,0 +1,47 @@
+# OryHydraClient::SubmitSelfServiceRegistrationFlow
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ory-client-client'
+
+OryHydraClient::SubmitSelfServiceRegistrationFlow.openapi_one_of
+# =>
+# [
+#   :'SubmitSelfServiceRegistrationFlowWithPasswordMethod'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ory-client-client'
+
+OryHydraClient::SubmitSelfServiceRegistrationFlow.build(data)
+# => #<SubmitSelfServiceRegistrationFlowWithPasswordMethod:0x00007fdd4aab02a0>
+
+OryHydraClient::SubmitSelfServiceRegistrationFlow.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SubmitSelfServiceRegistrationFlowWithPasswordMethod`
+- `nil` (if no type matches)
+

data/docs/SubmitSelfServiceRegistrationFlowWithPasswordMethod.md

@@ -0,0 +1,24 @@
+# OryHydraClient::SubmitSelfServiceRegistrationFlowWithPasswordMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | The CSRF Token | [optional] |
+| **method** | **String** | Method to use  This field must be set to `password` when using the password method. |  |
+| **password** | **String** | Password to sign the user up with | [optional] |
+| **traits** | **Object** | The identity's traits | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::SubmitSelfServiceRegistrationFlowWithPasswordMethod.new(
+  csrf_token: null,
+  method: null,
+  password: null,
+  traits: null
+)
+```
+

data/docs/SubmitSelfServiceSettingsFlow.md

@@ -0,0 +1,49 @@
+# OryHydraClient::SubmitSelfServiceSettingsFlow
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ory-client-client'
+
+OryHydraClient::SubmitSelfServiceSettingsFlow.openapi_one_of
+# =>
+# [
+#   :'SubmitSelfServiceSettingsFlowWithPasswordMethod',
+#   :'SubmitSelfServiceSettingsFlowWithProfileMethod'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ory-client-client'
+
+OryHydraClient::SubmitSelfServiceSettingsFlow.build(data)
+# => #<SubmitSelfServiceSettingsFlowWithPasswordMethod:0x00007fdd4aab02a0>
+
+OryHydraClient::SubmitSelfServiceSettingsFlow.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SubmitSelfServiceSettingsFlowWithPasswordMethod`
+- `SubmitSelfServiceSettingsFlowWithProfileMethod`
+- `nil` (if no type matches)
+

data/docs/SubmitSelfServiceSettingsFlowWithPasswordMethod.md

@@ -0,0 +1,22 @@
+# OryHydraClient::SubmitSelfServiceSettingsFlowWithPasswordMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | CSRFToken is the anti-CSRF token  type: string | [optional] |
+| **method** | **String** | Method  Should be set to password when trying to update a password.  type: string | [optional] |
+| **password** | **String** | Password is the updated password  type: string |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::SubmitSelfServiceSettingsFlowWithPasswordMethod.new(
+  csrf_token: null,
+  method: null,
+  password: null
+)
+```
+