kinde_sdk 1.1.1 → 1.2.0

data/kinde_api/docs/SubscribersApi.md

@@ -0,0 +1,229 @@
+# KindeApi::SubscribersApi
+
+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 |
+| [**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 |
+
+
+## create_subscriber
+
+> <CreateSubscriberSuccessResponse> create_subscriber(first_name, last_name, email)
+
+Create a new subscriber
+
+Create subscriber.
+
+### 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::SubscribersApi.new
+first_name = 'first_name_example' # String | Subscriber's first name.
+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
+  result = api_instance.create_subscriber(first_name, last_name, email)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling SubscribersApi->create_subscriber: #{e}"
+end
+```
+
+#### Using the create_subscriber_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSubscriberSuccessResponse>, Integer, Hash)> create_subscriber_with_http_info(first_name, last_name, email)
+
+```ruby
+begin
+  # Create a new subscriber
+  data, status_code, headers = api_instance.create_subscriber_with_http_info(first_name, last_name, email)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSubscriberSuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling SubscribersApi->create_subscriber_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | Subscriber&#39;s first name. |  |
+| **last_name** | **String** | Subscriber&#39;s last name. |  |
+| **email** | **String** | The email address of the subscriber. |  |
+
+### Return type
+
+[**CreateSubscriberSuccessResponse**](CreateSubscriberSuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## get_subscriber
+
+> <SuccessResponse> get_subscriber(subscriber_id)
+
+Get Subscriber
+
+Retrieve a subscriber record. 
+
+### 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::SubscribersApi.new
+subscriber_id = 'subscriber_id_example' # String | The subscriber's id.
+
+begin
+  # Get Subscriber
+  result = api_instance.get_subscriber(subscriber_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber: #{e}"
+end
+```
+
+#### Using the get_subscriber_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> get_subscriber_with_http_info(subscriber_id)
+
+```ruby
+begin
+  # Get Subscriber
+  data, status_code, headers = api_instance.get_subscriber_with_http_info(subscriber_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscriber_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscriber_id** | **String** | The subscriber&#39;s id. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## get_subscribers
+
+> <SuccessResponse> get_subscribers(opts)
+
+List Subscribers
+
+The returned list can be sorted by full name or email address in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query string parameter. 
+
+### 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::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.
+}
+
+begin
+  # List Subscribers
+  result = api_instance.get_subscribers(opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscribers: #{e}"
+end
+```
+
+#### Using the get_subscribers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> get_subscribers_with_http_info(opts)
+
+```ruby
+begin
+  # List Subscribers
+  data, status_code, headers = api_instance.get_subscribers_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling SubscribersApi->get_subscribers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| 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] |
+| **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)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+

data/kinde_api/docs/UpdateOrganizationRequest.md

@@ -0,0 +1,28 @@
+# KindeApi::UpdateOrganizationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The organization's name. | [optional] |
+| **external_id** | **String** | The organization's ID. | [optional] |
+| **background_color** | **String** | The organization's brand settings - background color. | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateOrganizationRequest.new(
+  name: null,
+  external_id: null,
+  background_color: null,
+  button_color: null,
+  button_text_color: null,
+  link_color: null
+)
+```
+

data/kinde_api/docs/UpdateOrganizationUsersRequest.md

@@ -0,0 +1,18 @@
+# KindeApi::UpdateOrganizationUsersRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **users** | [**Array<UpdateOrganizationUsersRequestUsersInner>**](UpdateOrganizationUsersRequestUsersInner.md) | Users to be added to the organization. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateOrganizationUsersRequest.new(
+  users: null
+)
+```
+

data/kinde_api/docs/UpdateOrganizationUsersRequestUsersInner.md

@@ -0,0 +1,24 @@
+# KindeApi::UpdateOrganizationUsersRequestUsersInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The users id. | [optional] |
+| **operation** | **String** | Optional operation, set to 'delete' to remove the user from the organization. | [optional] |
+| **roles** | **Array<String>** | Role keys to assign to the user. | [optional] |
+| **permissions** | **Array<String>** | Permission keys to assign to the user. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UpdateOrganizationUsersRequestUsersInner.new(
+  id: null,
+  operation: null,
+  roles: null,
+  permissions: null
+)
+```
+

data/kinde_api/docs/UpdateOrganizationUsersResponse.md

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

data/kinde_api/docs/UpdateUserRequest.md

@@ -7,6 +7,7 @@
 | **given_name** | **String** | User's first name. | [optional] |
 | **family_name** | **String** | User's last name. | [optional] |
 | **is_suspended** | **Boolean** | Whether the user is currently suspended or not. | [optional] |
+| **is_password_reset_requested** | **Boolean** | Prompt the user to change their password on next sign in. | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'kinde_api'
 instance = KindeApi::UpdateUserRequest.new(
   given_name: null,
   family_name: null,
-  is_suspended: null
+  is_suspended: null,
+  is_password_reset_requested: null
 )
 ```
 

data/kinde_api/docs/User.md

@@ -5,11 +5,18 @@
 | 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] |
+| **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] |
 
 ## Example
 
@@ -18,11 +25,18 @@ require 'kinde_api'
 
 instance = KindeApi::User.new(
   id: null,
+  provided_id: null,
   email: null,
   last_name: null,
   first_name: null,
+  full_name: null,
   is_suspended: null,
-  picture: null
+  picture: null,
+  is_password_reset_requested: null,
+  total_sign_ins: null,
+  failed_sign_ins: null,
+  last_signed_in: null,
+  created_on: null
 )
 ```
 

data/kinde_api/docs/UserIdentityResult.md

@@ -5,7 +5,6 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **created** | **Boolean** | True if the user identity was successfully created. | [optional] |
-| **identity_id** | **Integer** | Unique id of the user's identity in Kinde. | [optional] |
 
 ## Example
 
@@ -13,8 +12,7 @@
 require 'kinde_api'
 
 instance = KindeApi::UserIdentityResult.new(
-  created: null,
-  identity_id: null
+  created: null
 )
 ```
 

data/kinde_api/docs/UserProfile.md

@@ -9,6 +9,7 @@
 | **provided_id** | **String** | Value of the user's id in a third-party system when the user is imported into Kinde. | [optional] |
 | **last_name** | **String** | User's last name. | [optional] |
 | **first_name** | **String** | User's first name. | [optional] |
+| **picture** | **String** | URL that point's to the user's picture or avatar | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = KindeApi::UserProfile.new(
   preferred_email: null,
   provided_id: null,
   last_name: null,
-  first_name: null
+  first_name: null,
+  picture: null
 )
 ```
 

data/kinde_api/docs/UserProfileV2.md

@@ -4,13 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique id of the user in Kinde. | [optional] |
+| **id** | **String** | Unique id of the user in Kinde (deprecated). | [optional] |
+| **sub** | **String** | Unique id of the user in Kinde. | [optional] |
 | **provided_id** | **String** | Value of the user's id in a third-party system when the user is imported into Kinde. | [optional] |
 | **name** | **String** | Users's first and last name separated by a space. | [optional] |
 | **given_name** | **String** | User's first name. | [optional] |
 | **family_name** | **String** | User's last name. | [optional] |
 | **updated_at** | **Integer** | Date the user was last updated at (In Unix time). | [optional] |
 | **email** | **String** | User's email address if available. | [optional] |
+| **picture** | **String** | URL that point's to the user's picture or avatar | [optional] |
 
 ## Example
 
@@ -19,12 +21,14 @@ require 'kinde_api'
 
 instance = KindeApi::UserProfileV2.new(
   id: null,
+  sub: null,
   provided_id: null,
   name: null,
   given_name: null,
   family_name: null,
   updated_at: null,
-  email: null
+  email: null,
+  picture: null
 )
 ```