zitadel-client 1.8.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23c0606985a770bbf6d6af0dd113153b65bf5ce2d84bd9b8f85ca984e4b652a3
-  data.tar.gz: 942e372960ad8be30d939fde798554d1e1244d847b49fbddfce479eb9a5a083c
+  metadata.gz: 43908de987b3ec44b89f65e214f373f3b8ebf8f9f5450e21da3e67e2a5fcdace
+  data.tar.gz: 982f300de648d65c5ad01e70ea9d2bb83443b30961f31d5cfe2d17c2cc04236c
 SHA512:
-  metadata.gz: 36ed36ecb4f7307b40e8c057b4d726b4f592da7afa639c4ff0923f195ec0e4dc48fdfcc31b8638a91a7a5744e050a41ec94c4bffe20f87c96fedaca3d7d2c00a
-  data.tar.gz: 223d00a96b7a46419cb367e433f15918f9d470f95676ba6ed98c433307c2c9985b772b2a5c83038e363acbf2dfb13bef7d96fef20406e09278789a76c11eefba
+  metadata.gz: 965c5f4c5e9ac8fa80a118275a55c191b5ff83e7097a39e63263e0c2ea6075251109ed674c28ef336d9c95f4e326859a89fd8de1c7c979a00aad48dee62a6cfc
+  data.tar.gz: 9b52d0b967762120ecc24f630bd56c9c54d9a8752d891e4b8d1bf31045ef6c155c964492879a4340dba6e862e40c94dbfde4ad00f53ed83667ad71b9d7cc5196

data/README.md

@@ -21,6 +21,9 @@ For those use cases, consider using other solutions that are designed for
 user authentication across various platforms like web, mobile, or other
 client environments.
 
+> [!IMPORTANT]
+> Please be aware that this SDK is currently in an incubating stage. We are releasing it to the community to gather feedback and learn how it is being used. While you are welcome to use it, please note that the API and functionality may evolve based on community input. We encourage you to try it out and share your experiences, but advise caution when considering it for production environments as future updates may introduce changes.
+
 ## Getting Started
 
 ### Sign up for Zitadel
@@ -212,8 +215,7 @@ in terms of request handling and error management.
 
 ## Versioning
 
-This SDK follows [Semantic Versioning](https://semver.org/). You can refer to
-the releases for details on the changes between versions.
+A key aspect of our strategy is that the SDK's major version is synchronized with the ZITADEL core project's major version to ensure compatibility. For a detailed explanation of this policy and our release schedule, please see our [Versioning Guide](VERSIONING.md).
 
 ## Contributing
 

data/lib/zitadel/client/api/action_service_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.12.0
+Generator version: 7.13.0
 
 =end
 
@@ -20,21 +20,11 @@ module Zitadel::Client::Api
   @api_client = api_client
   end
       # Create Target
-      # Create a new target to your endpoint, which can be used in executions.  Required permission:   - `action.target.write`  Required feature flag:   - `actions`
+      # Create a new target to your endpoint, which can be used in executions.  Required permission:   - `action.target.write`  Required feature flag:   - `actions`
           # @param action_service_create_target_request [ActionServiceCreateTargetRequest] 
       # @param [Hash] opts the optional parameters
     # @return [ActionServiceBetaCreateTargetResponse]
     def action_service_create_target(action_service_create_target_request, opts = {})
-    data, _status_code, _headers = action_service_create_target_with_http_info(action_service_create_target_request, opts)
-    data
-    end
-
-      # Create Target
-      # Create a new target to your endpoint, which can be used in executions.  Required permission:   - `action.target.write`  Required feature flag:   - `actions`
-          # @param action_service_create_target_request [ActionServiceCreateTargetRequest] 
-      # @param [Hash] opts the optional parameters
-    # @return [Array<(ActionServiceBetaCreateTargetResponse, Integer, Hash)>] ActionServiceBetaCreateTargetResponse data, response status code and response headers
-    def action_service_create_target_with_http_info(action_service_create_target_request, opts = {})
     if @api_client.config.debugging
     @api_client.config.logger.debug 'Calling API: Api::ActionServiceApi.action_service_create_target ...' # MODIFIED
     end
@@ -84,25 +74,15 @@ module Zitadel::Client::Api
     if @api_client.config.debugging
     @api_client.config.logger.debug "API called: Api::ActionServiceApi#action_service_create_target\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" # MODIFIED
     end
-    return data, status_code, headers
+    return data
     end
 
       # Delete Target
-      # Delete an existing target. This will remove it from any configured execution as well. In case the target is not found, the request will return a successful response as the desired state is already achieved.  Required permission:   - `action.target.delete`  Required feature flag:   - `actions`
+      # Delete an existing target. This will remove it from any configured execution as well. In case the target is not found, the request will return a successful response as the desired state is already achieved.  Required permission:   - &#x60;action.target.delete&#x60;  Required feature flag:   - &#x60;actions&#x60;
           # @param id [String] 
       # @param [Hash] opts the optional parameters
     # @return [ActionServiceBetaDeleteTargetResponse]
     def action_service_delete_target(id, opts = {})
-    data, _status_code, _headers = action_service_delete_target_with_http_info(id, opts)
-    data
-    end
-
-      # Delete Target
-      # Delete an existing target. This will remove it from any configured execution as well. In case the target is not found, the request will return a successful response as the desired state is already achieved.  Required permission:   - &#x60;action.target.delete&#x60;  Required feature flag:   - &#x60;actions&#x60;
-          # @param id [String] 
-      # @param [Hash] opts the optional parameters
-    # @return [Array<(ActionServiceBetaDeleteTargetResponse, Integer, Hash)>] ActionServiceBetaDeleteTargetResponse data, response status code and response headers
-    def action_service_delete_target_with_http_info(id, opts = {})
     if @api_client.config.debugging
     @api_client.config.logger.debug 'Calling API: Api::ActionServiceApi.action_service_delete_target ...' # MODIFIED
     end
@@ -147,25 +127,15 @@ module Zitadel::Client::Api
     if @api_client.config.debugging
     @api_client.config.logger.debug "API called: Api::ActionServiceApi#action_service_delete_target\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" # MODIFIED
     end
-    return data, status_code, headers
+    return data
     end
 
       # Get Target
-      # Returns the target identified by the requested ID.  Required permission:   - `action.target.read`  Required feature flag:   - `actions`
+      # Returns the target identified by the requested ID.  Required permission:   - &#x60;action.target.read&#x60;  Required feature flag:   - &#x60;actions&#x60;
           # @param id [String] 
       # @param [Hash] opts the optional parameters
     # @return [ActionServiceBetaGetTargetResponse]
     def action_service_get_target(id, opts = {})
-    data, _status_code, _headers = action_service_get_target_with_http_info(id, opts)
-    data
-    end
-
-      # Get Target
-      # Returns the target identified by the requested ID.  Required permission:   - &#x60;action.target.read&#x60;  Required feature flag:   - &#x60;actions&#x60;
-          # @param id [String] 
-      # @param [Hash] opts the optional parameters
-    # @return [Array<(ActionServiceBetaGetTargetResponse, Integer, Hash)>] ActionServiceBetaGetTargetResponse data, response status code and response headers
-    def action_service_get_target_with_http_info(id, opts = {})
     if @api_client.config.debugging
     @api_client.config.logger.debug 'Calling API: Api::ActionServiceApi.action_service_get_target ...' # MODIFIED
     end
@@ -210,7 +180,7 @@ module Zitadel::Client::Api
     if @api_client.config.debugging
     @api_client.config.logger.debug "API called: Api::ActionServiceApi#action_service_get_target\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" # MODIFIED
     end
-    return data, status_code, headers
+    return data
     end
 
       # List Execution Functions
@@ -218,15 +188,6 @@ module Zitadel::Client::Api
       # @param [Hash] opts the optional parameters
     # @return [ActionServiceBetaListExecutionFunctionsResponse]
     def action_service_list_execution_functions(opts = {})
-    data, _status_code, _headers = action_service_list_execution_functions_with_http_info(opts)
-    data
-    end
-
-      # List Execution Functions
-      # List all available functions which can be used as condition for executions.
-      # @param [Hash] opts the optional parameters
-    # @return [Array<(ActionServiceBetaListExecutionFunctionsResponse, Integer, Hash)>] ActionServiceBetaListExecutionFunctionsResponse data, response status code and response headers
-    def action_service_list_execution_functions_with_http_info(opts = {})
     if @api_client.config.debugging
     @api_client.config.logger.debug 'Calling API: Api::ActionServiceApi.action_service_list_execution_functions ...' # MODIFIED
     end
@@ -267,7 +228,7 @@ module Zitadel::Client::Api
     if @api_client.config.debugging
     @api_client.config.logger.debug "API called: Api::ActionServiceApi#action_service_list_execution_functions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" # MODIFIED
     end
-    return data, status_code, headers
+    return data
     end
 
       # List Execution Methods
@@ -275,15 +236,6 @@ module Zitadel::Client::Api
       # @param [Hash] opts the optional parameters
     # @return [ActionServiceBetaListExecutionMethodsResponse]
     def action_service_list_execution_methods(opts = {})
-    data, _status_code, _headers = action_service_list_execution_methods_with_http_info(opts)
-    data
-    end
-
-      # List Execution Methods
-      # List all available methods which can be used as condition for executions.
-      # @param [Hash] opts the optional parameters
-    # @return [Array<(ActionServiceBetaListExecutionMethodsResponse, Integer, Hash)>] ActionServiceBetaListExecutionMethodsResponse data, response status code and response headers
-    def action_service_list_execution_methods_with_http_info(opts = {})
     if @api_client.config.debugging
     @api_client.config.logger.debug 'Calling API: Api::ActionServiceApi.action_service_list_execution_methods ...' # MODIFIED
     end
@@ -324,7 +276,7 @@ module Zitadel::Client::Api
     if @api_client.config.debugging
     @api_client.config.logger.debug "API called: Api::ActionServiceApi#action_service_list_execution_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" # MODIFIED
     end
-    return data, status_code, headers
+    return data
     end
 
       # List Execution Services
@@ -332,15 +284,6 @@ module Zitadel::Client::Api
       # @param [Hash] opts the optional parameters
     # @return [ActionServiceBetaListExecutionServicesResponse]
     def action_service_list_execution_services(opts = {})
-    data, _status_code, _headers = action_service_list_execution_services_with_http_info(opts)
-    data
-    end
-
-      # List Execution Services
-      # List all available services which can be used as condition for executions.
-      # @param [Hash] opts the optional parameters
-    # @return [Array<(ActionServiceBetaListExecutionServicesResponse, Integer, Hash)>] ActionServiceBetaListExecutionServicesResponse data, response status code and response headers
-    def action_service_list_execution_services_with_http_info(opts = {})
     if @api_client.config.debugging
     @api_client.config.logger.debug 'Calling API: Api::ActionServiceApi.action_service_list_execution_services ...' # MODIFIED
     end
@@ -381,11 +324,11 @@ module Zitadel::Client::Api
     if @api_client.config.debugging
     @api_client.config.logger.debug "API called: Api::ActionServiceApi#action_service_list_execution_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" # MODIFIED
     end
-    return data, status_code, headers
+    return data
     end
 
       # List Executions
-      # List all matching executions. By default all executions of the instance are returned that have at least one execution target. Make sure to include a limit and sorting for pagination.  Required permission:   - `action.execution.read`  Required feature flag:   - `actions`
+      # List all matching executions. By default all executions of the instance are returned that have at least one execution target. Make sure to include a limit and sorting for pagination.  Required permission:   - &#x60;action.execution.read&#x60;  Required feature flag:   - &#x60;actions&#x60;
       # @param [Hash] opts the optional parameters
         # @option opts [String] :pagination_offset Starting point for retrieval, in combination of offset used to query a set list of objects.
         # @option opts [Integer] :pagination_limit limit is the maximum amount of objects returned. The default is set to 100 with a maximum of 1000 in the runtime configuration. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
@@ -393,19 +336,6 @@ module Zitadel::Client::Api
         # @option opts [String] :sorting_column The field the result is sorted by. The default is the creation date. Beware that if you change this, your result pagination might be inconsistent. (default to 'EXECUTION_FIELD_NAME_UNSPECIFIED')
     # @return [ActionServiceBetaListExecutionsResponse]
     def action_service_list_executions(opts = {})
-    data, _status_code, _headers = action_service_list_executions_with_http_info(opts)
-    data
-    end
-
-      # List Executions
-      # List all matching executions. By default all executions of the instance are returned that have at least one execution target. Make sure to include a limit and sorting for pagination.  Required permission:   - &#x60;action.execution.read&#x60;  Required feature flag:   - &#x60;actions&#x60;
-      # @param [Hash] opts the optional parameters
-        # @option opts [String] :pagination_offset Starting point for retrieval, in combination of offset used to query a set list of objects.
-        # @option opts [Integer] :pagination_limit limit is the maximum amount of objects returned. The default is set to 100 with a maximum of 1000 in the runtime configuration. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
-        # @option opts [Boolean] :pagination_asc Asc is the sorting order. If true the list is sorted ascending, if false the list is sorted descending. The default is descending.
-        # @option opts [String] :sorting_column The field the result is sorted by. The default is the creation date. Beware that if you change this, your result pagination might be inconsistent. (default to 'EXECUTION_FIELD_NAME_UNSPECIFIED')
-    # @return [Array<(ActionServiceBetaListExecutionsResponse, Integer, Hash)>] ActionServiceBetaListExecutionsResponse data, response status code and response headers
-    def action_service_list_executions_with_http_info(opts = {})
     if @api_client.config.debugging
     @api_client.config.logger.debug 'Calling API: Api::ActionServiceApi.action_service_list_executions ...' # MODIFIED
     end
@@ -454,25 +384,15 @@ module Zitadel::Client::Api
     if @api_client.config.debugging
     @api_client.config.logger.debug "API called: Api::ActionServiceApi#action_service_list_executions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" # MODIFIED
     end
-    return data, status_code, headers
+    return data
     end
 
       # List targets
-      # List all matching targets. By default all targets of the instance are returned. Make sure to include a limit and sorting for pagination.  Required permission:   - `action.target.read`  Required feature flag:   - `actions`
+      # List all matching targets. By default all targets of the instance are returned. Make sure to include a limit and sorting for pagination.  Required permission:   - &#x60;action.target.read&#x60;  Required feature flag:   - &#x60;actions&#x60;
           # @param action_service_list_targets_request [ActionServiceListTargetsRequest] 
       # @param [Hash] opts the optional parameters
     # @return [ActionServiceBetaListTargetsResponse]
     def action_service_list_targets(action_service_list_targets_request, opts = {})
-    data, _status_code, _headers = action_service_list_targets_with_http_info(action_service_list_targets_request, opts)
-    data
-    end
-
-      # List targets
-      # List all matching targets. By default all targets of the instance are returned. Make sure to include a limit and sorting for pagination.  Required permission:   - &#x60;action.target.read&#x60;  Required feature flag:   - &#x60;actions&#x60;
-          # @param action_service_list_targets_request [ActionServiceListTargetsRequest] 
-      # @param [Hash] opts the optional parameters
-    # @return [Array<(ActionServiceBetaListTargetsResponse, Integer, Hash)>] ActionServiceBetaListTargetsResponse data, response status code and response headers
-    def action_service_list_targets_with_http_info(action_service_list_targets_request, opts = {})
     if @api_client.config.debugging
     @api_client.config.logger.debug 'Calling API: Api::ActionServiceApi.action_service_list_targets ...' # MODIFIED
     end
@@ -522,25 +442,15 @@ module Zitadel::Client::Api
     if @api_client.config.debugging
     @api_client.config.logger.debug "API called: Api::ActionServiceApi#action_service_list_targets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" # MODIFIED
     end
-    return data, status_code, headers
+    return data
     end
 
       # Set Execution
-      # Sets an execution to call a target or include the targets of another execution. Setting an empty list of targets will remove all targets from the execution, making it a noop.  Required permission:   - `action.execution.write`  Required feature flag:   - `actions`
+      # Sets an execution to call a target or include the targets of another execution. Setting an empty list of targets will remove all targets from the execution, making it a noop.  Required permission:   - &#x60;action.execution.write&#x60;  Required feature flag:   - &#x60;actions&#x60;
           # @param action_service_set_execution_request [ActionServiceSetExecutionRequest] 
       # @param [Hash] opts the optional parameters
     # @return [ActionServiceBetaSetExecutionResponse]
     def action_service_set_execution(action_service_set_execution_request, opts = {})
-    data, _status_code, _headers = action_service_set_execution_with_http_info(action_service_set_execution_request, opts)
-    data
-    end
-
-      # Set Execution
-      # Sets an execution to call a target or include the targets of another execution. Setting an empty list of targets will remove all targets from the execution, making it a noop.  Required permission:   - &#x60;action.execution.write&#x60;  Required feature flag:   - &#x60;actions&#x60;
-          # @param action_service_set_execution_request [ActionServiceSetExecutionRequest] 
-      # @param [Hash] opts the optional parameters
-    # @return [Array<(ActionServiceBetaSetExecutionResponse, Integer, Hash)>] ActionServiceBetaSetExecutionResponse data, response status code and response headers
-    def action_service_set_execution_with_http_info(action_service_set_execution_request, opts = {})
     if @api_client.config.debugging
     @api_client.config.logger.debug 'Calling API: Api::ActionServiceApi.action_service_set_execution ...' # MODIFIED
     end
@@ -590,27 +500,16 @@ module Zitadel::Client::Api
     if @api_client.config.debugging
     @api_client.config.logger.debug "API called: Api::ActionServiceApi#action_service_set_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" # MODIFIED
     end
-    return data, status_code, headers
+    return data
     end
 
       # Update Target
-      # Update an existing target. To generate a new signing key set the optional expirationSigningKey.  Required permission:   - `action.target.write`  Required feature flag:   - `actions`
+      # Update an existing target. To generate a new signing key set the optional expirationSigningKey.  Required permission:   - &#x60;action.target.write&#x60;  Required feature flag:   - &#x60;actions&#x60;
           # @param id [String] 
           # @param action_service_update_target_request [ActionServiceUpdateTargetRequest] 
       # @param [Hash] opts the optional parameters
     # @return [ActionServiceBetaUpdateTargetResponse]
     def action_service_update_target(id, action_service_update_target_request, opts = {})
-    data, _status_code, _headers = action_service_update_target_with_http_info(id, action_service_update_target_request, opts)
-    data
-    end
-
-      # Update Target
-      # Update an existing target. To generate a new signing key set the optional expirationSigningKey.  Required permission:   - &#x60;action.target.write&#x60;  Required feature flag:   - &#x60;actions&#x60;
-          # @param id [String] 
-          # @param action_service_update_target_request [ActionServiceUpdateTargetRequest] 
-      # @param [Hash] opts the optional parameters
-    # @return [Array<(ActionServiceBetaUpdateTargetResponse, Integer, Hash)>] ActionServiceBetaUpdateTargetResponse data, response status code and response headers
-    def action_service_update_target_with_http_info(id, action_service_update_target_request, opts = {})
     if @api_client.config.debugging
     @api_client.config.logger.debug 'Calling API: Api::ActionServiceApi.action_service_update_target ...' # MODIFIED
     end
@@ -664,7 +563,7 @@ module Zitadel::Client::Api
     if @api_client.config.debugging
     @api_client.config.logger.debug "API called: Api::ActionServiceApi#action_service_update_target\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" # MODIFIED
     end
-    return data, status_code, headers
+    return data
     end
   end
 end