ory-client 0.0.1.alpha168 → 0.0.1.alpha176

data/docs/ReadApi.md

@@ -0,0 +1,333 @@
+# OryClient::ReadApi
+
+All URIs are relative to *https://playground.projects.oryapis.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_check**](ReadApi.md#get_check) | **GET** /relation-tuples/check | Check a relation tuple |
+| [**get_expand**](ReadApi.md#get_expand) | **GET** /relation-tuples/expand | Expand a Relation Tuple |
+| [**get_relation_tuples**](ReadApi.md#get_relation_tuples) | **GET** /relation-tuples | Query relation tuples |
+| [**post_check**](ReadApi.md#post_check) | **POST** /relation-tuples/check | Check a relation tuple |
+
+
+## get_check
+
+> <GetCheckResponse> get_check(opts)
+
+Check a relation tuple
+
+To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
+
+### 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::ReadApi.new
+opts = {
+  namespace: 'namespace_example', # String | Namespace of the Relation Tuple
+  object: 'object_example', # String | Object of the Relation Tuple
+  relation: 'relation_example', # String | Relation of the Relation Tuple
+  subject_id: 'subject_id_example', # String | SubjectID of the Relation Tuple
+  subject_set_namespace: 'subject_set_namespace_example', # String | Namespace of the Subject Set
+  subject_set_object: 'subject_set_object_example', # String | Object of the Subject Set
+  subject_set_relation: 'subject_set_relation_example', # String | Relation of the Subject Set
+  max_depth: 789 # Integer | 
+}
+
+begin
+  # Check a relation tuple
+  result = api_instance.get_check(opts)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling ReadApi->get_check: #{e}"
+end
+```
+
+#### Using the get_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckResponse>, Integer, Hash)> get_check_with_http_info(opts)
+
+```ruby
+begin
+  # Check a relation tuple
+  data, status_code, headers = api_instance.get_check_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckResponse>
+rescue OryClient::ApiError => e
+  puts "Error when calling ReadApi->get_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Relation Tuple | [optional] |
+| **object** | **String** | Object of the Relation Tuple | [optional] |
+| **relation** | **String** | Relation of the Relation Tuple | [optional] |
+| **subject_id** | **String** | SubjectID of the Relation Tuple | [optional] |
+| **subject_set_namespace** | **String** | Namespace of the Subject Set | [optional] |
+| **subject_set_object** | **String** | Object of the Subject Set | [optional] |
+| **subject_set_relation** | **String** | Relation of the Subject Set | [optional] |
+| **max_depth** | **Integer** |  | [optional] |
+
+### Return type
+
+[**GetCheckResponse**](GetCheckResponse.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_expand
+
+> <ExpandTree> get_expand(namespace, object, relation, opts)
+
+Expand a Relation Tuple
+
+Use this endpoint to expand a relation tuple.
+
+### 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::ReadApi.new
+namespace = 'namespace_example' # String | Namespace of the Subject Set
+object = 'object_example' # String | Object of the Subject Set
+relation = 'relation_example' # String | Relation of the Subject Set
+opts = {
+  max_depth: 789 # Integer | 
+}
+
+begin
+  # Expand a Relation Tuple
+  result = api_instance.get_expand(namespace, object, relation, opts)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling ReadApi->get_expand: #{e}"
+end
+```
+
+#### Using the get_expand_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExpandTree>, Integer, Hash)> get_expand_with_http_info(namespace, object, relation, opts)
+
+```ruby
+begin
+  # Expand a Relation Tuple
+  data, status_code, headers = api_instance.get_expand_with_http_info(namespace, object, relation, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExpandTree>
+rescue OryClient::ApiError => e
+  puts "Error when calling ReadApi->get_expand_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Subject Set |  |
+| **object** | **String** | Object of the Subject Set |  |
+| **relation** | **String** | Relation of the Subject Set |  |
+| **max_depth** | **Integer** |  | [optional] |
+
+### Return type
+
+[**ExpandTree**](ExpandTree.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_relation_tuples
+
+> <GetRelationTuplesResponse> get_relation_tuples(opts)
+
+Query relation tuples
+
+Get all relation tuples that match the query. Only the namespace field is required.
+
+### 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::ReadApi.new
+opts = {
+  page_token: 'page_token_example', # String | 
+  page_size: 789, # Integer | 
+  namespace: 'namespace_example', # String | Namespace of the Relation Tuple
+  object: 'object_example', # String | Object of the Relation Tuple
+  relation: 'relation_example', # String | Relation of the Relation Tuple
+  subject_id: 'subject_id_example', # String | SubjectID of the Relation Tuple
+  subject_set_namespace: 'subject_set_namespace_example', # String | Namespace of the Subject Set
+  subject_set_object: 'subject_set_object_example', # String | Object of the Subject Set
+  subject_set_relation: 'subject_set_relation_example' # String | Relation of the Subject Set
+}
+
+begin
+  # Query relation tuples
+  result = api_instance.get_relation_tuples(opts)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling ReadApi->get_relation_tuples: #{e}"
+end
+```
+
+#### Using the get_relation_tuples_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRelationTuplesResponse>, Integer, Hash)> get_relation_tuples_with_http_info(opts)
+
+```ruby
+begin
+  # Query relation tuples
+  data, status_code, headers = api_instance.get_relation_tuples_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRelationTuplesResponse>
+rescue OryClient::ApiError => e
+  puts "Error when calling ReadApi->get_relation_tuples_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page_token** | **String** |  | [optional] |
+| **page_size** | **Integer** |  | [optional] |
+| **namespace** | **String** | Namespace of the Relation Tuple | [optional] |
+| **object** | **String** | Object of the Relation Tuple | [optional] |
+| **relation** | **String** | Relation of the Relation Tuple | [optional] |
+| **subject_id** | **String** | SubjectID of the Relation Tuple | [optional] |
+| **subject_set_namespace** | **String** | Namespace of the Subject Set | [optional] |
+| **subject_set_object** | **String** | Object of the Subject Set | [optional] |
+| **subject_set_relation** | **String** | Relation of the Subject Set | [optional] |
+
+### Return type
+
+[**GetRelationTuplesResponse**](GetRelationTuplesResponse.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_check
+
+> <GetCheckResponse> post_check(opts)
+
+Check a relation tuple
+
+To learn how relation tuples and the check works, head over to [the documentation](../concepts/relation-tuples.mdx).
+
+### 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::ReadApi.new
+opts = {
+  max_depth: 789, # Integer | 
+  relation_query: OryClient::RelationQuery.new # RelationQuery | 
+}
+
+begin
+  # Check a relation tuple
+  result = api_instance.post_check(opts)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling ReadApi->post_check: #{e}"
+end
+```
+
+#### Using the post_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckResponse>, Integer, Hash)> post_check_with_http_info(opts)
+
+```ruby
+begin
+  # Check a relation tuple
+  data, status_code, headers = api_instance.post_check_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckResponse>
+rescue OryClient::ApiError => e
+  puts "Error when calling ReadApi->post_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max_depth** | **Integer** |  | [optional] |
+| **relation_query** | [**RelationQuery**](RelationQuery.md) |  | [optional] |
+
+### Return type
+
+[**GetCheckResponse**](GetCheckResponse.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/RelationQuery.md

@@ -0,0 +1,26 @@
+# OryClient::RelationQuery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Relation Tuple | [optional] |
+| **object** | **String** | Object of the Relation Tuple | [optional] |
+| **relation** | **String** | Relation of the Relation Tuple | [optional] |
+| **subject_id** | **String** | SubjectID of the Relation Tuple  Either SubjectSet or SubjectID can be provided. | [optional] |
+| **subject_set** | [**SubjectSet**](SubjectSet.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::RelationQuery.new(
+  namespace: null,
+  object: null,
+  relation: null,
+  subject_id: null,
+  subject_set: null
+)
+```
+

data/docs/SelfServiceRecoveryFlow.md

@@ -11,7 +11,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** | [**SelfServiceRecoveryFlowState**](SelfServiceRecoveryFlowState.md) |  |  |
-| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
+| **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
 
 ## Example

data/docs/SelfServiceRegistrationFlow.md

@@ -10,7 +10,7 @@
 | **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. |  |
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
-| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
+| **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
 
 ## Example

data/docs/SelfServiceSettingsFlow.md

@@ -12,7 +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** | [**SelfServiceSettingsFlowState**](SelfServiceSettingsFlowState.md) |  |  |
-| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
+| **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
 
 ## Example

data/docs/SubjectSet.md

@@ -0,0 +1,22 @@
+# OryClient::SubjectSet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Subject Set |  |
+| **object** | **String** | Object of the Subject Set |  |
+| **relation** | **String** | Relation of the Subject Set |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubjectSet.new(
+  namespace: null,
+  object: null,
+  relation: null
+)
+```
+

data/docs/SubmitSelfServiceLoginFlowWithPasswordMethodBody.md

@@ -8,7 +8,7 @@
 | **identifier** | **String** | Identifier is the email or username of the user trying to log in. |  |
 | **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! |  |
+| **password_identifier** | **String** | Identifier is the email or username of the user trying to log in. This field is deprecated! | [optional] |
 
 ## Example
 

data/docs/Subscription.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **created_at** | **Time** |  | [readonly] |
-| **current_plan** | **String** | The currently active plan of the subscription | [readonly] |
+| **current_plan** | **String** | The currently active plan of the subscription unknown Unknown free Free start_up_monthly StartUpMonthly start_up_yearly StartUpYearly custom Custom | [readonly] |
 | **customer_id** | **String** | The ID of the stripe customer | [readonly] |
 | **id** | **String** |  |  |
 | **ongoing_stripe_checkout_id** | **String** |  | [optional] |

data/docs/UiNode.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **attributes** | [**UiNodeAttributes**](UiNodeAttributes.md) |  |  |
-| **group** | **String** |  |  |
+| **group** | **String** | Group specifies which group (e.g. password authenticator) this node belongs to. |  |
 | **messages** | [**Array<UiText>**](UiText.md) |  |  |
 | **meta** | [**UiNodeMeta**](UiNodeMeta.md) |  |  |
-| **type** | **String** |  |  |
+| **type** | **String** | The node's type |  |
 
 ## Example
 

data/docs/UiNodeAnchorAttributes.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **href** | **String** | The link's href (destination) URL.  format: uri |  |
 | **id** | **String** | A unique identifier |  |
-| **node_type** | **String** |  |  |
+| **node_type** | **String** | NodeType represents this node's types. It is a mirror of `node.type` and is primarily used to allow compatibility with OpenAPI 3.0.  In this struct it technically always is \"a\". |  |
 | **title** | [**UiText**](UiText.md) |  |  |
 
 ## Example

data/docs/UiNodeAttributes.md

@@ -47,8 +47,8 @@ require 'ory-client'
 OryClient::UiNodeAttributes.openapi_discriminator_mapping
 # =>
 # {
-#   :'anchor' => :'UiNodeAnchorAttributes',
-#   :'image' => :'UiNodeImageAttributes',
+#   :'a' => :'UiNodeAnchorAttributes',
+#   :'img' => :'UiNodeImageAttributes',
 #   :'input' => :'UiNodeInputAttributes',
 #   :'script' => :'UiNodeScriptAttributes',
 #   :'text' => :'UiNodeTextAttributes'

data/docs/UiNodeImageAttributes.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **height** | **Integer** | Height of the image |  |
 | **id** | **String** | A unique identifier |  |
-| **node_type** | **String** |  |  |
+| **node_type** | **String** | NodeType represents this node's types. It is a mirror of `node.type` and is primarily used to allow compatibility with OpenAPI 3.0.  In this struct it technically always is \"img\". |  |
 | **src** | **String** | The image's source URL.  format: uri |  |
 | **width** | **Integer** | Width of the image |  |
 

data/docs/UiNodeInputAttributes.md

@@ -7,7 +7,7 @@
 | **disabled** | **Boolean** | Sets the input's disabled field to true or false. |  |
 | **label** | [**UiText**](UiText.md) |  | [optional] |
 | **name** | **String** | The input's element name. |  |
-| **node_type** | **String** |  |  |
+| **node_type** | **String** | NodeType represents this node's types. It is a mirror of `node.type` and is primarily used to allow compatibility with OpenAPI 3.0.  In this struct it technically always is \"input\". |  |
 | **onclick** | **String** | OnClick may contain javascript which should be executed on click. This is primarily used for WebAuthn. | [optional] |
 | **pattern** | **String** | The input's pattern. | [optional] |
 | **required** | **Boolean** | Mark this input field as required. | [optional] |

data/docs/UiNodeScriptAttributes.md

@@ -8,7 +8,7 @@
 | **crossorigin** | **String** | The script cross origin policy |  |
 | **id** | **String** | A unique identifier |  |
 | **integrity** | **String** | The script's integrity hash |  |
-| **node_type** | **String** |  |  |
+| **node_type** | **String** | NodeType represents this node's types. It is a mirror of `node.type` and is primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\". |  |
 | **nonce** | **String** | Nonce for CSP  A nonce you may want to use to improve your Content Security Policy. You do not have to use this value but if you want to improve your CSP policies you may use it. You can also choose to use your own nonce value! |  |
 | **referrerpolicy** | **String** | The script referrer policy |  |
 | **src** | **String** | The script source |  |

data/docs/UiNodeTextAttributes.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | A unique identifier |  |
-| **node_type** | **String** |  |  |
+| **node_type** | **String** | NodeType represents this node's types. It is a mirror of `node.type` and is primarily used to allow compatibility with OpenAPI 3.0.  In this struct it technically always is \"text\". |  |
 | **text** | [**UiText**](UiText.md) |  |  |
 
 ## Example

data/docs/UpdateCustomHostnameBody.md

@@ -5,6 +5,8 @@
 | 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
@@ -14,6 +16,8 @@ require 'ory-client'
 
 instance = OryClient::UpdateCustomHostnameBody.new(
   cookie_domain: null,
+  cors_allowed_origins: null,
+  cors_enabled: null,
   hostname: null
 )
 ```

data/docs/V0alpha2Api.md

@@ -60,7 +60,7 @@ All URIs are relative to *https://playground.projects.oryapis.com*
 
 Create an Identity
 
-This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future.  Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
+This endpoint creates an identity. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
 
 ### Examples
 
@@ -630,7 +630,7 @@ end
 
 Update an Identity
 
-This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future.  The full identity payload (except credentials) is expected. This endpoint does not support patching.  Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
+This endpoint updates an identity. The full identity payload (except credentials) is expected. This endpoint does not support patching.  Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
 
 ### Examples
 
@@ -2722,6 +2722,7 @@ api_instance = OryClient::V0alpha2Api.new
 flow = 'flow_example' # String | The Login Flow ID  The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
 opts = {
   x_session_token: 'x_session_token_example', # String | The Session Token of the Identity performing the settings flow.
+  cookie: 'cookie_example', # String | CSRF Cookie  The CSRF cookie for browsers flow.
   submit_self_service_login_flow_body: OryClient::SubmitSelfServiceLoginFlowWithLookupSecretMethodBody.new({lookup_secret: 'lookup_secret_example', method: 'method_example'}) # SubmitSelfServiceLoginFlowBody | 
 }
 
@@ -2758,6 +2759,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **flow** | **String** | The Login Flow ID  The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). |  |
 | **x_session_token** | **String** | The Session Token of the Identity performing the settings flow. | [optional] |
+| **cookie** | **String** | CSRF Cookie  The CSRF cookie for browsers flow. | [optional] |
 | **submit_self_service_login_flow_body** | [**SubmitSelfServiceLoginFlowBody**](SubmitSelfServiceLoginFlowBody.md) |  | [optional] |
 
 ### Return type
@@ -3272,7 +3274,7 @@ end
 api_instance = OryClient::V0alpha2Api.new
 project_id = 'project_id_example' # String | Project ID  The project's ID.
 opts = {
-  update_project: OryClient::UpdateProject.new({name: 'name_example', services: OryClient::ProjectServices.new({identity: OryClient::ProjectServiceIdentity.new({config: 3.56})})}) # UpdateProject | 
+  update_project: OryClient::UpdateProject.new({name: 'name_example', services: OryClient::ProjectServices.new}) # UpdateProject | 
 }
 
 begin