scalar_api_ruby 0.2.0

data/rbi/scalar_api_ruby/resources/schemas.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    # Schemas
+    class Schemas
+      # Schemas
+      sig { returns(Scalar::Resources::Schemas::Version) }
+      attr_reader :version
+
+      # Schemas
+      sig { returns(Scalar::Resources::Schemas::AccessGroup) }
+      attr_reader :access_group
+
+      # Create a schema in a namespace.
+      sig do
+        params(
+          namespace: String,
+          document: String,
+          slug: String,
+          title: String,
+          version: String,
+          description: String,
+          is_private: T::Boolean,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::UID)
+      end
+      def create(
+        namespace,
+        document:,
+        slug:,
+        title:,
+        version:,
+        description: nil,
+        is_private: nil,
+        request_options: {}
+      )
+      end
+
+      # Update schema metadata.
+      sig do
+        params(
+          slug: String,
+          namespace: String,
+          description: String,
+          is_private: T::Boolean,
+          title: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def update(
+        # Path param
+        slug,
+        # Path param
+        namespace:,
+        # Body param
+        description: nil,
+        # Body param
+        is_private: nil,
+        # Body param
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      # List schemas in a namespace.
+      sig do
+        params(
+          namespace: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T::Array[Scalar::Schema])
+      end
+      def list(namespace, request_options: {})
+      end
+
+      # Delete a schema and all related versions.
+      sig do
+        params(
+          slug: String,
+          namespace: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def delete(slug, namespace:, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Scalar::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/resources/sdks/repositories.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    class Sdks
+      # SDKs
+      class Repositories
+        # Link one language target to a GitHub repository, so builds sync there.
+        sig do
+          params(
+            uid: String,
+            base_branch: String,
+            language: Scalar::Sdks::RepositoryLinkParams::Language::OrSymbol,
+            repository_id: Integer,
+            prerelease_type: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(Scalar::Models::Sdks::RepositoryLinkResponse)
+        end
+        def link(
+          uid,
+          base_branch:,
+          language:,
+          repository_id:,
+          prerelease_type: nil,
+          request_options: {}
+        )
+        end
+
+        # Unlink one language target from its repository.
+        sig do
+          params(
+            language: Scalar::Sdks::RepositoryUnlinkParams::Language::OrSymbol,
+            uid: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def unlink(language, uid:, request_options: {})
+        end
+
+        # Toggle publish-on-merge and the release settings for a linked target.
+        sig do
+          params(
+            language:
+              Scalar::Sdks::RepositoryUpdatePublishingParams::Language::OrSymbol,
+            uid: String,
+            publish_on_merge: T::Boolean,
+            access:
+              Scalar::Sdks::RepositoryUpdatePublishingParams::Access::OrSymbol,
+            auth_method:
+              Scalar::Sdks::RepositoryUpdatePublishingParams::AuthMethod::OrSymbol,
+            tag: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def update_publishing(
+          # Path param
+          language,
+          # Path param
+          uid:,
+          # Body param
+          publish_on_merge:,
+          # Body param
+          access: nil,
+          # Body param
+          auth_method: nil,
+          # Body param
+          tag: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Scalar::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/resources/sdks/versions.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    class Sdks
+      # SDKs
+      class Versions
+        # Create a new SDK version against a specific API version.
+        sig do
+          params(
+            uid: String,
+            api_version: String,
+            version: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def create(uid, api_version:, version:, request_options: {})
+        end
+
+        # Permanently delete one version of an SDK.
+        sig do
+          params(
+            version: String,
+            uid: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def delete(version, uid:, request_options: {})
+        end
+
+        # @api private
+        sig { params(client: Scalar::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/resources/sdks.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    # SDKs
+    class Sdks
+      # SDKs
+      sig { returns(Scalar::Resources::Sdks::Versions) }
+      attr_reader :versions
+
+      # SDKs
+      sig { returns(Scalar::Resources::Sdks::Repositories) }
+      attr_reader :repositories
+
+      # Create an SDK from an API document, targeting one or more languages.
+      sig do
+        params(
+          api_uid: String,
+          languages: T::Array[Scalar::SdkCreateParams::Language::OrSymbol],
+          class_name: String,
+          config: String,
+          slug: String,
+          title: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::UID)
+      end
+      def create(
+        api_uid:,
+        languages:,
+        class_name: nil,
+        config: nil,
+        slug: nil,
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a single SDK by its uid.
+      sig do
+        params(
+          uid: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Sdk)
+      end
+      def retrieve(uid, request_options: {})
+      end
+
+      # Update SDK metadata, its linked API, or its config.
+      sig do
+        params(
+          uid: String,
+          api_uid: T.nilable(String),
+          api_version: T.nilable(String),
+          config: String,
+          is_private: T::Boolean,
+          slug: String,
+          title: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def update(
+        uid,
+        api_uid: nil,
+        api_version: nil,
+        config: nil,
+        is_private: nil,
+        slug: nil,
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      # List every SDK on the team.
+      sig do
+        params(
+          limit: Integer,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::SdkListResponse)
+      end
+      def list(limit: nil, request_options: {})
+      end
+
+      # Delete an SDK and every version it holds.
+      sig do
+        params(
+          uid: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def delete(uid, request_options: {})
+      end
+
+      # Start a build. Omit `version` to build the current work — the open draft, else
+      # the latest version — and the resolved version comes back in the response.
+      sig do
+        params(
+          uid: String,
+          languages: T::Array[Scalar::SdkBuildParams::Language::OrSymbol],
+          version: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::SdkBuildResponse)
+      end
+      def build(uid, languages: nil, version: nil, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Scalar::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/resources/teams/invites.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    class Teams
+      # Teams
+      class Invites
+        # Withdraw an invite that has not been accepted.
+        sig do
+          params(
+            uid: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def cancel(uid, request_options: {})
+        end
+
+        # Invite someone to the current team by email.
+        sig do
+          params(
+            email: String,
+            role: Scalar::Teams::Role::OrSymbol,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def member(email:, role:, request_options: {})
+        end
+
+        # Send the invite email again.
+        sig do
+          params(
+            uid: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def resend(uid, request_options: {})
+        end
+
+        # @api private
+        sig { params(client: Scalar::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/resources/teams/members.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    class Teams
+      # Teams
+      class Members
+        # Change what a member of the current team is allowed to do.
+        sig do
+          params(
+            uid: String,
+            role: Scalar::Teams::Role::OrSymbol,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def update(uid, role:, request_options: {})
+        end
+
+        # List the members of the current team, along with the invites still outstanding.
+        sig do
+          params(request_options: Scalar::RequestOptions::OrHash).returns(
+            Scalar::Models::Teams::MemberListResponse
+          )
+        end
+        def list(request_options: {})
+        end
+
+        # Remove someone from the current team.
+        sig do
+          params(
+            uid: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def delete(uid, request_options: {})
+        end
+
+        # @api private
+        sig { params(client: Scalar::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/resources/teams.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    # Teams
+    class Teams
+      # Teams
+      sig { returns(Scalar::Resources::Teams::Members) }
+      attr_reader :members
+
+      # Teams
+      sig { returns(Scalar::Resources::Teams::Invites) }
+      attr_reader :invites
+
+      # List all available teams
+      sig do
+        params(request_options: Scalar::RequestOptions::OrHash).returns(
+          T::Array[Scalar::Team]
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Scalar::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/resources/themes.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    # Themes
+    class Themes
+      # Create a team theme.
+      sig do
+        params(
+          document: String,
+          name: String,
+          slug: String,
+          description: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::UID)
+      end
+      def create(document:, name:, slug:, description: nil, request_options: {})
+      end
+
+      # Get the theme document by slug.
+      sig do
+        params(
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(String)
+      end
+      def retrieve(slug, request_options: {})
+      end
+
+      # Update theme metadata.
+      sig do
+        params(
+          slug: String,
+          description: String,
+          name: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def update(slug, description: nil, name: nil, request_options: {})
+      end
+
+      # List all team themes.
+      sig do
+        params(request_options: Scalar::RequestOptions::OrHash).returns(
+          T::Array[Scalar::Theme]
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # Delete a theme by slug.
+      sig do
+        params(
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def delete(slug, request_options: {})
+      end
+
+      # Replace the theme document.
+      sig do
+        params(
+          slug: String,
+          document: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def replace_document(slug, document:, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Scalar::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module Scalar
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/manifest.yaml

@@ -0,0 +1,6 @@
+# Standard libraries the signatures in this directory depend on, for `rbs collection`.
+dependencies:
+  - name: date
+  - name: openssl
+  - name: pathname
+  - name: uri

data/sig/scalar_api_ruby/client.rbs

@@ -0,0 +1,51 @@
+module Scalar
+  class Client < Scalar::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader bearer_auth: String?
+
+    attr_reader o_auth2: String?
+
+    attr_reader registry: Scalar::Resources::Registry
+
+    attr_reader schemas: Scalar::Resources::Schemas
+
+    attr_reader login_portals: Scalar::Resources::LoginPortals
+
+    attr_reader access_groups: Scalar::Resources::AccessGroups
+
+    attr_reader rules: Scalar::Resources::Rules
+
+    attr_reader themes: Scalar::Resources::Themes
+
+    attr_reader teams: Scalar::Resources::Teams
+
+    attr_reader scalar_docs: Scalar::Resources::ScalarDocs
+
+    attr_reader namespaces: Scalar::Resources::Namespaces
+
+    attr_reader authentication: Scalar::Resources::Authentication
+
+    attr_reader sdks: Scalar::Resources::Sdks
+
+    attr_reader mcp: Scalar::Resources::Mcp
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?bearer_auth: String?,
+      ?o_auth2: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/scalar_api_ruby/errors.rbs

@@ -0,0 +1,117 @@
+module Scalar
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < Scalar::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
+    end
+
+    class APIError < Scalar::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor headers: ::Hash[String, String]?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < Scalar::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < Scalar::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < Scalar::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class BadRequestError < Scalar::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < Scalar::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < Scalar::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < Scalar::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < Scalar::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < Scalar::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < Scalar::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < Scalar::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end