kinde_sdk 1.2.3 → 1.7.0

data/kinde_api/docs/LogoutRedirectUrls.md

@@ -4,7 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **redirect_urls** | **Array<String>** | An application's logout URLs. | [optional] |
+| **logout_urls** | **Array<String>** | An application's logout URLs. | [optional] |
+| **code** | **String** | Response code. | [optional] |
+| **message** | **String** | Response message. | [optional] |
 
 ## Example
 
@@ -12,7 +14,9 @@
 require 'kinde_api'
 
 instance = KindeApi::LogoutRedirectUrls.new(
-  redirect_urls: null
+  logout_urls: null,
+  code: OK,
+  message: Success
 )
 ```
 

data/kinde_api/docs/MFAApi.md

@@ -0,0 +1,77 @@
+# KindeApi::MFAApi
+
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**replace_mfa**](MFAApi.md#replace_mfa) | **PUT** /api/v1/mfa | Replace MFA Configuration |
+
+
+## replace_mfa
+
+> <SuccessResponse> replace_mfa(replace_mfa_request)
+
+Replace MFA Configuration
+
+Replace MFA Configuration.  <div>   <code>update:mfa</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::MFAApi.new
+replace_mfa_request = KindeApi::ReplaceMFARequest.new({policy: 'required', enabled_factors: ['mfa:email']}) # ReplaceMFARequest | MFA details.
+
+begin
+  # Replace MFA Configuration
+  result = api_instance.replace_mfa(replace_mfa_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling MFAApi->replace_mfa: #{e}"
+end
+```
+
+#### Using the replace_mfa_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> replace_mfa_with_http_info(replace_mfa_request)
+
+```ruby
+begin
+  # Replace MFA Configuration
+  data, status_code, headers = api_instance.replace_mfa_with_http_info(replace_mfa_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling MFAApi->replace_mfa_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **replace_mfa_request** | [**ReplaceMFARequest**](ReplaceMFARequest.md) | MFA details. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/kinde_api/docs/NotFoundResponse.md

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

data/kinde_api/docs/NotFoundResponseErrors.md

@@ -0,0 +1,20 @@
+# KindeApi::NotFoundResponseErrors
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::NotFoundResponseErrors.new(
+  code: ROUTE_NOT_FOUND,
+  message: The requested API route does not exist
+)
+```
+

data/kinde_api/docs/OAuthApi.md

@@ -1,88 +1,21 @@
 # KindeApi::OAuthApi
 
-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_user**](OAuthApi.md#get_user) | **GET** /oauth2/user_profile | Get User Profile |
-| [**get_user_profile_v2**](OAuthApi.md#get_user_profile_v2) | **GET** /oauth2/v2/user_profile | Returns the details of the currently logged in user |
-| [**token_introspection**](OAuthApi.md#token_introspection) | **POST** /oauth2/introspect | Get token details |
+| [**get_user_profile_v2**](OAuthApi.md#get_user_profile_v2) | **GET** /oauth2/v2/user_profile | Get user profile |
+| [**token_introspection**](OAuthApi.md#token_introspection) | **POST** /oauth2/introspect | Introspect |
 | [**token_revocation**](OAuthApi.md#token_revocation) | **POST** /oauth2/revoke | Revoke token |
 
 
-## get_user
-
-> <UserProfile> get_user
-
-Get User Profile
-
-Contains the id, names and email of the currently logged in user. 
-
-### 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::OAuthApi.new
-
-begin
-  # Get User Profile
-  result = api_instance.get_user
-  p result
-rescue KindeApi::ApiError => e
-  puts "Error when calling OAuthApi->get_user: #{e}"
-end
-```
-
-#### Using the get_user_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<UserProfile>, Integer, Hash)> get_user_with_http_info
-
-```ruby
-begin
-  # Get User Profile
-  data, status_code, headers = api_instance.get_user_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <UserProfile>
-rescue KindeApi::ApiError => e
-  puts "Error when calling OAuthApi->get_user_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**UserProfile**](UserProfile.md)
-
-### Authorization
-
-[kindeBearerAuth](../README.md#kindeBearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
 ## get_user_profile_v2
 
 > <UserProfileV2> get_user_profile_v2
 
-Returns the details of the currently logged in user
+Get user profile
 
-Contains the id, names, profile picture URL and email of the currently logged in user. 
+This endpoint returns a user's ID, names, profile picture URL and email of the currently logged in user. 
 
 ### Examples
 
@@ -98,7 +31,7 @@ end
 api_instance = KindeApi::OAuthApi.new
 
 begin
-  # Returns the details of the currently logged in user
+  # Get user profile
   result = api_instance.get_user_profile_v2
   p result
 rescue KindeApi::ApiError => e
@@ -114,7 +47,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Returns the details of the currently logged in user
+  # Get user profile
   data, status_code, headers = api_instance.get_user_profile_v2_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -144,9 +77,9 @@ This endpoint does not need any parameter.
 
 ## token_introspection
 
-> <TokenIntrospect> token_introspection(opts)
+> <TokenIntrospect> token_introspection(token, opts)
 
-Get token details
+Introspect
 
 Retrieve information about the provided token.
 
@@ -162,14 +95,14 @@ KindeApi.configure do |config|
 end
 
 api_instance = KindeApi::OAuthApi.new
+token = 'token_example' # String | The token to be introspected.
 opts = {
-  token: 'token_example', # String | The token to be introspected.
-  token_type: 'token_type_example' # String | The provided token's type.
+  token_type_hint: 'access_token' # String | A hint about the token type being queried in the request.
 }
 
 begin
-  # Get token details
-  result = api_instance.token_introspection(opts)
+  # Introspect
+  result = api_instance.token_introspection(token, opts)
   p result
 rescue KindeApi::ApiError => e
   puts "Error when calling OAuthApi->token_introspection: #{e}"
@@ -180,12 +113,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<TokenIntrospect>, Integer, Hash)> token_introspection_with_http_info(opts)
+> <Array(<TokenIntrospect>, Integer, Hash)> token_introspection_with_http_info(token, opts)
 
 ```ruby
 begin
-  # Get token details
-  data, status_code, headers = api_instance.token_introspection_with_http_info(opts)
+  # Introspect
+  data, status_code, headers = api_instance.token_introspection_with_http_info(token, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <TokenIntrospect>
@@ -198,8 +131,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **token** | **String** | The token to be introspected. | [optional] |
-| **token_type** | **String** | The provided token&#39;s type. | [optional] |
+| **token** | **String** | The token to be introspected. |  |
+| **token_type_hint** | **String** | A hint about the token type being queried in the request. | [optional] |
 
 ### Return type
 
@@ -217,11 +150,11 @@ end
 
 ## token_revocation
 
-> token_revocation(opts)
+> token_revocation(client_id, token, opts)
 
 Revoke token
 
-Revoke a previously issued token.
+Use this endpoint to invalidate an access or refresh token. The token will no longer be valid for use.
 
 ### Examples
 
@@ -235,15 +168,16 @@ KindeApi.configure do |config|
 end
 
 api_instance = KindeApi::OAuthApi.new
+client_id = 'client_id_example' # String | The `client_id` of your application.
+token = 'token_example' # String | The token to be revoked.
 opts = {
-  token: 'token_example', # String | The token to be revoked.
-  client_id: 'client_id_example', # String | The identifier for your client.
-  client_secret: 'client_secret_example' # String | The secret associated with your client.
+  client_secret: 'client_secret_example', # String | The `client_secret` of your application. Required for backend apps only.
+  token_type_hint: 'access_token' # String | The type of token to be revoked.
 }
 
 begin
   # Revoke token
-  api_instance.token_revocation(opts)
+  api_instance.token_revocation(client_id, token, opts)
 rescue KindeApi::ApiError => e
   puts "Error when calling OAuthApi->token_revocation: #{e}"
 end
@@ -253,12 +187,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> token_revocation_with_http_info(opts)
+> <Array(nil, Integer, Hash)> token_revocation_with_http_info(client_id, token, opts)
 
 ```ruby
 begin
   # Revoke token
-  data, status_code, headers = api_instance.token_revocation_with_http_info(opts)
+  data, status_code, headers = api_instance.token_revocation_with_http_info(client_id, token, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -271,9 +205,10 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **token** | **String** | The token to be revoked. | [optional] |
-| **client_id** | **String** | The identifier for your client. | [optional] |
-| **client_secret** | **String** | The secret associated with your client. | [optional] |
+| **client_id** | **String** | The &#x60;client_id&#x60; of your application. |  |
+| **token** | **String** | The token to be revoked. |  |
+| **client_secret** | **String** | The &#x60;client_secret&#x60; of your application. Required for backend apps only. | [optional] |
+| **token_type_hint** | **String** | The type of token to be revoked. | [optional] |
 
 ### Return type
 
@@ -286,5 +221,5 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/x-www-form-urlencoded
-- **Accept**: application/json, application/json; charset=utf-8
+- **Accept**: application/json
 

data/kinde_api/docs/OrganizationItemSchema.md

@@ -0,0 +1,28 @@
+# KindeApi::OrganizationItemSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The unique identifier for the organization. | [optional] |
+| **name** | **String** | The organization's name. | [optional] |
+| **handle** | **String** | A unique handle for the organization - can be used for dynamic callback urls. | [optional] |
+| **is_default** | **Boolean** | Whether the organization is the default organization. | [optional] |
+| **external_id** | **String** | The organization's external identifier - commonly used when migrating from or mapping to other systems. | [optional] |
+| **is_auto_membership_enabled** | **Boolean** | If users become members of this organization when the org code is supplied during authentication. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::OrganizationItemSchema.new(
+  code: org_1ccfb819462,
+  name: Acme Corp,
+  handle: acme_corp,
+  is_default: false,
+  external_id: some1234,
+  is_auto_membership_enabled: true
+)
+```
+

data/kinde_api/docs/OrganizationUser.md

@@ -4,12 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **email** | **String** |  | [optional] |
-| **full_name** | **String** |  | [optional] |
-| **last_name** | **String** |  | [optional] |
-| **first_name** | **String** |  | [optional] |
-| **roles** | **Array<String>** |  | [optional] |
+| **id** | **String** | The unique ID for the user. | [optional] |
+| **email** | **String** | The user's email address. | [optional] |
+| **full_name** | **String** | The user's full name. | [optional] |
+| **last_name** | **String** | The user's last name. | [optional] |
+| **first_name** | **String** | The user's first name. | [optional] |
+| **picture** | **String** | The user's profile picture URL. | [optional] |
+| **joined_on** | **String** | The date the user joined the organization. | [optional] |
+| **last_accessed_on** | **String** | The date the user last accessed the organization. | [optional] |
+| **roles** | **Array<String>** | The roles the user has in the organization. | [optional] |
 
 ## Example
 
@@ -17,11 +20,14 @@
 require 'kinde_api'
 
 instance = KindeApi::OrganizationUser.new(
-  id: null,
-  email: null,
-  full_name: null,
-  last_name: null,
-  first_name: null,
+  id: kp:97c2ba24217d48e3b96a799b76cf2c74,
+  email: john.snow@example.com,
+  full_name: John Snow,
+  last_name: Snow,
+  first_name: John,
+  picture: https://example.com/john_snow.jpg,
+  joined_on: 2021-01-01T00:00:00Z,
+  last_accessed_on: 2022-01-01T00:00:00Z,
   roles: null
 )
 ```