kinde_sdk 1.6.4 → 1.6.6

data/kinde_api/docs/ConnectionsApi.md

@@ -0,0 +1,439 @@
+# KindeApi::ConnectionsApi
+
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_connection**](ConnectionsApi.md#create_connection) | **POST** /api/v1/connections | Create Connection |
+| [**delete_connection**](ConnectionsApi.md#delete_connection) | **DELETE** /api/v1/connections/{connection_id} | Delete Connection |
+| [**get_connection**](ConnectionsApi.md#get_connection) | **GET** /api/v1/connections/{connection_id} | Get Connection |
+| [**get_connections**](ConnectionsApi.md#get_connections) | **GET** /api/v1/connections | Get connections |
+| [**replace_connection**](ConnectionsApi.md#replace_connection) | **PUT** /api/v1/connections/{connection_id} | Replace Connection |
+| [**update_connection**](ConnectionsApi.md#update_connection) | **PATCH** /api/v1/connections/{connection_id} | Update Connection |
+
+
+## create_connection
+
+> <CreateConnectionResponse> create_connection(create_connection_request)
+
+Create Connection
+
+Create Connection.  <div>   <code>create:connections</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::ConnectionsApi.new
+create_connection_request = KindeApi::CreateConnectionRequest.new # CreateConnectionRequest | Connection details.
+
+begin
+  # Create Connection
+  result = api_instance.create_connection(create_connection_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->create_connection: #{e}"
+end
+```
+
+#### Using the create_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateConnectionResponse>, Integer, Hash)> create_connection_with_http_info(create_connection_request)
+
+```ruby
+begin
+  # Create Connection
+  data, status_code, headers = api_instance.create_connection_with_http_info(create_connection_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateConnectionResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->create_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_connection_request** | [**CreateConnectionRequest**](CreateConnectionRequest.md) | Connection details. |  |
+
+### Return type
+
+[**CreateConnectionResponse**](CreateConnectionResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_connection
+
+> <SuccessResponse> delete_connection(connection_id)
+
+Delete Connection
+
+Delete connection.  <div>   <code>delete:connections</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::ConnectionsApi.new
+connection_id = 'connection_id_example' # String | The identifier for the connection.
+
+begin
+  # Delete Connection
+  result = api_instance.delete_connection(connection_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->delete_connection: #{e}"
+end
+```
+
+#### Using the delete_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> delete_connection_with_http_info(connection_id)
+
+```ruby
+begin
+  # Delete Connection
+  data, status_code, headers = api_instance.delete_connection_with_http_info(connection_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->delete_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connection_id** | **String** | The identifier for the connection. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_connection
+
+> <Connection> get_connection(connection_id)
+
+Get Connection
+
+Get Connection.  <div>   <code>read:connections</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::ConnectionsApi.new
+connection_id = 'connection_id_example' # String | The unique identifier for the connection.
+
+begin
+  # Get Connection
+  result = api_instance.get_connection(connection_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->get_connection: #{e}"
+end
+```
+
+#### Using the get_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Connection>, Integer, Hash)> get_connection_with_http_info(connection_id)
+
+```ruby
+begin
+  # Get Connection
+  data, status_code, headers = api_instance.get_connection_with_http_info(connection_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Connection>
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->get_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connection_id** | **String** | The unique identifier for the connection. |  |
+
+### Return type
+
+[**Connection**](Connection.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_connections
+
+> <GetConnectionsResponse> get_connections(opts)
+
+Get connections
+
+Returns a list of authentication connections. Optionally you can filter this by a home realm domain.  <div>   <code>read:connections</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::ConnectionsApi.new
+opts = {
+  page_size: 56, # Integer | Number of results per page. Defaults to 10 if parameter not sent.
+  home_realm_domain: 'myapp.com', # String | Filter the results by the home realm domain.
+  starting_after: 'starting_after_example', # String | The ID of the connection to start after.
+  ending_before: 'ending_before_example' # String | The ID of the connection to end before.
+}
+
+begin
+  # Get connections
+  result = api_instance.get_connections(opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->get_connections: #{e}"
+end
+```
+
+#### Using the get_connections_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetConnectionsResponse>, Integer, Hash)> get_connections_with_http_info(opts)
+
+```ruby
+begin
+  # Get connections
+  data, status_code, headers = api_instance.get_connections_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetConnectionsResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->get_connections_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] |
+| **home_realm_domain** | **String** | Filter the results by the home realm domain. | [optional] |
+| **starting_after** | **String** | The ID of the connection to start after. | [optional] |
+| **ending_before** | **String** | The ID of the connection to end before. | [optional] |
+
+### Return type
+
+[**GetConnectionsResponse**](GetConnectionsResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8, application/json
+
+
+## replace_connection
+
+> <SuccessResponse> replace_connection(connection_id, replace_connection_request)
+
+Replace Connection
+
+Replace Connection Config.  <div>   <code>update:connections</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::ConnectionsApi.new
+connection_id = 'connection_id_example' # String | The unique identifier for the connection.
+replace_connection_request = KindeApi::ReplaceConnectionRequest.new # ReplaceConnectionRequest | The complete connection configuration to replace the existing one.
+
+begin
+  # Replace Connection
+  result = api_instance.replace_connection(connection_id, replace_connection_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->replace_connection: #{e}"
+end
+```
+
+#### Using the replace_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> replace_connection_with_http_info(connection_id, replace_connection_request)
+
+```ruby
+begin
+  # Replace Connection
+  data, status_code, headers = api_instance.replace_connection_with_http_info(connection_id, replace_connection_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->replace_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connection_id** | **String** | The unique identifier for the connection. |  |
+| **replace_connection_request** | [**ReplaceConnectionRequest**](ReplaceConnectionRequest.md) | The complete connection configuration to replace the existing one. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_connection
+
+> <SuccessResponse> update_connection(connection_id, update_connection_request)
+
+Update Connection
+
+Update Connection.  <div>   <code>update:connections</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::ConnectionsApi.new
+connection_id = 'connection_id_example' # String | The unique identifier for the connection.
+update_connection_request = KindeApi::UpdateConnectionRequest.new # UpdateConnectionRequest | The fields of the connection to update.
+
+begin
+  # Update Connection
+  result = api_instance.update_connection(connection_id, update_connection_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->update_connection: #{e}"
+end
+```
+
+#### Using the update_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> update_connection_with_http_info(connection_id, update_connection_request)
+
+```ruby
+begin
+  # Update Connection
+  data, status_code, headers = api_instance.update_connection_with_http_info(connection_id, update_connection_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling ConnectionsApi->update_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connection_id** | **String** | The unique identifier for the connection. |  |
+| **update_connection_request** | [**UpdateConnectionRequest**](UpdateConnectionRequest.md) | The fields of the connection to update. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/kinde_api/docs/CreateApiScopesResponse.md

@@ -0,0 +1,22 @@
+# KindeApi::CreateApiScopesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | A Kinde generated message. | [optional] |
+| **code** | **String** | A Kinde generated status code. | [optional] |
+| **scope** | [**CreateApiScopesResponseScope**](CreateApiScopesResponseScope.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::CreateApiScopesResponse.new(
+  message: Success,
+  code: OK,
+  scope: null
+)
+```
+

data/kinde_api/docs/CreateApiScopesResponseScope.md

@@ -0,0 +1,18 @@
+# KindeApi::CreateApiScopesResponseScope
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID for the API scope. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::CreateApiScopesResponseScope.new(
+  id: api_scope_0193ab57965aef77b2b687d0ef673713
+)
+```
+

data/kinde_api/docs/CreateApisResponse.md

@@ -0,0 +1,22 @@
+# KindeApi::CreateApisResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | A Kinde generated message. | [optional] |
+| **code** | **String** | A Kinde generated status code. | [optional] |
+| **api** | [**CreateApisResponseApi**](CreateApisResponseApi.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::CreateApisResponse.new(
+  message: Success,
+  code: OK,
+  api: null
+)
+```
+

data/kinde_api/docs/CreateApisResponseApi.md

@@ -0,0 +1,18 @@
+# KindeApi::CreateApisResponseApi
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID for the API. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::CreateApisResponseApi.new(
+  id: 7ccd126599aa422a771abcb341596881
+)
+```
+

data/kinde_api/docs/CreateApplicationRequest.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | The application's name. | [optional] |
-| **type** | **String** | The application's type. | [optional] |
+| **name** | **String** | The application's name. |  |
+| **type** | **String** | The application's type. Use `reg` for regular server rendered applications, `spa` for single-page applications, and `m2m` for machine-to-machine applications. |  |
 
 ## Example
 
@@ -13,7 +13,7 @@
 require 'kinde_api'
 
 instance = KindeApi::CreateApplicationRequest.new(
-  name: null,
+  name: React Native app,
   type: null
 )
 ```

data/kinde_api/docs/CreateApplicationResponseApplication.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The application's identifier. | [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] |
 
 ## Example
@@ -14,9 +14,9 @@
 require 'kinde_api'
 
 instance = KindeApi::CreateApplicationResponseApplication.new(
-  id: null,
-  client_id: null,
-  client_secret: null
+  id: 3b0b5c6c8fcc464fab397f4969b5f482,
+  client_id: 3b0b5c6c8fcc464fab397f4969b5f482,
+  client_secret: sUJSHI3ZQEVTJkx6hOxdOSHaLsZkCBRFLzTNOI791rX8mDjgt7LC
 )
 ```
 

data/kinde_api/docs/CreateBillingAgreementRequest.md

@@ -0,0 +1,24 @@
+# KindeApi::CreateBillingAgreementRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** | The ID of the billing customer to create a new agreement for |  |
+| **plan_code** | **String** | The code of the billing plan the new agreement will be based on |  |
+| **is_invoice_now** | **Boolean** | Generate a final invoice for any un-invoiced metered usage. | [optional] |
+| **is_prorate** | **Boolean** | Generate a proration invoice item that credits remaining unused features. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::CreateBillingAgreementRequest.new(
+  customer_id: customer_0195ac80a14c2ca2cec97d026d864de0,
+  plan_code: pro,
+  is_invoice_now: true,
+  is_prorate: true
+)
+```
+

data/kinde_api/docs/CreateCategoryRequest.md

@@ -0,0 +1,20 @@
+# KindeApi::CreateCategoryRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the category. |  |
+| **context** | **String** | The context that the category applies to. |  |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::CreateCategoryRequest.new(
+  name: null,
+  context: null
+)
+```
+

data/kinde_api/docs/CreateCategoryResponse.md

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

data/kinde_api/docs/CreateCategoryResponseCategory.md

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

data/kinde_api/docs/CreateConnectionRequest.md

@@ -0,0 +1,28 @@
+# KindeApi::CreateConnectionRequest
+
+## 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] |
+| **strategy** | **String** | The identity provider identifier for the connection. | [optional] |
+| **enabled_applications** | **Array<String>** | Client IDs of applications in which this connection is to be enabled. | [optional] |
+| **organization_code** | **String** | Enterprise connections only - the code for organization that manages this connection. | [optional] |
+| **options** | [**CreateConnectionRequestOptions**](CreateConnectionRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::CreateConnectionRequest.new(
+  name: null,
+  display_name: null,
+  strategy: null,
+  enabled_applications: null,
+  organization_code: org_80581732fbe,
+  options: null
+)
+```
+