kinde_sdk 1.2.1 → 1.2.3

data/kinde_api/docs/UsersApi.md

@@ -8,7 +8,9 @@ All URIs are relative to *https://app.kinde.com*
 | [**delete_user**](UsersApi.md#delete_user) | **DELETE** /api/v1/user | Delete User |
 | [**get_user_data**](UsersApi.md#get_user_data) | **GET** /api/v1/user | Get User |
 | [**get_users**](UsersApi.md#get_users) | **GET** /api/v1/users | List Users |
+| [**refresh_user_claims**](UsersApi.md#refresh_user_claims) | **POST** /api/v1/users/{user_id}/refresh_claims | Refresh User Claims and Invalidate Cache |
 | [**update_user**](UsersApi.md#update_user) | **PATCH** /api/v1/user | Update User |
+| [**update_user_feature_flag_override**](UsersApi.md#update_user_feature_flag_override) | **PATCH** /api/v1/users/{user_id}/feature_flags/{feature_flag_key} | Update User Feature Flag Override |
 
 
 ## create_user
@@ -84,7 +86,7 @@ end
 
 ## delete_user
 
-> <SuccessResponse> delete_user(opts)
+> <SuccessResponse> delete_user(id, opts)
 
 Delete User
 
@@ -102,13 +104,14 @@ KindeApi.configure do |config|
 end
 
 api_instance = KindeApi::UsersApi.new
+id = 'id_example' # String | The user's id.
 opts = {
-  id: 'id_example' # String | The user's id.
+  is_delete_profile: true # Boolean | Delete all data and remove the user's profile from all of Kinde, including the subscriber list
 }
 
 begin
   # Delete User
-  result = api_instance.delete_user(opts)
+  result = api_instance.delete_user(id, opts)
   p result
 rescue KindeApi::ApiError => e
   puts "Error when calling UsersApi->delete_user: #{e}"
@@ -119,12 +122,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SuccessResponse>, Integer, Hash)> delete_user_with_http_info(opts)
+> <Array(<SuccessResponse>, Integer, Hash)> delete_user_with_http_info(id, opts)
 
 ```ruby
 begin
   # Delete User
-  data, status_code, headers = api_instance.delete_user_with_http_info(opts)
+  data, status_code, headers = api_instance.delete_user_with_http_info(id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SuccessResponse>
@@ -137,7 +140,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The user&#39;s id. | [optional] |
+| **id** | **String** | The user&#39;s id. |  |
+| **is_delete_profile** | **Boolean** | Delete all data and remove the user&#39;s profile from all of Kinde, including the subscriber list | [optional] |
 
 ### Return type
 
@@ -155,7 +159,7 @@ end
 
 ## get_user_data
 
-> <User> get_user_data(id)
+> <User> get_user_data(id, opts)
 
 Get User
 
@@ -174,10 +178,13 @@ end
 
 api_instance = KindeApi::UsersApi.new
 id = 'id_example' # String | The user's id.
+opts = {
+  expand: 'expand_example' # String | Specify additional data to retrieve. Use \"organizations\" and/or \"identities\".
+}
 
 begin
   # Get User
-  result = api_instance.get_user_data(id)
+  result = api_instance.get_user_data(id, opts)
   p result
 rescue KindeApi::ApiError => e
   puts "Error when calling UsersApi->get_user_data: #{e}"
@@ -188,12 +195,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<User>, Integer, Hash)> get_user_data_with_http_info(id)
+> <Array(<User>, Integer, Hash)> get_user_data_with_http_info(id, opts)
 
 ```ruby
 begin
   # Get User
-  data, status_code, headers = api_instance.get_user_data_with_http_info(id)
+  data, status_code, headers = api_instance.get_user_data_with_http_info(id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <User>
@@ -207,6 +214,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The user&#39;s id. |  |
+| **expand** | **String** | Specify additional data to retrieve. Use \&quot;organizations\&quot; and/or \&quot;identities\&quot;. | [optional] |
 
 ### Return type
 
@@ -243,11 +251,11 @@ end
 
 api_instance = KindeApi::UsersApi.new
 opts = {
-  sort: 'name_asc', # String | Field and order to sort the result by.
   page_size: 56, # Integer | Number of results per page. Defaults to 10 if parameter not sent.
   user_id: 'user_id_example', # String | ID of the user to filter by.
   next_token: 'next_token_example', # String | A string to get the next page of results if there are more results.
-  email: 'email_example' # String | Filter the results by email address. The query string should be comma separated and url encoded.
+  email: 'email_example', # String | Filter the results by email address. The query string should be comma separated and url encoded.
+  expand: 'expand_example' # String | Specify additional data to retrieve. Use \"organizations\" and/or \"identities\".
 }
 
 begin
@@ -281,11 +289,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **sort** | **String** | Field and order to sort the result by. | [optional] |
 | **page_size** | **Integer** | Number of results per page. Defaults to 10 if parameter not sent. | [optional] |
 | **user_id** | **String** | ID of the user to filter by. | [optional] |
 | **next_token** | **String** | A string to get the next page of results if there are more results. | [optional] |
 | **email** | **String** | Filter the results by email address. The query string should be comma separated and url encoded. | [optional] |
+| **expand** | **String** | Specify additional data to retrieve. Use \&quot;organizations\&quot; and/or \&quot;identities\&quot;. | [optional] |
 
 ### Return type
 
@@ -301,9 +309,78 @@ end
 - **Accept**: application/json, application/json; charset=utf-8
 
 
+## refresh_user_claims
+
+> <SuccessResponse> refresh_user_claims(user_id)
+
+Refresh User Claims and Invalidate Cache
+
+Refreshes the user's claims and invalidates the current cache. 
+
+### 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::UsersApi.new
+user_id = 'user_id_example' # String | The id of the user whose claims needs to be updated.
+
+begin
+  # Refresh User Claims and Invalidate Cache
+  result = api_instance.refresh_user_claims(user_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling UsersApi->refresh_user_claims: #{e}"
+end
+```
+
+#### Using the refresh_user_claims_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> refresh_user_claims_with_http_info(user_id)
+
+```ruby
+begin
+  # Refresh User Claims and Invalidate Cache
+  data, status_code, headers = api_instance.refresh_user_claims_with_http_info(user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling UsersApi->refresh_user_claims_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The id of the user whose claims needs to be updated. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8, application/json
+
+
 ## update_user
 
-> <User> update_user(update_user_request, opts)
+> <UpdateUserResponse> update_user(id, update_user_request)
 
 Update User
 
@@ -321,14 +398,12 @@ KindeApi.configure do |config|
 end
 
 api_instance = KindeApi::UsersApi.new
+id = 'id_example' # String | The user's id.
 update_user_request = KindeApi::UpdateUserRequest.new # UpdateUserRequest | The user to update.
-opts = {
-  id: 'id_example' # String | The user's id.
-}
 
 begin
   # Update User
-  result = api_instance.update_user(update_user_request, opts)
+  result = api_instance.update_user(id, update_user_request)
   p result
 rescue KindeApi::ApiError => e
   puts "Error when calling UsersApi->update_user: #{e}"
@@ -339,15 +414,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<User>, Integer, Hash)> update_user_with_http_info(update_user_request, opts)
+> <Array(<UpdateUserResponse>, Integer, Hash)> update_user_with_http_info(id, update_user_request)
 
 ```ruby
 begin
   # Update User
-  data, status_code, headers = api_instance.update_user_with_http_info(update_user_request, opts)
+  data, status_code, headers = api_instance.update_user_with_http_info(id, update_user_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <User>
+  p data # => <UpdateUserResponse>
 rescue KindeApi::ApiError => e
   puts "Error when calling UsersApi->update_user_with_http_info: #{e}"
 end
@@ -357,12 +432,12 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **id** | **String** | The user&#39;s id. |  |
 | **update_user_request** | [**UpdateUserRequest**](UpdateUserRequest.md) | The user to update. |  |
-| **id** | **String** | The user&#39;s id. | [optional] |
 
 ### Return type
 
-[**User**](User.md)
+[**UpdateUserResponse**](UpdateUserResponse.md)
 
 ### Authorization
 
@@ -373,3 +448,76 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json, application/json; charset=utf-8
 
+
+## update_user_feature_flag_override
+
+> <SuccessResponse> update_user_feature_flag_override(user_id, feature_flag_key, value)
+
+Update User Feature Flag Override
+
+Update user feature flag override.
+
+### 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::UsersApi.new
+user_id = 'user_id_example' # String | The identifier for the user
+feature_flag_key = 'feature_flag_key_example' # String | The identifier for the feature flag
+value = 'value_example' # String | Override value
+
+begin
+  # Update User Feature Flag Override
+  result = api_instance.update_user_feature_flag_override(user_id, feature_flag_key, value)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling UsersApi->update_user_feature_flag_override: #{e}"
+end
+```
+
+#### Using the update_user_feature_flag_override_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> update_user_feature_flag_override_with_http_info(user_id, feature_flag_key, value)
+
+```ruby
+begin
+  # Update User Feature Flag Override
+  data, status_code, headers = api_instance.update_user_feature_flag_override_with_http_info(user_id, feature_flag_key, value)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling UsersApi->update_user_feature_flag_override_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The identifier for the user |  |
+| **feature_flag_key** | **String** | The identifier for the feature flag |  |
+| **value** | **String** | Override value |  |
+
+### 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
+

data/kinde_api/docs/UsersResponse.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **code** | **String** | Response code. | [optional] |
 | **message** | **String** | Response message. | [optional] |
-| **users** | [**Array<User>**](User.md) |  | [optional] |
+| **users** | [**Array<UsersResponseUsersInner>**](UsersResponseUsersInner.md) |  | [optional] |
 | **next_token** | **String** | Pagination token. | [optional] |
 
 ## Example

data/kinde_api/docs/UsersResponseUsersInner.md

@@ -0,0 +1,42 @@
+# KindeApi::UsersResponseUsersInner
+
+## 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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UsersResponseUsersInner.new(
+  id: null,
+  provided_id: null,
+  email: null,
+  last_name: null,
+  first_name: null,
+  is_suspended: null,
+  picture: null,
+  total_sign_ins: null,
+  failed_sign_ins: null,
+  last_signed_in: null,
+  created_on: null,
+  organizations: null,
+  identities: null
+)
+```
+