ory-client-client 0.0.1.alpha1

data/docs/SubmitSelfServiceSettingsFlowWithProfileMethod.md

@@ -0,0 +1,22 @@
+# OryHydraClient::SubmitSelfServiceSettingsFlowWithProfileMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | The Anti-CSRF Token  This token is only required when performing browser flows. | [optional] |
+| **method** | **String** | Method  Should be set to profile when trying to update a profile.  type: string | [optional] |
+| **traits** | **Object** | Traits contains all of the identity's traits. |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::SubmitSelfServiceSettingsFlowWithProfileMethod.new(
+  csrf_token: null,
+  method: null,
+  traits: null
+)
+```
+

data/docs/SubmitSelfServiceVerificationFlowWithLinkMethod.md

@@ -0,0 +1,20 @@
+# OryHydraClient::SubmitSelfServiceVerificationFlowWithLinkMethod
+
+## 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 Verify  Needs to be set when initiating the flow. If the email is a registered verification email, a verification 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::SubmitSelfServiceVerificationFlowWithLinkMethod.new(
+  csrf_token: null,
+  email: null
+)
+```
+

data/docs/UiContainer.md

@@ -0,0 +1,24 @@
+# OryHydraClient::UiContainer
+
+## 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::UiContainer.new(
+  action: null,
+  messages: null,
+  method: null,
+  nodes: null
+)
+```
+

data/docs/UiNode.md

@@ -0,0 +1,26 @@
+# OryHydraClient::UiNode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attributes** | [**UiNodeAttributes**](UiNodeAttributes.md) |  |  |
+| **group** | **String** |  |  |
+| **messages** | [**Array<UiText>**](UiText.md) |  |  |
+| **meta** | [**Meta**](Meta.md) |  |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::UiNode.new(
+  attributes: null,
+  group: null,
+  messages: null,
+  meta: null,
+  type: null
+)
+```
+

data/docs/UiNodeAnchorAttributes.md

@@ -0,0 +1,20 @@
+# OryHydraClient::UiNodeAnchorAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **href** | **String** | The link's href (destination) URL.  format: uri |  |
+| **title** | [**UiText**](UiText.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::UiNodeAnchorAttributes.new(
+  href: null,
+  title: null
+)
+```
+

data/docs/UiNodeAttributes.md

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

data/docs/UiNodeImageAttributes.md

@@ -0,0 +1,18 @@
+# OryHydraClient::UiNodeImageAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **src** | **String** | The image's source URL.  format: uri |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::UiNodeImageAttributes.new(
+  src: null
+)
+```
+

data/docs/UiNodeInputAttributes.md

@@ -0,0 +1,30 @@
+# OryHydraClient::UiNodeInputAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **disabled** | **Boolean** | Sets the input's disabled field to true or false. |  |
+| **label** | [**UiText**](UiText.md) |  | [optional] |
+| **name** | **String** | The input's element name. |  |
+| **pattern** | **String** | The input's pattern. | [optional] |
+| **required** | **Boolean** | Mark this input field as required. | [optional] |
+| **type** | **String** |  |  |
+| **value** | [**UiNodeInputAttributesValue**](UiNodeInputAttributesValue.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::UiNodeInputAttributes.new(
+  disabled: null,
+  label: null,
+  name: null,
+  pattern: null,
+  required: null,
+  type: null,
+  value: null
+)
+```
+

data/docs/UiNodeInputAttributesValue.md

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

data/docs/UiNodeTextAttributes.md

@@ -0,0 +1,18 @@
+# OryHydraClient::UiNodeTextAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | [**UiText**](UiText.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::UiNodeTextAttributes.new(
+  text: null
+)
+```
+

data/docs/UiText.md

@@ -0,0 +1,24 @@
+# OryHydraClient::UiText
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **context** | **Object** | The message's context. Useful when customizing messages. | [optional] |
+| **id** | **Integer** |  |  |
+| **text** | **String** | The message text. Written in american english. |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::UiText.new(
+  context: null,
+  id: null,
+  text: null,
+  type: null
+)
+```
+

data/docs/UpdateIdentity.md

@@ -0,0 +1,20 @@
+# OryHydraClient::UpdateIdentity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. If set will update the Identity's SchemaID. | [optional] |
+| **traits** | **Object** | Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in `schema_id`. |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::UpdateIdentity.new(
+  schema_id: null,
+  traits: null
+)
+```
+

data/docs/VerifiableIdentityAddress.md

@@ -0,0 +1,32 @@
+# OryHydraClient::VerifiableIdentityAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** | When this entry was created | [optional] |
+| **id** | **String** |  |  |
+| **status** | **String** | VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema |  |
+| **updated_at** | **Time** | When this entry was last updated | [optional] |
+| **value** | **String** | The address value  example foo@user.com |  |
+| **verified** | **Boolean** | Indicates if the address has already been verified |  |
+| **verified_at** | **Time** |  | [optional] |
+| **via** | **String** | VerifiableAddressType must not exceed 16 characters as that is the limitation in the SQL Schema |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::VerifiableIdentityAddress.new(
+  created_at: 2014-01-01T23:28:56.782Z,
+  id: null,
+  status: null,
+  updated_at: 2014-01-01T23:28:56.782Z,
+  value: null,
+  verified: true,
+  verified_at: null,
+  via: null
+)
+```
+

data/docs/VerificationFlow.md

@@ -0,0 +1,32 @@
+# OryHydraClient::VerificationFlow
+
+## 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 request expires. If the user still wishes to verify the address, a new request has to be initiated. | [optional] |
+| **id** | **String** |  |  |
+| **issued_at** | **Time** | IssuedAt is the time (UTC) when the request occurred. | [optional] |
+| **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. | [optional] |
+| **state** | **String** |  |  |
+| **type** | **String** | The flow type can either be `api` or `browser`. |  |
+| **ui** | [**UiContainer**](UiContainer.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::VerificationFlow.new(
+  active: null,
+  expires_at: null,
+  id: null,
+  issued_at: null,
+  request_url: null,
+  state: null,
+  type: null,
+  ui: null
+)
+```
+

data/docs/Version.md

@@ -0,0 +1,18 @@
+# OryHydraClient::Version
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | Version is the service's version. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::Version.new(
+  version: null
+)
+```
+

data/docs/Volume.md

@@ -0,0 +1,34 @@
+# OryHydraClient::Volume
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** | Date/Time the volume was created. | [optional] |
+| **driver** | **String** | Name of the volume driver used by the volume. |  |
+| **labels** | **Hash<String, String>** | User-defined key/value metadata. |  |
+| **mountpoint** | **String** | Mount path of the volume on the host. |  |
+| **name** | **String** | Name of the volume. |  |
+| **options** | **Hash<String, String>** | The driver specific options used when creating the volume. |  |
+| **scope** | **String** | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. |  |
+| **status** | **Hash<String, Object>** | Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`.  The `Status` field is optional, and is omitted if the volume driver does not support this feature. | [optional] |
+| **usage_data** | [**VolumeUsageData**](VolumeUsageData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client-client'
+
+instance = OryHydraClient::Volume.new(
+  created_at: null,
+  driver: null,
+  labels: null,
+  mountpoint: null,
+  name: null,
+  options: null,
+  scope: null,
+  status: null,
+  usage_data: null
+)
+```
+