ory-client 0.2.0.alpha60 → 1.0.0.alpha0

data/docs/SubmitSelfServiceRegistrationFlowBody.md

@@ -1,81 +0,0 @@
-# OryClient::SubmitSelfServiceRegistrationFlowBody
-
-## Class instance methods
-
-### `openapi_one_of`
-
-Returns the list of classes defined in oneOf.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceRegistrationFlowBody.openapi_one_of
-# =>
-# [
-#   :'SubmitSelfServiceRegistrationFlowWithOidcMethodBody',
-#   :'SubmitSelfServiceRegistrationFlowWithPasswordMethodBody',
-#   :'SubmitSelfServiceRegistrationFlowWithWebAuthnMethodBody'
-# ]
-```
-
-### `openapi_discriminator_name`
-
-Returns the discriminator's property name.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceRegistrationFlowBody.openapi_discriminator_name
-# => :'method'
-```
-
-### `openapi_discriminator_name`
-
-Returns the discriminator's mapping.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceRegistrationFlowBody.openapi_discriminator_mapping
-# =>
-# {
-#   :'oidc' => :'SubmitSelfServiceRegistrationFlowWithOidcMethodBody',
-#   :'password' => :'SubmitSelfServiceRegistrationFlowWithPasswordMethodBody',
-#   :'webauthn' => :'SubmitSelfServiceRegistrationFlowWithWebAuthnMethodBody'
-# }
-
-### build
-
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceRegistrationFlowBody.build(data)
-# => #<SubmitSelfServiceRegistrationFlowWithOidcMethodBody:0x00007fdd4aab02a0>
-
-OryClient::SubmitSelfServiceRegistrationFlowBody.build(data_that_doesnt_match)
-# => nil
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-
-#### Return type
-
-- `SubmitSelfServiceRegistrationFlowWithOidcMethodBody`
-- `SubmitSelfServiceRegistrationFlowWithPasswordMethodBody`
-- `SubmitSelfServiceRegistrationFlowWithWebAuthnMethodBody`
-- `nil` (if no type matches)
-

data/docs/SubmitSelfServiceRegistrationFlowWithOidcMethodBody.md

@@ -1,24 +0,0 @@
-# OryClient::SubmitSelfServiceRegistrationFlowWithOidcMethodBody
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **csrf_token** | **String** | The CSRF Token | [optional] |
-| **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 | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::SubmitSelfServiceRegistrationFlowWithOidcMethodBody.new(
-  csrf_token: null,
-  method: null,
-  provider: null,
-  traits: null
-)
-```
-

data/docs/SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.md

@@ -1,24 +0,0 @@
-# OryClient::SubmitSelfServiceRegistrationFlowWithPasswordMethodBody
-
-## 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 |  |
-| **traits** | **Object** | The identity's traits |  |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.new(
-  csrf_token: null,
-  method: null,
-  password: null,
-  traits: null
-)
-```
-

data/docs/SubmitSelfServiceRegistrationFlowWithWebAuthnMethodBody.md

@@ -1,26 +0,0 @@
-# OryClient::SubmitSelfServiceRegistrationFlowWithWebAuthnMethodBody
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **csrf_token** | **String** | CSRFToken is the anti-CSRF token | [optional] |
-| **method** | **String** | Method  Should be set to \"webauthn\" when trying to add, update, or remove a webAuthn pairing. |  |
-| **traits** | **Object** | The identity's traits |  |
-| **webauthn_register** | **String** | Register a WebAuthn Security Key  It is expected that the JSON returned by the WebAuthn registration process is included here. | [optional] |
-| **webauthn_register_displayname** | **String** | Name of the WebAuthn Security Key to be Added  A human-readable name for the security key which will be added. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::SubmitSelfServiceRegistrationFlowWithWebAuthnMethodBody.new(
-  csrf_token: null,
-  method: null,
-  traits: null,
-  webauthn_register: null,
-  webauthn_register_displayname: null
-)
-```
-

data/docs/SubmitSelfServiceSettingsFlowBody.md

@@ -1,90 +0,0 @@
-# OryClient::SubmitSelfServiceSettingsFlowBody
-
-## Class instance methods
-
-### `openapi_one_of`
-
-Returns the list of classes defined in oneOf.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceSettingsFlowBody.openapi_one_of
-# =>
-# [
-#   :'SubmitSelfServiceSettingsFlowWithLookupMethodBody',
-#   :'SubmitSelfServiceSettingsFlowWithOidcMethodBody',
-#   :'SubmitSelfServiceSettingsFlowWithPasswordMethodBody',
-#   :'SubmitSelfServiceSettingsFlowWithProfileMethodBody',
-#   :'SubmitSelfServiceSettingsFlowWithTotpMethodBody',
-#   :'SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody'
-# ]
-```
-
-### `openapi_discriminator_name`
-
-Returns the discriminator's property name.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceSettingsFlowBody.openapi_discriminator_name
-# => :'method'
-```
-
-### `openapi_discriminator_name`
-
-Returns the discriminator's mapping.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceSettingsFlowBody.openapi_discriminator_mapping
-# =>
-# {
-#   :'lookup_secret' => :'SubmitSelfServiceSettingsFlowWithLookupMethodBody',
-#   :'oidc' => :'SubmitSelfServiceSettingsFlowWithOidcMethodBody',
-#   :'password' => :'SubmitSelfServiceSettingsFlowWithPasswordMethodBody',
-#   :'profile' => :'SubmitSelfServiceSettingsFlowWithProfileMethodBody',
-#   :'totp' => :'SubmitSelfServiceSettingsFlowWithTotpMethodBody',
-#   :'webauthn' => :'SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody'
-# }
-
-### build
-
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceSettingsFlowBody.build(data)
-# => #<SubmitSelfServiceSettingsFlowWithLookupMethodBody:0x00007fdd4aab02a0>
-
-OryClient::SubmitSelfServiceSettingsFlowBody.build(data_that_doesnt_match)
-# => nil
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-
-#### Return type
-
-- `SubmitSelfServiceSettingsFlowWithLookupMethodBody`
-- `SubmitSelfServiceSettingsFlowWithOidcMethodBody`
-- `SubmitSelfServiceSettingsFlowWithPasswordMethodBody`
-- `SubmitSelfServiceSettingsFlowWithProfileMethodBody`
-- `SubmitSelfServiceSettingsFlowWithTotpMethodBody`
-- `SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody`
-- `nil` (if no type matches)
-

data/docs/SubmitSelfServiceSettingsFlowWithLookupMethodBody.md

@@ -1,28 +0,0 @@
-# OryClient::SubmitSelfServiceSettingsFlowWithLookupMethodBody
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **csrf_token** | **String** | CSRFToken is the anti-CSRF token | [optional] |
-| **lookup_secret_confirm** | **Boolean** | If set to true will save the regenerated lookup secrets | [optional] |
-| **lookup_secret_disable** | **Boolean** | Disables this method if true. | [optional] |
-| **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. |  |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::SubmitSelfServiceSettingsFlowWithLookupMethodBody.new(
-  csrf_token: null,
-  lookup_secret_confirm: null,
-  lookup_secret_disable: null,
-  lookup_secret_regenerate: null,
-  lookup_secret_reveal: null,
-  method: null
-)
-```
-

data/docs/SubmitSelfServiceSettingsFlowWithOidcMethodBody.md

@@ -1,26 +0,0 @@
-# OryClient::SubmitSelfServiceSettingsFlowWithOidcMethodBody
-
-## 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] |
-| **method** | **String** | Method  Should be set to profile when trying to update a profile. |  |
-| **traits** | **Object** | The identity's traits  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'
-
-instance = OryClient::SubmitSelfServiceSettingsFlowWithOidcMethodBody.new(
-  flow: null,
-  link: null,
-  method: null,
-  traits: null,
-  unlink: null
-)
-```
-

data/docs/SubmitSelfServiceSettingsFlowWithPasswordMethodBody.md

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

data/docs/SubmitSelfServiceSettingsFlowWithProfileMethodBody.md

@@ -1,22 +0,0 @@
-# OryClient::SubmitSelfServiceSettingsFlowWithProfileMethodBody
-
-## 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. |  |
-| **traits** | **Object** | Traits contains all of the identity's traits. |  |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::SubmitSelfServiceSettingsFlowWithProfileMethodBody.new(
-  csrf_token: null,
-  method: null,
-  traits: null
-)
-```
-

data/docs/SubmitSelfServiceSettingsFlowWithTotpMethodBody.md

@@ -1,24 +0,0 @@
-# OryClient::SubmitSelfServiceSettingsFlowWithTotpMethodBody
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **csrf_token** | **String** | CSRFToken is the anti-CSRF token | [optional] |
-| **method** | **String** | Method  Should be set to \"totp\" when trying to add, update, or remove a totp pairing. |  |
-| **totp_code** | **String** | ValidationTOTP must contain a valid TOTP based on the | [optional] |
-| **totp_unlink** | **Boolean** | UnlinkTOTP if true will remove the TOTP pairing, effectively removing the credential. This can be used to set up a new TOTP device. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::SubmitSelfServiceSettingsFlowWithTotpMethodBody.new(
-  csrf_token: null,
-  method: null,
-  totp_code: null,
-  totp_unlink: null
-)
-```
-

data/docs/SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody.md

@@ -1,26 +0,0 @@
-# OryClient::SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **csrf_token** | **String** | CSRFToken is the anti-CSRF token | [optional] |
-| **method** | **String** | Method  Should be set to \"webauthn\" when trying to add, update, or remove a webAuthn pairing. |  |
-| **webauthn_register** | **String** | Register a WebAuthn Security Key  It is expected that the JSON returned by the WebAuthn registration process is included here. | [optional] |
-| **webauthn_register_displayname** | **String** | Name of the WebAuthn Security Key to be Added  A human-readable name for the security key which will be added. | [optional] |
-| **webauthn_remove** | **String** | Remove a WebAuthn Security Key  This must contain the ID of the WebAuthN connection. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody.new(
-  csrf_token: null,
-  method: null,
-  webauthn_register: null,
-  webauthn_register_displayname: null,
-  webauthn_remove: null
-)
-```
-

data/docs/SubmitSelfServiceVerificationFlowBody.md

@@ -1,75 +0,0 @@
-# OryClient::SubmitSelfServiceVerificationFlowBody
-
-## Class instance methods
-
-### `openapi_one_of`
-
-Returns the list of classes defined in oneOf.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceVerificationFlowBody.openapi_one_of
-# =>
-# [
-#   :'SubmitSelfServiceVerificationFlowWithLinkMethodBody'
-# ]
-```
-
-### `openapi_discriminator_name`
-
-Returns the discriminator's property name.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceVerificationFlowBody.openapi_discriminator_name
-# => :'method'
-```
-
-### `openapi_discriminator_name`
-
-Returns the discriminator's mapping.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceVerificationFlowBody.openapi_discriminator_mapping
-# =>
-# {
-#   :'link' => :'SubmitSelfServiceVerificationFlowWithLinkMethodBody'
-# }
-
-### build
-
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-
-#### Example
-
-```ruby
-require 'ory-client'
-
-OryClient::SubmitSelfServiceVerificationFlowBody.build(data)
-# => #<SubmitSelfServiceVerificationFlowWithLinkMethodBody:0x00007fdd4aab02a0>
-
-OryClient::SubmitSelfServiceVerificationFlowBody.build(data_that_doesnt_match)
-# => nil
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-
-#### Return type
-
-- `SubmitSelfServiceVerificationFlowWithLinkMethodBody`
-- `nil` (if no type matches)
-

data/docs/SubmitSelfServiceVerificationFlowWithLinkMethodBody.md

@@ -1,22 +0,0 @@
-# OryClient::SubmitSelfServiceVerificationFlowWithLinkMethodBody
-
-## 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 |  |
-| **method** | **String** | Method supports `link` only right now. |  |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::SubmitSelfServiceVerificationFlowWithLinkMethodBody.new(
-  csrf_token: null,
-  email: null,
-  method: null
-)
-```
-

data/docs/SuccessfulOAuth2RequestResponse.md

@@ -1,18 +0,0 @@
-# OryClient::SuccessfulOAuth2RequestResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **redirect_to** | **String** | RedirectURL is the URL which you should redirect the user to once the authentication process is completed. |  |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::SuccessfulOAuth2RequestResponse.new(
-  redirect_to: null
-)
-```
-

data/docs/SuccessfulSelfServiceLoginWithoutBrowser.md

@@ -1,20 +0,0 @@
-# OryClient::SuccessfulSelfServiceLoginWithoutBrowser
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **session** | [**Session**](Session.md) |  |  |
-| **session_token** | **String** | The Session Token  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! | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::SuccessfulSelfServiceLoginWithoutBrowser.new(
-  session: null,
-  session_token: null
-)
-```
-

data/docs/SuccessfulSelfServiceRegistrationWithoutBrowser.md

@@ -1,22 +0,0 @@
-# OryClient::SuccessfulSelfServiceRegistrationWithoutBrowser
-
-## 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! | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::SuccessfulSelfServiceRegistrationWithoutBrowser.new(
-  identity: null,
-  session: null,
-  session_token: null
-)
-```
-

data/docs/SyntaxApi.md

@@ -1,77 +0,0 @@
-# OryClient::SyntaxApi
-
-All URIs are relative to *https://playground.projects.oryapis.com*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**check_opl_syntax**](SyntaxApi.md#check_opl_syntax) | **POST** /opl/syntax/check | Check the syntax of an OPL file |
-
-
-## check_opl_syntax
-
-> <PostCheckOplSyntaxResponse> check_opl_syntax(body)
-
-Check the syntax of an OPL file
-
-The OPL file is expected in the body of the request.
-
-### Examples
-
-```ruby
-require 'time'
-require 'ory-client'
-# setup authorization
-OryClient.configure do |config|
-  # Configure Bearer authorization: oryAccessToken
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = OryClient::SyntaxApi.new
-body = 'body_example' # String | the OPL content to check
-
-begin
-  # Check the syntax of an OPL file
-  result = api_instance.check_opl_syntax(body)
-  p result
-rescue OryClient::ApiError => e
-  puts "Error when calling SyntaxApi->check_opl_syntax: #{e}"
-end
-```
-
-#### Using the check_opl_syntax_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<PostCheckOplSyntaxResponse>, Integer, Hash)> check_opl_syntax_with_http_info(body)
-
-```ruby
-begin
-  # Check the syntax of an OPL file
-  data, status_code, headers = api_instance.check_opl_syntax_with_http_info(body)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <PostCheckOplSyntaxResponse>
-rescue OryClient::ApiError => e
-  puts "Error when calling SyntaxApi->check_opl_syntax_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | **String** | the OPL content to check |  |
-
-### Return type
-
-[**PostCheckOplSyntaxResponse**](PostCheckOplSyntaxResponse.md)
-
-### Authorization
-
-[oryAccessToken](../README.md#oryAccessToken)
-
-### HTTP request headers
-
-- **Content-Type**: text/plain
-- **Accept**: application/json
-

data/docs/UpdateCustomHostnameBody.md

@@ -1,24 +0,0 @@
-# OryClient::UpdateCustomHostnameBody
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **cookie_domain** | **String** | The domain where cookies will be set. Has to be a parent domain of the custom hostname to work. | [optional] |
-| **cors_allowed_origins** | **Array<String>** | CORS Allowed origins for the custom hostname. | [optional] |
-| **cors_enabled** | **Boolean** | CORS Enabled for the custom hostname. | [optional] |
-| **hostname** | **String** | The custom hostname where the API will be exposed. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::UpdateCustomHostnameBody.new(
-  cookie_domain: null,
-  cors_allowed_origins: null,
-  cors_enabled: null,
-  hostname: null
-)
-```
-