ory-client 0.2.0.alpha48 → 1.0.0.alpha0

data/docs/RelationshipApi.md

@@ -0,0 +1,460 @@
+# OryClient::RelationshipApi
+
+All URIs are relative to *https://playground.projects.oryapis.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**check_opl_syntax**](RelationshipApi.md#check_opl_syntax) | **POST** /opl/syntax/check | Check the syntax of an OPL file |
+| [**create_relationship**](RelationshipApi.md#create_relationship) | **PUT** /admin/relation-tuples | Create a Relationship |
+| [**delete_relationships**](RelationshipApi.md#delete_relationships) | **DELETE** /admin/relation-tuples | Delete Relationships |
+| [**get_relationships**](RelationshipApi.md#get_relationships) | **GET** /relation-tuples | Query relationships |
+| [**list_relationship_namespaces**](RelationshipApi.md#list_relationship_namespaces) | **GET** /namespaces | Query namespaces |
+| [**patch_relationships**](RelationshipApi.md#patch_relationships) | **PATCH** /admin/relation-tuples | Patch Multiple Relationships |
+
+
+## check_opl_syntax
+
+> <CheckOplSyntaxResult> check_opl_syntax(opts)
+
+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::RelationshipApi.new
+opts = {
+  body: 'body_example' # String | 
+}
+
+begin
+  # Check the syntax of an OPL file
+  result = api_instance.check_opl_syntax(opts)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->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(<CheckOplSyntaxResult>, Integer, Hash)> check_opl_syntax_with_http_info(opts)
+
+```ruby
+begin
+  # Check the syntax of an OPL file
+  data, status_code, headers = api_instance.check_opl_syntax_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckOplSyntaxResult>
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->check_opl_syntax_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** |  | [optional] |
+
+### Return type
+
+[**CheckOplSyntaxResult**](CheckOplSyntaxResult.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: text/plain
+- **Accept**: application/json
+
+
+## create_relationship
+
+> <Relationship> create_relationship(opts)
+
+Create a Relationship
+
+Use this endpoint to create a relationship.
+
+### 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::RelationshipApi.new
+opts = {
+  create_relationship_body: OryClient::CreateRelationshipBody.new # CreateRelationshipBody | 
+}
+
+begin
+  # Create a Relationship
+  result = api_instance.create_relationship(opts)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->create_relationship: #{e}"
+end
+```
+
+#### Using the create_relationship_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Relationship>, Integer, Hash)> create_relationship_with_http_info(opts)
+
+```ruby
+begin
+  # Create a Relationship
+  data, status_code, headers = api_instance.create_relationship_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Relationship>
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->create_relationship_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_relationship_body** | [**CreateRelationshipBody**](CreateRelationshipBody.md) |  | [optional] |
+
+### Return type
+
+[**Relationship**](Relationship.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_relationships
+
+> delete_relationships(opts)
+
+Delete Relationships
+
+Use this endpoint to delete relationships
+
+### 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::RelationshipApi.new
+opts = {
+  namespace: 'namespace_example', # String | Namespace of the Relationship
+  object: 'object_example', # String | Object of the Relationship
+  relation: 'relation_example', # String | Relation of the Relationship
+  subject_id: 'subject_id_example', # String | SubjectID of the Relationship
+  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
+  # Delete Relationships
+  api_instance.delete_relationships(opts)
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->delete_relationships: #{e}"
+end
+```
+
+#### Using the delete_relationships_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_relationships_with_http_info(opts)
+
+```ruby
+begin
+  # Delete Relationships
+  data, status_code, headers = api_instance.delete_relationships_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->delete_relationships_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespace** | **String** | Namespace of the Relationship | [optional] |
+| **object** | **String** | Object of the Relationship | [optional] |
+| **relation** | **String** | Relation of the Relationship | [optional] |
+| **subject_id** | **String** | SubjectID of the Relationship | [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
+
+nil (empty response body)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_relationships
+
+> <Relationships> get_relationships(opts)
+
+Query relationships
+
+Get all relationships 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::RelationshipApi.new
+opts = {
+  page_token: 'page_token_example', # String | 
+  page_size: 789, # Integer | 
+  namespace: 'namespace_example', # String | Namespace of the Relationship
+  object: 'object_example', # String | Object of the Relationship
+  relation: 'relation_example', # String | Relation of the Relationship
+  subject_id: 'subject_id_example', # String | SubjectID of the Relationship
+  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 relationships
+  result = api_instance.get_relationships(opts)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->get_relationships: #{e}"
+end
+```
+
+#### Using the get_relationships_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Relationships>, Integer, Hash)> get_relationships_with_http_info(opts)
+
+```ruby
+begin
+  # Query relationships
+  data, status_code, headers = api_instance.get_relationships_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Relationships>
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->get_relationships_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page_token** | **String** |  | [optional] |
+| **page_size** | **Integer** |  | [optional] |
+| **namespace** | **String** | Namespace of the Relationship | [optional] |
+| **object** | **String** | Object of the Relationship | [optional] |
+| **relation** | **String** | Relation of the Relationship | [optional] |
+| **subject_id** | **String** | SubjectID of the Relationship | [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
+
+[**Relationships**](Relationships.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_relationship_namespaces
+
+> <RelationshipNamespaces> list_relationship_namespaces
+
+Query namespaces
+
+Get all namespaces
+
+### 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::RelationshipApi.new
+
+begin
+  # Query namespaces
+  result = api_instance.list_relationship_namespaces
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->list_relationship_namespaces: #{e}"
+end
+```
+
+#### Using the list_relationship_namespaces_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RelationshipNamespaces>, Integer, Hash)> list_relationship_namespaces_with_http_info
+
+```ruby
+begin
+  # Query namespaces
+  data, status_code, headers = api_instance.list_relationship_namespaces_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RelationshipNamespaces>
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->list_relationship_namespaces_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**RelationshipNamespaces**](RelationshipNamespaces.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## patch_relationships
+
+> patch_relationships(opts)
+
+Patch Multiple Relationships
+
+Use this endpoint to patch one or more relationships.
+
+### 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::RelationshipApi.new
+opts = {
+  relationship_patch: [OryClient::RelationshipPatch.new] # Array<RelationshipPatch> | 
+}
+
+begin
+  # Patch Multiple Relationships
+  api_instance.patch_relationships(opts)
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->patch_relationships: #{e}"
+end
+```
+
+#### Using the patch_relationships_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> patch_relationships_with_http_info(opts)
+
+```ruby
+begin
+  # Patch Multiple Relationships
+  data, status_code, headers = api_instance.patch_relationships_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryClient::ApiError => e
+  puts "Error when calling RelationshipApi->patch_relationships_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **relationship_patch** | [**Array&lt;RelationshipPatch&gt;**](RelationshipPatch.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/RelationshipNamespaces.md

@@ -0,0 +1,18 @@
+# OryClient::RelationshipNamespaces
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **namespaces** | [**Array<Namespace>**](Namespace.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::RelationshipNamespaces.new(
+  namespaces: null
+)
+```
+

data/docs/RelationshipPatch.md

@@ -0,0 +1,20 @@
+# OryClient::RelationshipPatch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** |  | [optional] |
+| **relation_tuple** | [**Relationship**](Relationship.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::RelationshipPatch.new(
+  action: null,
+  relation_tuple: null
+)
+```
+

data/docs/Relationships.md

@@ -0,0 +1,20 @@
+# OryClient::Relationships
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_page_token** | **String** | The opaque token to provide in a subsequent request to get the next page. It is the empty string iff this is the last page. | [optional] |
+| **relation_tuples** | [**Array<Relationship>**](Relationship.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::Relationships.new(
+  next_page_token: null,
+  relation_tuples: null
+)
+```
+

data/docs/SelfServiceFlowExpiredError.md

@@ -7,13 +7,14 @@
 | **code** | **Integer** | The status code | [optional] |
 | **debug** | **String** | Debug information  This field is often not exposed to protect against leaking sensitive information. | [optional] |
 | **details** | **Hash<String, Object>** | Further error details | [optional] |
+| **expired_at** | **Time** | When the flow has expired | [optional] |
 | **id** | **String** | The error ID  Useful when trying to identify various errors in application logic. | [optional] |
 | **message** | **String** | Error message  The error's message. |  |
 | **reason** | **String** | A human-readable reason for the error | [optional] |
 | **request** | **String** | The request ID  The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID. | [optional] |
 | **since** | **Integer** | A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. | [optional] |
 | **status** | **String** | The status description | [optional] |
-| **use_flow_id** | **String** |  | [optional] |
+| **use_flow_id** | **String** | The flow ID that should be used for the new flow as it contains the correct messages. | [optional] |
 
 ## Example
 
@@ -24,6 +25,7 @@ instance = OryClient::SelfServiceFlowExpiredError.new(
   code: 404,
   debug: SQL field "foo" is not a bool.,
   details: null,
+  expired_at: null,
   id: null,
   message: The resource could not be found,
   reason: User with ID 1234 does not exist.,

data/docs/Session.md

@@ -8,8 +8,9 @@
 | **authenticated_at** | **Time** | The Session Authentication Timestamp  When this session was authenticated at. If multi-factor authentication was used this is the time when the last factor was authenticated (e.g. the TOTP code challenge was completed). | [optional] |
 | **authentication_methods** | [**Array<SessionAuthenticationMethod>**](SessionAuthenticationMethod.md) | A list of authenticators which were used to authenticate the session. | [optional] |
 | **authenticator_assurance_level** | [**AuthenticatorAssuranceLevel**](AuthenticatorAssuranceLevel.md) |  | [optional] |
+| **devices** | [**Array<SessionDevice>**](SessionDevice.md) | Devices has history of all endpoints where the session was used | [optional] |
 | **expires_at** | **Time** | The Session Expiry  When this session expires at. | [optional] |
-| **id** | **String** |  |  |
+| **id** | **String** | Session ID |  |
 | **identity** | [**Identity**](Identity.md) |  |  |
 | **issued_at** | **Time** | The Session Issuance Timestamp  When this session was issued at. Usually equal or close to `authenticated_at`. | [optional] |
 
@@ -23,6 +24,7 @@ instance = OryClient::Session.new(
   authenticated_at: null,
   authentication_methods: null,
   authenticator_assurance_level: null,
+  devices: null,
   expires_at: null,
   id: null,
   identity: null,

data/docs/SessionDevice.md

@@ -4,7 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_agent** | **String** | UserAgent of this device | [optional] |
+| **id** | **String** | Device record ID |  |
+| **ip_address** | **String** | IPAddress of the client | [optional] |
+| **location** | **String** | Geo Location corresponding to the IP Address | [optional] |
+| **user_agent** | **String** | UserAgent of the client | [optional] |
 
 ## Example
 
@@ -12,6 +15,9 @@
 require 'ory-client'
 
 instance = OryClient::SessionDevice.new(
+  id: null,
+  ip_address: null,
+  location: null,
   user_agent: null
 )
 ```

data/docs/SetActiveProjectInConsoleBody.md

@@ -0,0 +1,18 @@
+# OryClient::SetActiveProjectInConsoleBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project ID  The Project ID you want to set active.  format: uuid |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SetActiveProjectInConsoleBody.new(
+  project_id: null
+)
+```
+

data/docs/SetCustomDomainBody.md

@@ -0,0 +1,24 @@
+# OryClient::SetCustomDomainBody
+
+## 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::SetCustomDomainBody.new(
+  cookie_domain: null,
+  cors_allowed_origins: null,
+  cors_enabled: null,
+  hostname: null
+)
+```
+

data/docs/SetProject.md

@@ -0,0 +1,20 @@
+# OryClient::SetProject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the project. |  |
+| **services** | [**ProjectServices**](ProjectServices.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SetProject.new(
+  name: null,
+  services: null
+)
+```
+

data/docs/SettingsFlow.md

@@ -0,0 +1,36 @@
+# OryClient::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** | ID represents the flow's unique ID. When performing the settings flow, this represents the id in the settings ui's query parameter: http://<selfservice.flows.settings.ui_url>?flow=<id> |  |
+| **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. |  |
+| **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
+| **state** | [**SettingsFlowState**](SettingsFlowState.md) |  |  |
+| **type** | **String** | The flow type can either be `api` or `browser`. |  |
+| **ui** | [**UiContainer**](UiContainer.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SettingsFlow.new(
+  active: null,
+  expires_at: null,
+  id: null,
+  identity: null,
+  issued_at: null,
+  request_url: null,
+  return_to: null,
+  state: null,
+  type: null,
+  ui: null
+)
+```
+