scalar_api_ruby 0.2.0

data/rbi/scalar_api_ruby/resources/registry.rbi

@@ -0,0 +1,240 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    # Registry
+    class Registry
+      # Create an API document.
+      sig do
+        params(
+          namespace: String,
+          document: String,
+          slug: String,
+          title: String,
+          version: String,
+          description: String,
+          is_private: T::Boolean,
+          ruleset: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::RegistryCreateAPIDocumentResponse)
+      end
+      def create_api_document(
+        namespace,
+        document:,
+        slug:,
+        title:,
+        version:,
+        description: nil,
+        is_private: nil,
+        ruleset: nil,
+        request_options: {}
+      )
+      end
+
+      # Add an access group to an API document.
+      sig do
+        params(
+          slug: String,
+          access_group_slug: String,
+          namespace: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def create_api_document_access_group(
+        # Path param
+        slug,
+        # Body param
+        access_group_slug:,
+        # Path param
+        namespace:,
+        request_options: {}
+      )
+      end
+
+      # Create a new API document version.
+      sig do
+        params(
+          slug: String,
+          namespace: String,
+          document: String,
+          version: String,
+          force: T::Boolean,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::ManagedDocVersion)
+      end
+      def create_api_document_version(
+        # Path param
+        slug,
+        # Path param
+        namespace:,
+        # Body param
+        document:,
+        # Body param
+        version:,
+        # Body param
+        force: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete an API document and all versions.
+      sig do
+        params(
+          slug: String,
+          namespace: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def delete_api_document(slug, namespace:, request_options: {})
+      end
+
+      # Remove an access group from an API document.
+      sig do
+        params(
+          slug: String,
+          access_group_slug: String,
+          namespace: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def delete_api_document_access_group(
+        # Path param
+        slug,
+        # Body param
+        access_group_slug:,
+        # Path param
+        namespace:,
+        request_options: {}
+      )
+      end
+
+      # Delete a specific API document version.
+      sig do
+        params(
+          semver: String,
+          namespace: String,
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def delete_api_document_version(
+        semver,
+        namespace:,
+        slug:,
+        request_options: {}
+      )
+      end
+
+      # List all API documents across every namespace the caller can access.
+      sig do
+        params(request_options: Scalar::RequestOptions::OrHash).returns(
+          T::Array[Scalar::APIDocument]
+        )
+      end
+      def list_all_api_documents(request_options: {})
+      end
+
+      # Get metadata (uid, content shas, version sha, tags) for a specific API document
+      # version.
+      sig do
+        params(
+          semver: String,
+          namespace: String,
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::ManagedDocVersion)
+      end
+      def list_api_document_version_metadata(
+        semver,
+        namespace:,
+        slug:,
+        request_options: {}
+      )
+      end
+
+      # List API documents in a namespace.
+      sig do
+        params(
+          namespace: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T::Array[Scalar::APIDocument])
+      end
+      def list_api_documents(namespace, request_options: {})
+      end
+
+      # Get a specific API document version.
+      sig do
+        params(
+          semver: String,
+          namespace: String,
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(String)
+      end
+      def retrieve_api_document_version(
+        semver,
+        namespace:,
+        slug:,
+        request_options: {}
+      )
+      end
+
+      # Update metadata for an API document.
+      sig do
+        params(
+          slug: String,
+          namespace: String,
+          description: String,
+          is_private: T::Boolean,
+          ruleset: String,
+          title: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def update_api_document(
+        # Path param
+        slug,
+        # Path param
+        namespace:,
+        # Body param
+        description: nil,
+        # Body param
+        is_private: nil,
+        # Body param
+        ruleset: nil,
+        # Body param
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      # Update the registry file content for an API document version.
+      sig do
+        params(
+          semver: String,
+          namespace: String,
+          slug: String,
+          document: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::RegistryUpdateAPIDocumentVersionResponse)
+      end
+      def update_api_document_version(
+        # Path param
+        semver,
+        # Path param
+        namespace:,
+        # Path param
+        slug:,
+        # Body param
+        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/resources/rules.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    # Rules
+    class Rules
+      # Create a rule in a namespace.
+      sig do
+        params(
+          namespace: String,
+          document: String,
+          slug: String,
+          title: String,
+          description: String,
+          is_private: T::Boolean,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::UID)
+      end
+      def create_ruleset(
+        namespace,
+        document:,
+        slug:,
+        title:,
+        description: nil,
+        is_private: nil,
+        request_options: {}
+      )
+      end
+
+      # Grant an access group to a rule.
+      sig do
+        params(
+          slug: String,
+          access_group_slug: String,
+          namespace: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def create_ruleset_access_group(
+        # Path param
+        slug,
+        # Body param
+        access_group_slug:,
+        # Path param
+        namespace:,
+        request_options: {}
+      )
+      end
+
+      # Delete a rule by slug.
+      sig do
+        params(
+          slug: String,
+          namespace: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def delete_ruleset(slug, namespace:, request_options: {})
+      end
+
+      # Remove an access group from a rule.
+      sig do
+        params(
+          slug: String,
+          access_group_slug: String,
+          namespace: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def delete_ruleset_access_group(
+        # Path param
+        slug,
+        # Body param
+        access_group_slug:,
+        # Path param
+        namespace:,
+        request_options: {}
+      )
+      end
+
+      # List all rulesets in a namespace.
+      sig do
+        params(
+          namespace: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T::Array[Scalar::Rule])
+      end
+      def list_rulesets(namespace, request_options: {})
+      end
+
+      # Get a rule document by slug.
+      sig do
+        params(
+          slug: String,
+          namespace: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(String)
+      end
+      def retrieve_ruleset_document(slug, namespace:, request_options: {})
+      end
+
+      # Update rule metadata by slug.
+      sig do
+        params(
+          path_slug: String,
+          path_namespace: String,
+          description: String,
+          is_private: T::Boolean,
+          body_namespace: String,
+          body_slug: String,
+          title: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def update_ruleset(
+        # Path param
+        path_slug,
+        # Path param
+        path_namespace:,
+        # Body param
+        description: nil,
+        # Body param
+        is_private: nil,
+        # Body param
+        body_namespace: nil,
+        # Body param
+        body_slug: nil,
+        # Body param
+        title: 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/scalar_docs.rbi

@@ -0,0 +1,220 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    # Scalar Docs
+    class ScalarDocs
+      # Create a guide project.
+      sig do
+        params(
+          allowed_domains: T::Array[String],
+          allowed_users: T::Array[String],
+          is_private: T::Boolean,
+          name: String,
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::ScalarDocCreateGuideResponse)
+      end
+      def create_guide(
+        allowed_domains:,
+        allowed_users:,
+        is_private:,
+        name:,
+        slug: nil,
+        request_options: {}
+      )
+      end
+
+      # Create a docs project. Omit `provider` to have Scalar host the repository.
+      sig do
+        params(
+          name: String,
+          provider: Scalar::ScalarDocCreateProjectParams::Provider::OrSymbol,
+          bitbucket_repository:
+            Scalar::ScalarDocCreateProjectParams::BitbucketRepository::OrHash,
+          blank: T::Boolean,
+          github_repository:
+            Scalar::ScalarDocCreateProjectParams::GithubRepository::OrHash,
+          is_private: T::Boolean,
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::DocsProject)
+      end
+      def create_project(
+        name:,
+        provider:,
+        bitbucket_repository: nil,
+        blank: nil,
+        github_repository: nil,
+        is_private: nil,
+        slug: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete a docs project, its deploys, its publish records and its cached builds.
+      sig do
+        params(
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def delete_project(slug, request_options: {})
+      end
+
+      # List all guide projects.
+      sig do
+        params(request_options: Scalar::RequestOptions::OrHash).returns(
+          T::Array[Scalar::GithubProject]
+        )
+      end
+      def list_guides(request_options: {})
+      end
+
+      # Read `scalar.config.json` straight from the project repository, without cloning
+      # it. `baseToken` is the compare-and-swap handle for a later write.
+      sig do
+        params(
+          slug: String,
+          ref: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::ScalarDocListProjectConfigResponse)
+      end
+      def list_project_config(slug, ref: nil, request_options: {})
+      end
+
+      # The domains the project serves on — the Scalar-hosted one and the custom one,
+      # when set.
+      sig do
+        params(
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::ScalarDocListProjectDomainResponse)
+      end
+      def list_project_domain(slug, request_options: {})
+      end
+
+      # Whether the project custom domain points at Scalar yet. `expected` is the CNAME
+      # record to create; `found` is what resolves today. A project with no custom
+      # domain reports `verified` with no expected record, because Scalar serves its own
+      # subdomain directly.
+      sig do
+        params(
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::ScalarDocListProjectDomainStatusResponse)
+      end
+      def list_project_domain_status(slug, request_options: {})
+      end
+
+      # List every docs project on the team.
+      sig do
+        params(
+          limit: Integer,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::ScalarDocListProjectsResponse)
+      end
+      def list_projects(limit: nil, request_options: {})
+      end
+
+      # Start a new publish process.
+      sig do
+        params(
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::ScalarDocPublishGuideResponse)
+      end
+      def publish_guide(slug, request_options: {})
+      end
+
+      # Start a build and deploy. The returned `publishUid` identifies the publish
+      # record.
+      sig do
+        params(
+          slug: String,
+          commit_sha: String,
+          config_path: String,
+          preview: T::Boolean,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::ScalarDocPublishProjectResponse)
+      end
+      def publish_project(
+        slug,
+        commit_sha: nil,
+        config_path: nil,
+        preview: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a single docs project by its slug.
+      sig do
+        params(
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::DocsProject)
+      end
+      def retrieve_project(slug, request_options: {})
+      end
+
+      # Update project settings. Set `isPrivate` with `accessGroups` to put the site
+      # behind a login.
+      sig do
+        params(
+          slug: String,
+          access_groups: T::Array[String],
+          active_theme_id: String,
+          agent_enabled: T::Boolean,
+          analytics_enabled: T::Boolean,
+          is_private: T::Boolean,
+          login_portal_uid:
+            Scalar::ScalarDocUpdateProjectParams::LoginPortalUID::Variants,
+          name: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.anything)
+      end
+      def update_project(
+        slug,
+        access_groups: nil,
+        active_theme_id: nil,
+        agent_enabled: nil,
+        analytics_enabled: nil,
+        is_private: nil,
+        login_portal_uid: nil,
+        name: nil,
+        request_options: {}
+      )
+      end
+
+      # Commit `scalar.config.json` straight to the project repository. Pass the
+      # `baseToken` from the read this edit was based on; a conflict means the file
+      # moved underneath it.
+      sig do
+        params(
+          slug: String,
+          content: String,
+          base_token: String,
+          message: String,
+          path: String,
+          ref: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(Scalar::Models::ScalarDocUpdateProjectConfigResponse)
+      end
+      def update_project_config(
+        slug,
+        content:,
+        base_token: nil,
+        message: nil,
+        path: nil,
+        ref: 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/schemas/access_group.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    class Schemas
+      # Schemas
+      class AccessGroup
+        # Add an access group to a schema.
+        sig do
+          params(
+            slug: String,
+            access_group_slug: String,
+            namespace: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def create(
+          # Path param
+          slug,
+          # Body param
+          access_group_slug:,
+          # Path param
+          namespace:,
+          request_options: {}
+        )
+        end
+
+        # Remove an access group from a schema.
+        sig do
+          params(
+            slug: String,
+            access_group_slug: String,
+            namespace: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def delete(
+          # Path param
+          slug,
+          # Body param
+          access_group_slug:,
+          # Path param
+          namespace:,
+          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/schemas/version.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Scalar
+  module Resources
+    class Schemas
+      # Schemas
+      class Version
+        # Create a schema version.
+        sig do
+          params(
+            slug: String,
+            namespace: String,
+            document: String,
+            version: String,
+            force: T::Boolean,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(Scalar::Models::Schemas::VersionCreateResponse)
+        end
+        def create(
+          # Path param
+          slug,
+          # Path param
+          namespace:,
+          # Body param
+          document:,
+          # Body param
+          version:,
+          # Body param
+          force: nil,
+          request_options: {}
+        )
+        end
+
+        # Get a specific schema version document.
+        sig do
+          params(
+            semver: String,
+            namespace: String,
+            slug: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(String)
+        end
+        def retrieve(semver, namespace:, slug:, request_options: {})
+        end
+
+        # Delete a schema version.
+        sig do
+          params(
+            semver: String,
+            namespace: String,
+            slug: String,
+            request_options: Scalar::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def delete(semver, namespace:, slug:, request_options: {})
+        end
+
+        # @api private
+        sig { params(client: Scalar::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end