kinde_sdk 1.6.4 → 1.6.5

data/kinde_api/docs/Permissions.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The permission's id. | [optional] |
+| **id** | **String** | The permission's ID. | [optional] |
 | **key** | **String** | The permission identifier to use in code. | [optional] |
 | **name** | **String** | The permission's name. | [optional] |
 | **description** | **String** | The permission's description. | [optional] |

data/kinde_api/docs/PermissionsApi.md

@@ -1,6 +1,6 @@
 # KindeApi::PermissionsApi
 
-All URIs are relative to *https://app.kinde.com*
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
@@ -16,7 +16,7 @@ All URIs are relative to *https://app.kinde.com*
 
 Create Permission
 
-Create a new permission.
+Create a new permission.  <div>   <code>create:permissions</code> </div> 
 
 ### Examples
 
@@ -87,7 +87,7 @@ end
 
 Delete Permission
 
-Delete permission
+Delete permission  <div>   <code>delete:permissions</code> </div> 
 
 ### Examples
 
@@ -156,7 +156,7 @@ end
 
 List Permissions
 
-The returned list can be sorted by permission name or permission 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 permission name or permission 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:permissions</code> </div> 
 
 ### Examples
 
@@ -231,7 +231,7 @@ end
 
 Update Permission
 
-Update permission
+Update permission  <div>   <code>update:permissions</code> </div> 
 
 ### Examples
 
@@ -245,7 +245,7 @@ KindeApi.configure do |config|
 end
 
 api_instance = KindeApi::PermissionsApi.new
-permission_id = 56 # Integer | The identifier for the permission.
+permission_id = 'permission_id_example' # String | The identifier for the permission.
 opts = {
   create_permission_request: KindeApi::CreatePermissionRequest.new # CreatePermissionRequest | Permission details.
 }
@@ -281,7 +281,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **permission_id** | **Integer** | The identifier for the permission. |  |
+| **permission_id** | **String** | The identifier for the permission. |  |
 | **create_permission_request** | [**CreatePermissionRequest**](CreatePermissionRequest.md) | Permission details. | [optional] |
 
 ### Return type

data/kinde_api/docs/PropertiesApi.md

@@ -0,0 +1,297 @@
+# KindeApi::PropertiesApi
+
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_property**](PropertiesApi.md#create_property) | **POST** /api/v1/properties | Create Property |
+| [**delete_property**](PropertiesApi.md#delete_property) | **DELETE** /api/v1/properties/{property_id} | Delete Property |
+| [**get_properties**](PropertiesApi.md#get_properties) | **GET** /api/v1/properties | List properties |
+| [**update_property**](PropertiesApi.md#update_property) | **PUT** /api/v1/properties/{property_id} | Update Property |
+
+
+## create_property
+
+> <CreatePropertyResponse> create_property(create_property_request)
+
+Create Property
+
+Create property.  <div>   <code>create:properties</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::PropertiesApi.new
+create_property_request = KindeApi::CreatePropertyRequest.new({name: 'name_example', key: 'key_example', type: 'single_line_text', context: 'org', is_private: false, category_id: 'category_id_example'}) # CreatePropertyRequest | Property details.
+
+begin
+  # Create Property
+  result = api_instance.create_property(create_property_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertiesApi->create_property: #{e}"
+end
+```
+
+#### Using the create_property_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreatePropertyResponse>, Integer, Hash)> create_property_with_http_info(create_property_request)
+
+```ruby
+begin
+  # Create Property
+  data, status_code, headers = api_instance.create_property_with_http_info(create_property_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreatePropertyResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertiesApi->create_property_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_property_request** | [**CreatePropertyRequest**](CreatePropertyRequest.md) | Property details. |  |
+
+### Return type
+
+[**CreatePropertyResponse**](CreatePropertyResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/json; charset=utf-8
+
+
+## delete_property
+
+> <SuccessResponse> delete_property(property_id)
+
+Delete Property
+
+Delete property.  <div>   <code>delete:properties</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::PropertiesApi.new
+property_id = 'property_id_example' # String | The unique identifier for the property.
+
+begin
+  # Delete Property
+  result = api_instance.delete_property(property_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertiesApi->delete_property: #{e}"
+end
+```
+
+#### Using the delete_property_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> delete_property_with_http_info(property_id)
+
+```ruby
+begin
+  # Delete Property
+  data, status_code, headers = api_instance.delete_property_with_http_info(property_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertiesApi->delete_property_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **property_id** | **String** | The unique identifier for the property. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/json; charset=utf-8
+
+
+## get_properties
+
+> <GetPropertiesResponse> get_properties(opts)
+
+List properties
+
+Returns a list of properties  <div>   <code>read:properties</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::PropertiesApi.new
+opts = {
+  page_size: 56, # Integer | Number of results per page. Defaults to 10 if parameter not sent.
+  starting_after: 'starting_after_example', # String | The ID of the property to start after.
+  ending_before: 'ending_before_example', # String | The ID of the property to end before.
+  context: 'usr' # String | Filter results by user,  organization or application context
+}
+
+begin
+  # List properties
+  result = api_instance.get_properties(opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertiesApi->get_properties: #{e}"
+end
+```
+
+#### Using the get_properties_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPropertiesResponse>, Integer, Hash)> get_properties_with_http_info(opts)
+
+```ruby
+begin
+  # List properties
+  data, status_code, headers = api_instance.get_properties_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPropertiesResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertiesApi->get_properties_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page_size** | **Integer** | Number of results per page. Defaults to 10 if parameter not sent. | [optional] |
+| **starting_after** | **String** | The ID of the property to start after. | [optional] |
+| **ending_before** | **String** | The ID of the property to end before. | [optional] |
+| **context** | **String** | Filter results by user,  organization or application context | [optional] |
+
+### Return type
+
+[**GetPropertiesResponse**](GetPropertiesResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8, application/json
+
+
+## update_property
+
+> <SuccessResponse> update_property(property_id, update_property_request)
+
+Update Property
+
+Update property.  <div>   <code>update:properties</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::PropertiesApi.new
+property_id = 'property_id_example' # String | The unique identifier for the property.
+update_property_request = KindeApi::UpdatePropertyRequest.new({name: 'name_example', is_private: false, category_id: 'category_id_example'}) # UpdatePropertyRequest | The fields of the property to update.
+
+begin
+  # Update Property
+  result = api_instance.update_property(property_id, update_property_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertiesApi->update_property: #{e}"
+end
+```
+
+#### Using the update_property_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> update_property_with_http_info(property_id, update_property_request)
+
+```ruby
+begin
+  # Update Property
+  data, status_code, headers = api_instance.update_property_with_http_info(property_id, update_property_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertiesApi->update_property_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **property_id** | **String** | The unique identifier for the property. |  |
+| **update_property_request** | [**UpdatePropertyRequest**](UpdatePropertyRequest.md) | The fields of the property to update. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/json; charset=utf-8
+

data/kinde_api/docs/Property.md

@@ -0,0 +1,28 @@
+# KindeApi::Property
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **key** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **is_private** | **Boolean** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **is_kinde_property** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::Property.new(
+  id: null,
+  key: null,
+  name: null,
+  is_private: null,
+  description: null,
+  is_kinde_property: null
+)
+```
+

data/kinde_api/docs/PropertyCategoriesApi.md

@@ -0,0 +1,227 @@
+# KindeApi::PropertyCategoriesApi
+
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_category**](PropertyCategoriesApi.md#create_category) | **POST** /api/v1/property_categories | Create Category |
+| [**get_categories**](PropertyCategoriesApi.md#get_categories) | **GET** /api/v1/property_categories | List categories |
+| [**update_category**](PropertyCategoriesApi.md#update_category) | **PUT** /api/v1/property_categories/{category_id} | Update Category |
+
+
+## create_category
+
+> <CreateCategoryResponse> create_category(create_category_request)
+
+Create Category
+
+Create category.  <div>   <code>create:property_categories</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::PropertyCategoriesApi.new
+create_category_request = KindeApi::CreateCategoryRequest.new({name: 'name_example', context: 'org'}) # CreateCategoryRequest | Category details.
+
+begin
+  # Create Category
+  result = api_instance.create_category(create_category_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertyCategoriesApi->create_category: #{e}"
+end
+```
+
+#### Using the create_category_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCategoryResponse>, Integer, Hash)> create_category_with_http_info(create_category_request)
+
+```ruby
+begin
+  # Create Category
+  data, status_code, headers = api_instance.create_category_with_http_info(create_category_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCategoryResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertyCategoriesApi->create_category_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_category_request** | [**CreateCategoryRequest**](CreateCategoryRequest.md) | Category details. |  |
+
+### Return type
+
+[**CreateCategoryResponse**](CreateCategoryResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/json; charset=utf-8
+
+
+## get_categories
+
+> <GetCategoriesResponse> get_categories(opts)
+
+List categories
+
+Returns a list of categories.  <div>   <code>read:property_categories</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::PropertyCategoriesApi.new
+opts = {
+  page_size: 56, # Integer | Number of results per page. Defaults to 10 if parameter not sent.
+  starting_after: 'starting_after_example', # String | The ID of the category to start after.
+  ending_before: 'ending_before_example', # String | The ID of the category to end before.
+  context: 'usr' # String | Filter the results by User or Organization context
+}
+
+begin
+  # List categories
+  result = api_instance.get_categories(opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertyCategoriesApi->get_categories: #{e}"
+end
+```
+
+#### Using the get_categories_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCategoriesResponse>, Integer, Hash)> get_categories_with_http_info(opts)
+
+```ruby
+begin
+  # List categories
+  data, status_code, headers = api_instance.get_categories_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCategoriesResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertyCategoriesApi->get_categories_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page_size** | **Integer** | Number of results per page. Defaults to 10 if parameter not sent. | [optional] |
+| **starting_after** | **String** | The ID of the category to start after. | [optional] |
+| **ending_before** | **String** | The ID of the category to end before. | [optional] |
+| **context** | **String** | Filter the results by User or Organization context | [optional] |
+
+### Return type
+
+[**GetCategoriesResponse**](GetCategoriesResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8, application/json
+
+
+## update_category
+
+> <SuccessResponse> update_category(category_id, update_category_request)
+
+Update Category
+
+Update category.  <div>   <code>update:property_categories</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::PropertyCategoriesApi.new
+category_id = 'category_id_example' # String | The unique identifier for the category.
+update_category_request = KindeApi::UpdateCategoryRequest.new # UpdateCategoryRequest | The fields of the category to update.
+
+begin
+  # Update Category
+  result = api_instance.update_category(category_id, update_category_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertyCategoriesApi->update_category: #{e}"
+end
+```
+
+#### Using the update_category_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> update_category_with_http_info(category_id, update_category_request)
+
+```ruby
+begin
+  # Update Category
+  data, status_code, headers = api_instance.update_category_with_http_info(category_id, update_category_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling PropertyCategoriesApi->update_category_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_id** | **String** | The unique identifier for the category. |  |
+| **update_category_request** | [**UpdateCategoryRequest**](UpdateCategoryRequest.md) | The fields of the category to update. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/json; charset=utf-8
+

data/kinde_api/docs/PropertyValue.md

@@ -0,0 +1,26 @@
+# KindeApi::PropertyValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **key** | **String** |  | [optional] |
+| **value** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::PropertyValue.new(
+  id: prop_0192b7e8b4f8ca08110d2b22059662a8,
+  name: Town,
+  description: Where the entity is located,
+  key: kp_town,
+  value: West-side Staines massive
+)
+```
+

data/kinde_api/docs/ReadEnvLogoResponse.md

@@ -0,0 +1,22 @@
+# KindeApi::ReadEnvLogoResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Response code. | [optional] |
+| **logos** | [**Array<ReadEnvLogoResponseLogosInner>**](ReadEnvLogoResponseLogosInner.md) | A list of logos. | [optional] |
+| **message** | **String** | Response message. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::ReadEnvLogoResponse.new(
+  code: OK,
+  logos: null,
+  message: Success
+)
+```
+

data/kinde_api/docs/ReadEnvLogoResponseLogosInner.md

@@ -0,0 +1,20 @@
+# KindeApi::ReadEnvLogoResponseLogosInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of logo (light or dark). | [optional] |
+| **file_name** | **String** | The name of the logo file. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::ReadEnvLogoResponseLogosInner.new(
+  type: light,
+  file_name: kinde_light.jpeg
+)
+```
+