kinde_sdk 1.2.1 → 1.2.2

data/kinde_api/docs/OrganizationsApi.md

@@ -6,19 +6,23 @@ All URIs are relative to *https://app.kinde.com*
 | ------ | ------------ | ----------- |
 | [**add_organization_users**](OrganizationsApi.md#add_organization_users) | **POST** /api/v1/organizations/{org_code}/users | Add Organization Users |
 | [**create_organization**](OrganizationsApi.md#create_organization) | **POST** /api/v1/organization | Create Organization |
+| [**create_organization_user_permission**](OrganizationsApi.md#create_organization_user_permission) | **POST** /api/v1/organizations/{org_code}/users/{user_id}/permissions | Add Organization User Permission |
 | [**create_organization_user_role**](OrganizationsApi.md#create_organization_user_role) | **POST** /api/v1/organizations/{org_code}/users/{user_id}/roles | Add Organization User Role |
-| [**delete_organization_feature_flag_override**](OrganizationsApi.md#delete_organization_feature_flag_override) | **DELETE** /api/v1/organizations/{org_code}/feature_flags/{feature_flag_key} | Delete organization feature flag override |
-| [**delete_organization_feature_flag_overrides**](OrganizationsApi.md#delete_organization_feature_flag_overrides) | **DELETE** /api/v1/organizations/{org_code}/feature_flags | Delete all organization feature flag overrides |
+| [**delete_organization**](OrganizationsApi.md#delete_organization) | **DELETE** /api/v1/organization/{org_code} | Delete Organization |
+| [**delete_organization_feature_flag_override**](OrganizationsApi.md#delete_organization_feature_flag_override) | **DELETE** /api/v1/organizations/{org_code}/feature_flags/{feature_flag_key} | Delete Organization Feature Flag Override |
+| [**delete_organization_feature_flag_overrides**](OrganizationsApi.md#delete_organization_feature_flag_overrides) | **DELETE** /api/v1/organizations/{org_code}/feature_flags | Delete Organization Feature Flag Overrides |
+| [**delete_organization_user_permission**](OrganizationsApi.md#delete_organization_user_permission) | **DELETE** /api/v1/organizations/{org_code}/users/{user_id}/permissions/{permission_id} | Delete Organization User Permission |
 | [**delete_organization_user_role**](OrganizationsApi.md#delete_organization_user_role) | **DELETE** /api/v1/organizations/{org_code}/users/{user_id}/roles/{role_id} | Delete Organization User Role |
 | [**get_organization**](OrganizationsApi.md#get_organization) | **GET** /api/v1/organization | Get Organization |
-| [**get_organization_feature_flags**](OrganizationsApi.md#get_organization_feature_flags) | **GET** /api/v1/organizations/{org_code}/feature_flags | List organization feature flags |
+| [**get_organization_feature_flags**](OrganizationsApi.md#get_organization_feature_flags) | **GET** /api/v1/organizations/{org_code}/feature_flags | List Organization Feature Flags |
+| [**get_organization_user_permissions**](OrganizationsApi.md#get_organization_user_permissions) | **GET** /api/v1/organizations/{org_code}/users/{user_id}/permissions | List Organization User Permissions |
 | [**get_organization_user_roles**](OrganizationsApi.md#get_organization_user_roles) | **GET** /api/v1/organizations/{org_code}/users/{user_id}/roles | List Organization User Roles |
 | [**get_organization_users**](OrganizationsApi.md#get_organization_users) | **GET** /api/v1/organizations/{org_code}/users | List Organization Users |
 | [**get_organizations**](OrganizationsApi.md#get_organizations) | **GET** /api/v1/organizations | List Organizations |
 | [**remove_organization_user**](OrganizationsApi.md#remove_organization_user) | **DELETE** /api/v1/organizations/{org_code}/users/{user_id} | Remove Organization User |
 | [**update_organization**](OrganizationsApi.md#update_organization) | **PATCH** /api/v1/organization/{org_code} | Update Organization |
-| [**update_organization_feature_flag_override**](OrganizationsApi.md#update_organization_feature_flag_override) | **PATCH** /api/v1/organizations/{org_code}/feature_flags/{feature_flag_key} | Update organization feature flag override |
-| [**update_organization_users**](OrganizationsApi.md#update_organization_users) | **PATCH** /api/v1/organizations/{org_code}/users | Update organization users |
+| [**update_organization_feature_flag_override**](OrganizationsApi.md#update_organization_feature_flag_override) | **PATCH** /api/v1/organizations/{org_code}/feature_flags/{feature_flag_key} | Update Organization Feature Flag Override |
+| [**update_organization_users**](OrganizationsApi.md#update_organization_users) | **PATCH** /api/v1/organizations/{org_code}/users | Update Organization Users |
 
 
 ## add_organization_users
@@ -165,6 +169,79 @@ end
 - **Accept**: application/json, application/json; charset=utf-8
 
 
+## create_organization_user_permission
+
+> <SuccessResponse> create_organization_user_permission(org_code, user_id, create_organization_user_permission_request)
+
+Add Organization User Permission
+
+Add permission to an organization user.
+
+### 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::OrganizationsApi.new
+org_code = 'org_code_example' # String | The organization's code.
+user_id = 'user_id_example' # String | The user's id.
+create_organization_user_permission_request = KindeApi::CreateOrganizationUserPermissionRequest.new # CreateOrganizationUserPermissionRequest | Permission details.
+
+begin
+  # Add Organization User Permission
+  result = api_instance.create_organization_user_permission(org_code, user_id, create_organization_user_permission_request)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling OrganizationsApi->create_organization_user_permission: #{e}"
+end
+```
+
+#### Using the create_organization_user_permission_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> create_organization_user_permission_with_http_info(org_code, user_id, create_organization_user_permission_request)
+
+```ruby
+begin
+  # Add Organization User Permission
+  data, status_code, headers = api_instance.create_organization_user_permission_with_http_info(org_code, user_id, create_organization_user_permission_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling OrganizationsApi->create_organization_user_permission_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_code** | **String** | The organization&#39;s code. |  |
+| **user_id** | **String** | The user&#39;s id. |  |
+| **create_organization_user_permission_request** | [**CreateOrganizationUserPermissionRequest**](CreateOrganizationUserPermissionRequest.md) | Permission details. |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/json; charset=utf-8
+
+
 ## create_organization_user_role
 
 > <SuccessResponse> create_organization_user_role(org_code, user_id, create_organization_user_role_request)
@@ -238,11 +315,79 @@ end
 - **Accept**: application/json, application/json; charset=utf-8
 
 
+## delete_organization
+
+> delete_organization(org_code)
+
+Delete Organization
+
+Delete an organization.
+
+### 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::OrganizationsApi.new
+org_code = 'org_code_example' # String | The identifier for the organization.
+
+begin
+  # Delete Organization
+  api_instance.delete_organization(org_code)
+rescue KindeApi::ApiError => e
+  puts "Error when calling OrganizationsApi->delete_organization: #{e}"
+end
+```
+
+#### Using the delete_organization_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)> delete_organization_with_http_info(org_code)
+
+```ruby
+begin
+  # Delete Organization
+  data, status_code, headers = api_instance.delete_organization_with_http_info(org_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue KindeApi::ApiError => e
+  puts "Error when calling OrganizationsApi->delete_organization_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_code** | **String** | The identifier for the organization. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/json; charset=utf-8
+
+
 ## delete_organization_feature_flag_override
 
 > <SuccessResponse> delete_organization_feature_flag_override(org_code, feature_flag_key)
 
-Delete organization feature flag override
+Delete Organization Feature Flag Override
 
 Delete organization feature flag override.
 
@@ -262,7 +407,7 @@ org_code = 'org_code_example' # String | The identifier for the organization.
 feature_flag_key = 'feature_flag_key_example' # String | The identifier for the feature flag.
 
 begin
-  # Delete organization feature flag override
+  # Delete Organization Feature Flag Override
   result = api_instance.delete_organization_feature_flag_override(org_code, feature_flag_key)
   p result
 rescue KindeApi::ApiError => e
@@ -278,7 +423,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Delete organization feature flag override
+  # Delete Organization Feature Flag Override
   data, status_code, headers = api_instance.delete_organization_feature_flag_override_with_http_info(org_code, feature_flag_key)
   p status_code # => 2xx
   p headers # => { ... }
@@ -313,7 +458,7 @@ end
 
 > <SuccessResponse> delete_organization_feature_flag_overrides(org_code)
 
-Delete all organization feature flag overrides
+Delete Organization Feature Flag Overrides
 
 Delete all organization feature flag overrides.
 
@@ -332,7 +477,7 @@ api_instance = KindeApi::OrganizationsApi.new
 org_code = 'org_code_example' # String | The identifier for the organization.
 
 begin
-  # Delete all organization feature flag overrides
+  # Delete Organization Feature Flag Overrides
   result = api_instance.delete_organization_feature_flag_overrides(org_code)
   p result
 rescue KindeApi::ApiError => e
@@ -348,7 +493,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Delete all organization feature flag overrides
+  # Delete Organization Feature Flag Overrides
   data, status_code, headers = api_instance.delete_organization_feature_flag_overrides_with_http_info(org_code)
   p status_code # => 2xx
   p headers # => { ... }
@@ -378,6 +523,79 @@ end
 - **Accept**: application/json, application/json; charset=utf-8
 
 
+## delete_organization_user_permission
+
+> <SuccessResponse> delete_organization_user_permission(org_code, user_id, permission_id)
+
+Delete Organization User Permission
+
+Delete permission for an organization user.
+
+### 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::OrganizationsApi.new
+org_code = 'org_code_example' # String | The organization's code.
+user_id = 'user_id_example' # String | The user's id.
+permission_id = 'permission_id_example' # String | The permission id.
+
+begin
+  # Delete Organization User Permission
+  result = api_instance.delete_organization_user_permission(org_code, user_id, permission_id)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling OrganizationsApi->delete_organization_user_permission: #{e}"
+end
+```
+
+#### Using the delete_organization_user_permission_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> delete_organization_user_permission_with_http_info(org_code, user_id, permission_id)
+
+```ruby
+begin
+  # Delete Organization User Permission
+  data, status_code, headers = api_instance.delete_organization_user_permission_with_http_info(org_code, user_id, permission_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling OrganizationsApi->delete_organization_user_permission_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_code** | **String** | The organization&#39;s code. |  |
+| **user_id** | **String** | The user&#39;s id. |  |
+| **permission_id** | **String** | The permission id. |  |
+
+### 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
+
+
 ## delete_organization_user_role
 
 > <SuccessResponse> delete_organization_user_role(org_code, user_id, role_id)
@@ -526,7 +744,7 @@ end
 
 > <GetOrganizationFeatureFlagsResponse> get_organization_feature_flags(org_code)
 
-List organization feature flags
+List Organization Feature Flags
 
 Get all organization feature flags.
 
@@ -545,7 +763,7 @@ api_instance = KindeApi::OrganizationsApi.new
 org_code = 'org_code_example' # String | The identifier for the organization.
 
 begin
-  # List organization feature flags
+  # List Organization Feature Flags
   result = api_instance.get_organization_feature_flags(org_code)
   p result
 rescue KindeApi::ApiError => e
@@ -561,7 +779,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # List organization feature flags
+  # List Organization Feature Flags
   data, status_code, headers = api_instance.get_organization_feature_flags_with_http_info(org_code)
   p status_code # => 2xx
   p headers # => { ... }
@@ -591,6 +809,81 @@ end
 - **Accept**: application/json, application/json; charset=utf-8
 
 
+## get_organization_user_permissions
+
+> <GetOrganizationsUserPermissionsResponse> get_organization_user_permissions(org_code, user_id, opts)
+
+List Organization User Permissions
+
+Get permissions for an organization user.
+
+### 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::OrganizationsApi.new
+org_code = 'org_code_example' # String | The organization's code.
+user_id = 'user_id_example' # String | The user's id.
+opts = {
+  expand: 'expand_example' # String | Specify additional data to retrieve. Use \"roles\".
+}
+
+begin
+  # List Organization User Permissions
+  result = api_instance.get_organization_user_permissions(org_code, user_id, opts)
+  p result
+rescue KindeApi::ApiError => e
+  puts "Error when calling OrganizationsApi->get_organization_user_permissions: #{e}"
+end
+```
+
+#### Using the get_organization_user_permissions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetOrganizationsUserPermissionsResponse>, Integer, Hash)> get_organization_user_permissions_with_http_info(org_code, user_id, opts)
+
+```ruby
+begin
+  # List Organization User Permissions
+  data, status_code, headers = api_instance.get_organization_user_permissions_with_http_info(org_code, user_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetOrganizationsUserPermissionsResponse>
+rescue KindeApi::ApiError => e
+  puts "Error when calling OrganizationsApi->get_organization_user_permissions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_code** | **String** | The organization&#39;s code. |  |
+| **user_id** | **String** | The user&#39;s id. |  |
+| **expand** | **String** | Specify additional data to retrieve. Use \&quot;roles\&quot;. | [optional] |
+
+### Return type
+
+[**GetOrganizationsUserPermissionsResponse**](GetOrganizationsUserPermissionsResponse.md)
+
+### Authorization
+
+[kindeBearerAuth](../README.md#kindeBearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/json; charset=utf-8
+
+
 ## get_organization_user_roles
 
 > <GetOrganizationsUserRolesResponse> get_organization_user_roles(org_code, user_id)
@@ -664,7 +957,7 @@ end
 
 ## get_organization_users
 
-> <GetOrganizationsUsersResponse> get_organization_users(org_code, opts)
+> <GetOrganizationUsersResponse> get_organization_users(org_code, opts)
 
 List Organization Users
 
@@ -687,7 +980,8 @@ 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.
-  permissions: 'permissions_example' # String | Filter by user permissions
+  permissions: 'permissions_example', # String | Filter by user permissions comma separated (where all match)
+  roles: 'roles_example' # String | Filter by user roles comma separated (where all match)
 }
 
 begin
@@ -703,7 +997,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<GetOrganizationsUsersResponse>, Integer, Hash)> get_organization_users_with_http_info(org_code, opts)
+> <Array(<GetOrganizationUsersResponse>, Integer, Hash)> get_organization_users_with_http_info(org_code, opts)
 
 ```ruby
 begin
@@ -711,7 +1005,7 @@ begin
   data, status_code, headers = api_instance.get_organization_users_with_http_info(org_code, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <GetOrganizationsUsersResponse>
+  p data # => <GetOrganizationUsersResponse>
 rescue KindeApi::ApiError => e
   puts "Error when calling OrganizationsApi->get_organization_users_with_http_info: #{e}"
 end
@@ -725,11 +1019,12 @@ end
 | **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] |
-| **permissions** | **String** | Filter by user permissions | [optional] |
+| **permissions** | **String** | Filter by user permissions comma separated (where all match) | [optional] |
+| **roles** | **String** | Filter by user roles comma separated (where all match) | [optional] |
 
 ### Return type
 
-[**GetOrganizationsUsersResponse**](GetOrganizationsUsersResponse.md)
+[**GetOrganizationUsersResponse**](GetOrganizationUsersResponse.md)
 
 ### Authorization
 
@@ -889,7 +1184,7 @@ end
 
 ## update_organization
 
-> update_organization(org_code, opts)
+> <SuccessResponse> update_organization(org_code, opts)
 
 Update Organization
 
@@ -914,7 +1209,8 @@ opts = {
 
 begin
   # Update Organization
-  api_instance.update_organization(org_code, opts)
+  result = api_instance.update_organization(org_code, opts)
+  p result
 rescue KindeApi::ApiError => e
   puts "Error when calling OrganizationsApi->update_organization: #{e}"
 end
@@ -922,9 +1218,9 @@ end
 
 #### Using the update_organization_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> update_organization_with_http_info(org_code, opts)
+> <Array(<SuccessResponse>, Integer, Hash)> update_organization_with_http_info(org_code, opts)
 
 ```ruby
 begin
@@ -932,7 +1228,7 @@ begin
   data, status_code, headers = api_instance.update_organization_with_http_info(org_code, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <SuccessResponse>
 rescue KindeApi::ApiError => e
   puts "Error when calling OrganizationsApi->update_organization_with_http_info: #{e}"
 end
@@ -947,7 +1243,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**SuccessResponse**](SuccessResponse.md)
 
 ### Authorization
 
@@ -963,7 +1259,7 @@ nil (empty response body)
 
 > <SuccessResponse> update_organization_feature_flag_override(org_code, feature_flag_key, value)
 
-Update organization feature flag override
+Update Organization Feature Flag Override
 
 Update organization feature flag override.
 
@@ -984,7 +1280,7 @@ feature_flag_key = 'feature_flag_key_example' # String | The identifier for the
 value = 'value_example' # String | Override value
 
 begin
-  # Update organization feature flag override
+  # Update Organization Feature Flag Override
   result = api_instance.update_organization_feature_flag_override(org_code, feature_flag_key, value)
   p result
 rescue KindeApi::ApiError => e
@@ -1000,7 +1296,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Update organization feature flag override
+  # Update Organization Feature Flag Override
   data, status_code, headers = api_instance.update_organization_feature_flag_override_with_http_info(org_code, feature_flag_key, value)
   p status_code # => 2xx
   p headers # => { ... }
@@ -1036,7 +1332,7 @@ end
 
 > <UpdateOrganizationUsersResponse> update_organization_users(org_code, opts)
 
-Update organization users
+Update Organization Users
 
 Update users that belong to an organization.
 
@@ -1058,7 +1354,7 @@ opts = {
 }
 
 begin
-  # Update organization users
+  # Update Organization Users
   result = api_instance.update_organization_users(org_code, opts)
   p result
 rescue KindeApi::ApiError => e
@@ -1074,7 +1370,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Update organization users
+  # Update Organization Users
   data, status_code, headers = api_instance.update_organization_users_with_http_info(org_code, opts)
   p status_code # => 2xx
   p headers # => { ... }