kinde_sdk 1.6.4 → 1.6.5

data/kinde_api/docs/GetOrganizationResponseBillingAgreementsInner.md

@@ -0,0 +1,20 @@
+# KindeApi::GetOrganizationResponseBillingAgreementsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan_code** | **String** | The code of the plan from which this agreement is taken from | [optional] |
+| **agreement_id** | **String** | The id of the billing agreement in Kinde | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetOrganizationResponseBillingAgreementsInner.new(
+  plan_code: pro,
+  agreement_id: agreement_a1234b
+)
+```
+

data/kinde_api/docs/GetOrganizationUsersResponse.md

@@ -15,8 +15,8 @@
 require 'kinde_api'
 
 instance = KindeApi::GetOrganizationUsersResponse.new(
-  code: null,
-  message: null,
+  code: OK,
+  message: Success,
   organization_users: null,
   next_token: null
 )

data/kinde_api/docs/GetOrganizationsResponse.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **code** | **String** | Response code. | [optional] |
 | **message** | **String** | Response message. | [optional] |
-| **organizations** | [**Array<Organization>**](Organization.md) |  | [optional] |
+| **organizations** | [**Array<OrganizationItemSchema>**](OrganizationItemSchema.md) |  | [optional] |
 | **next_token** | **String** | Pagination token. | [optional] |
 
 ## Example
@@ -15,10 +15,10 @@
 require 'kinde_api'
 
 instance = KindeApi::GetOrganizationsResponse.new(
-  code: null,
-  message: null,
+  code: OK,
+  message: Success,
   organizations: null,
-  next_token: null
+  next_token: Mjo5Om1hbWVfYZNj
 )
 ```
 

data/kinde_api/docs/GetPropertiesResponse.md

@@ -0,0 +1,24 @@
+# KindeApi::GetPropertiesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Response code. | [optional] |
+| **message** | **String** | Response message. | [optional] |
+| **properties** | [**Array<Property>**](Property.md) |  | [optional] |
+| **has_more** | **Boolean** | Whether more records exist. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetPropertiesResponse.new(
+  code: null,
+  message: null,
+  properties: null,
+  has_more: null
+)
+```
+

data/kinde_api/docs/GetPropertyValuesResponse.md

@@ -0,0 +1,24 @@
+# KindeApi::GetPropertyValuesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Response code. | [optional] |
+| **message** | **String** | Response message. | [optional] |
+| **properties** | [**Array<PropertyValue>**](PropertyValue.md) |  | [optional] |
+| **next_token** | **String** | Pagination token. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetPropertyValuesResponse.new(
+  code: null,
+  message: null,
+  properties: null,
+  next_token: null
+)
+```
+

data/kinde_api/docs/GetRoleResponse.md

@@ -0,0 +1,22 @@
+# KindeApi::GetRoleResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Response code. | [optional] |
+| **message** | **String** | Response message. | [optional] |
+| **role** | [**GetRoleResponseRole**](GetRoleResponseRole.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetRoleResponse.new(
+  code: null,
+  message: null,
+  role: null
+)
+```
+

data/kinde_api/docs/GetRoleResponseRole.md

@@ -0,0 +1,26 @@
+# KindeApi::GetRoleResponseRole
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The role's ID. | [optional] |
+| **key** | **String** | The role identifier to use in code. | [optional] |
+| **name** | **String** | The role's name. | [optional] |
+| **description** | **String** | The role's description. | [optional] |
+| **is_default_role** | **Boolean** | Whether the role is the default role. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetRoleResponseRole.new(
+  id: 01929904-316d-bb2c-069f-99dfea4ac394,
+  key: admin,
+  name: Administrator,
+  description: Full access to all resources.,
+  is_default_role: false
+)
+```
+

data/kinde_api/docs/GetTimezonesResponse.md

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

data/kinde_api/docs/GetTimezonesResponseTimezonesInner.md

@@ -0,0 +1,20 @@
+# KindeApi::GetTimezonesResponseTimezonesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The unique key for the timezone. | [optional] |
+| **name** | **String** | The display name for the timezone. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetTimezonesResponseTimezonesInner.new(
+  key: london_greenwich_mean_time,
+  name: London (Greenwich Mean Time) [+01:00]
+)
+```
+

data/kinde_api/docs/GetUserMfaResponse.md

@@ -0,0 +1,22 @@
+# KindeApi::GetUserMfaResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **code** | **String** |  | [optional] |
+| **mfa** | [**GetUserMfaResponseMfa**](GetUserMfaResponseMfa.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetUserMfaResponse.new(
+  message: null,
+  code: null,
+  mfa: null
+)
+```
+

data/kinde_api/docs/GetUserMfaResponseMfa.md

@@ -0,0 +1,30 @@
+# KindeApi::GetUserMfaResponseMfa
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The MFA's identifier. | [optional] |
+| **type** | **String** | The type of MFA (e.g. email, SMS, authenticator app). | [optional] |
+| **created_on** | **Time** | The timestamp when the MFA was created. | [optional] |
+| **name** | **String** | The identifier used for MFA (e.g. email address, phone number). | [optional] |
+| **is_verified** | **Boolean** | Whether the MFA is verified or not. | [optional] |
+| **usage_count** | **Integer** | The number of times MFA has been used. | [optional] |
+| **last_used_on** | **Time** | The timestamp when the MFA was last used. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetUserMfaResponseMfa.new(
+  id: mfa_01933d1ca1f093e7fad48ebcdb65a871,
+  type: email,
+  created_on: 2024-11-18T13:31:46.795085+11:00,
+  name: sally@gmail.com,
+  is_verified: true,
+  usage_count: 2,
+  last_used_on: 2024-11-18T13:32:07.225380+11:00
+)
+```
+

data/kinde_api/docs/GetUserSessionsResponse.md

@@ -0,0 +1,24 @@
+# KindeApi::GetUserSessionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **has_more** | **Boolean** |  | [optional] |
+| **sessions** | [**Array<GetUserSessionsResponseSessionsInner>**](GetUserSessionsResponseSessionsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetUserSessionsResponse.new(
+  code: OK,
+  message: Success,
+  has_more: false,
+  sessions: null
+)
+```
+

data/kinde_api/docs/GetUserSessionsResponseSessionsInner.md

@@ -0,0 +1,40 @@
+# KindeApi::GetUserSessionsResponseSessionsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The unique identifier of the user associated with the session. | [optional] |
+| **org_code** | **String** | The organization code associated with the session, if applicable. | [optional] |
+| **client_id** | **String** | The client ID used to initiate the session. | [optional] |
+| **expires_on** | **Time** | The timestamp indicating when the session will expire. | [optional] |
+| **session_id** | **String** | The unique identifier of the session. | [optional] |
+| **started_on** | **Time** | The timestamp when the session was initiated. | [optional] |
+| **updated_on** | **Time** | The timestamp of the last update to the session. | [optional] |
+| **connection_id** | **String** | The identifier of the connection through which the session was established. | [optional] |
+| **last_ip_address** | **String** | The last known IP address of the user during this session. | [optional] |
+| **last_user_agent** | **String** | The last known user agent (browser or app) used during this session. | [optional] |
+| **initial_ip_address** | **String** | The IP address from which the session was initially started. | [optional] |
+| **initial_user_agent** | **String** | The user agent (browser or app) used when the session was first created. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetUserSessionsResponseSessionsInner.new(
+  user_id: kp_5fc30d0547734f30aca617450202169f,
+  org_code: org_1ccfb819462,
+  client_id: 3b0b5c6c8fcc464fab397f4969b5f482,
+  expires_on: 2025-04-02T13:04:20.315701+11:00,
+  session_id: session_0xc75ec12fe8434ffc9d527794f00692e5,
+  started_on: 2025-04-01T13:04:20.315701+11:00,
+  updated_on: 2025-04-01T13:04:20+11:00,
+  connection_id: conn_75ab8ec0faae4f73bae9fc64daf120c9,
+  last_ip_address: 192.168.65.1,
+  last_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36,
+  initial_ip_address: 192.168.65.1,
+  initial_user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36
+)
+```
+

data/kinde_api/docs/GetWebhooksResponse.md

@@ -0,0 +1,22 @@
+# KindeApi::GetWebhooksResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Response code. | [optional] |
+| **message** | **String** | Response message. | [optional] |
+| **webhooks** | [**Array<Webhook>**](Webhook.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetWebhooksResponse.new(
+  code: null,
+  message: null,
+  webhooks: null
+)
+```
+

data/kinde_api/docs/IdentitiesApi.md

@@ -0,0 +1,219 @@
+# KindeApi::IdentitiesApi
+
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_identity**](IdentitiesApi.md#delete_identity) | **DELETE** /api/v1/identities/{identity_id} | Delete identity |
+| [**get_identity**](IdentitiesApi.md#get_identity) | **GET** /api/v1/identities/{identity_id} | Get identity |
+| [**update_identity**](IdentitiesApi.md#update_identity) | **PATCH** /api/v1/identities/{identity_id} | Update identity |
+
+
+## delete_identity
+
+> <SuccessResponse> delete_identity(identity_id)
+
+Delete identity
+
+Delete identity by ID.  <div>   <code>delete:identities</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::IdentitiesApi.new
+identity_id = 'identity_id_example' # String | The unique identifier for the identity.
+
+begin
+  # Delete identity
+  result = api_instance.delete_identity(identity_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling IdentitiesApi->delete_identity: #{e}"
+end
+```
+
+#### Using the delete_identity_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> delete_identity_with_http_info(identity_id)
+
+```ruby
+begin
+  # Delete identity
+  data, status_code, headers = api_instance.delete_identity_with_http_info(identity_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling IdentitiesApi->delete_identity_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identity_id** | **String** | The unique identifier for the identity. |  |
+
+### 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_identity
+
+> <Identity> get_identity(identity_id)
+
+Get identity
+
+Returns an identity by ID  <div>   <code>read:identities</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::IdentitiesApi.new
+identity_id = 'identity_id_example' # String | The unique identifier for the identity.
+
+begin
+  # Get identity
+  result = api_instance.get_identity(identity_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling IdentitiesApi->get_identity: #{e}"
+end
+```
+
+#### Using the get_identity_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Identity>, Integer, Hash)> get_identity_with_http_info(identity_id)
+
+```ruby
+begin
+  # Get identity
+  data, status_code, headers = api_instance.get_identity_with_http_info(identity_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Identity>
+rescue KindeApi::ApiError => e
+  puts "Error when calling IdentitiesApi->get_identity_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identity_id** | **String** | The unique identifier for the identity. |  |
+
+### Return type
+
+[**Identity**](Identity.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8, application/json
+
+
+## update_identity
+
+> <SuccessResponse> update_identity(identity_id, update_identity_request)
+
+Update identity
+
+Update identity by ID.  <div>   <code>update:identities</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::IdentitiesApi.new
+identity_id = 'identity_id_example' # String | The unique identifier for the identity.
+update_identity_request = KindeApi::UpdateIdentityRequest.new # UpdateIdentityRequest | The fields of the identity to update.
+
+begin
+  # Update identity
+  result = api_instance.update_identity(identity_id, update_identity_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling IdentitiesApi->update_identity: #{e}"
+end
+```
+
+#### Using the update_identity_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> update_identity_with_http_info(identity_id, update_identity_request)
+
+```ruby
+begin
+  # Update identity
+  data, status_code, headers = api_instance.update_identity_with_http_info(identity_id, update_identity_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling IdentitiesApi->update_identity_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identity_id** | **String** | The unique identifier for the identity. |  |
+| **update_identity_request** | [**UpdateIdentityRequest**](UpdateIdentityRequest.md) | The fields of the identity 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/Identity.md

@@ -0,0 +1,34 @@
+# KindeApi::Identity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID for the identity | [optional] |
+| **type** | **String** | The type of identity | [optional] |
+| **is_confirmed** | **Boolean** | Whether the identity is confirmed | [optional] |
+| **created_on** | **String** | Date of user creation in ISO 8601 format | [optional] |
+| **last_login_on** | **String** | Date of last login in ISO 8601 format | [optional] |
+| **total_logins** | **Integer** |  | [optional] |
+| **name** | **String** | The value of the identity | [optional] |
+| **email** | **String** | The associated email of the identity | [optional] |
+| **is_primary** | **Boolean** | Whether the identity is the primary identity for the user | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::Identity.new(
+  id: identity_019617f0cd72460a42192cf37b41084f,
+  type: email,
+  is_confirmed: true,
+  created_on: 2025-01-01T00:00:00Z,
+  last_login_on: 2025-01-05T00:00:00Z,
+  total_logins: 20,
+  name: sally@example.com,
+  email: sally@example.com,
+  is_primary: true
+)
+```
+

data/kinde_api/docs/IndustriesApi.md

@@ -1,19 +1,19 @@
 # KindeApi::IndustriesApi
 
-All URIs are relative to *https://app.kinde.com*
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**get_industries**](IndustriesApi.md#get_industries) | **GET** /api/v1/industries | List industries and industry keys. |
+| [**get_industries**](IndustriesApi.md#get_industries) | **GET** /api/v1/industries | Get industries |
 
 
 ## get_industries
 
-> <SuccessResponse> get_industries(opts)
+> <GetIndustriesResponse> get_industries
 
-List industries and industry keys.
+Get industries
 
-Get a list of industries and associated industry keys.
+Get a list of industries and associated industry keys.  <div>   <code>read:industries</code> </div> 
 
 ### Examples
 
@@ -27,14 +27,10 @@ KindeApi.configure do |config|
 end
 
 api_instance = KindeApi::IndustriesApi.new
-opts = {
-  industry_key: 'industry_key_example', # String | Industry Key.
-  name: 'name_example' # String | Industry name.
-}
 
 begin
-  # List industries and industry keys.
-  result = api_instance.get_industries(opts)
+  # Get industries
+  result = api_instance.get_industries
   p result
 rescue KindeApi::ApiError => e
   puts "Error when calling IndustriesApi->get_industries: #{e}"
@@ -45,15 +41,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SuccessResponse>, Integer, Hash)> get_industries_with_http_info(opts)
+> <Array(<GetIndustriesResponse>, Integer, Hash)> get_industries_with_http_info
 
 ```ruby
 begin
-  # List industries and industry keys.
-  data, status_code, headers = api_instance.get_industries_with_http_info(opts)
+  # Get industries
+  data, status_code, headers = api_instance.get_industries_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SuccessResponse>
+  p data # => <GetIndustriesResponse>
 rescue KindeApi::ApiError => e
   puts "Error when calling IndustriesApi->get_industries_with_http_info: #{e}"
 end
@@ -61,14 +57,11 @@ end
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **industry_key** | **String** | Industry Key. | [optional] |
-| **name** | **String** | Industry name. | [optional] |
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**SuccessResponse**](SuccessResponse.md)
+[**GetIndustriesResponse**](GetIndustriesResponse.md)
 
 ### Authorization
 
@@ -77,5 +70,5 @@ end
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json; charset=utf-8
+- **Accept**: application/json