kinde_sdk 1.2.1 → 1.2.2

data/kinde_api/docs/UsersApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://app.kinde.com*
 | [**delete_user**](UsersApi.md#delete_user) | **DELETE** /api/v1/user | Delete User |
 | [**get_user_data**](UsersApi.md#get_user_data) | **GET** /api/v1/user | Get User |
 | [**get_users**](UsersApi.md#get_users) | **GET** /api/v1/users | List Users |
+| [**refresh_user_claims**](UsersApi.md#refresh_user_claims) | **POST** /api/v1/users/{user_id}/refresh_claims | Refresh User Claims and Invalidate Cache |
 | [**update_user**](UsersApi.md#update_user) | **PATCH** /api/v1/user | Update User |
 
 
@@ -84,7 +85,7 @@ end
 
 ## delete_user
 
-> <SuccessResponse> delete_user(opts)
+> <SuccessResponse> delete_user(id, opts)
 
 Delete User
 
@@ -102,13 +103,14 @@ KindeApi.configure do |config|
 end
 
 api_instance = KindeApi::UsersApi.new
+id = 'id_example' # String | The user's id.
 opts = {
-  id: 'id_example' # String | The user's id.
+  is_delete_profile: true # Boolean | Delete all data and remove the user's profile from all of Kinde, including the subscriber list
 }
 
 begin
   # Delete User
-  result = api_instance.delete_user(opts)
+  result = api_instance.delete_user(id, opts)
   p result
 rescue KindeApi::ApiError => e
   puts "Error when calling UsersApi->delete_user: #{e}"
@@ -119,12 +121,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SuccessResponse>, Integer, Hash)> delete_user_with_http_info(opts)
+> <Array(<SuccessResponse>, Integer, Hash)> delete_user_with_http_info(id, opts)
 
 ```ruby
 begin
   # Delete User
-  data, status_code, headers = api_instance.delete_user_with_http_info(opts)
+  data, status_code, headers = api_instance.delete_user_with_http_info(id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SuccessResponse>
@@ -137,7 +139,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The user&#39;s id. | [optional] |
+| **id** | **String** | The user&#39;s id. |  |
+| **is_delete_profile** | **Boolean** | Delete all data and remove the user&#39;s profile from all of Kinde, including the subscriber list | [optional] |
 
 ### Return type
 
@@ -155,7 +158,7 @@ end
 
 ## get_user_data
 
-> <User> get_user_data(id)
+> <User> get_user_data(id, opts)
 
 Get User
 
@@ -174,10 +177,13 @@ end
 
 api_instance = KindeApi::UsersApi.new
 id = 'id_example' # String | The user's id.
+opts = {
+  expand: 'expand_example' # String | Specify additional data to retrieve. Use \"organizations\" and/or \"identities\".
+}
 
 begin
   # Get User
-  result = api_instance.get_user_data(id)
+  result = api_instance.get_user_data(id, opts)
   p result
 rescue KindeApi::ApiError => e
   puts "Error when calling UsersApi->get_user_data: #{e}"
@@ -188,12 +194,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<User>, Integer, Hash)> get_user_data_with_http_info(id)
+> <Array(<User>, Integer, Hash)> get_user_data_with_http_info(id, opts)
 
 ```ruby
 begin
   # Get User
-  data, status_code, headers = api_instance.get_user_data_with_http_info(id)
+  data, status_code, headers = api_instance.get_user_data_with_http_info(id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <User>
@@ -207,6 +213,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The user&#39;s id. |  |
+| **expand** | **String** | Specify additional data to retrieve. Use \&quot;organizations\&quot; and/or \&quot;identities\&quot;. | [optional] |
 
 ### Return type
 
@@ -247,7 +254,8 @@ opts = {
   page_size: 56, # Integer | Number of results per page. Defaults to 10 if parameter not sent.
   user_id: 'user_id_example', # String | ID of the user to filter by.
   next_token: 'next_token_example', # String | A string to get the next page of results if there are more results.
-  email: 'email_example' # String | Filter the results by email address. The query string should be comma separated and url encoded.
+  email: 'email_example', # String | Filter the results by email address. The query string should be comma separated and url encoded.
+  expand: 'expand_example' # String | Specify additional data to retrieve. Use \"organizations\" and/or \"identities\".
 }
 
 begin
@@ -286,6 +294,7 @@ end
 | **user_id** | **String** | ID of the user to filter by. | [optional] |
 | **next_token** | **String** | A string to get the next page of results if there are more results. | [optional] |
 | **email** | **String** | Filter the results by email address. The query string should be comma separated and url encoded. | [optional] |
+| **expand** | **String** | Specify additional data to retrieve. Use \&quot;organizations\&quot; and/or \&quot;identities\&quot;. | [optional] |
 
 ### Return type
 
@@ -301,9 +310,78 @@ end
 - **Accept**: application/json, application/json; charset=utf-8
 
 
+## refresh_user_claims
+
+> <SuccessResponse> refresh_user_claims(user_id)
+
+Refresh User Claims and Invalidate Cache
+
+Refreshes the user's claims and invalidates the current cache. 
+
+### 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::UsersApi.new
+user_id = 'user_id_example' # String | The id of the user whose claims needs to be updated.
+
+begin
+  # Refresh User Claims and Invalidate Cache
+  result = api_instance.refresh_user_claims(user_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling UsersApi->refresh_user_claims: #{e}"
+end
+```
+
+#### Using the refresh_user_claims_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> refresh_user_claims_with_http_info(user_id)
+
+```ruby
+begin
+  # Refresh User Claims and Invalidate Cache
+  data, status_code, headers = api_instance.refresh_user_claims_with_http_info(user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling UsersApi->refresh_user_claims_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The id of the user whose claims needs to be updated. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8, application/json
+
+
 ## update_user
 
-> <User> update_user(update_user_request, opts)
+> <UpdateUserResponse> update_user(update_user_request, opts)
 
 Update User
 
@@ -339,7 +417,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<User>, Integer, Hash)> update_user_with_http_info(update_user_request, opts)
+> <Array(<UpdateUserResponse>, Integer, Hash)> update_user_with_http_info(update_user_request, opts)
 
 ```ruby
 begin
@@ -347,7 +425,7 @@ begin
   data, status_code, headers = api_instance.update_user_with_http_info(update_user_request, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <User>
+  p data # => <UpdateUserResponse>
 rescue KindeApi::ApiError => e
   puts "Error when calling UsersApi->update_user_with_http_info: #{e}"
 end
@@ -362,7 +440,7 @@ end
 
 ### Return type
 
-[**User**](User.md)
+[**UpdateUserResponse**](UpdateUserResponse.md)
 
 ### Authorization
 

data/kinde_api/docs/UsersResponse.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **code** | **String** | Response code. | [optional] |
 | **message** | **String** | Response message. | [optional] |
-| **users** | [**Array<User>**](User.md) |  | [optional] |
+| **users** | [**Array<UsersResponseUsersInner>**](UsersResponseUsersInner.md) |  | [optional] |
 | **next_token** | **String** | Pagination token. | [optional] |
 
 ## Example

data/kinde_api/docs/UsersResponseUsersInner.md

@@ -0,0 +1,42 @@
+# KindeApi::UsersResponseUsersInner
+
+## Properties
+
+| 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] |
+| **is_suspended** | **Boolean** | Whether the user is currently suspended or not. | [optional] |
+| **picture** | **String** | User's profile picture URL. | [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] |
+| **organizations** | **Array<String>** | Array of organizations a user belongs to. | [optional] |
+| **identities** | [**Array<UserIdentitiesInner>**](UserIdentitiesInner.md) | Array of identities belonging to the user. | [optional] |
+
+## Example
+
+```ruby
+require 'kinde_api'
+
+instance = KindeApi::UsersResponseUsersInner.new(
+  id: null,
+  provided_id: null,
+  email: null,
+  last_name: null,
+  first_name: null,
+  is_suspended: null,
+  picture: null,
+  total_sign_ins: null,
+  failed_sign_ins: null,
+  last_signed_in: null,
+  created_on: null,
+  organizations: null,
+  identities: null
+)
+```
+

data/kinde_api/lib/kinde_api/api/apis_api.rb

@@ -0,0 +1,347 @@
+=begin
+#Kinde Management API
+
+#Provides endpoints to manage your Kinde Businesses
+
+The version of the OpenAPI document: 1
+Contact: support@kinde.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'cgi'
+
+module KindeApi
+  class APIsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Add APIs
+    # Add APIs. 
+    # @param add_apis_request [AddAPIsRequest] API details.
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResponse]
+    def add_apis(add_apis_request, opts = {})
+      data, _status_code, _headers = add_apis_with_http_info(add_apis_request, opts)
+      data
+    end
+
+    # Add APIs
+    # Add APIs. 
+    # @param add_apis_request [AddAPIsRequest] API details.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
+    def add_apis_with_http_info(add_apis_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIsApi.add_apis ...'
+      end
+      # verify the required parameter 'add_apis_request' is set
+      if @api_client.config.client_side_validation && add_apis_request.nil?
+        fail ArgumentError, "Missing the required parameter 'add_apis_request' when calling APIsApi.add_apis"
+      end
+      # resource path
+      local_var_path = '/api/v1/apis'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8', 'application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(add_apis_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['kindeBearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIsApi.add_apis",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIsApi#add_apis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete API
+    # Deletes API. 
+    # @param api_id [String] The API&#39;s id.
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResponse]
+    def delete_api(api_id, opts = {})
+      data, _status_code, _headers = delete_api_with_http_info(api_id, opts)
+      data
+    end
+
+    # Delete API
+    # Deletes API. 
+    # @param api_id [String] The API&#39;s id.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
+    def delete_api_with_http_info(api_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIsApi.delete_api ...'
+      end
+      # verify the required parameter 'api_id' is set
+      if @api_client.config.client_side_validation && api_id.nil?
+        fail ArgumentError, "Missing the required parameter 'api_id' when calling APIsApi.delete_api"
+      end
+      # resource path
+      local_var_path = '/api/v1/apis/{api_id}'.sub('{' + 'api_id' + '}', CGI.escape(api_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8', 'application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['kindeBearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIsApi.delete_api",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIsApi#delete_api\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List API details
+    # Returns the details of the API. 
+    # @param api_id [String] The API&#39;s id.
+    # @param [Hash] opts the optional parameters
+    # @return [Api]
+    def get_api(api_id, opts = {})
+      data, _status_code, _headers = get_api_with_http_info(api_id, opts)
+      data
+    end
+
+    # List API details
+    # Returns the details of the API. 
+    # @param api_id [String] The API&#39;s id.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Api, Integer, Hash)>] Api data, response status code and response headers
+    def get_api_with_http_info(api_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIsApi.get_api ...'
+      end
+      # verify the required parameter 'api_id' is set
+      if @api_client.config.client_side_validation && api_id.nil?
+        fail ArgumentError, "Missing the required parameter 'api_id' when calling APIsApi.get_api"
+      end
+      # resource path
+      local_var_path = '/api/v1/apis/{api_id}'.sub('{' + 'api_id' + '}', CGI.escape(api_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8', 'application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Api'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['kindeBearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIsApi.get_api",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIsApi#get_api\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List APIs
+    # Returns a list of APIs. 
+    # @param [Hash] opts the optional parameters
+    # @return [Apis]
+    def get_apis(opts = {})
+      data, _status_code, _headers = get_apis_with_http_info(opts)
+      data
+    end
+
+    # List APIs
+    # Returns a list of APIs. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Apis, Integer, Hash)>] Apis data, response status code and response headers
+    def get_apis_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIsApi.get_apis ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/apis'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8', 'application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Apis'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['kindeBearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIsApi.get_apis",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIsApi#get_apis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update API Applications
+    # Update the applications under that API. 
+    # @param api_id [String] The identifier for the API.
+    # @param update_api_applications_request [UpdateAPIApplicationsRequest] The applications you want to connect or disconnect.
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResponse]
+    def update_api_applications(api_id, update_api_applications_request, opts = {})
+      data, _status_code, _headers = update_api_applications_with_http_info(api_id, update_api_applications_request, opts)
+      data
+    end
+
+    # Update API Applications
+    # Update the applications under that API. 
+    # @param api_id [String] The identifier for the API.
+    # @param update_api_applications_request [UpdateAPIApplicationsRequest] The applications you want to connect or disconnect.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
+    def update_api_applications_with_http_info(api_id, update_api_applications_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIsApi.update_api_applications ...'
+      end
+      # verify the required parameter 'api_id' is set
+      if @api_client.config.client_side_validation && api_id.nil?
+        fail ArgumentError, "Missing the required parameter 'api_id' when calling APIsApi.update_api_applications"
+      end
+      # verify the required parameter 'update_api_applications_request' is set
+      if @api_client.config.client_side_validation && update_api_applications_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_api_applications_request' when calling APIsApi.update_api_applications"
+      end
+      # resource path
+      local_var_path = '/api/v1/apis/{api_id}/applications'.sub('{' + 'api_id' + '}', CGI.escape(api_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8', 'application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_api_applications_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['kindeBearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIsApi.update_api_applications",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIsApi#update_api_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end