ory-client 1.0.0 → 1.0.2

data/docs/ProjectApi.md

@@ -4,26 +4,26 @@ All URIs are relative to *https://playground.projects.oryapis.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_project**](ProjectApi.md#create_project) | **POST** /projects | # Create a Project |
-| [**create_project_api_key**](ProjectApi.md#create_project_api_key) | **POST** /projects/{project}/tokens | # Create project API token |
-| [**delete_project_api_key**](ProjectApi.md#delete_project_api_key) | **DELETE** /projects/{project}/tokens/{token_id} | # Delete project API token |
-| [**get_active_project_in_console**](ProjectApi.md#get_active_project_in_console) | **GET** /console/active/project | # Returns the Ory Network Project selected in the Ory Network Console |
-| [**get_project**](ProjectApi.md#get_project) | **GET** /projects/{project_id} | # Get a Project |
-| [**get_project_members**](ProjectApi.md#get_project_members) | **GET** /projects/{project_id}/members | # Get all members associated with this project |
-| [**list_project_api_keys**](ProjectApi.md#list_project_api_keys) | **GET** /projects/{project}/tokens | # List a project's API Tokens |
-| [**list_projects**](ProjectApi.md#list_projects) | **GET** /projects | # List All Projects |
-| [**patch_project**](ProjectApi.md#patch_project) | **PATCH** /projects/{project_id} | # Patch an Ory Network Project Configuration |
-| [**purge_project**](ProjectApi.md#purge_project) | **DELETE** /projects/{project_id} | # Irrecoverably purge a project |
-| [**remove_project_member**](ProjectApi.md#remove_project_member) | **DELETE** /projects/{project_id}/members/{member_id} | # Remove a member associated with this project |
-| [**set_active_project_in_console**](ProjectApi.md#set_active_project_in_console) | **PUT** /console/active/project | # Sets the Ory Network Project active in the Ory Network Console |
-| [**set_project**](ProjectApi.md#set_project) | **PUT** /projects/{project_id} | # Update an Ory Network Project Configuration |
+| [**create_project**](ProjectApi.md#create_project) | **POST** /projects | Create a Project |
+| [**create_project_api_key**](ProjectApi.md#create_project_api_key) | **POST** /projects/{project}/tokens | Create project API token |
+| [**delete_project_api_key**](ProjectApi.md#delete_project_api_key) | **DELETE** /projects/{project}/tokens/{token_id} | Delete project API token |
+| [**get_active_project_in_console**](ProjectApi.md#get_active_project_in_console) | **GET** /console/active/project | Returns the Ory Network Project selected in the Ory Network Console |
+| [**get_project**](ProjectApi.md#get_project) | **GET** /projects/{project_id} | Get a Project |
+| [**get_project_members**](ProjectApi.md#get_project_members) | **GET** /projects/{project_id}/members | Get all members associated with this project |
+| [**list_project_api_keys**](ProjectApi.md#list_project_api_keys) | **GET** /projects/{project}/tokens | List a project's API Tokens |
+| [**list_projects**](ProjectApi.md#list_projects) | **GET** /projects | List All Projects |
+| [**patch_project**](ProjectApi.md#patch_project) | **PATCH** /projects/{project_id} | Patch an Ory Network Project Configuration |
+| [**purge_project**](ProjectApi.md#purge_project) | **DELETE** /projects/{project_id} | Irrecoverably purge a project |
+| [**remove_project_member**](ProjectApi.md#remove_project_member) | **DELETE** /projects/{project_id}/members/{member_id} | Remove a member associated with this project |
+| [**set_active_project_in_console**](ProjectApi.md#set_active_project_in_console) | **PUT** /console/active/project | Sets the Ory Network Project active in the Ory Network Console |
+| [**set_project**](ProjectApi.md#set_project) | **PUT** /projects/{project_id} | Update an Ory Network Project Configuration |
 
 
 ## create_project
 
 > <Project> create_project(opts)
 
-# Create a Project
+Create a Project
 
 Creates a new project.
 
@@ -44,7 +44,7 @@ opts = {
 }
 
 begin
-  # # Create a Project
+  # Create a Project
   result = api_instance.create_project(opts)
   p result
 rescue OryClient::ApiError => e
@@ -60,7 +60,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # # Create a Project
+  # Create a Project
   data, status_code, headers = api_instance.create_project_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -94,7 +94,7 @@ end
 
 > <ProjectApiKey> create_project_api_key(project, opts)
 
-# Create project API token
+Create project API token
 
 Create an API token for a project.
 
@@ -116,7 +116,7 @@ opts = {
 }
 
 begin
-  # # Create project API token
+  # Create project API token
   result = api_instance.create_project_api_key(project, opts)
   p result
 rescue OryClient::ApiError => e
@@ -132,7 +132,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # # Create project API token
+  # Create project API token
   data, status_code, headers = api_instance.create_project_api_key_with_http_info(project, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -167,7 +167,7 @@ end
 
 > delete_project_api_key(project, token_id)
 
-# Delete project API token
+Delete project API token
 
 Deletes an API token and immediately removes it.
 
@@ -187,7 +187,7 @@ project = 'project_example' # String | The Project ID or Project slug
 token_id = 'token_id_example' # String | The Token ID
 
 begin
-  # # Delete project API token
+  # Delete project API token
   api_instance.delete_project_api_key(project, token_id)
 rescue OryClient::ApiError => e
   puts "Error when calling ProjectApi->delete_project_api_key: #{e}"
@@ -202,7 +202,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # # Delete project API token
+  # Delete project API token
   data, status_code, headers = api_instance.delete_project_api_key_with_http_info(project, token_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -237,7 +237,7 @@ nil (empty response body)
 
 > <ActiveProjectInConsole> get_active_project_in_console
 
-# Returns the Ory Network Project selected in the Ory Network Console
+Returns the Ory Network Project selected in the Ory Network Console
 
 Use this API to get your active project in the Ory Network Console UI.
 
@@ -255,7 +255,7 @@ end
 api_instance = OryClient::ProjectApi.new
 
 begin
-  # # Returns the Ory Network Project selected in the Ory Network Console
+  # Returns the Ory Network Project selected in the Ory Network Console
   result = api_instance.get_active_project_in_console
   p result
 rescue OryClient::ApiError => e
@@ -271,7 +271,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # # Returns the Ory Network Project selected in the Ory Network Console
+  # Returns the Ory Network Project selected in the Ory Network Console
   data, status_code, headers = api_instance.get_active_project_in_console_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -303,7 +303,7 @@ This endpoint does not need any parameter.
 
 > <Project> get_project(project_id)
 
-# Get a Project
+Get a Project
 
 Get a projects you have access to by its ID.
 
@@ -322,7 +322,7 @@ api_instance = OryClient::ProjectApi.new
 project_id = 'project_id_example' # String | Project ID  The project's ID.
 
 begin
-  # # Get a Project
+  # Get a Project
   result = api_instance.get_project(project_id)
   p result
 rescue OryClient::ApiError => e
@@ -338,7 +338,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # # Get a Project
+  # Get a Project
   data, status_code, headers = api_instance.get_project_with_http_info(project_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -372,7 +372,7 @@ end
 
 > <Array<CloudAccount>> get_project_members(project_id)
 
-# Get all members associated with this project
+Get all members associated with this project
 
 This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`.
 
@@ -391,7 +391,7 @@ api_instance = OryClient::ProjectApi.new
 project_id = 'project_id_example' # String | Project ID  The project's ID.
 
 begin
-  # # Get all members associated with this project
+  # Get all members associated with this project
   result = api_instance.get_project_members(project_id)
   p result
 rescue OryClient::ApiError => e
@@ -407,7 +407,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # # Get all members associated with this project
+  # Get all members associated with this project
   data, status_code, headers = api_instance.get_project_members_with_http_info(project_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -441,7 +441,7 @@ end
 
 > <Array<ProjectApiKey>> list_project_api_keys(project)
 
-# List a project's API Tokens
+List a project's API Tokens
 
 A list of all the project's API tokens.
 
@@ -460,7 +460,7 @@ api_instance = OryClient::ProjectApi.new
 project = 'project_example' # String | The Project ID or Project slug
 
 begin
-  # # List a project's API Tokens
+  # List a project's API Tokens
   result = api_instance.list_project_api_keys(project)
   p result
 rescue OryClient::ApiError => e
@@ -476,7 +476,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # # List a project's API Tokens
+  # List a project's API Tokens
   data, status_code, headers = api_instance.list_project_api_keys_with_http_info(project)
   p status_code # => 2xx
   p headers # => { ... }
@@ -510,7 +510,7 @@ end
 
 > <Array<ProjectMetadata>> list_projects
 
-# List All Projects
+List All Projects
 
 Lists all projects you have access to.
 
@@ -528,7 +528,7 @@ end
 api_instance = OryClient::ProjectApi.new
 
 begin
-  # # List All Projects
+  # List All Projects
   result = api_instance.list_projects
   p result
 rescue OryClient::ApiError => e
@@ -544,7 +544,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # # List All Projects
+  # List All Projects
   data, status_code, headers = api_instance.list_projects_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -576,7 +576,7 @@ This endpoint does not need any parameter.
 
 > <SuccessfulProjectUpdate> patch_project(project_id, opts)
 
-# Patch an Ory Network Project Configuration
+Patch an Ory Network Project Configuration
 
 Deprecated: Use the `patchProjectWithRevision` endpoint instead to specify the exact revision the patch was generated for.  This endpoints allows you to patch individual Ory Network project configuration keys for Ory's services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions).  This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version.  If you have an older version of a configuration, you should set the version key in the payload!  While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source.  For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
 
@@ -598,7 +598,7 @@ opts = {
 }
 
 begin
-  # # Patch an Ory Network Project Configuration
+  # Patch an Ory Network Project Configuration
   result = api_instance.patch_project(project_id, opts)
   p result
 rescue OryClient::ApiError => e
@@ -614,7 +614,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # # Patch an Ory Network Project Configuration
+  # Patch an Ory Network Project Configuration
   data, status_code, headers = api_instance.patch_project_with_http_info(project_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -649,7 +649,7 @@ end
 
 > purge_project(project_id)
 
-# Irrecoverably purge a project
+Irrecoverably purge a project
 
 !! Use with extreme caution !!  Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete ALL your data.  !! Use with extreme caution !!
 
@@ -668,7 +668,7 @@ api_instance = OryClient::ProjectApi.new
 project_id = 'project_id_example' # String | Project ID  The project's ID.
 
 begin
-  # # Irrecoverably purge a project
+  # Irrecoverably purge a project
   api_instance.purge_project(project_id)
 rescue OryClient::ApiError => e
   puts "Error when calling ProjectApi->purge_project: #{e}"
@@ -683,7 +683,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # # Irrecoverably purge a project
+  # Irrecoverably purge a project
   data, status_code, headers = api_instance.purge_project_with_http_info(project_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -717,7 +717,7 @@ nil (empty response body)
 
 > remove_project_member(project_id, member_id)
 
-# Remove a member associated with this project
+Remove a member associated with this project
 
 This also sets their invite status to `REMOVED`. This endpoint requires the user to be a member of the project with the role `OWNER`.
 
@@ -737,7 +737,7 @@ project_id = 'project_id_example' # String | Project ID  The project's ID.
 member_id = 'member_id_example' # String | Member ID
 
 begin
-  # # Remove a member associated with this project
+  # Remove a member associated with this project
   api_instance.remove_project_member(project_id, member_id)
 rescue OryClient::ApiError => e
   puts "Error when calling ProjectApi->remove_project_member: #{e}"
@@ -752,7 +752,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # # Remove a member associated with this project
+  # Remove a member associated with this project
   data, status_code, headers = api_instance.remove_project_member_with_http_info(project_id, member_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -787,7 +787,7 @@ nil (empty response body)
 
 > set_active_project_in_console(opts)
 
-# Sets the Ory Network Project active in the Ory Network Console
+Sets the Ory Network Project active in the Ory Network Console
 
 Use this API to set your active project in the Ory Network Console UI.
 
@@ -808,7 +808,7 @@ opts = {
 }
 
 begin
-  # # Sets the Ory Network Project active in the Ory Network Console
+  # Sets the Ory Network Project active in the Ory Network Console
   api_instance.set_active_project_in_console(opts)
 rescue OryClient::ApiError => e
   puts "Error when calling ProjectApi->set_active_project_in_console: #{e}"
@@ -823,7 +823,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # # Sets the Ory Network Project active in the Ory Network Console
+  # Sets the Ory Network Project active in the Ory Network Console
   data, status_code, headers = api_instance.set_active_project_in_console_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -857,7 +857,7 @@ nil (empty response body)
 
 > <SuccessfulProjectUpdate> set_project(project_id, opts)
 
-# Update an Ory Network Project Configuration
+Update an Ory Network Project Configuration
 
 This endpoints allows you to update the Ory Network project configuration for individual services (identity, permission, ...). The configuration is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions).  This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version.  If you have an older version of a configuration, you should set the version key in the payload!  While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source.  For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.  Be aware that updating any service's configuration will completely override your current configuration for that service!
 
@@ -879,7 +879,7 @@ opts = {
 }
 
 begin
-  # # Update an Ory Network Project Configuration
+  # Update an Ory Network Project Configuration
   result = api_instance.set_project(project_id, opts)
   p result
 rescue OryClient::ApiError => e
@@ -895,7 +895,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # # Update an Ory Network Project Configuration
+  # Update an Ory Network Project Configuration
   data, status_code, headers = api_instance.set_project_with_http_info(project_id, opts)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/ProjectApiKey.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
+| **id** | **String** | The token's ID. | [readonly] |
 | **name** | **String** | The Token's Name  Set this to help you remember, for example, where you use the token. |  |
-| **owner_id** | **String** |  |  |
-| **project_id** | **String** |  | [optional] |
+| **owner_id** | **String** | The token's owner | [readonly] |
+| **project_id** | **String** | The Token's Project ID | [optional][readonly] |
 | **value** | **String** | The token's value | [optional][readonly] |
 
 ## Example

data/docs/ProjectHost.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **host** | **String** | The project's host. |  |
-| **id** | **String** |  |  |
-| **project_id** | **String** |  |  |
+| **id** | **String** | The mapping's ID. | [readonly] |
+| **project_id** | **String** | The Revision's Project ID |  |
 
 ## Example
 

data/docs/ProjectInvite.md

@@ -5,13 +5,13 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **created_at** | **Time** | The Project's Revision Creation Date | [readonly] |
-| **id** | **String** |  |  |
+| **id** | **String** | The invite's ID. | [readonly] |
 | **invitee_email** | **String** | The invitee's email |  |
 | **invitee_id** | **String** |  | [optional] |
 | **owner_email** | **String** | The invite owner's email Usually the project's owner email |  |
-| **owner_id** | **String** |  |  |
-| **project_id** | **String** |  |  |
-| **status** | **String** | The invite's status Keeps track of the invites status such as pending, accepted, declined, expired |  |
+| **owner_id** | **String** | The invite owner's ID Usually the project's owner |  |
+| **project_id** | **String** | The Project's ID this invite is associated with |  |
+| **status** | **String** | The invite's status Keeps track of the invites status such as pending, accepted, declined, expired pending PENDING accepted ACCEPTED declined DECLINED expired EXPIRED cancelled CANCELLED removed REMOVED |  |
 | **updated_at** | **Time** | Last Time Project's Revision was Updated | [readonly] |
 
 ## Example

data/docs/ProjectMetadata.md

@@ -6,10 +6,10 @@
 | ---- | ---- | ----------- | ----- |
 | **created_at** | **Time** | The Project's Creation Date |  |
 | **hosts** | **Array<String>** |  |  |
-| **id** | **String** |  |  |
+| **id** | **String** | The project's ID. | [readonly] |
 | **name** | **String** | The project's name if set |  |
 | **slug** | **String** | The project's slug | [optional][readonly] |
-| **state** | **String** | The state of the project. |  |
+| **state** | **String** | The state of the project. running Running halted Halted |  |
 | **subscription_id** | **String** |  | [optional] |
 | **updated_at** | **Time** | Last Time Project was Updated |  |
 

data/docs/Subscription.md

@@ -5,9 +5,9 @@
 | 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 business_monthly BusinessMonthly business_yearly BusinessYearly custom Custom | [readonly] |
 | **customer_id** | **String** | The ID of the stripe customer | [readonly] |
-| **id** | **String** |  |  |
+| **id** | **String** | The ID of the subscription | [readonly] |
 | **ongoing_stripe_checkout_id** | **String** |  | [optional] |
 | **payed_until** | **Time** | Until when the subscription is payed | [readonly] |
 | **plan_changes_at** | **Time** |  | [optional] |

data/lib/ory-client/api/courier_api.rb

@@ -3,7 +3,7 @@
 
 #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. 
 
-The version of the OpenAPI document: v1.0.0
+The version of the OpenAPI document: v1.0.2
 Contact: support@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-client/api/frontend_api.rb

@@ -3,7 +3,7 @@
 
 #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. 
 
-The version of the OpenAPI document: v1.0.0
+The version of the OpenAPI document: v1.0.2
 Contact: support@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-client/api/identity_api.rb

@@ -3,7 +3,7 @@
 
 #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. 
 
-The version of the OpenAPI document: v1.0.0
+The version of the OpenAPI document: v1.0.2
 Contact: support@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-client/api/jwk_api.rb

@@ -3,7 +3,7 @@
 
 #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. 
 
-The version of the OpenAPI document: v1.0.0
+The version of the OpenAPI document: v1.0.2
 Contact: support@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-client/api/metadata_api.rb

@@ -3,7 +3,7 @@
 
 #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. 
 
-The version of the OpenAPI document: v1.0.0
+The version of the OpenAPI document: v1.0.2
 Contact: support@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-client/api/o_auth2_api.rb

@@ -3,7 +3,7 @@
 
 #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. 
 
-The version of the OpenAPI document: v1.0.0
+The version of the OpenAPI document: v1.0.2
 Contact: support@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-client/api/oidc_api.rb

@@ -3,7 +3,7 @@
 
 #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. 
 
-The version of the OpenAPI document: v1.0.0
+The version of the OpenAPI document: v1.0.2
 Contact: support@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-client/api/permission_api.rb

@@ -3,7 +3,7 @@
 
 #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. 
 
-The version of the OpenAPI document: v1.0.0
+The version of the OpenAPI document: v1.0.2
 Contact: support@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1