kinde_sdk 1.6.3 → 1.6.5

data/kinde_api/docs/SearchApi.md

@@ -0,0 +1,89 @@
+# KindeApi::SearchApi
+
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**search_users**](SearchApi.md#search_users) | **GET** /api/v1/search/users | Search users |
+
+
+## search_users
+
+> <SearchUsersResponse> search_users(opts)
+
+Search users
+
+Search for users based on the provided query string. Set query to '*' to filter by other parameters only. The number of records to return at a time can be controlled using the `page_size` query string parameter.  <div>   <code>read:users</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::SearchApi.new
+opts = {
+  page_size: 56, # Integer | Number of results per page. Defaults to 10 if parameter not sent.
+  query: 'query_example', # String | Search the users by email or name. Use '*' to search all.
+  properties: { key: { key: ['inner_example']}}, # Hash<String, Array<String>> | 
+  starting_after: 'starting_after_example', # String | The ID of the user to start after.
+  ending_before: 'ending_before_example', # String | The ID of the user to end before.
+  expand: 'expand_example' # String | Specify additional data to retrieve. Use \"organizations\" and/or \"identities\".
+}
+
+begin
+  # Search users
+  result = api_instance.search_users(opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling SearchApi->search_users: #{e}"
+end
+```
+
+#### Using the search_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SearchUsersResponse>, Integer, Hash)> search_users_with_http_info(opts)
+
+```ruby
+begin
+  # Search users
+  data, status_code, headers = api_instance.search_users_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SearchUsersResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling SearchApi->search_users_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] |
+| **query** | **String** | Search the users by email or name. Use &#39;*&#39; to search all. | [optional] |
+| **properties** | [**Hash&lt;String, Array&lt;String&gt;&gt;**](Array&lt;String&gt;.md) |  | [optional] |
+| **starting_after** | **String** | The ID of the user to start after. | [optional] |
+| **ending_before** | **String** | The ID of the user to end before. | [optional] |
+| **expand** | **String** | Specify additional data to retrieve. Use \&quot;organizations\&quot; and/or \&quot;identities\&quot;. | [optional] |
+
+### Return type
+
+[**SearchUsersResponse**](SearchUsersResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/kinde_api/docs/SearchUsersResponse.md

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

data/kinde_api/docs/SearchUsersResponseResultsInner.md

@@ -0,0 +1,46 @@
+# KindeApi::SearchUsersResponseResultsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID of the user in Kinde. | [optional] |
+| **provided_id** | **String** | External ID for user. | [optional] |
+| **email** | **String** | Default email address of the user in Kinde. | [optional] |
+| **username** | **String** | Primary username of the user in Kinde. | [optional] |
+| **last_name** | **String** | User's last name. | [optional] |
+| **first_name** | **String** | User's first name. | [optional] |
+| **is_suspended** | **Boolean** | Whether the user is currently suspended or not. | [optional] |
+| **picture** | **String** | User's profile picture URL. | [optional] |
+| **total_sign_ins** | **Integer** | Total number of user sign ins. | [optional] |
+| **failed_sign_ins** | **Integer** | Number of consecutive failed user sign ins. | [optional] |
+| **last_signed_in** | **String** | Last sign in date in ISO 8601 format. | [optional] |
+| **created_on** | **String** | Date of user creation in ISO 8601 format. | [optional] |
+| **organizations** | **Array<String>** | Array of organizations a user belongs to. | [optional] |
+| **identities** | [**Array<UserIdentitiesInner>**](UserIdentitiesInner.md) | Array of identities belonging to the user. | [optional] |
+| **properties** | **Hash<String, String>** | The user properties. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::SearchUsersResponseResultsInner.new(
+  id: kp_0ba7c433e5d648cf992621ce99d42817,
+  provided_id: U123456,
+  email: user@domain.com,
+  username: john.snow,
+  last_name: Snow,
+  first_name: John,
+  is_suspended: true,
+  picture: https://example.com/john_snow.jpg,
+  total_sign_ins: 1,
+  failed_sign_ins: 0,
+  last_signed_in: 2025-02-12T18:02:23.614638+00:00,
+  created_on: 2025-02-12T18:02:23.614638+00:00,
+  organizations: null,
+  identities: null,
+  properties: null
+)
+```
+

data/kinde_api/docs/SetUserPasswordRequest.md

@@ -0,0 +1,26 @@
+# KindeApi::SetUserPasswordRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hashed_password** | **String** | The hashed password. |  |
+| **hashing_method** | **String** | The hashing method or algorithm used to encrypt the user’s password. Default is bcrypt. | [optional] |
+| **salt** | **String** | Extra characters added to passwords to make them stronger. Not required for bcrypt. | [optional] |
+| **salt_position** | **String** | Position of salt in password string. Not required for bcrypt. | [optional] |
+| **is_temporary_password** | **Boolean** | The user will be prompted to set a new password after entering this one. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::SetUserPasswordRequest.new(
+  hashed_password: null,
+  hashing_method: null,
+  salt: null,
+  salt_position: null,
+  is_temporary_password: null
+)
+```
+

data/kinde_api/docs/SubscribersApi.md

@@ -1,6 +1,6 @@
 # KindeApi::SubscribersApi
 
-All URIs are relative to *https://app.kinde.com*
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
@@ -15,7 +15,7 @@ All URIs are relative to *https://app.kinde.com*
 
 Create Subscriber
 
-Create subscriber.
+Create subscriber.  <div>   <code>create:subscribers</code> </div> 
 
 ### Examples
 
@@ -88,7 +88,7 @@ end
 
 Get Subscriber
 
-Retrieve a subscriber record. 
+Retrieve a subscriber record.  <div>   <code>read:subscribers</code> </div> 
 
 ### Examples
 
@@ -157,7 +157,7 @@ end
 
 List Subscribers
 
-The returned list can be sorted by full name or email address 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 full name or email address 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:subscribers</code> </div> 
 
 ### Examples
 

data/kinde_api/docs/SuccessResponse.md

@@ -13,8 +13,8 @@
 require 'kinde_api'
 
 instance = KindeApi::SuccessResponse.new(
-  message: null,
-  code: null
+  message: Success,
+  code: OK
 )
 ```
 

data/kinde_api/docs/TimezonesApi.md

@@ -1,19 +1,19 @@
 # KindeApi::TimezonesApi
 
-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_timezones**](TimezonesApi.md#get_timezones) | **GET** /api/v1/timezones | List timezones and timezone IDs. |
+| [**get_timezones**](TimezonesApi.md#get_timezones) | **GET** /api/v1/timezones | Get timezones |
 
 
 ## get_timezones
 
-> <SuccessResponse> get_timezones(opts)
+> <GetTimezonesResponse> get_timezones
 
-List timezones and timezone IDs.
+Get timezones
 
-Get a list of timezones and associated timezone keys.
+Get a list of timezones and associated timezone keys.  <div>   <code>read:timezones</code> </div> 
 
 ### Examples
 
@@ -27,14 +27,10 @@ KindeApi.configure do |config|
 end
 
 api_instance = KindeApi::TimezonesApi.new
-opts = {
-  timezone_key: 'timezone_key_example', # String | Timezone Key.
-  name: 'name_example' # String | Timezone.
-}
 
 begin
-  # List timezones and timezone IDs.
-  result = api_instance.get_timezones(opts)
+  # Get timezones
+  result = api_instance.get_timezones
   p result
 rescue KindeApi::ApiError => e
   puts "Error when calling TimezonesApi->get_timezones: #{e}"
@@ -45,15 +41,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SuccessResponse>, Integer, Hash)> get_timezones_with_http_info(opts)
+> <Array(<GetTimezonesResponse>, Integer, Hash)> get_timezones_with_http_info
 
 ```ruby
 begin
-  # List timezones and timezone IDs.
-  data, status_code, headers = api_instance.get_timezones_with_http_info(opts)
+  # Get timezones
+  data, status_code, headers = api_instance.get_timezones_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SuccessResponse>
+  p data # => <GetTimezonesResponse>
 rescue KindeApi::ApiError => e
   puts "Error when calling TimezonesApi->get_timezones_with_http_info: #{e}"
 end
@@ -61,14 +57,11 @@ end
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **timezone_key** | **String** | Timezone Key. | [optional] |
-| **name** | **String** | Timezone. | [optional] |
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**SuccessResponse**](SuccessResponse.md)
+[**GetTimezonesResponse**](GetTimezonesResponse.md)
 
 ### Authorization
 
@@ -77,5 +70,5 @@ end
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json; charset=utf-8
+- **Accept**: application/json
 

data/kinde_api/docs/TokenIntrospect.md

@@ -7,8 +7,8 @@
 | **active** | **Boolean** | Indicates the status of the token. | [optional] |
 | **aud** | **Array<String>** | Array of intended token recipients. | [optional] |
 | **client_id** | **String** | Identifier for the requesting client. | [optional] |
-| **exp** | **String** | Token expiration timestamp. | [optional] |
-| **iat** | **String** | Token issuance timestamp. | [optional] |
+| **exp** | **Integer** | Token expiration timestamp. | [optional] |
+| **iat** | **Integer** | Token issuance timestamp. | [optional] |
 
 ## Example
 
@@ -18,9 +18,9 @@ require 'kinde_api'
 instance = KindeApi::TokenIntrospect.new(
   active: null,
   aud: null,
-  client_id: null,
-  exp: null,
-  iat: null
+  client_id: 3b0b5c6c8fcc464fab397f4969b5f482,
+  exp: 1612345678,
+  iat: 1612345678
 )
 ```
 

data/kinde_api/docs/UpdateAPIApplicationsRequestApplicationsInner.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The application's id. |  |
-| **operation** | **String** | Optional operation, set to 'delete' to remove the user from the organization. | [optional] |
+| **id** | **String** | The application's Client ID. |  |
+| **operation** | **String** | Optional operation, set to 'delete' to revoke authorization for the application. If not set, the application will be authorized. | [optional] |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'kinde_api'
 
 instance = KindeApi::UpdateAPIApplicationsRequestApplicationsInner.new(
-  id: null,
-  operation: null
+  id: d2db282d6214242b3b145c123f0c123,
+  operation: delete
 )
 ```
 

data/kinde_api/docs/UpdateAPIScopeRequest.md

@@ -0,0 +1,18 @@
+# KindeApi::UpdateAPIScopeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the api scope purpose. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateAPIScopeRequest.new(
+  description: Scope for reading logs.
+)
+```
+

data/kinde_api/docs/UpdateApplicationRequest.md

@@ -8,6 +8,8 @@
 | **language_key** | **String** | The application's language key. | [optional] |
 | **logout_uris** | **Array<String>** | The application's logout uris. | [optional] |
 | **redirect_uris** | **Array<String>** | The application's redirect uris. | [optional] |
+| **login_uri** | **String** | The default login route for resolving session issues. | [optional] |
+| **homepage_uri** | **String** | The homepage link to your application. | [optional] |
 
 ## Example
 
@@ -18,7 +20,9 @@ instance = KindeApi::UpdateApplicationRequest.new(
   name: null,
   language_key: null,
   logout_uris: null,
-  redirect_uris: null
+  redirect_uris: null,
+  login_uri: null,
+  homepage_uri: null
 )
 ```
 

data/kinde_api/docs/UpdateApplicationTokensRequest.md

@@ -0,0 +1,26 @@
+# KindeApi::UpdateApplicationTokensRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token_lifetime** | **Integer** | The lifetime of an access token in seconds. | [optional] |
+| **refresh_token_lifetime** | **Integer** | The lifetime of a refresh token in seconds. | [optional] |
+| **id_token_lifetime** | **Integer** | The lifetime of an ID token in seconds. | [optional] |
+| **authenticated_session_lifetime** | **Integer** | The lifetime of an authenticated session in seconds. | [optional] |
+| **is_hasura_mapping_enabled** | **Boolean** | Enable or disable Hasura mapping. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateApplicationTokensRequest.new(
+  access_token_lifetime: 3600,
+  refresh_token_lifetime: 86400,
+  id_token_lifetime: 3600,
+  authenticated_session_lifetime: 86400,
+  is_hasura_mapping_enabled: true
+)
+```
+

data/kinde_api/docs/UpdateApplicationsPropertyRequest.md

@@ -0,0 +1,18 @@
+# KindeApi::UpdateApplicationsPropertyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | [**UpdateApplicationsPropertyRequestValue**](UpdateApplicationsPropertyRequestValue.md) |  |  |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateApplicationsPropertyRequest.new(
+  value: null
+)
+```
+

data/kinde_api/docs/UpdateApplicationsPropertyRequestValue.md

@@ -0,0 +1,49 @@
+# KindeApi::UpdateApplicationsPropertyRequestValue
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'kinde_api'
+
+KindeApi::UpdateApplicationsPropertyRequestValue.openapi_one_of
+# =>
+# [
+#   :'Boolean',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'kinde_api'
+
+KindeApi::UpdateApplicationsPropertyRequestValue.build(data)
+# => #<Boolean:0x00007fdd4aab02a0>
+
+KindeApi::UpdateApplicationsPropertyRequestValue.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Boolean`
+- `String`
+- `nil` (if no type matches)
+

data/kinde_api/docs/UpdateBusinessRequest.md

@@ -0,0 +1,36 @@
+# KindeApi::UpdateBusinessRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **business_name** | **String** | The name of the business. | [optional] |
+| **email** | **String** | The email address of the business. | [optional] |
+| **industry_key** | **String** | The key of the industry of your business. Can be retrieved from the /industries endpoint. | [optional] |
+| **is_click_wrap** | **Boolean** | Whether the business is using clickwrap agreements. | [optional] |
+| **is_show_kinde_branding** | **Boolean** | Whether the business is showing Kinde branding. Requires a paid plan. | [optional] |
+| **kinde_perk_code** | **String** | The Kinde perk code for the business. | [optional] |
+| **phone** | **String** | The phone number of the business. | [optional] |
+| **privacy_url** | **String** | The URL to the business's privacy policy. | [optional] |
+| **terms_url** | **String** | The URL to the business's terms of service. | [optional] |
+| **timezone_key** | **String** | The key of the timezone of your business. Can be retrieved from the /timezones endpoint. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateBusinessRequest.new(
+  business_name: Tailsforce Ltd,
+  email: sally@example.com,
+  industry_key: construction,
+  is_click_wrap: false,
+  is_show_kinde_branding: true,
+  kinde_perk_code: null,
+  phone: 123-456-7890,
+  privacy_url: https://example.com/privacy,
+  terms_url: https://example.com/terms,
+  timezone_key: los_angeles_pacific_standard_time
+)
+```
+

data/kinde_api/docs/UpdateCategoryRequest.md

@@ -0,0 +1,18 @@
+# KindeApi::UpdateCategoryRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the category. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateCategoryRequest.new(
+  name: null
+)
+```
+

data/kinde_api/docs/UpdateConnectionRequest.md

@@ -0,0 +1,24 @@
+# KindeApi::UpdateConnectionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The internal name of the connection. | [optional] |
+| **display_name** | **String** | The public facing name of the connection. | [optional] |
+| **enabled_applications** | **Array<String>** | Client IDs of applications in which this connection is to be enabled. | [optional] |
+| **options** | [**ReplaceConnectionRequestOptions**](ReplaceConnectionRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateConnectionRequest.new(
+  name: ConnectionA,
+  display_name: Connection,
+  enabled_applications: ["c647dbe20f5944e28af97c9184fded22","20bbffaa4c5e492a962273039d4ae18b"],
+  options: null
+)
+```
+

data/kinde_api/docs/UpdateEnvironmentVariableRequest.md

@@ -0,0 +1,22 @@
+# KindeApi::UpdateEnvironmentVariableRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The key to update. | [optional] |
+| **value** | **String** | The new value for the environment variable. | [optional] |
+| **is_secret** | **Boolean** | Whether the environment variable is sensitive. Secret variables are not-readable by you or your team after creation. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateEnvironmentVariableRequest.new(
+  key: MY_API_KEY,
+  value: new-secret-value,
+  is_secret: null
+)
+```
+

data/kinde_api/docs/UpdateEnvironmentVariableResponse.md

@@ -0,0 +1,20 @@
+# KindeApi::UpdateEnvironmentVariableResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | A Kinde generated message. | [optional] |
+| **code** | **String** | A Kinde generated status code. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateEnvironmentVariableResponse.new(
+  message: Environment variable updated,
+  code: ENVIRONMENT_VARIABLE_UPDATED
+)
+```
+

data/kinde_api/docs/UpdateIdentityRequest.md

@@ -0,0 +1,18 @@
+# KindeApi::UpdateIdentityRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_primary** | **Boolean** | Whether the identity is the primary for it's type | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateIdentityRequest.new(
+  is_primary: null
+)
+```
+

data/kinde_api/docs/UpdateOrganizationPropertiesRequest.md

@@ -0,0 +1,18 @@
+# KindeApi::UpdateOrganizationPropertiesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **properties** | **Object** | Property keys and values |  |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateOrganizationPropertiesRequest.new(
+  properties: null
+)
+```
+