kinde_sdk 1.2.3 → 1.7.0

data/kinde_api/docs/EnvironmentsApi.md

@@ -1,22 +1,97 @@
 # KindeApi::EnvironmentsApi
 
-All URIs are relative to *https://app.kinde.com*
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**add_logo**](EnvironmentsApi.md#add_logo) | **PUT** /api/v1/environment/logos/{type} | Add logo |
 | [**delete_environement_feature_flag_override**](EnvironmentsApi.md#delete_environement_feature_flag_override) | **DELETE** /api/v1/environment/feature_flags/{feature_flag_key} | Delete Environment Feature Flag Override |
 | [**delete_environement_feature_flag_overrides**](EnvironmentsApi.md#delete_environement_feature_flag_overrides) | **DELETE** /api/v1/environment/feature_flags | Delete Environment Feature Flag Overrides |
+| [**delete_logo**](EnvironmentsApi.md#delete_logo) | **DELETE** /api/v1/environment/logos/{type} | Delete logo |
 | [**get_environement_feature_flags**](EnvironmentsApi.md#get_environement_feature_flags) | **GET** /api/v1/environment/feature_flags | List Environment Feature Flags |
+| [**get_environment**](EnvironmentsApi.md#get_environment) | **GET** /api/v1/environment | Get environment |
+| [**read_logo**](EnvironmentsApi.md#read_logo) | **GET** /api/v1/environment/logos | Read logo details |
 | [**update_environement_feature_flag_override**](EnvironmentsApi.md#update_environement_feature_flag_override) | **PATCH** /api/v1/environment/feature_flags/{feature_flag_key} | Update Environment Feature Flag Override |
 
 
+## add_logo
+
+> <SuccessResponse> add_logo(type, logo)
+
+Add logo
+
+Add environment logo  <div>   <code>update:environments</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::EnvironmentsApi.new
+type = 'dark' # String | The type of logo to add.
+logo = File.new('/path/to/some/file') # File | The logo file to upload.
+
+begin
+  # Add logo
+  result = api_instance.add_logo(type, logo)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling EnvironmentsApi->add_logo: #{e}"
+end
+```
+
+#### Using the add_logo_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> add_logo_with_http_info(type, logo)
+
+```ruby
+begin
+  # Add logo
+  data, status_code, headers = api_instance.add_logo_with_http_info(type, logo)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling EnvironmentsApi->add_logo_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of logo to add. |  |
+| **logo** | **File** | The logo file to upload. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+
+
 ## delete_environement_feature_flag_override
 
 > <SuccessResponse> delete_environement_feature_flag_override(feature_flag_key)
 
 Delete Environment Feature Flag Override
 
-Delete environment feature flag override.
+Delete environment feature flag override.  <div>   <code>delete:environment_feature_flags</code> </div> 
 
 ### Examples
 
@@ -85,7 +160,7 @@ end
 
 Delete Environment Feature Flag Overrides
 
-Delete all environment feature flag overrides.
+Delete all environment feature flag overrides.  <div>   <code>delete:environment_feature_flags</code> </div> 
 
 ### Examples
 
@@ -145,13 +220,82 @@ This endpoint does not need any parameter.
 - **Accept**: application/json, application/json; charset=utf-8
 
 
+## delete_logo
+
+> <SuccessResponse> delete_logo(type)
+
+Delete logo
+
+Delete environment logo  <div>   <code>update:environments</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::EnvironmentsApi.new
+type = 'dark' # String | The type of logo to delete.
+
+begin
+  # Delete logo
+  result = api_instance.delete_logo(type)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling EnvironmentsApi->delete_logo: #{e}"
+end
+```
+
+#### Using the delete_logo_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> delete_logo_with_http_info(type)
+
+```ruby
+begin
+  # Delete logo
+  data, status_code, headers = api_instance.delete_logo_with_http_info(type)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling EnvironmentsApi->delete_logo_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of logo to delete. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_environement_feature_flags
 
 > <GetEnvironmentFeatureFlagsResponse> get_environement_feature_flags
 
 List Environment Feature Flags
 
-Get environment feature flags.
+Get environment feature flags.  <div>   <code>read:environment_feature_flags</code> </div> 
 
 ### Examples
 
@@ -211,13 +355,145 @@ This endpoint does not need any parameter.
 - **Accept**: application/json, application/json; charset=utf-8
 
 
+## get_environment
+
+> <GetEnvironmentResponse> get_environment
+
+Get environment
+
+Gets the current environment.  <div>   <code>read:environments</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::EnvironmentsApi.new
+
+begin
+  # Get environment
+  result = api_instance.get_environment
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling EnvironmentsApi->get_environment: #{e}"
+end
+```
+
+#### Using the get_environment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetEnvironmentResponse>, Integer, Hash)> get_environment_with_http_info
+
+```ruby
+begin
+  # Get environment
+  data, status_code, headers = api_instance.get_environment_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetEnvironmentResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling EnvironmentsApi->get_environment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetEnvironmentResponse**](GetEnvironmentResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read_logo
+
+> <ReadEnvLogoResponse> read_logo
+
+Read logo details
+
+Read environment logo details  <div>   <code>read:environments</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::EnvironmentsApi.new
+
+begin
+  # Read logo details
+  result = api_instance.read_logo
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling EnvironmentsApi->read_logo: #{e}"
+end
+```
+
+#### Using the read_logo_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ReadEnvLogoResponse>, Integer, Hash)> read_logo_with_http_info
+
+```ruby
+begin
+  # Read logo details
+  data, status_code, headers = api_instance.read_logo_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ReadEnvLogoResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling EnvironmentsApi->read_logo_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ReadEnvLogoResponse**](ReadEnvLogoResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## update_environement_feature_flag_override
 
 > <SuccessResponse> update_environement_feature_flag_override(feature_flag_key, update_environement_feature_flag_override_request)
 
 Update Environment Feature Flag Override
 
-Update environment feature flag override.
+Update environment feature flag override.  <div>   <code>update:environment_feature_flags</code> </div> 
 
 ### Examples
 

data/kinde_api/docs/EventType.md

@@ -0,0 +1,26 @@
+# KindeApi::EventType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **code** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **origin** | **String** |  | [optional] |
+| **schema** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::EventType.new(
+  id: null,
+  code: null,
+  name: null,
+  origin: null,
+  schema: null
+)
+```
+

data/kinde_api/docs/FeatureFlagsApi.md

@@ -1,6 +1,6 @@
 # KindeApi::FeatureFlagsApi
 
-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 Feature Flag
 
-Create feature flag.
+Create feature flag.  <div>   <code>create:feature_flags</code> </div> 
 
 ### Examples
 
@@ -84,7 +84,7 @@ end
 
 Delete Feature Flag
 
-Delete feature flag
+Delete feature flag  <div>   <code>delete:feature_flags</code> </div> 
 
 ### Examples
 
@@ -153,7 +153,7 @@ end
 
 Replace Feature Flag
 
-Update feature flag.
+Update feature flag.  <div>   <code>update:feature_flags</code> </div> 
 
 ### Examples
 

data/kinde_api/docs/GetApiResponse.md

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

data/kinde_api/docs/GetApiResponseApi.md

@@ -0,0 +1,28 @@
+# KindeApi::GetApiResponseApi
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID of the API. | [optional] |
+| **name** | **String** | The API’s name. | [optional] |
+| **audience** | **String** | A unique identifier for the API - commonly the URL. This value will be used as the `audience` parameter in authorization claims. | [optional] |
+| **is_management_api** | **Boolean** | Whether or not it is the Kinde management API. | [optional] |
+| **scopes** | [**Array<GetApiResponseApiScopesInner>**](GetApiResponseApiScopesInner.md) |  | [optional] |
+| **applications** | [**Array<GetApiResponseApiApplicationsInner>**](GetApiResponseApiApplicationsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetApiResponseApi.new(
+  id: 7ccd126599aa422a771abcb341596881,
+  name: Example API,
+  audience: https://api.example.com,
+  is_management_api: false,
+  scopes: null,
+  applications: null
+)
+```
+

data/kinde_api/docs/GetApiResponseApiApplicationsInner.md

@@ -0,0 +1,24 @@
+# KindeApi::GetApiResponseApiApplicationsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Client ID of the application. | [optional] |
+| **name** | **String** | The application's name. | [optional] |
+| **type** | **String** | The application's type. | [optional] |
+| **is_active** | **Boolean** | Whether or not the application is authorized to access the API | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetApiResponseApiApplicationsInner.new(
+  id: 3b0b5c6c8fcc464fab397f4969b5f482,
+  name: My M2M app,
+  type: Machine to machine (M2M),
+  is_active: true
+)
+```
+

data/kinde_api/docs/GetApiResponseApiScopesInner.md

@@ -0,0 +1,20 @@
+# KindeApi::GetApiResponseApiScopesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the scope. | [optional] |
+| **key** | **String** | The reference key for the scope. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetApiResponseApiScopesInner.new(
+  id: api_scope_01939222ef24200668b9f5829af001ce,
+  key: read:logs
+)
+```
+

data/kinde_api/docs/GetApiScopeResponse.md

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

data/kinde_api/docs/GetApiScopesResponse.md

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

data/kinde_api/docs/GetApiScopesResponseScopesInner.md

@@ -0,0 +1,22 @@
+# KindeApi::GetApiScopesResponseScopesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID of the API scope. | [optional] |
+| **key** | **String** | The scope's reference key. | [optional] |
+| **description** | **String** | Explanation of the scope purpose. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetApiScopesResponseScopesInner.new(
+  id: api_scope_01939128c3d7193ae87c4755213c07c6,
+  key: read:logs,
+  description: Read logs scope
+)
+```
+

data/kinde_api/docs/GetApisResponse.md

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

data/kinde_api/docs/GetApisResponseApisInner.md

@@ -0,0 +1,26 @@
+# KindeApi::GetApisResponseApisInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID for the API. | [optional] |
+| **name** | **String** | The API’s name. | [optional] |
+| **audience** | **String** | A unique identifier for the API - commonly the URL. This value will be used as the `audience` parameter in authorization claims. | [optional] |
+| **is_management_api** | **Boolean** | Whether or not it is the Kinde management API. | [optional] |
+| **scopes** | [**Array<GetApisResponseApisInnerScopesInner>**](GetApisResponseApisInnerScopesInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetApisResponseApisInner.new(
+  id: 7ccd126599aa422a771abcb341596881,
+  name: Example API,
+  audience: https://api.example.com,
+  is_management_api: false,
+  scopes: null
+)
+```
+

data/kinde_api/docs/GetApisResponseApisInnerScopesInner.md

@@ -0,0 +1,20 @@
+# KindeApi::GetApisResponseApisInnerScopesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **key** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetApisResponseApisInnerScopesInner.new(
+  id: api_scope_01939128c3d7193ae87c4755213c07c6,
+  key: create:apis
+)
+```
+

data/kinde_api/docs/GetApplicationResponseApplication.md

@@ -7,8 +7,11 @@
 | **id** | **String** | The application's identifier. | [optional] |
 | **name** | **String** | The application's name. | [optional] |
 | **type** | **String** | The application's type. | [optional] |
-| **client_id** | **String** | The application's client id. | [optional] |
+| **client_id** | **String** | The application's client ID. | [optional] |
 | **client_secret** | **String** | The application's client secret. | [optional] |
+| **login_uri** | **String** | The default login route for resolving session issues. | [optional] |
+| **homepage_uri** | **String** | The homepage link to your application. | [optional] |
+| **has_cancel_button** | **Boolean** | Whether the application has a cancel button to allow users to exit the auth flow [Beta]. | [optional] |
 
 ## Example
 
@@ -16,11 +19,14 @@
 require 'kinde_api'
 
 instance = KindeApi::GetApplicationResponseApplication.new(
-  id: null,
-  name: null,
+  id: 3b0b5c6c8fcc464fab397f4969b5f482,
+  name: My React app,
   type: null,
-  client_id: null,
-  client_secret: null
+  client_id: 3b0b5c6c8fcc464fab397f4969b5f482,
+  client_secret: sUJSHI3ZQEVTJkx6hOxdOSHaLsZkCBRFLzTNOI791rX8mDjgt7LC,
+  login_uri: https://yourapp.com/api/auth/login,
+  homepage_uri: https://yourapp.com,
+  has_cancel_button: false
 )
 ```
 

data/kinde_api/docs/GetBillingAgreementsResponse.md

@@ -0,0 +1,24 @@
+# KindeApi::GetBillingAgreementsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Response code. | [optional] |
+| **message** | **String** | Response message. | [optional] |
+| **has_more** | **Boolean** | Whether more records exist. | [optional] |
+| **agreements** | [**Array<GetBillingAgreementsResponseAgreementsInner>**](GetBillingAgreementsResponseAgreementsInner.md) | A list of billing agreements | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::GetBillingAgreementsResponse.new(
+  code: OK,
+  message: Success,
+  has_more: null,
+  agreements: null
+)
+```
+