kinde_sdk 1.6.3 → 1.6.5

data/kinde_api/docs/BillingAgreementsApi.md

@@ -0,0 +1,157 @@
+# KindeApi::BillingAgreementsApi
+
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_billing_agreement**](BillingAgreementsApi.md#create_billing_agreement) | **POST** /api/v1/billing/agreements | Create billing agreement |
+| [**get_billing_agreements**](BillingAgreementsApi.md#get_billing_agreements) | **GET** /api/v1/billing/agreements | Get billing agreements |
+
+
+## create_billing_agreement
+
+> <SuccessResponse> create_billing_agreement(create_billing_agreement_request)
+
+Create billing agreement
+
+Creates a new billing agreement based on the plan code passed, and cancels the customer's existing agreements  <div>   <code>create:billing_agreements</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::BillingAgreementsApi.new
+create_billing_agreement_request = KindeApi::CreateBillingAgreementRequest.new({customer_id: 'customer_0195ac80a14c2ca2cec97d026d864de0', plan_code: 'pro'}) # CreateBillingAgreementRequest | New agreement request values
+
+begin
+  # Create billing agreement
+  result = api_instance.create_billing_agreement(create_billing_agreement_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling BillingAgreementsApi->create_billing_agreement: #{e}"
+end
+```
+
+#### Using the create_billing_agreement_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> create_billing_agreement_with_http_info(create_billing_agreement_request)
+
+```ruby
+begin
+  # Create billing agreement
+  data, status_code, headers = api_instance.create_billing_agreement_with_http_info(create_billing_agreement_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling BillingAgreementsApi->create_billing_agreement_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_billing_agreement_request** | [**CreateBillingAgreementRequest**](CreateBillingAgreementRequest.md) | New agreement request values |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_billing_agreements
+
+> <GetBillingAgreementsResponse> get_billing_agreements(customer_id, opts)
+
+Get billing agreements
+
+Returns all the agreements a billing customer currently has access to  <div>   <code>read:billing_agreements</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::BillingAgreementsApi.new
+customer_id = 'customer_0195ac80a14c2ca2cec97d026d864de0' # String | The ID of the billing customer to retrieve agreements for
+opts = {
+  page_size: 56, # Integer | Number of results per page. Defaults to 10 if parameter not sent.
+  starting_after: 'starting_after_example', # String | The ID of the billing agreement to start after.
+  ending_before: 'ending_before_example', # String | The ID of the billing agreement to end before.
+  feature_code: 'feature_code_example' # String | The feature code to filter by agreements only containing that feature
+}
+
+begin
+  # Get billing agreements
+  result = api_instance.get_billing_agreements(customer_id, opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling BillingAgreementsApi->get_billing_agreements: #{e}"
+end
+```
+
+#### Using the get_billing_agreements_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetBillingAgreementsResponse>, Integer, Hash)> get_billing_agreements_with_http_info(customer_id, opts)
+
+```ruby
+begin
+  # Get billing agreements
+  data, status_code, headers = api_instance.get_billing_agreements_with_http_info(customer_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetBillingAgreementsResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling BillingAgreementsApi->get_billing_agreements_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** | The ID of the billing customer to retrieve agreements for |  |
+| **page_size** | **Integer** | Number of results per page. Defaults to 10 if parameter not sent. | [optional] |
+| **starting_after** | **String** | The ID of the billing agreement to start after. | [optional] |
+| **ending_before** | **String** | The ID of the billing agreement to end before. | [optional] |
+| **feature_code** | **String** | The feature code to filter by agreements only containing that feature | [optional] |
+
+### Return type
+
+[**GetBillingAgreementsResponse**](GetBillingAgreementsResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8, application/json
+

data/kinde_api/docs/BillingEntitlementsApi.md

@@ -0,0 +1,89 @@
+# KindeApi::BillingEntitlementsApi
+
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_billing_entitlements**](BillingEntitlementsApi.md#get_billing_entitlements) | **GET** /api/v1/billing/entitlements | Get billing entitlements |
+
+
+## get_billing_entitlements
+
+> <GetBillingEntitlementsResponse> get_billing_entitlements(customer_id, opts)
+
+Get billing entitlements
+
+Returns all the entitlements a billing customer currently has access to  <div>   <code>read:billing_entitlements</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::BillingEntitlementsApi.new
+customer_id = 'customer_id_example' # String | The ID of the billing customer to retrieve entitlements for
+opts = {
+  page_size: 56, # Integer | Number of results per page. Defaults to 10 if parameter not sent.
+  starting_after: 'starting_after_example', # String | The ID of the billing entitlement to start after.
+  ending_before: 'ending_before_example', # String | The ID of the billing entitlement to end before.
+  max_value: 'max_value_example', # String | When the maximum limit of an entitlement is null, this value is returned as the maximum limit
+  expand: 'plans' # String | Specify additional plan data to retrieve. Use \"plans\".
+}
+
+begin
+  # Get billing entitlements
+  result = api_instance.get_billing_entitlements(customer_id, opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling BillingEntitlementsApi->get_billing_entitlements: #{e}"
+end
+```
+
+#### Using the get_billing_entitlements_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetBillingEntitlementsResponse>, Integer, Hash)> get_billing_entitlements_with_http_info(customer_id, opts)
+
+```ruby
+begin
+  # Get billing entitlements
+  data, status_code, headers = api_instance.get_billing_entitlements_with_http_info(customer_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetBillingEntitlementsResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling BillingEntitlementsApi->get_billing_entitlements_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** | The ID of the billing customer to retrieve entitlements for |  |
+| **page_size** | **Integer** | Number of results per page. Defaults to 10 if parameter not sent. | [optional] |
+| **starting_after** | **String** | The ID of the billing entitlement to start after. | [optional] |
+| **ending_before** | **String** | The ID of the billing entitlement to end before. | [optional] |
+| **max_value** | **String** | When the maximum limit of an entitlement is null, this value is returned as the maximum limit | [optional] |
+| **expand** | **String** | Specify additional plan data to retrieve. Use \&quot;plans\&quot;. | [optional] |
+
+### Return type
+
+[**GetBillingEntitlementsResponse**](GetBillingEntitlementsResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8, application/json
+

data/kinde_api/docs/BillingMeterUsageApi.md

@@ -0,0 +1,77 @@
+# KindeApi::BillingMeterUsageApi
+
+All URIs are relative to *https://your_kinde_subdomain.kinde.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_meter_usage_record**](BillingMeterUsageApi.md#create_meter_usage_record) | **POST** /api/v1/billing/meter_usage | Create meter usage record |
+
+
+## create_meter_usage_record
+
+> <CreateMeterUsageRecordResponse> create_meter_usage_record(create_meter_usage_record_request)
+
+Create meter usage record
+
+Create a new meter usage record  <div>   <code>create:meter_usage</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::BillingMeterUsageApi.new
+create_meter_usage_record_request = KindeApi::CreateMeterUsageRecordRequest.new({customer_agreement_id: 'agreement_0195ac80a14c2ca2cec97d026d864de0', billing_feature_code: 'pro_gym', meter_value: 'pro_gym'}) # CreateMeterUsageRecordRequest | Meter usage record
+
+begin
+  # Create meter usage record
+  result = api_instance.create_meter_usage_record(create_meter_usage_record_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling BillingMeterUsageApi->create_meter_usage_record: #{e}"
+end
+```
+
+#### Using the create_meter_usage_record_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateMeterUsageRecordResponse>, Integer, Hash)> create_meter_usage_record_with_http_info(create_meter_usage_record_request)
+
+```ruby
+begin
+  # Create meter usage record
+  data, status_code, headers = api_instance.create_meter_usage_record_with_http_info(create_meter_usage_record_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateMeterUsageRecordResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling BillingMeterUsageApi->create_meter_usage_record_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_meter_usage_record_request** | [**CreateMeterUsageRecordRequest**](CreateMeterUsageRecordRequest.md) | Meter usage record |  |
+
+### Return type
+
+[**CreateMeterUsageRecordResponse**](CreateMeterUsageRecordResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/kinde_api/docs/BusinessApi.md

@@ -1,20 +1,20 @@
 # KindeApi::BusinessApi
 
-All URIs are relative to *https://app.kinde.com*
+All URIs are relative to *https://your_kinde_subdomain.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**](BusinessApi.md#get_business) | **GET** /api/v1/business | Get business |
+| [**update_business**](BusinessApi.md#update_business) | **PATCH** /api/v1/business | Update business |
 
 
 ## get_business
 
-> <SuccessResponse> get_business(code, name, email, opts)
+> <GetBusinessResponse> get_business
 
-List business details
+Get business
 
-Get your business details.
+Get your business details.  <div>   <code>read:businesses</code> </div> 
 
 ### Examples
 
@@ -28,20 +28,10 @@ KindeApi.configure do |config|
 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)
+  # Get business
+  result = api_instance.get_business
   p result
 rescue KindeApi::ApiError => e
   puts "Error when calling BusinessApi->get_business: #{e}"
@@ -52,15 +42,15 @@ end
 
 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)
+> <Array(<GetBusinessResponse>, Integer, Hash)> get_business_with_http_info
 
 ```ruby
 begin
-  # List business details
-  data, status_code, headers = api_instance.get_business_with_http_info(code, name, email, opts)
+  # Get business
+  data, status_code, headers = api_instance.get_business_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SuccessResponse>
+  p data # => <GetBusinessResponse>
 rescue KindeApi::ApiError => e
   puts "Error when calling BusinessApi->get_business_with_http_info: #{e}"
 end
@@ -68,20 +58,11 @@ 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] |
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**SuccessResponse**](SuccessResponse.md)
+[**GetBusinessResponse**](GetBusinessResponse.md)
 
 ### Authorization
 
@@ -90,16 +71,16 @@ end
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json; charset=utf-8
+- **Accept**: application/json
 
 
 ## update_business
 
-> <SuccessResponse> update_business(business_name, primary_email, opts)
+> <SuccessResponse> update_business(update_business_request)
 
-Update business details
+Update business
 
-Update business details.
+Update your business details.  <div>   <code>update:businesses</code> </div> 
 
 ### Examples
 
@@ -113,22 +94,11 @@ KindeApi.configure do |config|
 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.
-}
+update_business_request = KindeApi::UpdateBusinessRequest.new # UpdateBusinessRequest | The business details to update.
 
 begin
-  # Update business details
-  result = api_instance.update_business(business_name, primary_email, opts)
+  # Update business
+  result = api_instance.update_business(update_business_request)
   p result
 rescue KindeApi::ApiError => e
   puts "Error when calling BusinessApi->update_business: #{e}"
@@ -139,12 +109,12 @@ end
 
 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)
+> <Array(<SuccessResponse>, Integer, Hash)> update_business_with_http_info(update_business_request)
 
 ```ruby
 begin
-  # Update business details
-  data, status_code, headers = api_instance.update_business_with_http_info(business_name, primary_email, opts)
+  # Update business
+  data, status_code, headers = api_instance.update_business_with_http_info(update_business_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SuccessResponse>
@@ -157,16 +127,7 @@ end
 
 | 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] |
+| **update_business_request** | [**UpdateBusinessRequest**](UpdateBusinessRequest.md) | The business details to update. |  |
 
 ### Return type
 
@@ -178,6 +139,6 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json; charset=utf-8
+- **Content-Type**: application/json
+- **Accept**: application/json