kinde_sdk 1.2.1 → 1.2.3

data/kinde_api/docs/Subscriber.md

@@ -0,0 +1,24 @@
+# KindeApi::Subscriber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **preferred_email** | **String** |  | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::Subscriber.new(
+  id: null,
+  preferred_email: null,
+  first_name: null,
+  last_name: null
+)
+```
+

data/kinde_api/docs/SubscribersApi.md

@@ -4,7 +4,7 @@ All URIs are relative to *https://app.kinde.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_subscriber**](SubscribersApi.md#create_subscriber) | **POST** /api/v1/subscribers | Create a new subscriber |
+| [**create_subscriber**](SubscribersApi.md#create_subscriber) | **POST** /api/v1/subscribers | Create Subscriber |
 | [**get_subscriber**](SubscribersApi.md#get_subscriber) | **GET** /api/v1/subscribers/{subscriber_id} | Get Subscriber |
 | [**get_subscribers**](SubscribersApi.md#get_subscribers) | **GET** /api/v1/subscribers | List Subscribers |
 
@@ -13,7 +13,7 @@ All URIs are relative to *https://app.kinde.com*
 
 > <CreateSubscriberSuccessResponse> create_subscriber(first_name, last_name, email)
 
-Create a new subscriber
+Create Subscriber
 
 Create subscriber.
 
@@ -34,7 +34,7 @@ last_name = 'last_name_example' # String | Subscriber's last name.
 email = 'email_example' # String | The email address of the subscriber.
 
 begin
-  # Create a new subscriber
+  # Create Subscriber
   result = api_instance.create_subscriber(first_name, last_name, email)
   p result
 rescue KindeApi::ApiError => e
@@ -50,7 +50,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Create a new subscriber
+  # Create Subscriber
   data, status_code, headers = api_instance.create_subscriber_with_http_info(first_name, last_name, email)
   p status_code # => 2xx
   p headers # => { ... }
@@ -84,7 +84,7 @@ end
 
 ## get_subscriber
 
-> <SuccessResponse> get_subscriber(subscriber_id)
+> <GetSubscriberResponse> get_subscriber(subscriber_id)
 
 Get Subscriber
 
@@ -117,7 +117,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SuccessResponse>, Integer, Hash)> get_subscriber_with_http_info(subscriber_id)
+> <Array(<GetSubscriberResponse>, Integer, Hash)> get_subscriber_with_http_info(subscriber_id)
 
 ```ruby
 begin
@@ -125,7 +125,7 @@ begin
   data, status_code, headers = api_instance.get_subscriber_with_http_info(subscriber_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SuccessResponse>
+  p data # => <GetSubscriberResponse>
 rescue KindeApi::ApiError => e
   puts "Error when calling SubscribersApi->get_subscriber_with_http_info: #{e}"
 end
@@ -139,7 +139,7 @@ end
 
 ### Return type
 
-[**SuccessResponse**](SuccessResponse.md)
+[**GetSubscriberResponse**](GetSubscriberResponse.md)
 
 ### Authorization
 
@@ -153,7 +153,7 @@ end
 
 ## get_subscribers
 
-> <SuccessResponse> get_subscribers(opts)
+> <GetSubscribersResponse> get_subscribers(opts)
 
 List Subscribers
 
@@ -174,7 +174,6 @@ api_instance = KindeApi::SubscribersApi.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.
-  subscriber_id: 56, # Integer | ID of the subscriber to filter by.
   next_token: 'next_token_example' # String | A string to get the next page of results if there are more results.
 }
 
@@ -191,7 +190,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SuccessResponse>, Integer, Hash)> get_subscribers_with_http_info(opts)
+> <Array(<GetSubscribersResponse>, Integer, Hash)> get_subscribers_with_http_info(opts)
 
 ```ruby
 begin
@@ -199,7 +198,7 @@ begin
   data, status_code, headers = api_instance.get_subscribers_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SuccessResponse>
+  p data # => <GetSubscribersResponse>
 rescue KindeApi::ApiError => e
   puts "Error when calling SubscribersApi->get_subscribers_with_http_info: #{e}"
 end
@@ -211,12 +210,11 @@ end
 | ---- | ---- | ----------- | ----- |
 | **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] |
-| **subscriber_id** | **Integer** | ID of the subscriber to filter by. | [optional] |
 | **next_token** | **String** | A string to get the next page of results if there are more results. | [optional] |
 
 ### Return type
 
-[**SuccessResponse**](SuccessResponse.md)
+[**GetSubscribersResponse**](GetSubscribersResponse.md)
 
 ### Authorization
 

data/kinde_api/docs/SubscribersSubscriber.md

@@ -0,0 +1,26 @@
+# KindeApi::SubscribersSubscriber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **full_name** | **String** |  | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::SubscribersSubscriber.new(
+  id: null,
+  email: null,
+  full_name: null,
+  first_name: null,
+  last_name: null
+)
+```
+

data/kinde_api/docs/TimezonesApi.md

@@ -0,0 +1,81 @@
+# KindeApi::TimezonesApi
+
+All URIs are relative to *https://app.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_timezones**](TimezonesApi.md#get_timezones) | **GET** /api/v1/timezones | List timezones and timezone IDs. |
+
+
+## get_timezones
+
+> <SuccessResponse> get_timezones(opts)
+
+List timezones and timezone IDs.
+
+Get a list of timezones and associated timezone keys.
+
+### 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::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)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling TimezonesApi->get_timezones: #{e}"
+end
+```
+
+#### Using the get_timezones_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> get_timezones_with_http_info(opts)
+
+```ruby
+begin
+  # List timezones and timezone IDs.
+  data, status_code, headers = api_instance.get_timezones_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling TimezonesApi->get_timezones_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timezone_key** | **String** | Timezone Key. | [optional] |
+| **name** | **String** | Timezone. | [optional] |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+

data/kinde_api/docs/TokenErrorResponse.md

@@ -0,0 +1,20 @@
+# KindeApi::TokenErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** | Error. | [optional] |
+| **error_description** | **String** | The error description. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::TokenErrorResponse.new(
+  error: null,
+  error_description: null
+)
+```
+

data/kinde_api/docs/TokenIntrospect.md

@@ -0,0 +1,26 @@
+# KindeApi::TokenIntrospect
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::TokenIntrospect.new(
+  active: null,
+  aud: null,
+  client_id: null,
+  exp: null,
+  iat: null
+)
+```
+

data/kinde_api/docs/UpdateAPIApplicationsRequest.md

@@ -0,0 +1,18 @@
+# KindeApi::UpdateAPIApplicationsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **applications** | [**Array<UpdateAPIApplicationsRequestApplicationsInner>**](UpdateAPIApplicationsRequestApplicationsInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateAPIApplicationsRequest.new(
+  applications: null
+)
+```
+

data/kinde_api/docs/UpdateAPIApplicationsRequestApplicationsInner.md

@@ -0,0 +1,20 @@
+# KindeApi::UpdateAPIApplicationsRequestApplicationsInner
+
+## Properties
+
+| 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] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateAPIApplicationsRequestApplicationsInner.new(
+  id: null,
+  operation: null
+)
+```
+

data/kinde_api/docs/UpdateApplicationRequest.md

@@ -0,0 +1,24 @@
+# KindeApi::UpdateApplicationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The application's name. | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateApplicationRequest.new(
+  name: null,
+  language_key: null,
+  logout_uris: null,
+  redirect_uris: null
+)
+```
+

data/kinde_api/docs/UpdateEnvironementFeatureFlagOverrideRequest.md

@@ -0,0 +1,18 @@
+# KindeApi::UpdateEnvironementFeatureFlagOverrideRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** | The flag override value. |  |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateEnvironementFeatureFlagOverrideRequest.new(
+  value: null
+)
+```
+

data/kinde_api/docs/UpdateOrganizationRequest.md

@@ -10,6 +10,13 @@
 | **button_color** | **String** | The organization's brand settings - button color. | [optional] |
 | **button_text_color** | **String** | The organization's brand settings - button text color. | [optional] |
 | **link_color** | **String** | The organization's brand settings - link color. | [optional] |
+| **background_color_dark** | **String** | The organization's brand settings - dark mode background color. | [optional] |
+| **button_color_dark** | **String** | The organization's brand settings - dark mode button color. | [optional] |
+| **button_text_color_dark** | **String** | The organization's brand settings - dark mode button text color. | [optional] |
+| **link_color_dark** | **String** | The organization's brand settings - dark mode link color. | [optional] |
+| **theme_code** | **String** | The organization's brand settings - theme/mode 'light' | 'dark' | 'user_preference'. | [optional] |
+| **handle** | **String** | The organization's handle. | [optional] |
+| **is_allow_registrations** | **Boolean** | Users can sign up to this organization. | [optional] |
 
 ## Example
 
@@ -22,7 +29,14 @@ instance = KindeApi::UpdateOrganizationRequest.new(
   background_color: null,
   button_color: null,
   button_text_color: null,
-  link_color: null
+  link_color: null,
+  background_color_dark: null,
+  button_color_dark: null,
+  button_text_color_dark: null,
+  link_color_dark: null,
+  theme_code: null,
+  handle: null,
+  is_allow_registrations: null
 )
 ```
 

data/kinde_api/docs/UpdateOrganizationUsersRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **users** | [**Array<UpdateOrganizationUsersRequestUsersInner>**](UpdateOrganizationUsersRequestUsersInner.md) | Users to be added to the organization. | [optional] |
+| **users** | [**Array<UpdateOrganizationUsersRequestUsersInner>**](UpdateOrganizationUsersRequestUsersInner.md) | Users to add, update or remove from the organization. | [optional] |
 
 ## Example
 

data/kinde_api/docs/UpdateRolePermissionsRequest.md

@@ -0,0 +1,18 @@
+# KindeApi::UpdateRolePermissionsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **permissions** | [**Array<UpdateRolePermissionsRequestPermissionsInner>**](UpdateRolePermissionsRequestPermissionsInner.md) | Permissions to add or remove from the role. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateRolePermissionsRequest.new(
+  permissions: null
+)
+```
+

data/kinde_api/docs/UpdateRolePermissionsRequestPermissionsInner.md

@@ -0,0 +1,20 @@
+# KindeApi::UpdateRolePermissionsRequestPermissionsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The permission id. | [optional] |
+| **operation** | **String** | Optional operation, set to 'delete' to remove the permission from the role. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateRolePermissionsRequestPermissionsInner.new(
+  id: null,
+  operation: null
+)
+```
+

data/kinde_api/docs/UpdateRolePermissionsResponse.md

@@ -0,0 +1,24 @@
+# KindeApi::UpdateRolePermissionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **permissions_added** | **Array<String>** |  | [optional] |
+| **permissions_removed** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateRolePermissionsResponse.new(
+  code: null,
+  message: null,
+  permissions_added: null,
+  permissions_removed: null
+)
+```
+

data/kinde_api/docs/UpdateRolesRequest.md

@@ -0,0 +1,24 @@
+# KindeApi::UpdateRolesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The role's name. |  |
+| **description** | **String** | The role's description. | [optional] |
+| **key** | **String** | The role identifier to use in code. |  |
+| **is_default_role** | **Boolean** | Set role as default for new users. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateRolesRequest.new(
+  name: null,
+  description: null,
+  key: null,
+  is_default_role: null
+)
+```
+

data/kinde_api/docs/UpdateUserResponse.md

@@ -0,0 +1,30 @@
+# KindeApi::UpdateUserResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique id of the user in Kinde. | [optional] |
+| **given_name** | **String** | User's first name. | [optional] |
+| **family_name** | **String** | User's last name. | [optional] |
+| **email** | **String** | User's preferred email. | [optional] |
+| **is_suspended** | **Boolean** | Whether the user is currently suspended or not. | [optional] |
+| **is_password_reset_requested** | **Boolean** | Whether a password reset has been requested. | [optional] |
+| **picture** | **String** | User's profile picture URL. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateUserResponse.new(
+  id: null,
+  given_name: null,
+  family_name: null,
+  email: null,
+  is_suspended: null,
+  is_password_reset_requested: null,
+  picture: null
+)
+```
+

data/kinde_api/docs/User.md

@@ -6,17 +6,17 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
+| **preferred_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] |
-| **full_name** | **String** | User's full name. | [optional] |
 | **is_suspended** | **Boolean** | Whether the user is currently suspended or not. | [optional] |
 | **picture** | **String** | User's profile picture URL. | [optional] |
-| **is_password_reset_requested** | **Boolean** | Whether the user has been asked to reset their password. | [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
 
@@ -26,17 +26,17 @@ require 'kinde_api'
 instance = KindeApi::User.new(
   id: null,
   provided_id: null,
-  email: null,
+  preferred_email: null,
   last_name: null,
   first_name: null,
-  full_name: null,
   is_suspended: null,
   picture: null,
-  is_password_reset_requested: null,
   total_sign_ins: null,
   failed_sign_ins: null,
   last_signed_in: null,
-  created_on: null
+  created_on: null,
+  organizations: null,
+  identities: null
 )
 ```
 

data/kinde_api/docs/UserIdentitiesInner.md

@@ -0,0 +1,20 @@
+# KindeApi::UserIdentitiesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **identity** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UserIdentitiesInner.new(
+  type: null,
+  identity: null
+)
+```
+