zitadel-client 1.4.2 → 1.5.0

data/lib/zitadel_client.rb

@@ -6,7 +6,7 @@ require_relative 'patch'
 
 Warning.ignore(:method_redefined, __dir__)
 
-# Main entrypoint for the ZitadelClient Ruby SDK.
+# Main entrypoint for the Zitadel::Client Ruby SDK.
 #
 # This module encapsulates all functionality for authenticating with and accessing
 # Zitadel's identity and access management APIs.
@@ -14,15 +14,29 @@ Warning.ignore(:method_redefined, __dir__)
 # Usage:
 #   require 'zitadel-client'
 #
-#   client = ZitadelClient::SomeService.new(...)
+#   client = Zitadel::Client::SomeService.new(...)
 #
-# For more details, see: https://github.com/zitadel/zitadel-client-ruby
+# For more details, see: https://github.com/zitadel/zitadel-ruby
 #
-module ZitadelClient
+module Zitadel
+  # Main entrypoint for the Zitadel::Client Ruby SDK.
+  #
+  # This module encapsulates all functionality for authenticating with and accessing
+  # Zitadel's identity and access management APIs.
+  #
+  # Usage:
+  #   require 'zitadel-client'
+  #
+  #   client = Zitadel::Client::SomeService.new(...)
+  #
+  # For more details, see: https://github.com/zitadel/zitadel-ruby
+  #
+  module Client
+  end
 end
 
 loader = Zeitwerk::Loader.new
-loader.inflector.inflect('version' => 'VERSION')
 loader.tag = File.basename(__FILE__, '.rb')
-loader.push_dir("#{__dir__}/zitadel-client", namespace: ZitadelClient)
+loader.push_dir("#{__dir__}/zitadel", namespace: Zitadel)
+loader.inflector.inflect('version' => 'VERSION')
 loader.setup

data/sig/lib.rbs

@@ -1,291 +1,294 @@
-module ZitadelClient
+module Zitadel
 
-  VERSION: String
+  module Client
 
-  module Models
+    VERSION: String
 
-  end
-
-  module Utils
-    class UrlUtil
-
-      def self.build_hostname: (String) -> String
-    end
-  end
-
-  module Api
-    class FeatureServiceApi
+    module Models
 
-      def initialize: (ApiClient) -> void
     end
 
-    class IdentityProviderServiceApi
-
-      def initialize: (ApiClient) -> void
-    end
+    module Utils
+      class UrlUtil
 
-    class OIDCServiceApi
-
-      def initialize: (ApiClient) -> void
+        def self.build_hostname: (String) -> String
+      end
     end
 
-    class OrganizationServiceApi
+    module Api
+      class FeatureServiceApi
 
-      def initialize: (ApiClient) -> void
-    end
+        def initialize: (ApiClient) -> void
+      end
 
-    class SessionServiceApi
+      class IdentityProviderServiceApi
 
-      def initialize: (ApiClient) -> void
-    end
+        def initialize: (ApiClient) -> void
+      end
 
-    class SettingsServiceApi
+      class OIDCServiceApi
 
-      def initialize: (ApiClient) -> void
-    end
+        def initialize: (ApiClient) -> void
+      end
 
-    class UserServiceApi
+      class OrganizationServiceApi
 
-      def initialize: (ApiClient) -> void
-    end
+        def initialize: (ApiClient) -> void
+      end
 
-    class SAMLServiceApi
+      class SessionServiceApi
 
-      def initialize: (ApiClient) -> void
-    end
-  end
+        def initialize: (ApiClient) -> void
+      end
 
-  class Configuration
-    USER_AGENT: String
+      class SettingsServiceApi
 
-    @@default: Configuration
+        def initialize: (ApiClient) -> void
+      end
 
-    attr_reader authenticator: Auth::Authenticator
-    attr_accessor debugging: bool
-    attr_accessor logger: untyped
-    attr_accessor temp_folder_path: String
-    attr_accessor timeout: Integer
-    attr_accessor client_side_validation: bool
-    attr_accessor user_agent: String
-    attr_accessor verify_ssl: bool
-    attr_accessor verify_ssl_host: bool
-    attr_accessor ssl_ca_cert: String?
-    attr_accessor cert_file: String?
-    attr_accessor key_file: String?
-    attr_accessor params_encoding: Symbol?
+      class UserServiceApi
 
-    def self.default: () -> Configuration
+        def initialize: (ApiClient) -> void
+      end
 
-    def initialize: (?Auth::Authenticator) ?{ (Configuration) -> untyped } -> void
+      class SAMLServiceApi
 
-    def configure: () ?{ (Configuration) -> untyped } -> void
+        def initialize: (ApiClient) -> void
+      end
+    end
 
-  end
+    class Configuration
+      USER_AGENT: String
 
-  class ApiClient
+      @@default: Configuration
 
-    @config: Configuration
-    @default_headers: Hash[String, String]
-    @user_agent: String
+      attr_reader authenticator: Auth::Authenticator
+      attr_accessor debugging: bool
+      attr_accessor logger: untyped
+      attr_accessor temp_folder_path: String
+      attr_accessor timeout: Integer
+      attr_accessor client_side_validation: bool
+      attr_accessor user_agent: String
+      attr_accessor verify_ssl: bool
+      attr_accessor verify_ssl_host: bool
+      attr_accessor ssl_ca_cert: String?
+      attr_accessor cert_file: String?
+      attr_accessor key_file: String?
+      attr_accessor params_encoding: Symbol?
 
-    attr_accessor config: Configuration
+      def self.default: () -> Configuration
 
-    attr_accessor default_headers: Hash[String, String]
+      def initialize: (?Auth::Authenticator) ?{ (Configuration) -> untyped } -> void
 
-    def initialize: (?Configuration) -> void
+      def configure: () ?{ (Configuration) -> untyped } -> void
 
-    def self.default: () -> untyped
+    end
 
-    def call_api: (untyped http_method, untyped path, ?::Hash[untyped, untyped] opts) -> ::Array[untyped]
+    class ApiClient
 
-    def build_request: (Symbol http_method, String path, Hash[Symbol, untyped] opts) -> Typhoeus::Request
+      @config: Configuration
+      @default_headers: Hash[String, String]
+      @user_agent: String
 
-    def build_request_body: (untyped header_params, untyped form_params, untyped body) -> untyped
+      attr_accessor config: Configuration
 
-    def download_file: (untyped request) ?{ (untyped) -> untyped } -> untyped
+      attr_accessor default_headers: Hash[String, String]
 
-    def ensure_tempfile: (::Tempfile?) -> ::Tempfile
+      def initialize: (?Configuration) -> void
 
-    def json_mime?: (untyped mime) -> untyped
+      def self.default: () -> untyped
 
-    def deserialize: (untyped response, untyped return_type) -> (nil | untyped)
+      def call_api: (untyped http_method, untyped path, ?::Hash[untyped, untyped] opts) -> ::Array[untyped]
 
-    def convert_to_type: (untyped data, untyped return_type) -> (nil | untyped)
+      def build_request: (Symbol http_method, String path, Hash[Symbol, untyped] opts) -> Typhoeus::Request
 
-    def sanitize_filename: (untyped filename) -> untyped
+      def build_request_body: (untyped header_params, untyped form_params, untyped body) -> untyped
 
-    def select_header_accept: (untyped accepts) -> (nil | untyped)
+      def download_file: (untyped request) ?{ (untyped) -> untyped } -> untyped
 
-    def select_header_content_type: (untyped content_types) -> (nil | untyped)
+      def ensure_tempfile: (::Tempfile?) -> ::Tempfile
 
-    def object_to_http_body: (untyped model) -> untyped
+      def json_mime?: (untyped mime) -> untyped
 
-    def object_to_hash: (untyped obj) -> untyped
+      def deserialize: (untyped response, untyped return_type) -> (nil | untyped)
 
-    def build_collection_param: (untyped param, untyped collection_format) -> untyped
-  end
+      def convert_to_type: (untyped data, untyped return_type) -> (nil | untyped)
 
-  class ZitadelError < StandardError
-    def initialize: (String) -> void
-  end
+      def sanitize_filename: (untyped filename) -> untyped
 
-  #
-  # Represents an HTTP error returned from the Zitadel API.
-  #
-  # This class captures the HTTP status code, headers, and body,
-  # and provides a helpful string representation for debugging.
-  #
-  class ApiError < ZitadelError
-    attr_reader code: Integer
-    attr_reader response_headers: Hash[String, Array[String]]
-    attr_reader response_body: String | Typhoeus::Response
-
-    def initialize: (Integer, Hash[String, Array[String]], String | Typhoeus::Response) -> void
-  end
+      def select_header_accept: (untyped accepts) -> (nil | untyped)
 
-  module Auth
+      def select_header_content_type: (untyped content_types) -> (nil | untyped)
 
-    class Authenticator
+      def object_to_http_body: (untyped model) -> untyped
 
-      @host: String
+      def object_to_hash: (untyped obj) -> untyped
 
-      attr_reader host: String
+      def build_collection_param: (untyped param, untyped collection_format) -> untyped
+    end
 
+    class ZitadelError < StandardError
       def initialize: (String) -> void
-
-      def auth_headers: () -> Hash[String, String]
     end
 
-    class ClientCredentialsAuthenticator < OAuthAuthenticator
+    #
+    # Represents an HTTP error returned from the Zitadel API.
+    #
+    # This class captures the HTTP status code, headers, and body,
+    # and provides a helpful string representation for debugging.
+    #
+    class ApiError < ZitadelError
+      attr_reader code: Integer
+      attr_reader response_headers: Hash[String, Array[String]]
+      attr_reader response_body: String | Typhoeus::Response
+
+      def initialize: (Integer, Hash[String, Array[String]], String | Typhoeus::Response) -> void
+    end
 
-      def initialize: (OpenId, String, String, Set[String]) -> void
+    module Auth
 
-      def get_grant: (OAuth2::Client, String) -> OAuth2::AccessToken
+      class Authenticator
 
-      def self.builder: (String, String, String) -> ClientCredentialsAuthenticatorBuilder
+        @host: String
 
-      class ClientCredentialsAuthenticatorBuilder < OAuthAuthenticatorBuilder
-        @client_id: String
-        @client_secret: String
+        attr_reader host: String
 
-        def initialize: (String, String, String) -> void
+        def initialize: (String) -> void
 
-        def build: -> ClientCredentialsAuthenticator
+        def auth_headers: () -> Hash[String, String]
       end
 
-    end
+      class ClientCredentialsAuthenticator < OAuthAuthenticator
 
-    class NoAuthAuthenticator < Authenticator
+        def initialize: (OpenId, String, String, Set[String]) -> void
 
-      def initialize: (?String) -> void
+        def get_grant: (OAuth2::Client, String) -> OAuth2::AccessToken
 
-      def auth_headers: () -> Hash[String, String]
-    end
+        def self.builder: (String, String, String) -> ClientCredentialsAuthenticatorBuilder
 
-    class OAuthAuthenticatorBuilder
-      @auth_scopes: Set[String]
-      @open_id: OpenId
+        class ClientCredentialsAuthenticatorBuilder < OAuthAuthenticatorBuilder
+          @client_id: String
+          @client_secret: String
 
-      attr_reader open_id: OpenId
-      attr_reader auth_scopes: Set[String]
+          def initialize: (String, String, String) -> void
 
-      def initialize: (String) -> void
+          def build: -> ClientCredentialsAuthenticator
+        end
 
-      def scopes: -> untyped
-    end
+      end
 
-    class OAuthAuthenticator < Authenticator
-      @auth_session: OAuth2::Client
-      @open_id: OpenId
-      @token: OAuth2::AccessToken | nil
-      @auth_scopes: String
+      class NoAuthAuthenticator < Authenticator
 
-      def initialize: (OpenId, Set[String], OAuth2::Client) -> void
+        def initialize: (?String) -> void
 
-      def auth_token: () -> String
+        def auth_headers: () -> Hash[String, String]
+      end
 
-      def auth_headers: () -> Hash[String, String]
+      class OAuthAuthenticatorBuilder
+        @auth_scopes: Set[String]
+        @open_id: OpenId
 
-      def get_grant: (OAuth2::Client, String) -> OAuth2::AccessToken
+        attr_reader open_id: OpenId
+        attr_reader auth_scopes: Set[String]
 
-      def refresh_token: () -> OAuth2::AccessToken
-    end
+        def initialize: (String) -> void
 
-    class OpenId
-      @host_endpoint: String
-      @token_endpoint: String
+        def scopes: -> untyped
+      end
 
-      attr_accessor host_endpoint: String
-      attr_accessor token_endpoint: String
+      class OAuthAuthenticator < Authenticator
+        @auth_session: OAuth2::Client
+        @open_id: OpenId
+        @token: OAuth2::AccessToken | nil
+        @auth_scopes: String
 
-      def initialize: (String) -> void
+        def initialize: (OpenId, Set[String], OAuth2::Client) -> void
 
-      def self.build_well_known_url: (String) -> String
-    end
+        def auth_token: () -> String
 
-    class PersonalAccessTokenAuthenticator < Authenticator
-      @token: String
+        def auth_headers: () -> Hash[String, String]
 
-      def initialize: (String, String) -> void
+        def get_grant: (OAuth2::Client, String) -> OAuth2::AccessToken
 
-      def auth_headers: -> Hash[String, String]
-    end
+        def refresh_token: () -> OAuth2::AccessToken
+      end
+
+      class OpenId
+        @host_endpoint: String
+        @token_endpoint: String
 
-    class WebTokenAuthenticator < OAuthAuthenticator
-      @jwt_algorithm: String
-      @jwt_audience: String
-      @jwt_issuer: String
-      @jwt_lifetime: Integer
-      @jwt_subject: String
-      @key_id: String?
-      @private_key: String
+        attr_accessor host_endpoint: String
+        attr_accessor token_endpoint: String
 
-      def self.builder: (String, String, String) -> WebTokenAuthenticatorBuilder
+        def initialize: (String) -> void
 
-      def self.from_json: (String, String) -> WebTokenAuthenticator
+        def self.build_well_known_url: (String) -> String
+      end
 
-      def get_grant: (OAuth2::Client, String) -> OAuth2::AccessToken
+      class PersonalAccessTokenAuthenticator < Authenticator
+        @token: String
 
-      def initialize: (OpenId, Set[String], String, String, String, String | OpenSSL::PKey::PKey, ?jwt_lifetime: Integer, ?jwt_algorithm: String, ?key_id: String?) -> void
+        def initialize: (String, String) -> void
 
-      class WebTokenAuthenticatorBuilder < OAuthAuthenticatorBuilder
+        def auth_headers: -> Hash[String, String]
+      end
+
+      class WebTokenAuthenticator < OAuthAuthenticator
+        @jwt_algorithm: String
         @jwt_audience: String
         @jwt_issuer: String
         @jwt_lifetime: Integer
         @jwt_subject: String
-        @key_id: String
+        @key_id: String?
         @private_key: String
 
-        def initialize: (String, String, String, String, String) -> void
+        def self.builder: (String, String, String) -> WebTokenAuthenticatorBuilder
+
+        def self.from_json: (String, String) -> WebTokenAuthenticator
+
+        def get_grant: (OAuth2::Client, String) -> OAuth2::AccessToken
 
-        def build: -> WebTokenAuthenticator
+        def initialize: (OpenId, Set[String], String, String, String, String | OpenSSL::PKey::PKey, ?jwt_lifetime: Integer, ?jwt_algorithm: String, ?key_id: String?) -> void
 
-        def key_identifier: (String) -> self
+        class WebTokenAuthenticatorBuilder < OAuthAuthenticatorBuilder
+          @jwt_audience: String
+          @jwt_issuer: String
+          @jwt_lifetime: Integer
+          @jwt_subject: String
+          @key_id: String
+          @private_key: String
 
-        def token_lifetime_seconds: (Integer) -> self
+          def initialize: (String, String, String, String, String) -> void
+
+          def build: -> WebTokenAuthenticator
+
+          def key_identifier: (String) -> self
+
+          def token_lifetime_seconds: (Integer) -> self
+        end
       end
     end
-  end
 
-  class Zitadel
-    def self.with_access_token: (String, String) -> Zitadel
+    class Zitadel
+      def self.with_access_token: (String, String) -> Zitadel
 
-    def self.with_client_credentials: (String, String, String) -> Zitadel
+      def self.with_client_credentials: (String, String, String) -> Zitadel
 
-    def self.with_private_key: (String, String) -> Zitadel
+      def self.with_private_key: (String, String) -> Zitadel
 
-    attr_reader configuration: Configuration
-    attr_reader features: untyped
-    attr_reader idps: untyped
-    attr_reader oidc: untyped
-    attr_reader organizations: untyped
-    attr_reader saml: untyped
-    attr_reader sessions: untyped
-    attr_reader settings: untyped
-    attr_reader users: untyped
+      attr_reader configuration: Configuration
+      attr_reader features: untyped
+      attr_reader idps: untyped
+      attr_reader oidc: untyped
+      attr_reader organizations: untyped
+      attr_reader saml: untyped
+      attr_reader sessions: untyped
+      attr_reader settings: untyped
+      attr_reader users: untyped
 
-    def initialize: (Auth::Authenticator) ?{ (Configuration) -> void } -> void
+      def initialize: (Auth::Authenticator) ?{ (Configuration) -> void } -> void
 
-  end
+    end
 
+  end
 end