kinde_sdk 1.2.1 → 1.2.2

data/kinde_api/docs/Apis.md

@@ -0,0 +1,24 @@
+# KindeApi::Apis
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique id of the API. | [optional] |
+| **name** | **String** | The API's name. | [optional] |
+| **audience** | **String** | The logical identifier for the API. | [optional] |
+| **is_management_api** | **Boolean** | Whether it is the management API or not. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::Apis.new(
+  id: null,
+  name: null,
+  audience: null,
+  is_management_api: null
+)
+```
+

data/kinde_api/docs/Applications.md

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

data/kinde_api/docs/ApplicationsApi.md

@@ -0,0 +1,368 @@
+# KindeApi::ApplicationsApi
+
+All URIs are relative to *https://app.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_application**](ApplicationsApi.md#create_application) | **POST** /api/v1/applications | Create Application |
+| [**delete_application**](ApplicationsApi.md#delete_application) | **DELETE** /api/v1/applications/{application_id} | Delete Application |
+| [**get_application**](ApplicationsApi.md#get_application) | **GET** /api/v1/applications/{application_id} | Get Application |
+| [**get_applications**](ApplicationsApi.md#get_applications) | **GET** /api/v1/applications | List Applications |
+| [**update_application**](ApplicationsApi.md#update_application) | **PATCH** /api/v1/applications/{application_id} | Update Application |
+
+
+## create_application
+
+> <CreateApplicationResponse> create_application(opts)
+
+Create Application
+
+Create an application.
+
+### 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::ApplicationsApi.new
+opts = {
+  create_application_request: KindeApi::CreateApplicationRequest.new # CreateApplicationRequest | Application details.
+}
+
+begin
+  # Create Application
+  result = api_instance.create_application(opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling ApplicationsApi->create_application: #{e}"
+end
+```
+
+#### Using the create_application_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateApplicationResponse>, Integer, Hash)> create_application_with_http_info(opts)
+
+```ruby
+begin
+  # Create Application
+  data, status_code, headers = api_instance.create_application_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateApplicationResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling ApplicationsApi->create_application_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_application_request** | [**CreateApplicationRequest**](CreateApplicationRequest.md) | Application details. | [optional] |
+
+### Return type
+
+[**CreateApplicationResponse**](CreateApplicationResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/json; charset=utf-8
+
+
+## delete_application
+
+> <SuccessResponse> delete_application(application_id)
+
+Delete Application
+
+Delete application. 
+
+### 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::ApplicationsApi.new
+application_id = 'application_id_example' # String | The identifier for the application.
+
+begin
+  # Delete Application
+  result = api_instance.delete_application(application_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling ApplicationsApi->delete_application: #{e}"
+end
+```
+
+#### Using the delete_application_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> delete_application_with_http_info(application_id)
+
+```ruby
+begin
+  # Delete Application
+  data, status_code, headers = api_instance.delete_application_with_http_info(application_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling ApplicationsApi->delete_application_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **application_id** | **String** | The identifier for the application. |  |
+
+### 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
+
+
+## get_application
+
+> <GetApplicationResponse> get_application(application_id)
+
+Get Application
+
+Gets an application given the application's id. 
+
+### 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::ApplicationsApi.new
+application_id = 'application_id_example' # String | The identifier for the application.
+
+begin
+  # Get Application
+  result = api_instance.get_application(application_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling ApplicationsApi->get_application: #{e}"
+end
+```
+
+#### Using the get_application_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetApplicationResponse>, Integer, Hash)> get_application_with_http_info(application_id)
+
+```ruby
+begin
+  # Get Application
+  data, status_code, headers = api_instance.get_application_with_http_info(application_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetApplicationResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling ApplicationsApi->get_application_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **application_id** | **String** | The identifier for the application. |  |
+
+### Return type
+
+[**GetApplicationResponse**](GetApplicationResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/json; charset=utf-8
+
+
+## get_applications
+
+> <GetApplicationsResponse> get_applications(opts)
+
+List Applications
+
+Get a list of applications. 
+
+### 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::ApplicationsApi.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.
+  next_token: 'next_token_example' # String | A string to get the next page of results if there are more results.
+}
+
+begin
+  # List Applications
+  result = api_instance.get_applications(opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling ApplicationsApi->get_applications: #{e}"
+end
+```
+
+#### Using the get_applications_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetApplicationsResponse>, Integer, Hash)> get_applications_with_http_info(opts)
+
+```ruby
+begin
+  # List Applications
+  data, status_code, headers = api_instance.get_applications_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetApplicationsResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling ApplicationsApi->get_applications_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] |
+| **next_token** | **String** | A string to get the next page of results if there are more results. | [optional] |
+
+### Return type
+
+[**GetApplicationsResponse**](GetApplicationsResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/json; charset=utf-8
+
+
+## update_application
+
+> update_application(application_id, opts)
+
+Update Application
+
+Update an application.
+
+### 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::ApplicationsApi.new
+application_id = 'application_id_example' # String | The identifier for the application.
+opts = {
+  update_application_request: KindeApi::UpdateApplicationRequest.new # UpdateApplicationRequest | Application details.
+}
+
+begin
+  # Update Application
+  api_instance.update_application(application_id, opts)
+rescue KindeApi::ApiError => e
+  puts "Error when calling ApplicationsApi->update_application: #{e}"
+end
+```
+
+#### Using the update_application_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> update_application_with_http_info(application_id, opts)
+
+```ruby
+begin
+  # Update Application
+  data, status_code, headers = api_instance.update_application_with_http_info(application_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue KindeApi::ApiError => e
+  puts "Error when calling ApplicationsApi->update_application_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **application_id** | **String** | The identifier for the application. |  |
+| **update_application_request** | [**UpdateApplicationRequest**](UpdateApplicationRequest.md) | Application details. | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/json; charset=utf-8
+

data/kinde_api/docs/BusinessApi.md

@@ -0,0 +1,183 @@
+# KindeApi::BusinessApi
+
+All URIs are relative to *https://app.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_business**](BusinessApi.md#get_business) | **GET** /api/v1/business | List business details |
+| [**update_business**](BusinessApi.md#update_business) | **PATCH** /api/v1/business | Update business details |
+
+
+## get_business
+
+> <SuccessResponse> get_business(code, name, email, opts)
+
+List business details
+
+Get your business details.
+
+### 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::BusinessApi.new
+code = 'code_example' # String | Business code.
+name = 'name_example' # String | Business name.
+email = 'email_example' # String | Email associated with business.
+opts = {
+  phone: 'phone_example', # String | Phone number associated with business.
+  industry: 'industry_example', # String | The industry your business is in.
+  timezone: 'timezone_example', # String | The timezone your business is in.
+  privacy_url: 'privacy_url_example', # String | Your Privacy policy URL.
+  terms_url: 'terms_url_example' # String | Your Terms and Conditions URL.
+}
+
+begin
+  # List business details
+  result = api_instance.get_business(code, name, email, opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling BusinessApi->get_business: #{e}"
+end
+```
+
+#### Using the get_business_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> get_business_with_http_info(code, name, email, opts)
+
+```ruby
+begin
+  # List business details
+  data, status_code, headers = api_instance.get_business_with_http_info(code, name, email, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling BusinessApi->get_business_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Business code. |  |
+| **name** | **String** | Business name. |  |
+| **email** | **String** | Email associated with business. |  |
+| **phone** | **String** | Phone number associated with business. | [optional] |
+| **industry** | **String** | The industry your business is in. | [optional] |
+| **timezone** | **String** | The timezone your business is in. | [optional] |
+| **privacy_url** | **String** | Your Privacy policy URL. | [optional] |
+| **terms_url** | **String** | Your Terms and Conditions URL. | [optional] |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## update_business
+
+> <SuccessResponse> update_business(business_name, primary_email, opts)
+
+Update business details
+
+Update business details.
+
+### 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::BusinessApi.new
+business_name = 'business_name_example' # String | Business name.
+primary_email = 'primary_email_example' # String | Email associated with business.
+opts = {
+  primary_phone: 'primary_phone_example', # String | Phone number associated with business.
+  industry_key: 'industry_key_example', # String | The key of the industry your business is in.
+  timezone_id: 'timezone_id_example', # String | The ID of the timezone your business is in.
+  privacy_url: 'privacy_url_example', # String | Your Privacy policy URL.
+  terms_url: 'terms_url_example', # String | Your Terms and Conditions URL.
+  is_show_kinde_branding: 'is_show_kinde_branding_example', # String | Display \"Powered by Kinde\" on your sign up, sign in, and subscription pages.
+  is_click_wrap: true, # Boolean | Show a policy acceptance checkbox on sign up.
+  partner_code: 'partner_code_example' # String | Your Kinde Perk code.
+}
+
+begin
+  # Update business details
+  result = api_instance.update_business(business_name, primary_email, opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling BusinessApi->update_business: #{e}"
+end
+```
+
+#### Using the update_business_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> update_business_with_http_info(business_name, primary_email, opts)
+
+```ruby
+begin
+  # Update business details
+  data, status_code, headers = api_instance.update_business_with_http_info(business_name, primary_email, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling BusinessApi->update_business_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **business_name** | **String** | Business name. |  |
+| **primary_email** | **String** | Email associated with business. |  |
+| **primary_phone** | **String** | Phone number associated with business. | [optional] |
+| **industry_key** | **String** | The key of the industry your business is in. | [optional] |
+| **timezone_id** | **String** | The ID of the timezone your business is in. | [optional] |
+| **privacy_url** | **String** | Your Privacy policy URL. | [optional] |
+| **terms_url** | **String** | Your Terms and Conditions URL. | [optional] |
+| **is_show_kinde_branding** | **String** | Display \&quot;Powered by Kinde\&quot; on your sign up, sign in, and subscription pages. | [optional] |
+| **is_click_wrap** | **Boolean** | Show a policy acceptance checkbox on sign up. | [optional] |
+| **partner_code** | **String** | Your Kinde Perk code. | [optional] |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+