kinde_sdk 1.6.4 → 1.6.6

data/kinde_api/docs/RolesApi.md

@@ -1,25 +1,100 @@
 # KindeApi::RolesApi
 
-All URIs are relative to *https://app.kinde.com*
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_role**](RolesApi.md#create_role) | **POST** /api/v1/roles | Create Role |
-| [**delete_role**](RolesApi.md#delete_role) | **DELETE** /api/v1/roles/{role_id} | Delete Role |
-| [**get_role_permission**](RolesApi.md#get_role_permission) | **GET** /api/v1/roles/{role_id}/permissions | Get Role Permissions |
-| [**get_roles**](RolesApi.md#get_roles) | **GET** /api/v1/roles | List Roles |
-| [**remove_role_permission**](RolesApi.md#remove_role_permission) | **DELETE** /api/v1/roles/{role_id}/permissions/{permission_id} | Remove Role Permission |
-| [**update_role_permissions**](RolesApi.md#update_role_permissions) | **PATCH** /api/v1/roles/{role_id}/permissions | Update Role Permissions |
-| [**update_roles**](RolesApi.md#update_roles) | **PATCH** /api/v1/roles/{role_id} | Update Role |
+| [**add_role_scope**](RolesApi.md#add_role_scope) | **POST** /api/v1/roles/{role_id}/scopes | Add role scope |
+| [**create_role**](RolesApi.md#create_role) | **POST** /api/v1/roles | Create role |
+| [**delete_role**](RolesApi.md#delete_role) | **DELETE** /api/v1/roles/{role_id} | Delete role |
+| [**delete_role_scope**](RolesApi.md#delete_role_scope) | **DELETE** /api/v1/roles/{role_id}/scopes/{scope_id} | Delete role scope |
+| [**get_role**](RolesApi.md#get_role) | **GET** /api/v1/roles/{role_id} | Get role |
+| [**get_role_permissions**](RolesApi.md#get_role_permissions) | **GET** /api/v1/roles/{role_id}/permissions | Get role permissions |
+| [**get_role_scopes**](RolesApi.md#get_role_scopes) | **GET** /api/v1/roles/{role_id}/scopes | Get role scopes |
+| [**get_roles**](RolesApi.md#get_roles) | **GET** /api/v1/roles | List roles |
+| [**remove_role_permission**](RolesApi.md#remove_role_permission) | **DELETE** /api/v1/roles/{role_id}/permissions/{permission_id} | Remove role permission |
+| [**update_role_permissions**](RolesApi.md#update_role_permissions) | **PATCH** /api/v1/roles/{role_id}/permissions | Update role permissions |
+| [**update_roles**](RolesApi.md#update_roles) | **PATCH** /api/v1/roles/{role_id} | Update role |
+
+
+## add_role_scope
+
+> <AddRoleScopeResponse> add_role_scope(role_id, add_role_scope_request)
+
+Add role scope
+
+Add scope to role.  <div>   <code>create:role_scopes</code> </div> 
+
+### Examples
+
+```ruby
+require 'time'
+require 'kinde_api'
+# setup authorization
+KindeApi.configure do |config|
+  # Configure Bearer authorization (JWT): kindeBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = KindeApi::RolesApi.new
+role_id = 'role_id_example' # String | The role id.
+add_role_scope_request = KindeApi::AddRoleScopeRequest.new({scope_id: 'scope_id_example'}) # AddRoleScopeRequest | Add scope to role.
+
+begin
+  # Add role scope
+  result = api_instance.add_role_scope(role_id, add_role_scope_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling RolesApi->add_role_scope: #{e}"
+end
+```
+
+#### Using the add_role_scope_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddRoleScopeResponse>, Integer, Hash)> add_role_scope_with_http_info(role_id, add_role_scope_request)
+
+```ruby
+begin
+  # Add role scope
+  data, status_code, headers = api_instance.add_role_scope_with_http_info(role_id, add_role_scope_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddRoleScopeResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling RolesApi->add_role_scope_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role_id** | **String** | The role id. |  |
+| **add_role_scope_request** | [**AddRoleScopeRequest**](AddRoleScopeRequest.md) | Add scope to role. |  |
+
+### Return type
+
+[**AddRoleScopeResponse**](AddRoleScopeResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 
 ## create_role
 
-> <SuccessResponse> create_role(opts)
+> <CreateRolesResponse> create_role(opts)
 
-Create Role
+Create role
 
-Create role.
+Create role.  <div>   <code>create:roles</code> </div> 
 
 ### Examples
 
@@ -38,7 +113,7 @@ opts = {
 }
 
 begin
-  # Create Role
+  # Create role
   result = api_instance.create_role(opts)
   p result
 rescue KindeApi::ApiError => e
@@ -50,15 +125,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SuccessResponse>, Integer, Hash)> create_role_with_http_info(opts)
+> <Array(<CreateRolesResponse>, Integer, Hash)> create_role_with_http_info(opts)
 
 ```ruby
 begin
-  # Create Role
+  # Create role
   data, status_code, headers = api_instance.create_role_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SuccessResponse>
+  p data # => <CreateRolesResponse>
 rescue KindeApi::ApiError => e
   puts "Error when calling RolesApi->create_role_with_http_info: #{e}"
 end
@@ -72,7 +147,7 @@ end
 
 ### Return type
 
-[**SuccessResponse**](SuccessResponse.md)
+[**CreateRolesResponse**](CreateRolesResponse.md)
 
 ### Authorization
 
@@ -81,17 +156,17 @@ end
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: application/json, application/json; charset=utf-8
+- **Accept**: application/json
 
 
 ## delete_role
 
 > <SuccessResponse> delete_role(role_id)
 
-Delete Role
-
 Delete role
 
+Delete role  <div>   <code>delete:roles</code> </div> 
+
 ### Examples
 
 ```ruby
@@ -107,7 +182,7 @@ api_instance = KindeApi::RolesApi.new
 role_id = 'role_id_example' # String | The identifier for the role.
 
 begin
-  # Delete Role
+  # Delete role
   result = api_instance.delete_role(role_id)
   p result
 rescue KindeApi::ApiError => e
@@ -123,7 +198,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Delete Role
+  # Delete role
   data, status_code, headers = api_instance.delete_role_with_http_info(role_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -150,16 +225,156 @@ end
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json, application/json; charset=utf-8
+- **Accept**: application/json
+
+
+## delete_role_scope
+
+> <DeleteRoleScopeResponse> delete_role_scope(role_id, scope_id)
+
+Delete role scope
+
+Delete scope from role.  <div>   <code>delete:role_scopes</code> </div> 
+
+### Examples
+
+```ruby
+require 'time'
+require 'kinde_api'
+# setup authorization
+KindeApi.configure do |config|
+  # Configure Bearer authorization (JWT): kindeBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = KindeApi::RolesApi.new
+role_id = 'role_id_example' # String | The role id.
+scope_id = 'scope_id_example' # String | The scope id.
+
+begin
+  # Delete role scope
+  result = api_instance.delete_role_scope(role_id, scope_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling RolesApi->delete_role_scope: #{e}"
+end
+```
+
+#### Using the delete_role_scope_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteRoleScopeResponse>, Integer, Hash)> delete_role_scope_with_http_info(role_id, scope_id)
+
+```ruby
+begin
+  # Delete role scope
+  data, status_code, headers = api_instance.delete_role_scope_with_http_info(role_id, scope_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteRoleScopeResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling RolesApi->delete_role_scope_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role_id** | **String** | The role id. |  |
+| **scope_id** | **String** | The scope id. |  |
+
+### Return type
+
+[**DeleteRoleScopeResponse**](DeleteRoleScopeResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_role
+
+> <GetRoleResponse> get_role(role_id)
+
+Get role
+
+Get a role  <div>   <code>read:roles</code> </div> 
+
+### Examples
+
+```ruby
+require 'time'
+require 'kinde_api'
+# setup authorization
+KindeApi.configure do |config|
+  # Configure Bearer authorization (JWT): kindeBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = KindeApi::RolesApi.new
+role_id = 'role_id_example' # String | The identifier for the role.
+
+begin
+  # Get role
+  result = api_instance.get_role(role_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling RolesApi->get_role: #{e}"
+end
+```
+
+#### Using the get_role_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRoleResponse>, Integer, Hash)> get_role_with_http_info(role_id)
+
+```ruby
+begin
+  # Get role
+  data, status_code, headers = api_instance.get_role_with_http_info(role_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRoleResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling RolesApi->get_role_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role_id** | **String** | The identifier for the role. |  |
+
+### Return type
+
+[**GetRoleResponse**](GetRoleResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
-## get_role_permission
+## get_role_permissions
 
-> <Array<RolesPermissionResponseInner>> get_role_permission(role_id, opts)
+> <RolePermissionsResponse> get_role_permissions(role_id, opts)
 
-Get Role Permissions
+Get role permissions
 
-Get permissions for a role.
+Get permissions for a role.  <div>   <code>read:role_permissions</code> </div> 
 
 ### Examples
 
@@ -181,29 +396,29 @@ opts = {
 }
 
 begin
-  # Get Role Permissions
-  result = api_instance.get_role_permission(role_id, opts)
+  # Get role permissions
+  result = api_instance.get_role_permissions(role_id, opts)
   p result
 rescue KindeApi::ApiError => e
-  puts "Error when calling RolesApi->get_role_permission: #{e}"
+  puts "Error when calling RolesApi->get_role_permissions: #{e}"
 end
 ```
 
-#### Using the get_role_permission_with_http_info variant
+#### Using the get_role_permissions_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<RolesPermissionResponseInner>>, Integer, Hash)> get_role_permission_with_http_info(role_id, opts)
+> <Array(<RolePermissionsResponse>, Integer, Hash)> get_role_permissions_with_http_info(role_id, opts)
 
 ```ruby
 begin
-  # Get Role Permissions
-  data, status_code, headers = api_instance.get_role_permission_with_http_info(role_id, opts)
+  # Get role permissions
+  data, status_code, headers = api_instance.get_role_permissions_with_http_info(role_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<RolesPermissionResponseInner>>
+  p data # => <RolePermissionsResponse>
 rescue KindeApi::ApiError => e
-  puts "Error when calling RolesApi->get_role_permission_with_http_info: #{e}"
+  puts "Error when calling RolesApi->get_role_permissions_with_http_info: #{e}"
 end
 ```
 
@@ -218,7 +433,76 @@ end
 
 ### Return type
 
-[**Array&lt;RolesPermissionResponseInner&gt;**](RolesPermissionResponseInner.md)
+[**RolePermissionsResponse**](RolePermissionsResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/json; charset=utf-8
+
+
+## get_role_scopes
+
+> <RoleScopesResponse> get_role_scopes(role_id)
+
+Get role scopes
+
+Get scopes for a role.  <div>   <code>read:role_scopes</code> </div> 
+
+### Examples
+
+```ruby
+require 'time'
+require 'kinde_api'
+# setup authorization
+KindeApi.configure do |config|
+  # Configure Bearer authorization (JWT): kindeBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = KindeApi::RolesApi.new
+role_id = 'role_id_example' # String | The role id.
+
+begin
+  # Get role scopes
+  result = api_instance.get_role_scopes(role_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling RolesApi->get_role_scopes: #{e}"
+end
+```
+
+#### Using the get_role_scopes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RoleScopesResponse>, Integer, Hash)> get_role_scopes_with_http_info(role_id)
+
+```ruby
+begin
+  # Get role scopes
+  data, status_code, headers = api_instance.get_role_scopes_with_http_info(role_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RoleScopesResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling RolesApi->get_role_scopes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role_id** | **String** | The role id. |  |
+
+### Return type
+
+[**RoleScopesResponse**](RoleScopesResponse.md)
 
 ### Authorization
 
@@ -234,9 +518,9 @@ end
 
 > <GetRolesResponse> get_roles(opts)
 
-List Roles
+List roles
 
-The returned list can be sorted by role name or role ID in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query string parameter. 
+The returned list can be sorted by role name or role ID in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query string parameter.  <div>   <code>read:roles</code> </div> 
 
 ### Examples
 
@@ -257,7 +541,7 @@ opts = {
 }
 
 begin
-  # List Roles
+  # List roles
   result = api_instance.get_roles(opts)
   p result
 rescue KindeApi::ApiError => e
@@ -273,7 +557,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # List Roles
+  # List roles
   data, status_code, headers = api_instance.get_roles_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -302,16 +586,16 @@ end
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json, application/json; charset=utf-8
+- **Accept**: application/json
 
 
 ## remove_role_permission
 
 > <SuccessResponse> remove_role_permission(role_id, permission_id)
 
-Remove Role Permission
+Remove role permission
 
-Remove a permission from a role.
+Remove a permission from a role.  <div>   <code>delete:role_permissions</code> </div> 
 
 ### Examples
 
@@ -329,7 +613,7 @@ role_id = 'role_id_example' # String | The role's public id.
 permission_id = 'permission_id_example' # String | The permission's public id.
 
 begin
-  # Remove Role Permission
+  # Remove role permission
   result = api_instance.remove_role_permission(role_id, permission_id)
   p result
 rescue KindeApi::ApiError => e
@@ -345,7 +629,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Remove Role Permission
+  # Remove role permission
   data, status_code, headers = api_instance.remove_role_permission_with_http_info(role_id, permission_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -380,9 +664,9 @@ end
 
 > <UpdateRolePermissionsResponse> update_role_permissions(role_id, update_role_permissions_request)
 
-Update Role Permissions
+Update role permissions
 
-Update role permissions. 
+Update role permissions.  <div>   <code>update:role_permissions</code> </div> 
 
 ### Examples
 
@@ -400,7 +684,7 @@ role_id = 'role_id_example' # String | The identifier for the role.
 update_role_permissions_request = KindeApi::UpdateRolePermissionsRequest.new # UpdateRolePermissionsRequest | 
 
 begin
-  # Update Role Permissions
+  # Update role permissions
   result = api_instance.update_role_permissions(role_id, update_role_permissions_request)
   p result
 rescue KindeApi::ApiError => e
@@ -416,7 +700,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Update Role Permissions
+  # Update role permissions
   data, status_code, headers = api_instance.update_role_permissions_with_http_info(role_id, update_role_permissions_request)
   p status_code # => 2xx
   p headers # => { ... }
@@ -451,9 +735,9 @@ end
 
 > <SuccessResponse> update_roles(role_id, opts)
 
-Update Role
+Update role
 
-Update a role
+Update a role  <div>   <code>update:roles</code> </div> 
 
 ### Examples
 
@@ -473,7 +757,7 @@ opts = {
 }
 
 begin
-  # Update Role
+  # Update role
   result = api_instance.update_roles(role_id, opts)
   p result
 rescue KindeApi::ApiError => e
@@ -489,7 +773,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Update Role
+  # Update role
   data, status_code, headers = api_instance.update_roles_with_http_info(role_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -517,5 +801,5 @@ end
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: application/json; charset=utf-8
+- **Accept**: application/json
 

data/kinde_api/docs/Scopes.md

@@ -0,0 +1,24 @@
+# KindeApi::Scopes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Scope ID. | [optional] |
+| **key** | **String** | Scope key. | [optional] |
+| **description** | **String** | Description of scope. | [optional] |
+| **api_id** | **String** | API ID. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::Scopes.new(
+  id: api_scope_019541f3fa0c874fc47b3ae73585b21c,
+  key: create:users,
+  description: Create users,
+  api_id: 3635b4431f174de6b789c67481bd0c7a
+)
+```
+